为react组件库添加typescript类型提示的方法

184 阅读 0 评论 122 点赞

我是靠谱客的博主忧伤长颈鹿，这篇文章主要介绍为react组件库添加typescript类型提示的方法，现在分享给大家，希望可以做个参考。

以我自己的组件react-better-countdown为例，

首先在package.json里面添加types: types/index.d.ts，

，

然后文件目录上添加对应文件夹和文件，

最后是index.d.ts文件的编写，具体看代码:

复制代码

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
import * as React from 'react';

interface CountdownProps {
  count?: number;
  dayText?: string | React.ReactElement;
  hourText?: string | React.ReactElement;
  minuteText?: string | React.ReactElement;
  secondText?: string | React.ReactElement;
  callback?: Function;
  className?: string;
  style?: React.CSSProperties;
  rest?: any
}

interface CountdownState {
  count?: number;
}

declare module 'react-better-countdown' {
  export default class Countdown extends React.Component<CountdownProps, CountdownState> {
    state: CountdownState;
    timer: null | number;
    tick: () => void;
    componentDidMount(): void;
    componentDidUpdate(prevProps: CountdownProps): void;
    componentWillUnmount(): void;
    render: () => React.ReactElement;
  }
}