如何为无状态 React 组件创建 TypeScript 类型定义？

Question

我正在尝试为现有的 stateless React 组件套件创建类型定义，这样我就可以自动生成文档并改进团队工具中的智能感知。

示例组件可能如下所示：

myComponent.js

import React from 'react';

export const MyComponent = ({ prop1, prop2, prop3 }) => (
    <div>
        { prop1 ? prop2 : prop3 }
    </div>
);

我希望我的类型定义为：

• 定义哪些道具是允许的（以及哪些是必需的）
• 它将返回 JSX

查看this 使用 TypeScript 创建 React 组件的示例，我发现了类型：React.SFC。

我试图在我的定义中使用它：

index.d.ts

declare module "MyComponent" {
    import React from 'react';

    interface MyComponentProps {
        prop1: boolean;
        prop2?: string;
        prop3?: string;
    }

    export const MyComponent = React.SFC<MyComponentProps>
}

但我收到了 linting 错误 [ts] '(' expected.

我对 TypeScript 很陌生，我显然遗漏了一些东西，但我找不到任何关于为无状态组件创建类型定义的文章。

编辑 需要明确的是，我不想在 TypeScript 中重写我的组件。我想为现有的 ES6 无状态组件创建一个类型定义文件 (*.d.ts)。

Answer 1

经过大量的摆弄，我们确定了以下设置。

import React from 'react';

export interface MyComponentProps {
    prop1: boolean;
    prop2?: string;
    prop3?: string;
}

declare const MyComponent: React.SFC<MyComponentProps>

export default MyComponent

这方面的灵感来自： https://github.com/DefinitelyTyped/DefinitelyTyped/blob/master/types/material-ui/index.d.ts

它适用于 TypeDoc 以及 VS Code 的智能感知。

我相信export default 是在这里破解智能感知的关键。

Answer 2

试试这个：

declare module "MyComponent" {
  import React from 'react';

  interface MyComponentProps {
    prop1: boolean;
    prop2?: string;
    prop3?: string;
  }

  export const MyComponent: (props: MyComponentProps) => React.SFC<MyComponentProps>
}

来自官方 React 页面推荐 Type Definitions

Answer 3

我觉得你需要var MyComponent: React.SFC<MyComponentProps>;

您可能会考虑在 typescript 中重写现有代码，只是为了看看 tsc 会生成什么样的定义。然后丢弃代码，只保留定义。

Answer 4

它是:，而不是=。

export const MyComponent:React.SFC<MyComponentProps> = ({ prop1, prop2, prop3 }) => (
<div>
    { prop1 ? prop2 : prop3 }
</div>
);

Answer 5

我正在使用 Microsoft 提供的 react typescript react 样板 https://github.com/Microsoft/TypeScript-React-Starter

我在 typescript 中这样创建一个无状态组件：

export interface IMyComponentProps {
   prop1: string;
   prop2: (event: React.MouseEvent) => void;
   prop3: number;
}

export class MyComponent extends React.Component<IMyComponentProps> {
    render(): JSX.Element {
        const {prop1, prop2} = this.props

        return (
            //My code here
            <button>prop1</button>
            <button>prop2</button>
        );
    }
}

Answer 6

你可以试试这样的。

export type YourComponentType = {
  props1,
  props2
}

const YourComponent = ({
  props1,
  props2,
  ...restProps //additional props if passed to components.
}: YourComponentType) => (
  <div>{props1}</div>
)

export default YourComponent;