diff --git a/packages/components/affix/affix.en-US.md b/packages/components/affix/affix.en-US.md index 9adbc53cec..6fdcf79381 100644 --- a/packages/components/affix/affix.en-US.md +++ b/packages/components/affix/affix.en-US.md @@ -5,12 +5,12 @@ name | type | default | description | required -- | -- | -- | -- | -- -className | String | - | 类名 | N -style | Object | - | 样式，Typescript：`React.CSSProperties` | N -children | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -container | String / Function | () => (() => window) | Typescript：`ScrollContainer`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -content | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +className | String | - | className of component | N +style | Object | - | CSS(Cascading Style Sheets)，Typescript: `React.CSSProperties` | N +children | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +container | String / Function | () => (() => window) | Typescript: `ScrollContainer`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +content | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N offsetBottom | Number | 0 | When the distance from the bottom of the container reaches the specified distance, the trigger is fixed | N offsetTop | Number | 0 | When the distance from the top of the container reaches the specified distance, the trigger is fixed | N zIndex | Number | - | \- | N -onFixedChange | Function | | Typescript：`(affixed: boolean, context: { top: number }) => void`
| N +onFixedChange | Function | | Typescript: `(affixed: boolean, context: { top: number }) => void`
| N diff --git a/packages/components/affix/affix.md b/packages/components/affix/affix.md index 78cdd362df..a0fa6a4f62 100644 --- a/packages/components/affix/affix.md +++ b/packages/components/affix/affix.md @@ -3,7 +3,7 @@ ## API ### Affix Props -名称 | 类型 | 默认值 | 说明 | 必传 +名称 | 类型 | 默认值 | 描述 | 必传 -- | -- | -- | -- | -- className | String | - | 类名 | N style | Object | - | 样式，TS 类型：`React.CSSProperties` | N diff --git a/packages/components/alert/alert.en-US.md b/packages/components/alert/alert.en-US.md index 4ee5841af6..a36ac644b4 100644 --- a/packages/components/alert/alert.en-US.md +++ b/packages/components/alert/alert.en-US.md @@ -7,14 +7,14 @@ name | type | default | description | required -- | -- | -- | -- | -- className | String | - | className of component | N -style | Object | - | CSS(Cascading Style Sheets)，Typescript：`React.CSSProperties` | N -close | TNode | false | Deprecated, use closeBtn instead. Typescript：`string \| boolean \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -closeBtn | TNode | false | Close button. Value "true" show the close button. Value "False" hide close button. Value type string display as is. Use TNode to custom the close trigger. Typescript：`string \| boolean \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -icon | TElement | - | Typescript：`TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +style | Object | - | CSS(Cascading Style Sheets)，Typescript: `React.CSSProperties` | N +close | TNode | false | Deprecated, use closeBtn instead. Typescript: `string \| boolean \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +closeBtn | TNode | false | Close button. Value "true" show the close button. Value "False" hide close button. Value type string display as is. Use TNode to custom the close trigger. Typescript: `string \| boolean \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +icon | TElement | - | Typescript: `TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N maxLine | Number | 0 | \- | N -message | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -operation | TElement | - | Typescript：`TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +message | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +operation | TElement | - | Typescript: `TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N theme | String | info | options: success/info/warning/error | N -title | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -onClose | Function | | Typescript：`(context: { e: MouseEvent }) => void`
| N -onClosed | Function | | Typescript：`(context: { e: TransitionEvent }) => void`
| N +title | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +onClose | Function | | Typescript: `(context: { e: MouseEvent }) => void`
| N +onClosed | Function | | Typescript: `(context: { e: TransitionEvent }) => void`
| N diff --git a/packages/components/anchor/anchor.en-US.md b/packages/components/anchor/anchor.en-US.md index 4cb08b896a..84b61f5def 100644 --- a/packages/components/anchor/anchor.en-US.md +++ b/packages/components/anchor/anchor.en-US.md @@ -5,33 +5,33 @@ name | type | default | description | required -- | -- | -- | -- | -- -className | String | - | 类名 | N -style | Object | - | 样式，Typescript：`React.CSSProperties` | N -affixProps | Object | - | Typescript：`Omit`，[Affix API Documents](./affix?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/anchor/type.ts) | N +className | String | - | className of component | N +style | Object | - | CSS(Cascading Style Sheets)，Typescript: `React.CSSProperties` | N +affixProps | Object | - | Typescript: `Omit`，[Affix API Documents](./affix?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/anchor/type.ts) | N bounds | Number | 5 | \- | N -container | String / Function | () => window | Typescript：`ScrollContainer`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -cursor | TElement | - | Typescript：`TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -getCurrentAnchor | Function | - | Custom Highlighted Anchor Points。Typescript：`(activeLink: string) => string` | N -size | String | medium | options: small/medium/large。Typescript：`SizeEnum`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +container | String / Function | () => window | Typescript: `ScrollContainer`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +cursor | TElement | - | Typescript: `TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +getCurrentAnchor | Function | - | Custom Highlighted Anchor Points。Typescript: `(activeLink: string) => string` | N +size | String | medium | options: small/medium/large。Typescript: `SizeEnum`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N targetOffset | Number | 0 | \- | N -onChange | Function | | Typescript：`(currentLink: string, prevLink: string) => void`
| N -onClick | Function | | Typescript：`(link: { href: string; title: string; e: MouseEvent }) => void`
| N +onChange | Function | | Typescript: `(currentLink: string, prevLink: string) => void`
| N +onClick | Function | | Typescript: `(link: { href: string; title: string; e: MouseEvent }) => void`
| N ### AnchorItem Props name | type | default | description | required -- | -- | -- | -- | -- -className | String | - | 类名 | N -style | Object | - | 样式，Typescript：`React.CSSProperties` | N +className | String | - | className of component | N +style | Object | - | CSS(Cascading Style Sheets)，Typescript: `React.CSSProperties` | N href | String | - | required | Y target | String | _self | options: _self/_blank/_parent/_top | N -title | TNode | '' | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +title | TNode | '' | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N ### AnchorTarget Props name | type | default | description | required -- | -- | -- | -- | -- -className | String | - | 类名 | N -style | Object | - | 样式，Typescript：`React.CSSProperties` | N +className | String | - | className of component | N +style | Object | - | CSS(Cascading Style Sheets)，Typescript: `React.CSSProperties` | N id | String | - | required | Y tag | String | div | \- | N diff --git a/packages/components/anchor/anchor.md b/packages/components/anchor/anchor.md index 9486f4d1a5..abe1916ff8 100644 --- a/packages/components/anchor/anchor.md +++ b/packages/components/anchor/anchor.md @@ -3,7 +3,7 @@ ## API ### Anchor Props -名称 | 类型 | 默认值 | 说明 | 必传 +名称 | 类型 | 默认值 | 描述 | 必传 -- | -- | -- | -- | -- className | String | - | 类名 | N style | Object | - | 样式，TS 类型：`React.CSSProperties` | N @@ -19,7 +19,7 @@ onClick | Function | | TS 类型：`(link: { href: string; title: string; e: Mo ### AnchorItem Props -名称 | 类型 | 默认值 | 说明 | 必传 +名称 | 类型 | 默认值 | 描述 | 必传 -- | -- | -- | -- | -- className | String | - | 类名 | N style | Object | - | 样式，TS 类型：`React.CSSProperties` | N @@ -29,7 +29,7 @@ title | TNode | '' | 锚点文本。TS 类型：`string \| TNode`。[通用类 ### AnchorTarget Props -名称 | 类型 | 默认值 | 说明 | 必传 +名称 | 类型 | 默认值 | 描述 | 必传 -- | -- | -- | -- | -- className | String | - | 类名 | N style | Object | - | 样式，TS 类型：`React.CSSProperties` | N diff --git a/packages/components/auto-complete/auto-complete.en-US.md b/packages/components/auto-complete/auto-complete.en-US.md index d0cd7b978f..bdd02be21e 100644 --- a/packages/components/auto-complete/auto-complete.en-US.md +++ b/packages/components/auto-complete/auto-complete.en-US.md @@ -7,35 +7,35 @@ name | type | default | description | required -- | -- | -- | -- | -- className | String | - | className of component | N -style | Object | - | CSS(Cascading Style Sheets)，Typescript：`React.CSSProperties` | N +style | Object | - | CSS(Cascading Style Sheets)，Typescript: `React.CSSProperties` | N autofocus | Boolean | - | \- | N borderless | Boolean | false | \- | N -children | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +children | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N clearable | Boolean | - | \- | N disabled | Boolean | - | \- | N -empty | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -filter | Function | - | Typescript：`(filterWords: string, option: T) => boolean \| Promise` | N +empty | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +filter | Function | - | Typescript: `(filterWords: string, option: T) => boolean \| Promise` | N filterable | Boolean | true | \- | N highlightKeyword | Boolean | true | \- | N -inputProps | Object | - | Typescript：`InputProps`，[Input API Documents](./input?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/auto-complete/type.ts) | N -options | Array | - | Typescript：`Array` | N -panelBottomContent | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -panelTopContent | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +inputProps | Object | - | Typescript: `InputProps`，[Input API Documents](./input?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/auto-complete/type.ts) | N +options | Array | - | Typescript: `Array` | N +panelBottomContent | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +panelTopContent | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N placeholder | String | undefined | \- | N -popupProps | Object | - | Typescript：`PopupProps`，[Popup API Documents](./popup?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/auto-complete/type.ts) | N +popupProps | Object | - | Typescript: `PopupProps`，[Popup API Documents](./popup?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/auto-complete/type.ts) | N readonly | Boolean | - | \- | N -size | String | medium | options: small/medium/large。Typescript：`SizeEnum`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +size | String | medium | options: small/medium/large。Typescript: `SizeEnum`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N status | String | default | options: default/success/warning/error | N -textareaProps | Object | - | Typescript：`TextareaProps`，[Textarea API Documents](./textarea?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/auto-complete/type.ts) | N -tips | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -triggerElement | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +textareaProps | Object | - | Typescript: `TextareaProps`，[Textarea API Documents](./textarea?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/auto-complete/type.ts) | N +tips | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +triggerElement | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N value | String | - | \- | N defaultValue | String | - | uncontrolled property | N -onBlur | Function | | Typescript：`(context: { e: FocusEvent; value: string }) => void`
| N -onChange | Function | | Typescript：`(value: string, context?: { e?: InputEvent \| MouseEvent \| CompositionEvent \| KeyboardEvent }) => void`
| N -onClear | Function | | Typescript：`(context: { e: MouseEvent }) => void`
| N -onCompositionend | Function | | Typescript：`(context: { e: CompositionEvent; value: string }) => void`
trigger on compositionend | N -onCompositionstart | Function | | Typescript：`(context: { e: CompositionEvent; value: string }) => void`
trigger on compositionstart | N -onEnter | Function | | Typescript：`(context: { e: KeyboardEvent; value: string }) => void`
| N -onFocus | Function | | Typescript：`(context: { e: FocusEvent; value: string }) => void`
| N -onSelect | Function | | Typescript：`(value: string, context: { e: MouseEvent \| KeyboardEvent }) => void`
| N +onBlur | Function | | Typescript: `(context: { e: FocusEvent; value: string }) => void`
| N +onChange | Function | | Typescript: `(value: string, context?: { e?: InputEvent \| MouseEvent \| CompositionEvent \| KeyboardEvent }) => void`
| N +onClear | Function | | Typescript: `(context: { e: MouseEvent }) => void`
| N +onCompositionend | Function | | Typescript: `(context: { e: CompositionEvent; value: string }) => void`
trigger on compositionend | N +onCompositionstart | Function | | Typescript: `(context: { e: CompositionEvent; value: string }) => void`
trigger on compositionstart | N +onEnter | Function | | Typescript: `(context: { e: KeyboardEvent; value: string }) => void`
| N +onFocus | Function | | Typescript: `(context: { e: FocusEvent; value: string }) => void`
| N +onSelect | Function | | Typescript: `(value: string, context: { e: MouseEvent \| KeyboardEvent }) => void`
| N diff --git a/packages/components/avatar/avatar.en-US.md b/packages/components/avatar/avatar.en-US.md index d520ed6503..827f49958f 100644 --- a/packages/components/avatar/avatar.en-US.md +++ b/packages/components/avatar/avatar.en-US.md @@ -5,30 +5,30 @@ name | type | default | description | required -- | -- | -- | -- | -- -className | String | - | 类名 | N -style | Object | - | 样式，Typescript：`React.CSSProperties` | N +className | String | - | className of component | N +style | Object | - | CSS(Cascading Style Sheets)，Typescript: `React.CSSProperties` | N alt | String | - | show it when url is not valid | N -children | TNode | - | children, same as `content`。Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -content | TNode | - | content slot or props.content。Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +children | TNode | - | children, same as `content`。Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +content | TNode | - | content slot or props.content。Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N hideOnLoadFailed | Boolean | false | hide image when loading image failed | N -icon | TElement | - | use icon to fill。Typescript：`TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +icon | TElement | - | use icon to fill。Typescript: `TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N image | String | - | images url | N -imageProps | Object | - | Typescript：`ImageProps`，[Image API Documents](./image?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/avatar/type.ts) | N -shape | String | circle | shape。options：circle/round。Typescript：`ShapeEnum ` `type ShapeEnum = 'circle' \| 'round'`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/avatar/type.ts) | N +imageProps | Object | - | Typescript: `ImageProps`，[Image API Documents](./image?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/avatar/type.ts) | N +shape | String | circle | shape。options：circle/round。Typescript: `ShapeEnum ` `type ShapeEnum = 'circle' \| 'round'`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/avatar/type.ts) | N size | String | - | size | N -onError | Function | | Typescript：`(context: { e: ImageEvent }) => void`
trigger on image load failed | N -onClick | Function | | Typescript：`(context: { e: React.MouseEvent }) => void`
trigger on click | N -onHover | Function | | Typescript：`(context: { e: React.MouseEvent }) => void`
trigger on hover | N -onContextmenu | Function | | Typescript：`(context: { e: React.MouseEvent }) => void`
trigger on right click | N +onError | Function | | Typescript: `(context: { e: ImageEvent }) => void`
trigger on image load failed | N +onClick | Function | | Typescript: `(context: { e: React.MouseEvent }) => void`
trigger on click | N +onHover | Function | | Typescript: `(context: { e: React.MouseEvent }) => void`
trigger on hover | N +onContextmenu | Function | | Typescript: `(context: { e: React.MouseEvent }) => void`
trigger on right click | N ### AvatarGroup Props name | type | default | description | required -- | -- | -- | -- | -- -className | String | - | 类名 | N -style | Object | - | 样式，Typescript：`React.CSSProperties` | N -cascading | String | 'right-up' | multiple images cascading。options：left-up/right-up。Typescript：`CascadingValue` `type CascadingValue = 'left-up' \| 'right-up'`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/avatar/type.ts) | N -collapseAvatar | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +className | String | - | className of component | N +style | Object | - | CSS(Cascading Style Sheets)，Typescript: `React.CSSProperties` | N +cascading | String | 'right-up' | multiple images cascading。options：left-up/right-up。Typescript: `CascadingValue` `type CascadingValue = 'left-up' \| 'right-up'`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/avatar/type.ts) | N +collapseAvatar | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N max | Number | - | \- | N -popupProps | Object | - | Typescript：`PopupProps`，[Popup API Documents](./popup?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/avatar/type.ts) | N +popupProps | Object | - | Typescript: `PopupProps`，[Popup API Documents](./popup?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/avatar/type.ts) | N size | String | - | size | N diff --git a/packages/components/avatar/avatar.md b/packages/components/avatar/avatar.md index 3dd4a04e7f..3ac8aebb39 100644 --- a/packages/components/avatar/avatar.md +++ b/packages/components/avatar/avatar.md @@ -3,7 +3,7 @@ ## API ### Avatar Props -名称 | 类型 | 默认值 | 说明 | 必传 +名称 | 类型 | 默认值 | 描述 | 必传 -- | -- | -- | -- | -- className | String | - | 类名 | N style | Object | - | 样式，TS 类型：`React.CSSProperties` | N @@ -23,7 +23,7 @@ onContextmenu | Function | | TS 类型：`(context: { e: React.MouseEvent }) => ### AvatarGroup Props -名称 | 类型 | 默认值 | 说明 | 必传 +名称 | 类型 | 默认值 | 描述 | 必传 -- | -- | -- | -- | -- className | String | - | 类名 | N style | Object | - | 样式，TS 类型：`React.CSSProperties` | N diff --git a/packages/components/back-top/back-top.en-US.md b/packages/components/back-top/back-top.en-US.md index 433290dee6..e73f65308e 100644 --- a/packages/components/back-top/back-top.en-US.md +++ b/packages/components/back-top/back-top.en-US.md @@ -6,17 +6,17 @@ name | type | default | description | required -- | -- | -- | -- | -- -className | String | - | 类名 | N -style | Object | - | 样式，Typescript：`React.CSSProperties` | N -children | TNode | - | Backtop's children elements, same as `content`。Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -container | String / Function | 'body' | Typescript：`AttachNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -content | TNode | - | Backtop's children elements。Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -default | TNode | - | Backtop's children elements, same as `content`。Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +className | String | - | className of component | N +style | Object | - | CSS(Cascading Style Sheets)，Typescript: `React.CSSProperties` | N +children | TNode | - | Backtop's children elements, same as `content`。Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +container | String / Function | 'body' | Typescript: `AttachNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +content | TNode | - | Backtop's children elements。Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +default | TNode | - | Backtop's children elements, same as `content`。Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N duration | Number | 200 | \- | N -offset | Array | ["24px", "80px"] | Typescript：`Array` | N -shape | String | square | shape of BackTop element。options：circle/square。Typescript：`BackTopShapeEnum ` `type BackTopShapeEnum = 'circle' \| 'square'`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/back-top/type.ts) | N +offset | Array | ["24px", "80px"] | Typescript: `Array` | N +shape | String | square | shape of BackTop element。options：circle/square。Typescript: `BackTopShapeEnum ` `type BackTopShapeEnum = 'circle' \| 'square'`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/back-top/type.ts) | N size | String | medium | size of BackTop。options：medium/small | N -target | String / Function | 'body' | Typescript：`AttachNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +target | String / Function | 'body' | Typescript: `AttachNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N theme | String | light | theme of BackTop。options：light/primary/dark | N visibleHeight | String / Number | '200px' | \- | N -onClick | Function | | Typescript：`(context: { e: MouseEvent }) => void`
| N +onClick | Function | | Typescript: `(context: { e: MouseEvent }) => void`
| N diff --git a/packages/components/back-top/back-top.md b/packages/components/back-top/back-top.md index 8d40b603b6..f8ad2d9d82 100644 --- a/packages/components/back-top/back-top.md +++ b/packages/components/back-top/back-top.md @@ -4,7 +4,7 @@ ### BackTop Props -名称 | 类型 | 默认值 | 说明 | 必传 +名称 | 类型 | 默认值 | 描述 | 必传 -- | -- | -- | -- | -- className | String | - | 类名 | N style | Object | - | 样式，TS 类型：`React.CSSProperties` | N diff --git a/packages/components/badge/badge.en-US.md b/packages/components/badge/badge.en-US.md index 7702187ca6..c39f18a009 100644 --- a/packages/components/badge/badge.en-US.md +++ b/packages/components/badge/badge.en-US.md @@ -6,15 +6,15 @@ name | type | default | description | required -- | -- | -- | -- | -- -className | String | - | 类名 | N -style | Object | - | 样式，Typescript：`React.CSSProperties` | N -children | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +className | String | - | className of component | N +style | Object | - | CSS(Cascading Style Sheets)，Typescript：`React.CSSProperties` | N +children | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N color | String | - | \- | N -content | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -count | TNode | 0 | Typescript：`string \| number \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +content | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +count | TNode | 0 | Typescript: `string \| number \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N dot | Boolean | false | \- | N maxCount | Number | 99 | \- | N -offset | Array | - | Typescript：`Array` | N +offset | Array | - | Typescript: `Array` | N shape | String | circle | options：circle/round | N showZero | Boolean | false | \- | N size | String | medium | options：small/medium | N diff --git a/packages/components/badge/badge.md b/packages/components/badge/badge.md index af36b85af7..96e2cff81f 100644 --- a/packages/components/badge/badge.md +++ b/packages/components/badge/badge.md @@ -3,7 +3,7 @@ ## API ### Badge Props -名称 | 类型 | 默认值 | 说明 | 必传 +名称 | 类型 | 默认值 | 描述 | 必传 -- | -- | -- | -- | -- className | String | - | 类名 | N style | Object | - | 样式，TS 类型：`React.CSSProperties` | N diff --git a/packages/components/breadcrumb/breadcrumb.en-US.md b/packages/components/breadcrumb/breadcrumb.en-US.md index f4e934f9e9..4bd96c8d03 100644 --- a/packages/components/breadcrumb/breadcrumb.en-US.md +++ b/packages/components/breadcrumb/breadcrumb.en-US.md @@ -7,10 +7,10 @@ name | type | default | description | required -- | -- | -- | -- | -- className | String | - | className of component | N -style | Object | - | CSS(Cascading Style Sheets)，Typescript：`React.CSSProperties` | N +style | Object | - | CSS(Cascading Style Sheets)，Typescript: `React.CSSProperties` | N maxItemWidth | String | undefined | \- | N -options | Array | - | Typescript：`Array` | N -separator | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +options | Array | - | Typescript: `Array` | N +separator | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N ### BreadcrumbItem Props @@ -18,16 +18,16 @@ separator | TNode | - | Typescript：`string \| TNode`。[see more ts definition name | type | default | description | required -- | -- | -- | -- | -- className | String | - | className of component | N -style | Object | - | CSS(Cascading Style Sheets)，Typescript：`React.CSSProperties` | N -children | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -content | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +style | Object | - | CSS(Cascading Style Sheets)，Typescript: `React.CSSProperties` | N +children | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +content | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N disabled | Boolean | - | \- | N href | String | - | \- | N -icon | TElement | - | prefix icon in breadcrumb item。Typescript：`TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +icon | TElement | - | prefix icon in breadcrumb item。Typescript: `TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N maxWidth | String | undefined | \- | N replace | Boolean | false | \- | N -router | Object | - | Typescript：`any` | N +router | Object | - | Typescript: `any` | N target | String | _self | options: _blank/_self/_parent/_top | N -to | String / Object | - | Typescript：`string \| Route` `interface Route { path?: string; name?: string; hash?: string; query?: RouteData; params?: RouteData }` `type RouteData = { [key: string]: string \| string[] }`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/breadcrumb/type.ts) | N -tooltipProps | Object | - | Typescript：`TooltipProps`，[Tooltip API Documents](./tooltip?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/breadcrumb/type.ts) | N -onClick | Function | | Typescript：`(e: MouseEvent) => void`
trigger on click | N +to | String / Object | - | Typescript: `string \| Route` `interface Route { path?: string; name?: string; hash?: string; query?: RouteData; params?: RouteData }` `type RouteData = { [key: string]: string \| string[] }`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/breadcrumb/type.ts) | N +tooltipProps | Object | - | Typescript: `TooltipProps`，[Tooltip API Documents](./tooltip?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/breadcrumb/type.ts) | N +onClick | Function | | Typescript: `(e: MouseEvent) => void`
trigger on click | N diff --git a/packages/components/button/button.en-US.md b/packages/components/button/button.en-US.md index c417d90bbb..bb77d95a38 100644 --- a/packages/components/button/button.en-US.md +++ b/packages/components/button/button.en-US.md @@ -5,22 +5,22 @@ name | type | default | description | required -- | -- | -- | -- | -- -className | String | - | 类名 | N -style | Object | - | 样式，Typescript：`React.CSSProperties` | N +className | String | - | className of component | N +style | Object | - | CSS(Cascading Style Sheets)，Typescript: `React.CSSProperties` | N block | Boolean | false | make button to be a block-level element | N -children | TNode | - | button's children elements。Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -content | TNode | - | button's children elements。Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +children | TNode | - | button's children elements。Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +content | TNode | - | button's children elements。Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N disabled | Boolean | false | disable the button, make it can not be clicked | N form | String | undefined | native `form` attribute，which supports triggering events for a form with a specified id through the use of the form attribute. | N ghost | Boolean | false | make background-color to be transparent | N href | String | - | \- | N -icon | TElement | - | use it to set left icon in button。Typescript：`TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +icon | TElement | - | use it to set left icon in button。Typescript: `TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N loading | Boolean | false | set button to be loading state | N shape | String | rectangle | button shape。options：rectangle/square/round/circle | N -size | String | medium | a button has three size。options：small/medium/large。Typescript：`SizeEnum`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -suffix | TElement | - | Typescript：`TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +size | String | medium | a button has three size。options：small/medium/large。Typescript: `SizeEnum`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +suffix | TElement | - | Typescript: `TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N tag | String | - | HTML Tag Element。options：button/a/div | N theme | String | - | button theme。options：default/primary/danger/warning/success | N type | String | button | type of button element in html。options：submit/reset/button | N variant | String | base | variant of button。options：base/outline/dashed/text | N -onClick | Function | | Typescript：`(e: MouseEvent) => void`
trigger on click | N +onClick | Function | | Typescript: `(e: MouseEvent) => void`
trigger on click | N diff --git a/packages/components/button/button.md b/packages/components/button/button.md index 75ff9210b7..d3f4aa5e28 100644 --- a/packages/components/button/button.md +++ b/packages/components/button/button.md @@ -3,7 +3,7 @@ ## API ### Button Props -名称 | 类型 | 默认值 | 说明 | 必传 +名称 | 类型 | 默认值 | 描述 | 必传 -- | -- | -- | -- | -- className | String | - | 类名 | N style | Object | - | 样式，TS 类型：`React.CSSProperties` | N diff --git a/packages/components/calendar/calendar.en-US.md b/packages/components/calendar/calendar.en-US.md index 4a2f909f4c..827efbd708 100644 --- a/packages/components/calendar/calendar.en-US.md +++ b/packages/components/calendar/calendar.en-US.md @@ -6,47 +6,47 @@ name | type | default | description | required -- | -- | -- | -- | -- -className | String | - | 类名 | N -style | Object | - | 样式，Typescript：`React.CSSProperties` | N -cell | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -cellAppend | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -controllerConfig | Boolean / Object | - | Typescript：`boolean \| CalendarController` | N +className | String | - | className of component | N +style | Object | - | CSS(Cascading Style Sheets)，Typescript: `React.CSSProperties` | N +cell | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +cellAppend | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +controllerConfig | Boolean / Object | - | Typescript: `boolean \| CalendarController` | N fillWithZero | Boolean | true | \- | N firstDayOfWeek | Number | 1 | options：1/2/3/4/5/6/7 | N format | String | 'YYYY-MM-DD' | \- | N -head | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +head | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N isShowWeekendDefault | Boolean | true | \- | N mode | String | month | options：month/year | N month | String / Number | - | \- | N preventCellContextmenu | Boolean | false | \- | N -range | Array | - | Typescript：`Array` | N +range | Array | - | Typescript: `Array` | N theme | String | full | options：full/card | N -value | String / Date | - | Typescript：`CalendarValue` `type CalendarValue = string \| Date`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/calendar/type.ts) | N -week | TNode | - | Typescript：`Array \| TNode` `interface CalendarWeek { day: WeekDay }` `type WeekDay = 1 \| 2 \| 3 \| 4 \| 5 \| 6 \| 7`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/calendar/type.ts) | N +value | String / Date | - | Typescript: `CalendarValue` `type CalendarValue = string \| Date`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/calendar/type.ts) | N +week | TNode | - | Typescript: `Array \| TNode` `interface CalendarWeek { day: WeekDay }` `type WeekDay = 1 \| 2 \| 3 \| 4 \| 5 \| 6 \| 7`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/calendar/type.ts) | N year | String / Number | - | \- | N -onCellClick | Function | | Typescript：`(options: { cell: CalendarCell; e: MouseEvent }) => void`
| N -onCellDoubleClick | Function | | Typescript：`(options: { cell: CalendarCell; e: MouseEvent }) => void`
| N -onCellRightClick | Function | | Typescript：`(options: { cell: CalendarCell; e: MouseEvent }) => void`
| N -onControllerChange | Function | | Typescript：`(options: ControllerOptions) => void`
[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/calendar/type.ts)。
`interface ControllerOptions { filterDate: Date; formattedFilterDate: string; mode: string; isShowWeekend: boolean }`
| N -onMonthChange | Function | | Typescript：`(options: { month: string; year: string }) => void`
| N +onCellClick | Function | | Typescript: `(options: { cell: CalendarCell; e: MouseEvent }) => void`
| N +onCellDoubleClick | Function | | Typescript: `(options: { cell: CalendarCell; e: MouseEvent }) => void`
| N +onCellRightClick | Function | | Typescript: `(options: { cell: CalendarCell; e: MouseEvent }) => void`
| N +onControllerChange | Function | | Typescript: `(options: ControllerOptions) => void`
[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/calendar/type.ts)。
`interface ControllerOptions { filterDate: Date; formattedFilterDate: string; mode: string; isShowWeekend: boolean }`
| N +onMonthChange | Function | | Typescript: `(options: { month: string; year: string }) => void`
| N ### CalendarController name | type | default | description | required -- | -- | -- | -- | -- -current | Object | - | Typescript：`{ visible?: boolean; currentDayButtonProps?: ButtonProps; currentMonthButtonProps?: ButtonProps }` | N +current | Object | - | Typescript: `{ visible?: boolean; currentDayButtonProps?: ButtonProps; currentMonthButtonProps?: ButtonProps }` | N disabled | Boolean | false | \- | N -mode | Object | - | Typescript：`{ visible?: boolean; radioGroupProps?: RadioGroupProps }`，[Radio API Documents](./radio?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/calendar/type.ts) | N -month | Object | - | Typescript：`{ visible?: boolean; selectProps?: SelectProps }` | N -weekend | Object | - | Typescript：`{ visible?: boolean; showWeekendButtonProps?: CheckTagProps; hideWeekendButtonProps?: CheckTagProps }`，[Tag API Documents](./tag?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/calendar/type.ts) | N -year | Object | - | Typescript：`{ visible?: boolean; selectProps?: SelectProps }`，[Select API Documents](./select?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/calendar/type.ts) | N +mode | Object | - | Typescript: `{ visible?: boolean; radioGroupProps?: RadioGroupProps }`，[Radio API Documents](./radio?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/calendar/type.ts) | N +month | Object | - | Typescript: `{ visible?: boolean; selectProps?: SelectProps }` | N +weekend | Object | - | Typescript: `{ visible?: boolean; showWeekendButtonProps?: CheckTagProps; hideWeekendButtonProps?: CheckTagProps }`，[Tag API Documents](./tag?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/calendar/type.ts) | N +year | Object | - | Typescript: `{ visible?: boolean; selectProps?: SelectProps }`，[Select API Documents](./select?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/calendar/type.ts) | N ### CalendarCell name | type | default | description | required -- | -- | -- | -- | -- belongTo | Number | - | \- | N -date | Object | - | Typescript：`Date` | N +date | Object | - | Typescript: `Date` | N day | Number | - | \- | N formattedDate | String | - | \- | N isCurrent | Boolean | - | \- | N diff --git a/packages/components/calendar/calendar.md b/packages/components/calendar/calendar.md index ace3ec19bc..1f15aabb41 100644 --- a/packages/components/calendar/calendar.md +++ b/packages/components/calendar/calendar.md @@ -3,7 +3,7 @@ ## API ### Calendar Props -名称 | 类型 | 默认值 | 说明 | 必传 +名称 | 类型 | 默认值 | 描述 | 必传 -- | -- | -- | -- | -- className | String | - | 类名 | N style | Object | - | 样式，TS 类型：`React.CSSProperties` | N @@ -31,7 +31,7 @@ onMonthChange | Function | | TS 类型：`(options: { month: string; year: stri ### CalendarController -名称 | 类型 | 默认值 | 说明 | 必传 +名称 | 类型 | 默认值 | 描述 | 必传 -- | -- | -- | -- | -- current | Object | - | “今天(本月)”按钮控制器。TS 类型：`{ visible?: boolean; currentDayButtonProps?: ButtonProps; currentMonthButtonProps?: ButtonProps }` | N disabled | Boolean | false | 是否禁用右上角控制器 | N @@ -42,7 +42,7 @@ year | Object | - | 日历年份控制器。TS 类型：`{ visible?: boolean; se ### CalendarCell -名称 | 类型 | 默认值 | 说明 | 必传 +名称 | 类型 | 默认值 | 描述 | 必传 -- | -- | -- | -- | -- belongTo | Number | - | 用于表示日期单元格属于哪一个月份。值为 0 表示是当前日历显示的月份中的日期，值为 -1 表示是上个月的，值为 1 表示是下个月的（日历展示维度是“月”时有值） | N date | Object | - | 日历单元格日期。TS 类型：`Date` | N diff --git a/packages/components/card/card.en-US.md b/packages/components/card/card.en-US.md index 6bbbff6e34..f035668e80 100644 --- a/packages/components/card/card.en-US.md +++ b/packages/components/card/card.en-US.md @@ -7,29 +7,29 @@ name | type | default | description | required -- | -- | -- | -- | -- className | String | - | className of component | N -style | Object | - | CSS(Cascading Style Sheets)，Typescript：`React.CSSProperties` | N -actions | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -avatar | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +style | Object | - | CSS(Cascading Style Sheets)，Typescript: `React.CSSProperties` | N +actions | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +avatar | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N bodyClassName | String | - | \- | N -bodyStyle | Object | - | Styles that apply to the card body content。Typescript：`Styles`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +bodyStyle | Object | - | Styles that apply to the card body content。Typescript: `Styles`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N bordered | Boolean | true | \- | N -children | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -content | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -cover | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -description | TNode | - | card description。Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -footer | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +children | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +content | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +cover | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +description | TNode | - | card description。Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +footer | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N footerClassName | String | - | \- | N -footerStyle | Object | - | Styles that apply to the card footer content。Typescript：`Styles`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -header | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +footerStyle | Object | - | Styles that apply to the card footer content。Typescript: `Styles`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +header | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N headerBordered | Boolean | false | \- | N headerClassName | String | - | \- | N -headerStyle | Object | - | Styles that apply to the card header content。Typescript：`Styles`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +headerStyle | Object | - | Styles that apply to the card header content。Typescript: `Styles`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N hoverShadow | Boolean | false | \- | N -loading | TNode | false | Typescript：`boolean \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -loadingProps | Object | - | Loading Component Props。Typescript：`LoadingProps`，[Loading API Documents](./loading?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/card/type.ts) | N +loading | TNode | false | Typescript: `boolean \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +loadingProps | Object | - | Loading Component Props。Typescript: `LoadingProps`，[Loading API Documents](./loading?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/card/type.ts) | N shadow | Boolean | false | \- | N size | String | medium | options: medium/small | N status | String | - | \- | N -subtitle | TNode | - | card subtitle。Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +subtitle | TNode | - | card subtitle。Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N theme | String | normal | options: normal/poster1/poster2 | N -title | TNode | - | card title。Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +title | TNode | - | card title。Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N diff --git a/packages/components/cascader/cascader.en-US.md b/packages/components/cascader/cascader.en-US.md index f741fd30b1..f16796843c 100644 --- a/packages/components/cascader/cascader.en-US.md +++ b/packages/components/cascader/cascader.en-US.md @@ -7,56 +7,56 @@ name | type | default | description | required -- | -- | -- | -- | -- className | String | - | className of component | N -style | Object | - | CSS(Cascading Style Sheets)，Typescript：`React.CSSProperties` | N +style | Object | - | CSS(Cascading Style Sheets)，Typescript: `React.CSSProperties` | N autofocus | Boolean | - | \- | N borderless | Boolean | false | \- | N -checkProps | Object | - | Typescript：`CheckboxProps`，[Checkbox API Documents](./checkbox?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/cascader/type.ts) | N +checkProps | Object | - | Typescript: `CheckboxProps`，[Checkbox API Documents](./checkbox?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/cascader/type.ts) | N checkStrictly | Boolean | false | \- | N clearable | Boolean | false | \- | N -collapsedItems | TElement | - | Typescript：`TNode<{ value: CascaderOption[]; collapsedSelectedItems: CascaderOption[]; count: number; onClose: (context: { index: number, e?: MouseEvent }) => void }>`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +collapsedItems | TElement | - | Typescript: `TNode<{ value: CascaderOption[]; collapsedSelectedItems: CascaderOption[]; count: number; onClose: (context: { index: number, e?: MouseEvent }) => void }>`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N disabled | Boolean | undefined | \- | N -empty | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -filter | Function | - | Typescript：`(filterWords: string, node: TreeNodeModel) => boolean \| Promise` | N +empty | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +filter | Function | - | Typescript: `(filterWords: string, node: TreeNodeModel) => boolean \| Promise` | N filterable | Boolean | false | \- | N -inputProps | Object | - | Typescript：`InputProps`，[Input API Documents](./input?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/cascader/type.ts) | N -keys | Object | - | Typescript：`TreeKeysType`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -label | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +inputProps | Object | - | Typescript: `InputProps`，[Input API Documents](./input?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/cascader/type.ts) | N +keys | Object | - | Typescript: `TreeKeysType`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +label | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N lazy | Boolean | true | \- | N -load | Function | - | Typescript：`(node: TreeNodeModel) => Promise>` | N +load | Function | - | Typescript: `(node: TreeNodeModel) => Promise>` | N loading | Boolean | false | \- | N -loadingText | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +loadingText | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N max | Number | 0 | \- | N minCollapsedNum | Number | 0 | \- | N multiple | Boolean | false | \- | N -option | TElement | - | customize one option。Typescript：`TNode<{ item: CascaderOption; index: number; context: { node: TreeNodeModel } }>`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -options | Array | [] | Typescript：`Array` | N -panelBottomContent | TNode | - | bottom content of the cascader panel。Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -panelTopContent | TNode | - | top content of the cascader panel。Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +option | TElement | - | customize one option。Typescript: `TNode<{ item: CascaderOption; index: number; context: { node: TreeNodeModel } }>`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +options | Array | [] | Typescript: `Array` | N +panelBottomContent | TNode | - | bottom content of the cascader panel。Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +panelTopContent | TNode | - | top content of the cascader panel。Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N placeholder | String | undefined | \- | N -popupProps | Object | - | Typescript：`PopupProps`，[Popup API Documents](./popup?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/cascader/type.ts) | N +popupProps | Object | - | Typescript: `PopupProps`，[Popup API Documents](./popup?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/cascader/type.ts) | N popupVisible | Boolean | - | \- | N defaultPopupVisible | Boolean | - | uncontrolled property | N -prefixIcon | TElement | - | Typescript：`TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +prefixIcon | TElement | - | Typescript: `TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N readonly | Boolean | false | \- | N reserveKeyword | Boolean | false | \- | N -selectInputProps | Object | - | Typescript：`SelectInputProps`，[SelectInput API Documents](./select-input?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/cascader/type.ts) | N +selectInputProps | Object | - | Typescript: `SelectInputProps`，[SelectInput API Documents](./select-input?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/cascader/type.ts) | N showAllLevels | Boolean | true | \- | N -size | String | medium | options: large/medium/small。Typescript：`SizeEnum`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +size | String | medium | options: large/medium/small。Typescript: `SizeEnum`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N status | String | default | options: default/success/warning/error | N -suffix | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -suffixIcon | TElement | - | Typescript：`TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -tagInputProps | Object | - | Typescript：`TagInputProps`，[TagInput API Documents](./tag-input?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/cascader/type.ts) | N -tagProps | Object | - | Typescript：`TagProps`，[Tag API Documents](./tag?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/cascader/type.ts) | N -tips | TNode | - | tips at the bottom of cascader。Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +suffix | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +suffixIcon | TElement | - | Typescript: `TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +tagInputProps | Object | - | Typescript: `TagInputProps`，[TagInput API Documents](./tag-input?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/cascader/type.ts) | N +tagProps | Object | - | Typescript: `TagProps`，[Tag API Documents](./tag?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/cascader/type.ts) | N +tips | TNode | - | tips at the bottom of cascader。Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N trigger | String | click | options: click/hover | N -value | String / Number / Array | [] | Typescript：`CascaderValue` `type CascaderValue = string \| number \| T \| Array>`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/cascader/type.ts) | N -defaultValue | String / Number / Array | [] | uncontrolled property。Typescript：`CascaderValue` `type CascaderValue = string \| number \| T \| Array>`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/cascader/type.ts) | N -valueDisplay | TNode | - | `MouseEvent`。Typescript：`string \| TNode<{ value: CascaderValue; onClose: (index: number) => void; displayValue?: CascaderValue; selectedOptions: CascaderOption[] }>`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +value | String / Number / Array | [] | Typescript: `CascaderValue` `type CascaderValue = string \| number \| T \| Array>`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/cascader/type.ts) | N +defaultValue | String / Number / Array | [] | uncontrolled property。Typescript: `CascaderValue` `type CascaderValue = string \| number \| T \| Array>`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/cascader/type.ts) | N +valueDisplay | TNode | - | `MouseEvent`。Typescript: `string \| TNode<{ value: CascaderValue; onClose: (index: number) => void; displayValue?: CascaderValue; selectedOptions: CascaderOption[] }>`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N valueMode | String | onlyLeaf | options: onlyLeaf/parentFirst/all | N valueType | String | single | options: single/full | N -onBlur | Function | | Typescript：`(context: { value: CascaderValue } & SelectInputBlurContext ) => void`
| N -onChange | Function | | Typescript：`(value: CascaderValue, context: CascaderChangeContext) => void`
[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/cascader/type.ts)。
`interface CascaderChangeContext { node?: TreeNodeModel; source: CascaderChangeSource }`

`import { TreeNodeModel } from '@Tree'`

`type CascaderChangeSource = 'invalid-value' \| 'check' \| 'clear' \| 'uncheck'`
| N -onClear | Function | | Typescript：`(context: { e: MouseEvent }) => void`
Triggered when the clear button is clicked | N -onFocus | Function | | Typescript：`(context: { value: CascaderValue; e: FocusEvent }) => void`
| N -onPopupVisibleChange | Function | | Typescript：`(visible: boolean, context: PopupVisibleChangeContext) => void`
[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/cascader/type.ts)。
`import { PopupVisibleChangeContext } from '@Popup'`
| N -onRemove | Function | | Typescript：`(context: RemoveContext) => void`
[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/cascader/type.ts)。
`interface RemoveContext { value: CascaderValue; node: TreeNodeModel }`
| N +onBlur | Function | | Typescript: `(context: { value: CascaderValue } & SelectInputBlurContext ) => void`
| N +onChange | Function | | Typescript: `(value: CascaderValue, context: CascaderChangeContext) => void`
[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/cascader/type.ts)。
`interface CascaderChangeContext { node?: TreeNodeModel; source: CascaderChangeSource }`

`import { TreeNodeModel } from '@Tree'`

`type CascaderChangeSource = 'invalid-value' \| 'check' \| 'clear' \| 'uncheck'`
| N +onClear | Function | | Typescript: `(context: { e: MouseEvent }) => void`
Triggered when the clear button is clicked | N +onFocus | Function | | Typescript: `(context: { value: CascaderValue; e: FocusEvent }) => void`
| N +onPopupVisibleChange | Function | | Typescript: `(visible: boolean, context: PopupVisibleChangeContext) => void`
[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/cascader/type.ts)。
`import { PopupVisibleChangeContext } from '@Popup'`
| N +onRemove | Function | | Typescript: `(context: RemoveContext) => void`
[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/cascader/type.ts)。
`interface RemoveContext { value: CascaderValue; node: TreeNodeModel }`
| N diff --git a/packages/components/checkbox/checkbox.en-US.md b/packages/components/checkbox/checkbox.en-US.md index e224330c89..9b03e83e84 100644 --- a/packages/components/checkbox/checkbox.en-US.md +++ b/packages/components/checkbox/checkbox.en-US.md @@ -5,33 +5,33 @@ name | type | default | description | required -- | -- | -- | -- | -- -className | String | - | 类名 | N -style | Object | - | 样式，Typescript：`React.CSSProperties` | N +className | String | - | className of component | N +style | Object | - | CSS(Cascading Style Sheets)，Typescript: `React.CSSProperties` | N checkAll | Boolean | false | \- | N checked | Boolean | false | \- | N defaultChecked | Boolean | false | uncontrolled property | N -children | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +children | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N disabled | Boolean | undefined | \- | N indeterminate | Boolean | false | \- | N -label | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +label | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N name | String | - | \- | N readonly | Boolean | false | \- | N title | String | - | html attribute | N -value | String / Number / Boolean | - | value of checkbox。Typescript：`string \| number \| boolean` | N -onChange | Function | | Typescript：`(checked: boolean, context: { e: ChangeEvent }) => void`
| N -onClick | Function | | Typescript：`(context: { e: MouseEvent }) => void`
trigger on click | N +value | String / Number / Boolean | - | value of checkbox。Typescript: `string \| number \| boolean` | N +onChange | Function | | Typescript: `(checked: boolean, context: { e: ChangeEvent }) => void`
| N +onClick | Function | | Typescript: `(context: { e: MouseEvent }) => void`
trigger on click | N ### CheckboxGroup Props name | type | default | description | required -- | -- | -- | -- | -- -className | String | - | 类名 | N -style | Object | - | 样式，Typescript：`React.CSSProperties` | N +className | String | - | className of component | N +style | Object | - | CSS(Cascading Style Sheets)，Typescript: `React.CSSProperties` | N disabled | Boolean | - | \- | N max | Number | undefined | \- | N name | String | - | \- | N -options | Array | - | Typescript：`Array` `type CheckboxOption = string \| number \| CheckboxOptionObj` `interface CheckboxOptionObj { label?: string \| TNode; value?: string \| number; disabled?: boolean; name?: string; checkAll?: true }`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/checkbox/type.ts) | N +options | Array | - | Typescript: `Array` `type CheckboxOption = string \| number \| CheckboxOptionObj` `interface CheckboxOptionObj { label?: string \| TNode; value?: string \| number; disabled?: boolean; name?: string; checkAll?: true }`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/checkbox/type.ts) | N readonly | Boolean | undefined | \- | N -value | Array | [] | Typescript：`T` `type CheckboxGroupValue = Array`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/checkbox/type.ts) | N -defaultValue | Array | [] | uncontrolled property。Typescript：`T` `type CheckboxGroupValue = Array`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/checkbox/type.ts) | N -onChange | Function | | Typescript：`(value: T, context: CheckboxGroupChangeContext) => void`
[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/checkbox/type.ts)。
`interface CheckboxGroupChangeContext { e: ChangeEvent; current: CheckboxOption \| TdCheckboxProps; type: 'check' \| 'uncheck' }`
| N +value | Array | [] | Typescript: `T` `type CheckboxGroupValue = Array`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/checkbox/type.ts) | N +defaultValue | Array | [] | uncontrolled property。Typescript: `T` `type CheckboxGroupValue = Array`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/checkbox/type.ts) | N +onChange | Function | | Typescript: `(value: T, context: CheckboxGroupChangeContext) => void`
[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/checkbox/type.ts)。
`interface CheckboxGroupChangeContext { e: ChangeEvent; current: CheckboxOption \| TdCheckboxProps; type: 'check' \| 'uncheck' }`
| N diff --git a/packages/components/checkbox/checkbox.md b/packages/components/checkbox/checkbox.md index f34a46dad0..47647d6707 100644 --- a/packages/components/checkbox/checkbox.md +++ b/packages/components/checkbox/checkbox.md @@ -8,7 +8,7 @@ ## API ### Checkbox Props -名称 | 类型 | 默认值 | 说明 | 必传 +名称 | 类型 | 默认值 | 描述 | 必传 -- | -- | -- | -- | -- className | String | - | 类名 | N style | Object | - | 样式，TS 类型：`React.CSSProperties` | N @@ -28,7 +28,7 @@ onClick | Function | | TS 类型：`(context: { e: MouseEvent }) => void`
### CheckboxGroup Props -名称 | 类型 | 默认值 | 说明 | 必传 +名称 | 类型 | 默认值 | 描述 | 必传 -- | -- | -- | -- | -- className | String | - | 类名 | N style | Object | - | 样式，TS 类型：`React.CSSProperties` | N diff --git a/packages/components/collapse/collapse.en-US.md b/packages/components/collapse/collapse.en-US.md index 9a974c5fdf..cb5edb2129 100644 --- a/packages/components/collapse/collapse.en-US.md +++ b/packages/components/collapse/collapse.en-US.md @@ -5,30 +5,30 @@ name | type | default | description | required -- | -- | -- | -- | -- -className | String | - | 类名 | N -style | Object | - | 样式，Typescript：`React.CSSProperties` | N +className | String | - | className of component | N +style | Object | - | CSS(Cascading Style Sheets)，Typescript: `React.CSSProperties` | N borderless | Boolean | false | \- | N defaultExpandAll | Boolean | false | \- | N disabled | Boolean | - | \- | N -expandIcon | TNode | true | Typescript：`boolean \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +expandIcon | TNode | true | Typescript: `boolean \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N expandIconPlacement | String | left | options：left/right | N expandMutex | Boolean | false | \- | N expandOnRowClick | Boolean | true | \- | N -value | Array | [] | Typescript：`CollapseValue` `type CollapseValue = Array`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/collapse/type.ts) | N -defaultValue | Array | [] | uncontrolled property。Typescript：`CollapseValue` `type CollapseValue = Array`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/collapse/type.ts) | N -onChange | Function | | Typescript：`(value: CollapseValue, context: { e: MouseEvent }) => void`
| N +value | Array | [] | Typescript: `CollapseValue` `type CollapseValue = Array`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/collapse/type.ts) | N +defaultValue | Array | [] | uncontrolled property。Typescript: `CollapseValue` `type CollapseValue = Array`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/collapse/type.ts) | N +onChange | Function | | Typescript: `(value: CollapseValue, context: { e: MouseEvent }) => void`
| N ### CollapsePanel Props name | type | default | description | required -- | -- | -- | -- | -- -className | String | - | 类名 | N -style | Object | - | 样式，Typescript：`React.CSSProperties` | N -children | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -content | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +className | String | - | className of component | N +style | Object | - | CSS(Cascading Style Sheets)，Typescript: `React.CSSProperties` | N +children | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +content | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N destroyOnCollapse | Boolean | false | \- | N disabled | Boolean | undefined | \- | N -expandIcon | TNode | undefined | Typescript：`boolean \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -header | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -headerRightContent | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +expandIcon | TNode | undefined | Typescript: `boolean \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +header | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +headerRightContent | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N value | String / Number | - | \- | N diff --git a/packages/components/collapse/collapse.md b/packages/components/collapse/collapse.md index e86d4d173f..a55ca8c42d 100644 --- a/packages/components/collapse/collapse.md +++ b/packages/components/collapse/collapse.md @@ -3,7 +3,7 @@ ## API ### Collapse Props -名称 | 类型 | 默认值 | 说明 | 必传 +名称 | 类型 | 默认值 | 描述 | 必传 -- | -- | -- | -- | -- className | String | - | 类名 | N style | Object | - | 样式，TS 类型：`React.CSSProperties` | N @@ -20,7 +20,7 @@ onChange | Function | | TS 类型：`(value: CollapseValue, context: { e: Mouse ### CollapsePanel Props -名称 | 类型 | 默认值 | 说明 | 必传 +名称 | 类型 | 默认值 | 描述 | 必传 -- | -- | -- | -- | -- className | String | - | 类名 | N style | Object | - | 样式，TS 类型：`React.CSSProperties` | N diff --git a/packages/components/color-picker/color-picker.en-US.md b/packages/components/color-picker/color-picker.en-US.md index 5b82973e8a..30aef2f0a3 100644 --- a/packages/components/color-picker/color-picker.en-US.md +++ b/packages/components/color-picker/color-picker.en-US.md @@ -7,24 +7,24 @@ name | type | default | description | required -- | -- | -- | -- | -- className | String | - | className of component | N -style | Object | - | CSS(Cascading Style Sheets)，Typescript：`React.CSSProperties` | N +style | Object | - | CSS(Cascading Style Sheets)，Typescript: `React.CSSProperties` | N borderless | Boolean | false | \- | N clearable | Boolean | false | \- | N -colorModes | Array | ["monochrome", "linear-gradient"] | Typescript：`Array<'monochrome' \| 'linear-gradient'>` | N +colorModes | Array | ["monochrome", "linear-gradient"] | Typescript: `Array<'monochrome' \| 'linear-gradient'>` | N disabled | Boolean | undefined | \- | N enableAlpha | Boolean | false | \- | N enableMultipleGradient | Boolean | true | \- | N format | String | RGB | When `enableAlpha` is true, `HEX8/RGBA/HSLA/HSVA` are valid。options: HEX/HEX8/RGB/RGBA/HSL/HSLA/HSV/HSVA/CMYK/CSS | N -inputProps | Object | - | Typescript：`InputProps`，[Input API Documents](./input?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/color-picker/type.ts) | N -popupProps | Object | - | Typescript：`PopupProps`，[Popup API Documents](./popup?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/color-picker/type.ts) | N -recentColors | Array | [] | used color recently。Typescript：`Array \| boolean \| null` | N -defaultRecentColors | Array | [] | used color recently。uncontrolled property。Typescript：`Array \| boolean \| null` | N -selectInputProps | Object | - | Typescript：`SelectInputProps`，[SelectInput API Documents](./select-input?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/color-picker/type.ts) | N +inputProps | Object | - | Typescript: `InputProps`，[Input API Documents](./input?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/color-picker/type.ts) | N +popupProps | Object | - | Typescript: `PopupProps`，[Popup API Documents](./popup?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/color-picker/type.ts) | N +recentColors | Array | [] | used color recently。Typescript: `Array \| boolean \| null` | N +defaultRecentColors | Array | [] | used color recently。uncontrolled property。Typescript: `Array \| boolean \| null` | N +selectInputProps | Object | - | Typescript: `SelectInputProps`，[SelectInput API Documents](./select-input?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/color-picker/type.ts) | N showPrimaryColorPreview | Boolean | true | \- | N -swatchColors | Array | undefined | swatch colors。Typescript：`Array \| null \| undefined` | N +swatchColors | Array | undefined | swatch colors。Typescript: `Array \| null \| undefined` | N value | String | - | color value | N defaultValue | String | - | color value。uncontrolled property | N -onChange | Function | | Typescript：`(value: string, context: { color: ColorObject; trigger: ColorPickerChangeTrigger }) => void`
[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/color-picker/type.ts)。
`type ColorPickerChangeTrigger = 'palette-saturation-brightness' \| 'palette-saturation' \| 'palette-brightness' \| 'palette-hue-bar' \| 'palette-alpha-bar' \| 'input' \| 'preset' \| 'recent' `
| N -onClear | Function | | Typescript：`(context: { e: MouseEvent }) => void`
| N -onPaletteBarChange | Function | | Typescript：`(context: { color: ColorObject }) => void`
[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/color-picker/type.ts)。
`interface ColorObject { alpha: number; css: string; hex: string; hex8: string; hsl: string; hsla: string; hsv: string; hsva: string; rgb: string; rgba: string; saturation: number; value: number; isGradient: boolean; linearGradient?: string; }`
| N -onRecentColorsChange | Function | | Typescript：`(value: Array) => void`
| N +onChange | Function | | Typescript: `(value: string, context: { color: ColorObject; trigger: ColorPickerChangeTrigger }) => void`
[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/color-picker/type.ts)。
`type ColorPickerChangeTrigger = 'palette-saturation-brightness' \| 'palette-saturation' \| 'palette-brightness' \| 'palette-hue-bar' \| 'palette-alpha-bar' \| 'input' \| 'preset' \| 'recent' `
| N +onClear | Function | | Typescript: `(context: { e: MouseEvent }) => void`
| N +onPaletteBarChange | Function | | Typescript: `(context: { color: ColorObject }) => void`
[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/color-picker/type.ts)。
`interface ColorObject { alpha: number; css: string; hex: string; hex8: string; hsl: string; hsla: string; hsv: string; hsva: string; rgb: string; rgba: string; saturation: number; value: number; isGradient: boolean; linearGradient?: string; }`
| N +onRecentColorsChange | Function | | Typescript: `(value: Array) => void`
| N diff --git a/packages/components/comment/comment.en-US.md b/packages/components/comment/comment.en-US.md index f4fc90fab7..420f32044b 100644 --- a/packages/components/comment/comment.en-US.md +++ b/packages/components/comment/comment.en-US.md @@ -6,12 +6,12 @@ name | type | default | description | required -- | -- | -- | -- | -- -className | String | - | 类名 | N -style | Object | - | 样式，Typescript：`React.CSSProperties` | N -actions | Array | - | Typescript：`Array`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -author | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -avatar | TNode | - | Typescript：`string \| AvatarProps \| TNode`，[Avatar API Documents](./avatar?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/comment/type.ts) | N -content | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -datetime | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -quote | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -reply | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +className | String | - | className of component | N +style | Object | - | CSS(Cascading Style Sheets)，Typescript: `React.CSSProperties` | N +actions | Array | - | Typescript: `Array`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +author | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +avatar | TNode | - | Typescript: `string \| AvatarProps \| TNode`，[Avatar API Documents](./avatar?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/comment/type.ts) | N +content | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +datetime | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +quote | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +reply | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N diff --git a/packages/components/comment/comment.md b/packages/components/comment/comment.md index 63c651b353..fd4132c91d 100644 --- a/packages/components/comment/comment.md +++ b/packages/components/comment/comment.md @@ -3,7 +3,7 @@ ## API ### Comment Props -名称 | 类型 | 默认值 | 说明 | 必传 +名称 | 类型 | 默认值 | 描述 | 必传 -- | -- | -- | -- | -- className | String | - | 类名 | N style | Object | - | 样式，TS 类型：`React.CSSProperties` | N diff --git a/packages/components/config-provider/config-provider.en-US.md b/packages/components/config-provider/config-provider.en-US.md index 197909b563..c9f819040b 100644 --- a/packages/components/config-provider/config-provider.en-US.md +++ b/packages/components/config-provider/config-provider.en-US.md @@ -6,49 +6,49 @@ name | type | default | description | required -- | -- | -- | -- | -- -globalConfig | Object | - | global config。Typescript：`GlobalConfigProvider` | N +globalConfig | Object | - | global config。Typescript: `GlobalConfigProvider` | N ### GlobalConfigProvider name | type | default | description | required -- | -- | -- | -- | -- -alert | Object | - | Alert global configs。Typescript：`AlertConfig` | N -anchor | Object | - | Anchor global configs。Typescript：`AnchorConfig` | N -animation | Object | - | Typescript：`Partial>>` `type AnimationType = 'ripple' \| 'expand' \| 'fade'`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/config-provider/type.ts) | N -attach | String / Object / Function | - | Typescript：`AttachNode \| { imageViewer?: AttachNode; popup?: AttachNode; dialog?: AttachNode; drawer?: AttachNode; }`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -autoComplete | Object | - | AutoComplete global configs。Typescript：`AutoCompleteConfig` | N -calendar | Object | - | Calendar global configs。Typescript：`CalendarConfig` | N -cascader | Object | - | Cascader global configs。Typescript：`CascaderConfig` | N +alert | Object | - | Alert global configs。Typescript: `AlertConfig` | N +anchor | Object | - | Anchor global configs。Typescript: `AnchorConfig` | N +animation | Object | - | Typescript: `Partial>>` `type AnimationType = 'ripple' \| 'expand' \| 'fade'`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/config-provider/type.ts) | N +attach | String / Object / Function | - | Typescript: `AttachNode \| { imageViewer?: AttachNode; popup?: AttachNode; dialog?: AttachNode; drawer?: AttachNode; }`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +autoComplete | Object | - | AutoComplete global configs。Typescript: `AutoCompleteConfig` | N +calendar | Object | - | Calendar global configs。Typescript: `CalendarConfig` | N +cascader | Object | - | Cascader global configs。Typescript: `CascaderConfig` | N classPrefix | String | t | \- | N -colorPicker | Object | - | ColorPicker global configs。Typescript：`ColorPickerConfig` | N -datePicker | Object | - | DatePicker global configs。Typescript：`DatePickerConfig` | N -descriptions | Object | - | Descriptions global configs。Typescript：`DescriptionsConfig` | N -dialog | Object | - | Dialog global configs。Typescript：`DialogConfig` | N -drawer | Object | - | Drawer global configs。Typescript：`DrawerConfig` | N -empty | Object | - | Empty global configs。Typescript：`EmptyConfig` | N -form | Object | - | Form global configs。Typescript：`FormConfig` | N -guide | Object | - | Guide global configs。Typescript：`GuideConfig` | N -icon | Object | - | icon config。Typescript：`IconConfig` `type IconConfig = GlobalIconConfig` `import { GlobalIconConfig } from '@icon'`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/config-provider/type.ts) | N -image | Object | - | image global configs。Typescript：`ImageConfig` | N -imageViewer | Object | - | imageViewer global configs。Typescript：`ImageViewerConfig` | N -input | Object | - | Input global configs。Typescript：`InputConfig` | N +colorPicker | Object | - | ColorPicker global configs。Typescript: `ColorPickerConfig` | N +datePicker | Object | - | DatePicker global configs。Typescript: `DatePickerConfig` | N +descriptions | Object | - | Descriptions global configs。Typescript: `DescriptionsConfig` | N +dialog | Object | - | Dialog global configs。Typescript: `DialogConfig` | N +drawer | Object | - | Drawer global configs。Typescript: `DrawerConfig` | N +empty | Object | - | Empty global configs。Typescript: `EmptyConfig` | N +form | Object | - | Form global configs。Typescript: `FormConfig` | N +guide | Object | - | Guide global configs。Typescript: `GuideConfig` | N +icon | Object | - | icon config。Typescript: `IconConfig` `type IconConfig = GlobalIconConfig` `import { GlobalIconConfig } from '@icon'`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/config-provider/type.ts) | N +image | Object | - | image global configs。Typescript: `ImageConfig` | N +imageViewer | Object | - | imageViewer global configs。Typescript: `ImageViewerConfig` | N +input | Object | - | Input global configs。Typescript: `InputConfig` | N isContextEffectPlugin | Boolean | false | Whether the global configuration affects the components used by the functional invocation method | N -list | Object | - | List global configs。Typescript：`ListConfig` | N -message | Object | - | Message Component global configs。Typescript：`MessageConfig` | N -pagination | Object | - | Pagination global configs。Typescript：`PaginationConfig` | N -popconfirm | Object | - | Popconfirm global configs。Typescript：`PopconfirmConfig` | N -qrcode | Object | - | QRCode global configs。Typescript：`QRCodeConfig` | N -rate | Object | - | Rate global configs。Typescript：`RateConfig` | N -select | Object | - | Select global configs。Typescript：`SelectConfig` | N -steps | Object | - | Steps global configs。Typescript：`StepsConfig` | N -table | Object | - | Table global configs。Typescript：`TableConfig` | N -tag | Object | - | Tag global configs。Typescript：`TagConfig` | N -timePicker | Object | - | TimePicker global configs。Typescript：`TimePickerConfig` | N -transfer | Object | - | Transfer global configs。Typescript：`TransferConfig` | N -tree | Object | - | Tree global configs。Typescript：`TreeConfig` | N -treeSelect | Object | - | TreeSelect global configs。Typescript：`TreeSelectConfig` | N -typography | Object | - | Typography global configs。Typescript：`TypographyConfig` | N -upload | Object | - | Upload global configs。Typescript：`UploadConfig` | N +list | Object | - | List global configs。Typescript: `ListConfig` | N +message | Object | - | Message Component global configs。Typescript: `MessageConfig` | N +pagination | Object | - | Pagination global configs。Typescript: `PaginationConfig` | N +popconfirm | Object | - | Popconfirm global configs。Typescript: `PopconfirmConfig` | N +qrcode | Object | - | QRCode global configs。Typescript: `QRCodeConfig` | N +rate | Object | - | Rate global configs。Typescript: `RateConfig` | N +select | Object | - | Select global configs。Typescript: `SelectConfig` | N +steps | Object | - | Steps global configs。Typescript: `StepsConfig` | N +table | Object | - | Table global configs。Typescript: `TableConfig` | N +tag | Object | - | Tag global configs。Typescript: `TagConfig` | N +timePicker | Object | - | TimePicker global configs。Typescript: `TimePickerConfig` | N +transfer | Object | - | Transfer global configs。Typescript: `TransferConfig` | N +tree | Object | - | Tree global configs。Typescript: `TreeConfig` | N +treeSelect | Object | - | TreeSelect global configs。Typescript: `TreeSelectConfig` | N +typography | Object | - | Typography global configs。Typescript: `TypographyConfig` | N +upload | Object | - | Upload global configs。Typescript: `UploadConfig` | N ### AlertConfig @@ -75,12 +75,12 @@ empty | String | - | \- | N name | type | default | description | required -- | -- | -- | -- | -- cellMonth | String | - | \- | N -controllerConfig | Object | - | Typescript：`CalendarController`，[Calendar API Documents](./calendar?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/config-provider/type.ts) | N +controllerConfig | Object | - | Typescript: `CalendarController`，[Calendar API Documents](./calendar?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/config-provider/type.ts) | N fillWithZero | Boolean | true | \- | N firstDayOfWeek | Number | 1 | options: 1/2/3/4/5/6/7 | N hideWeekend | String | - | \- | N monthRadio | String | - | \- | N -monthSelection | String / Function | - | Typescript：`string \| (( data: { month: number })=>string)` | N +monthSelection | String / Function | - | Typescript: `string \| (( data: { month: number })=>string)` | N showWeekend | String | - | \- | N thisMonth | String | - | \- | N today | String | - | \- | N @@ -115,22 +115,22 @@ direction | String | 'ltr' | range separator text | N firstDayOfWeek | Number | 7 | options: 1/2/3/4/5/6/7 | N format | String | 'YYYY-MM-DD' | date format rules | N monthAriaLabel | String | - | month text | N -months | Array | - | Typescript：`string[]` | N +months | Array | - | Typescript: `string[]` | N nextDecade | String | - | next decade text | N nextMonth | String | - | next month text | N nextYear | String | - | next year text | N now | String | - | now text | N -placeholder | Object | - | Typescript：`{ date?: string; month?: string; year?: string }` | N +placeholder | Object | - | Typescript: `{ date?: string; month?: string; year?: string }` | N preDecade | String | - | pre decade text | N preMonth | String | - | pre month text | N preYear | String | - | pre year text | N -presets | Object | - | Typescript：`ConfigPresetDate` `interface ConfigPresetDate { [name: string]: DateConfigValue \| (() => DateConfigValue) }` `type DateConfigValue = string \| Date \| Array`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/config-provider/type.ts) | N -quarters | Array | - | Typescript：`string[]` | N +presets | Object | - | Typescript: `ConfigPresetDate` `interface ConfigPresetDate { [name: string]: DateConfigValue \| (() => DateConfigValue) }` `type DateConfigValue = string \| Date \| Array`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/config-provider/type.ts) | N +quarters | Array | - | Typescript: `string[]` | N rangeSeparator | String | - | range separator text | N selectDate | String | - | select date text | N selectTime | String | - | select time text | N weekAbbreviation | String | - | week text | N -weekdays | Array | - | Typescript：`string[]` | N +weekdays | Array | - | Typescript: `string[]` | N yearAriaLabel | String | - | year text | N ### DescriptionsConfig @@ -143,35 +143,35 @@ colonText | String | - | colon on the right of label, ":" | N name | type | default | description | required -- | -- | -- | -- | -- -cancel | Object | - | Typescript：`string \| ButtonProps`，[Button API Documents](./button?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/config-provider/type.ts) | N +cancel | Object | - | Typescript: `string \| ButtonProps`，[Button API Documents](./button?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/config-provider/type.ts) | N closeOnEscKeydown | Boolean | true | trigger dialog close on `ESC` keydown | N closeOnOverlayClick | Boolean | true | \- | N -confirm | Object | - | Typescript：`string \| ButtonProps` | N -confirmBtnTheme | Object | - | Typescript：`{ default: string; info: string; warning: string; danger: string; success: string; }` | N +confirm | Object | - | Typescript: `string \| ButtonProps` | N +confirmBtnTheme | Object | - | Typescript: `{ default: string; info: string; warning: string; danger: string; success: string; }` | N ### DrawerConfig name | type | default | description | required -- | -- | -- | -- | -- -cancel | String | - | Typescript：`string \| ButtonProps` | N +cancel | String | - | Typescript: `string \| ButtonProps` | N closeOnEscKeydown | Boolean | true | trigger drawer close event on `ESC` keydown | N closeOnOverlayClick | Boolean | true | \- | N -confirm | String | - | Typescript：`string \| ButtonProps` | N +confirm | String | - | Typescript: `string \| ButtonProps` | N size | String | 'small' | \- | N ### EmptyConfig name | type | default | description | required -- | -- | -- | -- | -- -image | Object | - | Typescript：`{ maintenance: TNode; success: TNode; fail: TNode; empty: TNode; networkError: TNode; }`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -titleText | Object | - | Typescript：`{ maintenance: string; success: string; fail: string; empty: string; networkError: string; }` | N +image | Object | - | Typescript: `{ maintenance: TNode; success: TNode; fail: TNode; empty: TNode; networkError: TNode; }`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +titleText | Object | - | Typescript: `{ maintenance: string; success: string; fail: string; empty: string; networkError: string; }` | N ### FormConfig name | type | default | description | required -- | -- | -- | -- | -- colonText | String | - | colon on the right of label ":" | N -errorMessage | Object | - | Typescript：`FormErrorMessage`，[Form API Documents](./form?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/config-provider/type.ts) | N +errorMessage | Object | - | Typescript: `FormErrorMessage`，[Form API Documents](./form?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/config-provider/type.ts) | N requiredMark | Boolean | true | \- | N requiredMarkPosition | String | left | Display position of required symbols。options: left/right | N @@ -179,10 +179,10 @@ requiredMarkPosition | String | left | Display position of required symbols。op name | type | default | description | required -- | -- | -- | -- | -- -finishButtonProps | Object | - | finish button in last step. `{ content: 'Finish', theme: 'primary' }`。Typescript：`ButtonProps` | N -nextButtonProps | Object | - | next step button. `{ content: 'Next Button', theme: 'primary' }`。Typescript：`ButtonProps` | N -prevButtonProps | Object | - | previous step button. `{ content: 'Previous Step', theme: 'default' }`。Typescript：`ButtonProps` | N -skipButtonProps | Object | - | skip button. `{ content: 'Skip', theme: 'default' }`。Typescript：`ButtonProps` | N +finishButtonProps | Object | - | finish button in last step. `{ content: 'Finish', theme: 'primary' }`。Typescript: `ButtonProps` | N +nextButtonProps | Object | - | next step button. `{ content: 'Next Button', theme: 'primary' }`。Typescript: `ButtonProps` | N +prevButtonProps | Object | - | previous step button. `{ content: 'Previous Step', theme: 'default' }`。Typescript: `ButtonProps` | N +skipButtonProps | Object | - | skip button. `{ content: 'Skip', theme: 'default' }`。Typescript: `ButtonProps` | N ### ImageConfig @@ -190,7 +190,7 @@ name | type | default | description | required -- | -- | -- | -- | -- errorText | String | - | loading text, default value is "Error" | N loadingText | String | - | loading text, default value is "loading" | N -replaceImageSrc | Function | - | replace all `src` attribute of images。Typescript：`(params: ImageProps) => string`，[Image API Documents](./image?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/config-provider/type.ts) | N +replaceImageSrc | Function | - | replace all `src` attribute of images。Typescript: `(params: ImageProps) => string`，[Image API Documents](./image?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/config-provider/type.ts) | N ### ImageViewerConfig @@ -240,9 +240,9 @@ jumper | `(jumperProps: JumperProps)` | `TNode` | [see more ts defi name | type | default | description | required -- | -- | -- | -- | -- -cancel | String / Object | - | Typescript：`string \| ButtonProps`，[Button API Documents](./button?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/config-provider/type.ts) | N -confirm | String / Object | - | Typescript：`string \| ButtonProps` | N -confirmBtnTheme | Object | - | Typescript：`{ default: string; warning: string; danger: string; }` | N +cancel | String / Object | - | Typescript: `string \| ButtonProps`，[Button API Documents](./button?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/config-provider/type.ts) | N +confirm | String / Object | - | Typescript: `string \| ButtonProps` | N +confirmBtnTheme | Object | - | Typescript: `{ default: string; warning: string; danger: string; }` | N ### QRCodeConfig @@ -256,13 +256,13 @@ scannedText | String | - | Language configuration, "QR code scanned" description name | type | default | description | required -- | -- | -- | -- | -- -rateText | Array | - | Typescript：`string[]` | N +rateText | Array | - | Typescript: `string[]` | N ### SelectConfig name | type | default | description | required -- | -- | -- | -- | -- -clearIcon | Function | - | Typescript：`TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +clearIcon | Function | - | Typescript: `TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N empty | String | - | \- | N filterable | Boolean | false | \- | N loadingText | String | - | \- | N @@ -272,8 +272,8 @@ placeholder | String | - | placeholder text | N name | type | default | description | required -- | -- | -- | -- | -- -checkIcon | TElement | - | Typescript：`TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -errorIcon | TElement | - | Typescript：`TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +checkIcon | TElement | - | Typescript: `TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +errorIcon | TElement | - | Typescript: `TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N ### TableConfig @@ -285,27 +285,27 @@ columnConfigButtonText | String | - | \- | N columnConfigDescriptionText | String | - | \- | N columnConfigTitleText | String | - | \- | N confirmText | String | - | \- | N -empty | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -expandIcon | TElement | undefined | Typescript：`TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -filterIcon | TElement | undefined | Typescript：`TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +empty | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +expandIcon | TElement | undefined | Typescript: `TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +filterIcon | TElement | undefined | Typescript: `TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N hideSortTips | Boolean | false | hide sort tips | N loadingMoreText | String | - | \- | N loadingText | String | - | \- | N resetText | String | - | \- | N searchResultText | String | - | \- | N selectAllText | String | - | \- | N -size | String | medium | options: small/medium/large。Typescript：`SizeEnum`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +size | String | medium | options: small/medium/large。Typescript: `SizeEnum`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N sortAscendingOperationText | String | - | \- | N sortCancelOperationText | String | - | \- | N sortDescendingOperationText | String | - | \- | N -sortIcon | TElement | undefined | Typescript：`TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -treeExpandAndFoldIcon | Function | undefined | Typescript：`TNode<{ type: 'expand' \| 'fold' }>`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +sortIcon | TElement | undefined | Typescript: `TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +treeExpandAndFoldIcon | Function | undefined | Typescript: `TNode<{ type: 'expand' \| 'fold' }>`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N ### TagConfig name | type | default | description | required -- | -- | -- | -- | -- -closeIcon | Function | - | Typescript：`TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +closeIcon | Function | - | Typescript: `TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N ### TimePickerConfig @@ -330,7 +330,7 @@ title | String | - | \- | N name | type | default | description | required -- | -- | -- | -- | -- empty | String | - | \- | N -folderIcon | Function | - | Typescript：`TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +folderIcon | Function | - | Typescript: `TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N ### TreeSelectConfig @@ -353,11 +353,11 @@ expandText | String | - | expand text | N name | type | default | description | required -- | -- | -- | -- | -- cancelUploadText | String | - | \- | N -dragger | Object | - | Typescript：`UploadConfigDragger` | N -file | Object | - | Typescript：`UploadConfigFileList` | N -progress | Object | - | Typescript：`UploadConfigProgress` | N +dragger | Object | - | Typescript: `UploadConfigDragger` | N +file | Object | - | Typescript: `UploadConfigFileList` | N +progress | Object | - | Typescript: `UploadConfigProgress` | N sizeLimitMessage | String | - | \- | N -triggerUploadText | Object | - | Typescript：`UploadTriggerUploadText` `interface UploadTriggerUploadText { image?: string, normal?: string, fileInput?: string, reupload?: string, continueUpload?: string, delete?: string }`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/config-provider/type.ts) | N +triggerUploadText | Object | - | Typescript: `UploadTriggerUploadText` `interface UploadTriggerUploadText { image?: string, normal?: string, fileInput?: string, reupload?: string, continueUpload?: string, delete?: string }`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/config-provider/type.ts) | N ### UploadConfigDragger diff --git a/packages/components/date-picker/date-picker.en-US.md b/packages/components/date-picker/date-picker.en-US.md index 86fd0c21f5..d79eda6386 100644 --- a/packages/components/date-picker/date-picker.en-US.md +++ b/packages/components/date-picker/date-picker.en-US.md @@ -7,44 +7,44 @@ name | type | default | description | required -- | -- | -- | -- | -- className | String | - | className of component | N -style | Object | - | CSS(Cascading Style Sheets)，Typescript：`React.CSSProperties` | N +style | Object | - | CSS(Cascading Style Sheets)，Typescript: `React.CSSProperties` | N allowInput | Boolean | false | \- | N borderless | Boolean | false | \- | N clearable | Boolean | false | \- | N defaultTime | String | '00:00:00' | Time selector default value | N -disableDate | Object / Array / Function | - | Typescript：`DisableDate` `type DisableDate = Array \| DisableDateObj \| ((date: DateValue) => boolean)` `interface DisableDateObj { from?: string; to?: string; before?: string; after?: string }`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/date-picker/type.ts) | N -disableTime | Function | - | disable time config function。Typescript：`(time: Date) => Partial<{ hour: Array, minute: Array, second: Array, millisecond: Array }>` | N +disableDate | Object / Array / Function | - | Typescript: `DisableDate` `type DisableDate = Array \| DisableDateObj \| ((date: DateValue) => boolean)` `interface DisableDateObj { from?: string; to?: string; before?: string; after?: string }`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/date-picker/type.ts) | N +disableTime | Function | - | disable time config function。Typescript: `(time: Date) => Partial<{ hour: Array, minute: Array, second: Array, millisecond: Array }>` | N disabled | Boolean | - | make DatePicker to be disabled | N enableTimePicker | Boolean | false | \- | N firstDayOfWeek | Number | 7 | options: 1/2/3/4/5/6/7 | N format | String | 'YYYY-MM-DD' | \- | N -inputProps | Object | - | Typescript：`InputProps`，[Input API Documents](./input?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/date-picker/type.ts) | N -label | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +inputProps | Object | - | Typescript: `InputProps`，[Input API Documents](./input?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/date-picker/type.ts) | N +label | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N mode | String | date | options: year/quarter/month/week/date | N -multiple | Boolean | false | support multiple date，but not support being use together with range-picker、enableTimePicker and allowInput。Typescript：`boolean` | N +multiple | Boolean | false | support multiple date，but not support being use together with range-picker、enableTimePicker and allowInput。Typescript: `boolean` | N needConfirm | Boolean | true | whether a confirmation button needs to be clicked to complete the action in the date-time picker scenario, default is true | N -placeholder | String / Array | undefined | Typescript：`string` | N -popupProps | Object | - | Typescript：`PopupProps`，[Popup API Documents](./popup?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/date-picker/type.ts) | N -prefixIcon | TElement | - | Typescript：`TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -presets | Object | - | Typescript：`PresetDate` `interface PresetDate { [name: string]: DateValue \| (() => DateValue) }`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/date-picker/type.ts) | N +placeholder | String / Array | undefined | Typescript: `string` | N +popupProps | Object | - | Typescript: `PopupProps`，[Popup API Documents](./popup?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/date-picker/type.ts) | N +prefixIcon | TElement | - | Typescript: `TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +presets | Object | - | Typescript: `PresetDate` `interface PresetDate { [name: string]: DateValue \| (() => DateValue) }`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/date-picker/type.ts) | N presetsPlacement | String | bottom | options: left/top/right/bottom | N -selectInputProps | Object | - | Typescript：`SelectInputProps`，[SelectInput API Documents](./select-input?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/date-picker/type.ts) | N -size | String | medium | options: small/medium/large。Typescript：`SizeEnum`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +selectInputProps | Object | - | Typescript: `SelectInputProps`，[SelectInput API Documents](./select-input?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/date-picker/type.ts) | N +size | String | medium | options: small/medium/large。Typescript: `SizeEnum`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N status | String | default | options: default/success/warning/error | N -suffixIcon | TElement | - | Typescript：`TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -timePickerProps | Object | - | Typescript：`TimePickerProps`，[TimePicker API Documents](./time-picker?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/date-picker/type.ts) | N -tips | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -value | String / Number / Array / Date | '' | Typescript：`DateValue \| DateMultipleValue` ` type DateValue = string \| number \| Date ` ` type DateMultipleValue = Array `。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/date-picker/type.ts) | N -defaultValue | String / Number / Array / Date | '' | uncontrolled property。Typescript：`DateValue \| DateMultipleValue` ` type DateValue = string \| number \| Date ` ` type DateMultipleValue = Array `。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/date-picker/type.ts) | N -valueDisplay | TNode | - | `MouseEvent`。Typescript：`string \| TNode<{ value: DateValue; displayValue?: DateValue }>`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -valueType | String | - | Typescript：`DatePickerValueType` `type DatePickerValueType = 'time-stamp' \| 'Date' \| 'YYYY' \| 'YYYY-MM' \| 'YYYY-MM-DD' \| 'YYYY-MM-DD HH' \| 'YYYY-MM-DD HH:mm' \| 'YYYY-MM-DD HH:mm:ss' \| 'YYYY-MM-DD HH:mm:ss:SSS'` `type ValueTypeEnum = DatePickerValueType`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/date-picker/type.ts) | N -onBlur | Function | | Typescript：`(context: { value: DateValue; e: FocusEvent }) => void`
| N -onChange | Function | | Typescript：`(value: DateValue, context: { dayjsValue?: Dayjs, trigger?: DatePickerTriggerSource }) => void`
[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/date-picker/type.ts)。
`import { Dayjs } from 'dayjs'`

`type DatePickerTriggerSource = 'confirm' \| 'pick' \| 'enter' \| 'preset' \| 'clear' \| 'tag-remove'`
| N -onClear | Function | | Typescript：`(context: { e: MouseEvent }) => void`
Triggered when the clear button is clicked | N -onConfirm | Function | | Typescript：`(context: { date: Date, e: MouseEvent }) => void`
| N -onFocus | Function | | Typescript：`(context: { value: DateValue; e: FocusEvent }) => void`
| N -onPick | Function | | Typescript：`(value: DateValue) => void`
| N -onPresetClick | Function | | Typescript：`(context: { preset: PresetDate, e: MouseEvent }) => void`
| N +suffixIcon | TElement | - | Typescript: `TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +timePickerProps | Object | - | Typescript: `TimePickerProps`，[TimePicker API Documents](./time-picker?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/date-picker/type.ts) | N +tips | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +value | String / Number / Array / Date | '' | Typescript: `DateValue \| DateMultipleValue` ` type DateValue = string \| number \| Date ` ` type DateMultipleValue = Array `。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/date-picker/type.ts) | N +defaultValue | String / Number / Array / Date | '' | uncontrolled property。Typescript: `DateValue \| DateMultipleValue` ` type DateValue = string \| number \| Date ` ` type DateMultipleValue = Array `。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/date-picker/type.ts) | N +valueDisplay | TNode | - | `MouseEvent`。Typescript: `string \| TNode<{ value: DateValue; displayValue?: DateValue }>`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +valueType | String | - | Typescript: `DatePickerValueType` `type DatePickerValueType = 'time-stamp' \| 'Date' \| 'YYYY' \| 'YYYY-MM' \| 'YYYY-MM-DD' \| 'YYYY-MM-DD HH' \| 'YYYY-MM-DD HH:mm' \| 'YYYY-MM-DD HH:mm:ss' \| 'YYYY-MM-DD HH:mm:ss:SSS'` `type ValueTypeEnum = DatePickerValueType`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/date-picker/type.ts) | N +onBlur | Function | | Typescript: `(context: { value: DateValue; e: FocusEvent }) => void`
| N +onChange | Function | | Typescript: `(value: DateValue, context: { dayjsValue?: Dayjs, trigger?: DatePickerTriggerSource }) => void`
[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/date-picker/type.ts)。
`import { Dayjs } from 'dayjs'`

`type DatePickerTriggerSource = 'confirm' \| 'pick' \| 'enter' \| 'preset' \| 'clear' \| 'tag-remove'`
| N +onClear | Function | | Typescript: `(context: { e: MouseEvent }) => void`
Triggered when the clear button is clicked | N +onConfirm | Function | | Typescript: `(context: { date: Date, e: MouseEvent }) => void`
| N +onFocus | Function | | Typescript: `(context: { value: DateValue; e: FocusEvent }) => void`
| N +onPick | Function | | Typescript: `(value: DateValue) => void`
| N +onPresetClick | Function | | Typescript: `(context: { preset: PresetDate, e: MouseEvent }) => void`
| N ### DateRangePicker Props @@ -52,45 +52,45 @@ onPresetClick | Function | | Typescript：`(context: { preset: PresetDate, e: M name | type | default | description | required -- | -- | -- | -- | -- className | String | - | className of component | N -style | Object | - | CSS(Cascading Style Sheets)，Typescript：`React.CSSProperties` | N +style | Object | - | CSS(Cascading Style Sheets)，Typescript: `React.CSSProperties` | N allowInput | Boolean | false | \- | N borderless | Boolean | false | \- | N cancelRangeSelectLimit | Boolean | false | The default date selection interaction is determined based on the order of dates clicked and will be restricted. For example, if a user first clicks on the start date input box and chooses a date, for instance, 2020-05-15, the interaction will automatically shift focus to the end date input box, waiting for the user to select the end time. At this point, the user can only select a date later than 2020-05-15 (previous dates will be grayed out and disabled, restricting the user's selection). When this value is set to `true`, this restriction is lifted | N clearable | Boolean | false | \- | N -defaultTime | Array | ["00:00:00", "23:59:59"] | Time selector default value。Typescript：`string[]` | N -disableDate | Object / Array / Function | - | Typescript：`DisableRangeDate` `type DisableRangeDate = Array \| DisableDateObj \| ((context: { date: DateRangeValue; partial: DateRangePickerPartial }) => boolean)` `interface DisableDateObj { from?: string; to?: string; before?: string; after?: string }` `type DateRangePickerPartial = 'start' \| 'end'`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/date-picker/type.ts) | N -disableTime | Function | - | disable time config function。Typescript：`(times: Array, context: { partial: DateRangePickerPartial }) => Partial<{ hour: Array, minute: Array, second: Array }>` | N +defaultTime | Array | ["00:00:00", "23:59:59"] | Time selector default value。Typescript: `string[]` | N +disableDate | Object / Array / Function | - | Typescript: `DisableRangeDate` `type DisableRangeDate = Array \| DisableDateObj \| ((context: { date: DateRangeValue; partial: DateRangePickerPartial }) => boolean)` `interface DisableDateObj { from?: string; to?: string; before?: string; after?: string }` `type DateRangePickerPartial = 'start' \| 'end'`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/date-picker/type.ts) | N +disableTime | Function | - | disable time config function。Typescript: `(times: Array, context: { partial: DateRangePickerPartial }) => Partial<{ hour: Array, minute: Array, second: Array }>` | N disabled | Boolean | - | \- | N enableTimePicker | Boolean | false | \- | N firstDayOfWeek | Number | - | options: 1/2/3/4/5/6/7 | N format | String | - | \- | N -label | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +label | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N mode | String | date | options: year/quarter/month/week/date | N needConfirm | Boolean | true | whether a confirmation button needs to be clicked to complete the action in the date-time range picker scenario, default is true | N panelPreselection | Boolean | true | \- | N -placeholder | String / Array | - | Typescript：`string \| Array` | N -popupProps | Object | - | Typescript：`PopupProps`，[Popup API Documents](./popup?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/date-picker/type.ts) | N -prefixIcon | TElement | - | Typescript：`TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -presets | Object | - | Typescript：`PresetRange` `interface PresetRange { [range: string]: DateRange \| (() => DateRange)}` `type DateRange = [DateValue, DateValue]`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/date-picker/type.ts) | N +placeholder | String / Array | - | Typescript: `string \| Array` | N +popupProps | Object | - | Typescript: `PopupProps`，[Popup API Documents](./popup?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/date-picker/type.ts) | N +prefixIcon | TElement | - | Typescript: `TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +presets | Object | - | Typescript: `PresetRange` `interface PresetRange { [range: string]: DateRange \| (() => DateRange)}` `type DateRange = [DateValue, DateValue]`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/date-picker/type.ts) | N presetsPlacement | String | bottom | options: left/top/right/bottom | N -rangeInputProps | Object | - | Typescript：`RangeInputProps`，[RangeInput API Documents](./range-input?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/date-picker/type.ts) | N +rangeInputProps | Object | - | Typescript: `RangeInputProps`，[RangeInput API Documents](./range-input?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/date-picker/type.ts) | N separator | String | - | \- | N -size | String | medium | options: small/medium/large。Typescript：`SizeEnum`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +size | String | medium | options: small/medium/large。Typescript: `SizeEnum`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N status | String | default | options: default/success/warning/error | N -suffixIcon | TElement | - | Typescript：`TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -timePickerProps | Object | - | Typescript：`TimePickerProps`，[TimePicker API Documents](./time-picker?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/date-picker/type.ts) | N -tips | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -value | Array | [] | Typescript：`DateRangeValue` `type DateRangeValue = Array`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/date-picker/type.ts) | N -defaultValue | Array | [] | uncontrolled property。Typescript：`DateRangeValue` `type DateRangeValue = Array`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/date-picker/type.ts) | N +suffixIcon | TElement | - | Typescript: `TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +timePickerProps | Object | - | Typescript: `TimePickerProps`，[TimePicker API Documents](./time-picker?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/date-picker/type.ts) | N +tips | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +value | Array | [] | Typescript: `DateRangeValue` `type DateRangeValue = Array`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/date-picker/type.ts) | N +defaultValue | Array | [] | uncontrolled property。Typescript: `DateRangeValue` `type DateRangeValue = Array`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/date-picker/type.ts) | N valueType | String | - | options: time-stamp/Date/YYYY/YYYY-MM/YYYY-MM-DD/YYYY-MM-DD HH/YYYY-MM-DD HH:mm/YYYY-MM-DD HH:mm:ss/YYYY-MM-DD HH:mm:ss:SSS | N -onBlur | Function | | Typescript：`(context: { value: DateRangeValue; partial: DateRangePickerPartial; e: FocusEvent }) => void`
| N -onChange | Function | | Typescript：`(value: DateRangeValue, context: { dayjsValue?: Dayjs[], trigger?: DatePickerTriggerSource }) => void`
[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/date-picker/type.ts)。
`import { Dayjs } from 'dayjs'`
| N -onClear | Function | | Typescript：`(context: { e: MouseEvent }) => void`
Triggered when the clear button is clicked | N -onConfirm | Function | | Typescript：`(context: { date: Date[], e: MouseEvent, partial: DateRangePickerPartial }) => void`
| N -onFocus | Function | | Typescript：`(context: { value: DateRangeValue; partial: DateRangePickerPartial; e: FocusEvent }) => void`
| N -onInput | Function | | Typescript：`(context: { input: string; value: DateRangeValue; partial: DateRangePickerPartial; e: InputEvent }) => void`
| N -onPick | Function | | Typescript：`(value: DateValue, context: PickContext) => void`
[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/date-picker/type.ts)。
`interface PickContext { e: MouseEvent; partial: DateRangePickerPartial }`
| N -onPresetClick | Function | | Typescript：`(context: { preset: PresetDate, e: MouseEvent }) => void`
| N +onBlur | Function | | Typescript: `(context: { value: DateRangeValue; partial: DateRangePickerPartial; e: FocusEvent }) => void`
| N +onChange | Function | | Typescript: `(value: DateRangeValue, context: { dayjsValue?: Dayjs[], trigger?: DatePickerTriggerSource }) => void`
[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/date-picker/type.ts)。
`import { Dayjs } from 'dayjs'`
| N +onClear | Function | | Typescript: `(context: { e: MouseEvent }) => void`
Triggered when the clear button is clicked | N +onConfirm | Function | | Typescript: `(context: { date: Date[], e: MouseEvent, partial: DateRangePickerPartial }) => void`
| N +onFocus | Function | | Typescript: `(context: { value: DateRangeValue; partial: DateRangePickerPartial; e: FocusEvent }) => void`
| N +onInput | Function | | Typescript: `(context: { input: string; value: DateRangeValue; partial: DateRangePickerPartial; e: InputEvent }) => void`
| N +onPick | Function | | Typescript: `(value: DateValue, context: PickContext) => void`
[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/date-picker/type.ts)。
`interface PickContext { e: MouseEvent; partial: DateRangePickerPartial }`
| N +onPresetClick | Function | | Typescript: `(context: { preset: PresetDate, e: MouseEvent }) => void`
| N ### DatePickerPanel Props @@ -98,17 +98,17 @@ onPresetClick | Function | | Typescript：`(context: { preset: PresetDate, e: M name | type | default | description | required -- | -- | -- | -- | -- className | String | - | className of component | N -style | Object | - | CSS(Cascading Style Sheets)，Typescript：`React.CSSProperties` | N +style | Object | - | CSS(Cascading Style Sheets)，Typescript: `React.CSSProperties` | N defaultTime | String | '00:00:00' | Time selector default value | N `Pick` | \- | - | extends `Pick` | N -onCellClick | Function | | Typescript：`(context: { date: Date, e: MouseEvent }) => void`
| N -onChange | Function | | Typescript：`(value: DateValue, context: { dayjsValue?: Dayjs, e?: MouseEvent, trigger?: DatePickerTriggerSource }) => void`
| N -onConfirm | Function | | Typescript：`(context: { date: Date, e: MouseEvent }) => void`
| N -onMonthChange | Function | | Typescript：`(context: { month: number, date: Date, e?: MouseEvent, trigger: DatePickerMonthChangeTrigger }) => void`
[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/date-picker/type.ts)。
`type DatePickerMonthChangeTrigger = 'month-select' \| 'month-arrow-next' \| 'month-arrow-previous' \| 'today'`
| N -onPanelClick | Function | | Typescript：`(context: { e: MouseEvent }) => void`
| N -onPresetClick | Function | | Typescript：`(context: { preset: PresetDate, e: MouseEvent }) => void`
| N -onTimeChange | Function | | Typescript：`(context: { time: string, date: Date, trigger: DatePickerTimeChangeTrigger, e?: MouseEvent }) => void`
[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/date-picker/type.ts)。
`type DatePickerTimeChangeTrigger = 'time-hour' \| 'time-minute' \| 'time-second'`
| N -onYearChange | Function | | Typescript：`(context: { year: number, date: Date, trigger: DatePickerYearChangeTrigger, e?: MouseEvent }) => void`
[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/date-picker/type.ts)。
`type DatePickerYearChangeTrigger = 'year-select' \| 'year-arrow-next' \| 'year-arrow-previous' \| 'today'`
| N +onCellClick | Function | | Typescript: `(context: { date: Date, e: MouseEvent }) => void`
| N +onChange | Function | | Typescript: `(value: DateValue, context: { dayjsValue?: Dayjs, e?: MouseEvent, trigger?: DatePickerTriggerSource }) => void`
| N +onConfirm | Function | | Typescript: `(context: { date: Date, e: MouseEvent }) => void`
| N +onMonthChange | Function | | Typescript: `(context: { month: number, date: Date, e?: MouseEvent, trigger: DatePickerMonthChangeTrigger }) => void`
[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/date-picker/type.ts)。
`type DatePickerMonthChangeTrigger = 'month-select' \| 'month-arrow-next' \| 'month-arrow-previous' \| 'today'`
| N +onPanelClick | Function | | Typescript: `(context: { e: MouseEvent }) => void`
| N +onPresetClick | Function | | Typescript: `(context: { preset: PresetDate, e: MouseEvent }) => void`
| N +onTimeChange | Function | | Typescript: `(context: { time: string, date: Date, trigger: DatePickerTimeChangeTrigger, e?: MouseEvent }) => void`
[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/date-picker/type.ts)。
`type DatePickerTimeChangeTrigger = 'time-hour' \| 'time-minute' \| 'time-second'`
| N +onYearChange | Function | | Typescript: `(context: { year: number, date: Date, trigger: DatePickerYearChangeTrigger, e?: MouseEvent }) => void`
[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/date-picker/type.ts)。
`type DatePickerYearChangeTrigger = 'year-select' \| 'year-arrow-next' \| 'year-arrow-previous' \| 'today'`
| N ### DateRangePickerPanel Props @@ -116,14 +116,14 @@ onYearChange | Function | | Typescript：`(context: { year: number, date: Date, name | type | default | description | required -- | -- | -- | -- | -- className | String | - | className of component | N -style | Object | - | CSS(Cascading Style Sheets)，Typescript：`React.CSSProperties` | N -defaultTime | Array | ["00:00:00", "23:59:59"] | Time selector default value。Typescript：`string[]` | N +style | Object | - | CSS(Cascading Style Sheets)，Typescript: `React.CSSProperties` | N +defaultTime | Array | ["00:00:00", "23:59:59"] | Time selector default value。Typescript: `string[]` | N `Pick` | \- | - | extends `Pick` | N -onCellClick | Function | | Typescript：`(context: { date: Date[], partial: DateRangePickerPartial, e: MouseEvent }) => void`
| N -onChange | Function | | Typescript：`(value: DateRangeValue, context: { dayjsValue?: Dayjs[], partial: DateRangePickerPartial, e?: MouseEvent, trigger?: DatePickerTriggerSource }) => void`
| N -onConfirm | Function | | Typescript：`(context: { date: Date[], e: MouseEvent }) => void`
| N -onMonthChange | Function | | Typescript：`(context: { month: number, date: Date[], partial: DateRangePickerPartial, e?: MouseEvent, trigger: DatePickerMonthChangeTrigger }) => void`
| N -onPanelClick | Function | | Typescript：`(context: { e: MouseEvent }) => void`
| N -onPresetClick | Function | | Typescript：`(context: { preset: PresetDate, e: MouseEvent }) => void`
| N -onTimeChange | Function | | Typescript：`(context: { time: string, date: Date[], partial: DateRangePickerPartial, trigger: DatePickerTimeChangeTrigger, e?: MouseEvent }) => void`
| N -onYearChange | Function | | Typescript：`(context: { year: number, date: Date[], partial: DateRangePickerPartial, trigger: DatePickerYearChangeTrigger, e?: MouseEvent }) => void`
| N +onCellClick | Function | | Typescript: `(context: { date: Date[], partial: DateRangePickerPartial, e: MouseEvent }) => void`
| N +onChange | Function | | Typescript: `(value: DateRangeValue, context: { dayjsValue?: Dayjs[], partial: DateRangePickerPartial, e?: MouseEvent, trigger?: DatePickerTriggerSource }) => void`
| N +onConfirm | Function | | Typescript: `(context: { date: Date[], e: MouseEvent }) => void`
| N +onMonthChange | Function | | Typescript: `(context: { month: number, date: Date[], partial: DateRangePickerPartial, e?: MouseEvent, trigger: DatePickerMonthChangeTrigger }) => void`
| N +onPanelClick | Function | | Typescript: `(context: { e: MouseEvent }) => void`
| N +onPresetClick | Function | | Typescript: `(context: { preset: PresetDate, e: MouseEvent }) => void`
| N +onTimeChange | Function | | Typescript: `(context: { time: string, date: Date[], partial: DateRangePickerPartial, trigger: DatePickerTimeChangeTrigger, e?: MouseEvent }) => void`
| N +onYearChange | Function | | Typescript: `(context: { year: number, date: Date[], partial: DateRangePickerPartial, trigger: DatePickerYearChangeTrigger, e?: MouseEvent }) => void`
| N diff --git a/packages/components/descriptions/descriptions.en-US.md b/packages/components/descriptions/descriptions.en-US.md index 0eb005b02d..06570473f1 100644 --- a/packages/components/descriptions/descriptions.en-US.md +++ b/packages/components/descriptions/descriptions.en-US.md @@ -7,18 +7,18 @@ name | type | default | description | required -- | -- | -- | -- | -- className | String | - | className of component | N -style | Object | - | CSS(Cascading Style Sheets)，Typescript：`React.CSSProperties` | N +style | Object | - | CSS(Cascading Style Sheets)，Typescript: `React.CSSProperties` | N bordered | Boolean | false | set description list with grey border | N colon | Boolean | - | set label with ":" on the right | N column | Number | 2 | count of DescriptionsItem in one row | N -contentStyle | Object | - | style of description content。Typescript：`Styles`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +contentStyle | Object | - | style of description content。Typescript: `Styles`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N itemLayout | String | horizontal | layout direction of description item。options: horizontal/vertical | N -items | Array | - | list of descriptions items。Typescript：`Array` | N -labelStyle | Object | - | style of description item, which takes effect when `tableLayout` is `auto`。Typescript：`Styles`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +items | Array | - | list of descriptions items。Typescript: `Array` | N +labelStyle | Object | - | style of description item, which takes effect when `tableLayout` is `auto`。Typescript: `Styles`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N layout | String | horizontal | layout direction。options: horizontal/vertical | N -size | String | medium | a descriptions has three size。options: small/medium/large。Typescript：`SizeEnum`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +size | String | medium | a descriptions has three size。options: small/medium/large。Typescript: `SizeEnum`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N tableLayout | String | auto | Sets the algorithm used to layout `table` cells, rows, and columns, exactly the same as the native table-layout css property. `fixed`: uses fixed layout algorithm; `auto`: uses automatic layout algorithm. For more details, see [MDN](https://developer.mozilla.org/en-US/docs/Web/CSS/table-layout)。options: fixed/auto | N -title | TNode | - | title of descriptions。Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +title | TNode | - | title of descriptions。Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N ### DescriptionsItem Props @@ -26,7 +26,7 @@ title | TNode | - | title of descriptions。Typescript：`string \| TNode`。[se name | type | default | description | required -- | -- | -- | -- | -- className | String | - | className of component | N -style | Object | - | CSS(Cascading Style Sheets)，Typescript：`React.CSSProperties` | N -content | TNode | - | content of description item。Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -label | TNode | - | label of description item。Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +style | Object | - | CSS(Cascading Style Sheets)，Typescript: `React.CSSProperties` | N +content | TNode | - | content of description item。Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +label | TNode | - | label of description item。Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N span | Number | 1 | width count | N diff --git a/packages/components/dialog/dialog.en-US.md b/packages/components/dialog/dialog.en-US.md index 4f238034b4..8b25de31eb 100644 --- a/packages/components/dialog/dialog.en-US.md +++ b/packages/components/dialog/dialog.en-US.md @@ -6,8 +6,8 @@ name | type | default | description | required -- | -- | -- | -- | -- className | String | - | className of component | N -style | Object | - | CSS(Cascading Style Sheets)，Typescript：`React.CSSProperties` | N -`Pick` | TNode | - | extends `Pick`。Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +style | Object | - | CSS(Cascading Style Sheets)，Typescript: `React.CSSProperties` | N +`Pick` | TNode | - | extends `Pick`。Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N ### Dialog Props @@ -15,23 +15,23 @@ style | Object | - | CSS(Cascading Style Sheets)，Typescript：`React.CSSProper name | type | default | description | required -- | -- | -- | -- | -- className | String | - | className of component | N -style | Object | - | CSS(Cascading Style Sheets)，Typescript：`React.CSSProperties` | N -attach | String / Function | - | Typescript：`AttachNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -body | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -cancelBtn | TNode | - | Typescript：`string \| ButtonProps \| TNode \| null`，[Button API Documents](./button?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/dialog/type.ts) | N -children | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -closeBtn | TNode | true | Typescript：`string \| boolean \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +style | Object | - | CSS(Cascading Style Sheets)，Typescript: `React.CSSProperties` | N +attach | String / Function | - | Typescript: `AttachNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +body | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +cancelBtn | TNode | - | Typescript: `string \| ButtonProps \| TNode \| null`，[Button API Documents](./button?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/dialog/type.ts) | N +children | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +closeBtn | TNode | true | Typescript: `string \| boolean \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N closeOnEscKeydown | Boolean | true | trigger dialog close event on `ESC` keydown | N closeOnOverlayClick | Boolean | true | \- | N -confirmBtn | TNode | - | Typescript：`string \| ButtonProps \| TNode \| null`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +confirmBtn | TNode | - | Typescript: `string \| ButtonProps \| TNode \| null`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N confirmLoading | Boolean | undefined | confirm button loading status | N confirmOnEnter | Boolean | - | confirm on enter | N destroyOnClose | Boolean | false | \- | N dialogClassName | String | - | \- | N draggable | Boolean | false | \- | N -footer | TNode | true | Typescript：`boolean \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +footer | TNode | true | Typescript: `boolean \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N forceRender | Boolean | false | to force render Dialog, deprecated, please use `lazy` compatibility support | N -header | TNode | true | Typescript：`string \| boolean \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +header | TNode | true | Typescript: `string \| boolean \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N lazy | Boolean | true | Enable Dialog lazy loading, the contents of the dialog box are not rendered when enable | N mode | String | modal | options: modal/modeless/full-screen | N placement | String | top | options: top/center | N @@ -43,24 +43,24 @@ top | String / Number | - | \- | N visible | Boolean | - | \- | N width | String / Number | - | \- | N zIndex | Number | - | \- | N -onBeforeClose | Function | | Typescript：`() => void`
| N -onBeforeOpen | Function | | Typescript：`() => void`
| N -onCancel | Function | | Typescript：`(context: { e: MouseEvent }) => void`
| N -onClose | Function | | Typescript：`(context: DialogCloseContext) => void`
[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/dialog/type.ts)。
`type DialogEventSource = 'esc' \| 'close-btn' \| 'cancel' \| 'overlay'`

`interface DialogCloseContext { trigger: DialogEventSource; e: MouseEvent \| KeyboardEvent }`
| N -onCloseBtnClick | Function | | Typescript：`(context: { e: MouseEvent }) => void`
| N -onClosed | Function | | Typescript：`() => void`
| N -onConfirm | Function | | Typescript：`(context: { e: MouseEvent \| KeyboardEvent }) => void`
| N -onEscKeydown | Function | | Typescript：`(context: { e: KeyboardEvent }) => void`
| N -onOpened | Function | | Typescript：`() => void`
| N -onOverlayClick | Function | | Typescript：`(context: { e: MouseEvent }) => void`
| N +onBeforeClose | Function | | Typescript: `() => void`
| N +onBeforeOpen | Function | | Typescript: `() => void`
| N +onCancel | Function | | Typescript: `(context: { e: MouseEvent }) => void`
| N +onClose | Function | | Typescript: `(context: DialogCloseContext) => void`
[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/dialog/type.ts)。
`type DialogEventSource = 'esc' \| 'close-btn' \| 'cancel' \| 'overlay'`

`interface DialogCloseContext { trigger: DialogEventSource; e: MouseEvent \| KeyboardEvent }`
| N +onCloseBtnClick | Function | | Typescript: `(context: { e: MouseEvent }) => void`
| N +onClosed | Function | | Typescript: `() => void`
| N +onConfirm | Function | | Typescript: `(context: { e: MouseEvent \| KeyboardEvent }) => void`
| N +onEscKeydown | Function | | Typescript: `(context: { e: KeyboardEvent }) => void`
| N +onOpened | Function | | Typescript: `() => void`
| N +onOverlayClick | Function | | Typescript: `(context: { e: MouseEvent }) => void`
| N ### DialogOptions name | type | default | description | required -- | -- | -- | -- | -- -attach | String / Function | 'body' | Typescript：`AttachNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +attach | String / Function | 'body' | Typescript: `AttachNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N className | String | - | \- | N -style | Object | - | Typescript：`Styles`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +style | Object | - | Typescript: `Styles`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N `Omit` | \- | - | extends `Omit` | N ### DialogInstance @@ -77,7 +77,7 @@ update | `(props: DialogOptions)` | \- | required name | params | default | description -- | -- | -- | -- -options | \- | - | Typescript：`DialogOptions` +options | \- | - | Typescript: `DialogOptions` 插件返回值：`DialogInstance` @@ -85,10 +85,10 @@ options | \- | - | Typescript：`DialogOptions` name | params | default | description -- | -- | -- | -- -options | \- | - | Typescript：`DialogOptions` +options | \- | - | Typescript: `DialogOptions` ### dialog.alert 或 DialogPlugin.alert name | params | default | description -- | -- | -- | -- -options | Object | - | Typescript：`Omit` +options | Object | - | Typescript: `Omit` diff --git a/packages/components/divider/divider.en-US.md b/packages/components/divider/divider.en-US.md index 7ce5bf023b..792c35988c 100644 --- a/packages/components/divider/divider.en-US.md +++ b/packages/components/divider/divider.en-US.md @@ -7,10 +7,10 @@ name | type | default | description | required -- | -- | -- | -- | -- className | String | - | className of component | N -style | Object | - | CSS(Cascading Style Sheets)，Typescript：`React.CSSProperties` | N +style | Object | - | CSS(Cascading Style Sheets)，Typescript: `React.CSSProperties` | N align | String | center | options: left/right/center | N -children | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -content | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +children | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +content | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N dashed | Boolean | false | \- | N layout | String | horizontal | options: horizontal/vertical | N size | String / Number | - | Spacing size | N diff --git a/packages/components/drawer/drawer.en-US.md b/packages/components/drawer/drawer.en-US.md index 1e0de28cdc..5a89768c86 100644 --- a/packages/components/drawer/drawer.en-US.md +++ b/packages/components/drawer/drawer.en-US.md @@ -25,19 +25,19 @@ A component instance: `DrawerInstance = DrawerPlugin(options)`. name | type | default | description | required -- | -- | -- | -- | -- className | String | - | className of component | N -style | Object | - | CSS(Cascading Style Sheets)，Typescript：`React.CSSProperties` | N -attach | String / Function | - | Typescript：`AttachNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -body | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -cancelBtn | TNode | - | Typescript：`FooterButton` `type FooterButton = string \| ButtonProps \| TNode \| null`，[Button API Documents](./button?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/drawer/type.ts) | N -children | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -closeBtn | TNode | - | Typescript：`string \| boolean \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +style | Object | - | CSS(Cascading Style Sheets)，Typescript: `React.CSSProperties` | N +attach | String / Function | - | Typescript: `AttachNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +body | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +cancelBtn | TNode | - | Typescript: `FooterButton` `type FooterButton = string \| ButtonProps \| TNode \| null`，[Button API Documents](./button?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/drawer/type.ts) | N +children | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +closeBtn | TNode | - | Typescript: `string \| boolean \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N closeOnEscKeydown | Boolean | true | trigger drawer close event on `ESC` keydown | N closeOnOverlayClick | Boolean | true | \- | N -confirmBtn | TNode | - | Typescript：`FooterButton` `type FooterButton = string \| ButtonProps \| TNode \| null`，[Button API Documents](./button?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/drawer/type.ts) | N +confirmBtn | TNode | - | Typescript: `FooterButton` `type FooterButton = string \| ButtonProps \| TNode \| null`，[Button API Documents](./button?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/drawer/type.ts) | N destroyOnClose | Boolean | false | \- | N -footer | TNode | true | Typescript：`boolean \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +footer | TNode | true | Typescript: `boolean \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N forceRender | Boolean | false | to force render Drawer, deprecated, please use `lazy` api for compatibility | N -header | TNode | true | Typescript：`string \| boolean \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +header | TNode | true | Typescript: `string \| boolean \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N lazy | Boolean | true | Enable Drawer lazy loading, the contents of the Drawer are not rendered when enable | N mode | String | overlay | options: overlay/push | N placement | String | right | options: left/right/top/bottom | N @@ -45,26 +45,26 @@ preventScrollThrough | Boolean | true | \- | N showInAttachedElement | Boolean | false | \- | N showOverlay | Boolean | true | \- | N size | String | 'small' | \- | N -sizeDraggable | Boolean / Object | false | allow resizing drawer width/height, set `max` or `min` to limit size。Typescript：`boolean \| SizeDragLimit` `interface SizeDragLimit { max: number, min: number }`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/drawer/type.ts) | N +sizeDraggable | Boolean / Object | false | allow resizing drawer width/height, set `max` or `min` to limit size。Typescript: `boolean \| SizeDragLimit` `interface SizeDragLimit { max: number, min: number }`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/drawer/type.ts) | N visible | Boolean | false | \- | N zIndex | Number | - | \- | N -onBeforeClose | Function | | Typescript：`() => void`
| N -onBeforeOpen | Function | | Typescript：`() => void`
| N -onCancel | Function | | Typescript：`(context: { e: MouseEvent }) => void`
| N -onClose | Function | | Typescript：`(context: DrawerCloseContext) => void`
[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/drawer/type.ts)。
`type DrawerEventSource = 'esc' \| 'close-btn' \| 'cancel' \| 'overlay'`

`interface DrawerCloseContext { trigger: DrawerEventSource; e: MouseEvent \| KeyboardEvent }`
| N -onCloseBtnClick | Function | | Typescript：`(context: { e: MouseEvent }) => void`
| N -onConfirm | Function | | Typescript：`(context: { e: MouseEvent }) => void`
| N -onEscKeydown | Function | | Typescript：`(context: { e: KeyboardEvent }) => void`
| N -onOverlayClick | Function | | Typescript：`(context: { e: MouseEvent }) => void`
| N -onSizeDragEnd | Function | | Typescript：`(context: { e: globalThis.MouseEvent; size: number }) => void`
trigger on size drag end | N +onBeforeClose | Function | | Typescript: `() => void`
| N +onBeforeOpen | Function | | Typescript: `() => void`
| N +onCancel | Function | | Typescript: `(context: { e: MouseEvent }) => void`
| N +onClose | Function | | Typescript: `(context: DrawerCloseContext) => void`
[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/drawer/type.ts)。
`type DrawerEventSource = 'esc' \| 'close-btn' \| 'cancel' \| 'overlay'`

`interface DrawerCloseContext { trigger: DrawerEventSource; e: MouseEvent \| KeyboardEvent }`
| N +onCloseBtnClick | Function | | Typescript: `(context: { e: MouseEvent }) => void`
| N +onConfirm | Function | | Typescript: `(context: { e: MouseEvent }) => void`
| N +onEscKeydown | Function | | Typescript: `(context: { e: KeyboardEvent }) => void`
| N +onOverlayClick | Function | | Typescript: `(context: { e: MouseEvent }) => void`
| N +onSizeDragEnd | Function | | Typescript: `(context: { e: globalThis.MouseEvent; size: number }) => void`
trigger on size drag end | N ### DrawerOptions name | type | default | description | required -- | -- | -- | -- | -- -attach | String / Function | 'body' | Typescript：`AttachNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +attach | String / Function | 'body' | Typescript: `AttachNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N className | String | - | \- | N -style | Object | - | Typescript：`Styles`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +style | Object | - | Typescript: `Styles`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N `Omit` | \- | - | extends `Omit` | N ### DrawerInstance @@ -80,4 +80,4 @@ update | `(props: DrawerOptions)` | \- | \- name | params | default | description -- | -- | -- | -- -options | \- | - | Typescript：`DrawerOptions` +options | \- | - | Typescript: `DrawerOptions` diff --git a/packages/components/dropdown/dropdown.en-US.md b/packages/components/dropdown/dropdown.en-US.md index 6f042a448b..94afa152d0 100644 --- a/packages/components/dropdown/dropdown.en-US.md +++ b/packages/components/dropdown/dropdown.en-US.md @@ -5,33 +5,33 @@ name | type | default | description | required -- | -- | -- | -- | -- -className | String | - | 类名 | N -style | Object | - | 样式，Typescript：`React.CSSProperties` | N +className | String | - | className of component | N +style | Object | - | CSS(Cascading Style Sheets)，Typescript: `React.CSSProperties` | N direction | String | right | options: left/right | N disabled | Boolean | false | \- | N hideAfterItemClick | Boolean | true | \- | N maxColumnWidth | String / Number | 100 | \- | N maxHeight | Number | 300 | \- | N minColumnWidth | String / Number | 10 | \- | N -options | Array | [] | Typescript：`Array` `type DropdownOption = { children?: Array } & TdDropdownItemProps & Record`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/dropdown/type.ts) | N -panelBottomContent | TNode | - | bottom content of the dropdown panel。Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -panelTopContent | TNode | - | top content of the dropdown panel。Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +options | Array | [] | Typescript: `Array` `type DropdownOption = { children?: Array } & TdDropdownItemProps & Record`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/dropdown/type.ts) | N +panelBottomContent | TNode | - | bottom content of the dropdown panel。Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +panelTopContent | TNode | - | top content of the dropdown panel。Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N placement | String | bottom-left | options: top/left/right/bottom/top-left/top-right/bottom-left/bottom-right/left-top/left-bottom/right-top/right-bottom | N -popupProps | Object | - | Typescript：`PopupProps`，[Popup API Documents](./popup?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/dropdown/type.ts) | N +popupProps | Object | - | Typescript: `PopupProps`，[Popup API Documents](./popup?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/dropdown/type.ts) | N trigger | String | hover | options: hover/click/focus/context-menu | N -onClick | Function | | Typescript：`(dropdownItem: DropdownOption, context: { e: MouseEvent }) => void`
| N +onClick | Function | | Typescript: `(dropdownItem: DropdownOption, context: { e: MouseEvent }) => void`
| N ### DropdownItem Props name | type | default | description | required -- | -- | -- | -- | -- -className | String | - | 类名 | N -style | Object | - | 样式，Typescript：`React.CSSProperties` | N +className | String | - | className of component | N +style | Object | - | CSS(Cascading Style Sheets)，Typescript: `React.CSSProperties` | N active | Boolean | false | \- | N -content | TNode | '' | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +content | TNode | '' | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N disabled | Boolean | false | \- | N divider | Boolean | false | \- | N -prefixIcon | TElement | - | Typescript：`TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -theme | String | default | options: default/success/warning/error。Typescript：`DropdownItemTheme` `type DropdownItemTheme = 'default' \| 'success' \| 'warning' \| 'error'`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/dropdown-menu/type.ts) | N -value | String / Number / Object | - | Typescript：`string \| number \| { [key: string]: any }` | N -onClick | Function | | Typescript：`(dropdownItem: DropdownOption, context: { e: MouseEvent }) => void`
| N +prefixIcon | TElement | - | Typescript: `TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +theme | String | default | options: default/success/warning/error。Typescript: `DropdownItemTheme` `type DropdownItemTheme = 'default' \| 'success' \| 'warning' \| 'error'`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/dropdown-menu/type.ts) | N +value | String / Number / Object | - | Typescript: `string \| number \| { [key: string]: any }` | N +onClick | Function | | Typescript: `(dropdownItem: DropdownOption, context: { e: MouseEvent }) => void`
| N diff --git a/packages/components/dropdown/dropdown.md b/packages/components/dropdown/dropdown.md index bbff0e2b66..a448188776 100644 --- a/packages/components/dropdown/dropdown.md +++ b/packages/components/dropdown/dropdown.md @@ -9,7 +9,7 @@ ## API ### Dropdown Props -名称 | 类型 | 默认值 | 说明 | 必传 +名称 | 类型 | 默认值 | 描述 | 必传 -- | -- | -- | -- | -- className | String | - | 类名 | N style | Object | - | 样式，TS 类型：`React.CSSProperties` | N @@ -29,7 +29,7 @@ onClick | Function | | TS 类型：`(dropdownItem: DropdownOption, context: { e ### DropdownItem Props -名称 | 类型 | 默认值 | 说明 | 必传 +名称 | 类型 | 默认值 | 描述 | 必传 -- | -- | -- | -- | -- className | String | - | 类名 | N style | Object | - | 样式，TS 类型：`React.CSSProperties` | N diff --git a/packages/components/empty/empty.en-US.md b/packages/components/empty/empty.en-US.md index 1f71a48a00..e725765ecf 100644 --- a/packages/components/empty/empty.en-US.md +++ b/packages/components/empty/empty.en-US.md @@ -7,11 +7,11 @@ name | type | default | description | required -- | -- | -- | -- | -- className | String | - | className of component | N -style | Object | - | CSS(Cascading Style Sheets)，Typescript：`React.CSSProperties` | N -action | TElement | - | action block。Typescript：`TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -description | TNode | - | empty component description。Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -image | TNode | - | image url, or Image component props, or custom any node you need.。Typescript：`string \| ImageProps \| TNode `，[Image API Documents](./image?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/empty/type.ts) | N -imageStyle | Object | - | pass `Cascading Style Sheets` to image element。Typescript：`Styles`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -size | String | medium | size of Empty, default value is `medium`。options: small/medium/large。Typescript：`SizeEnum`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -title | TNode | - | empty component title。Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +style | Object | - | CSS(Cascading Style Sheets)，Typescript: `React.CSSProperties` | N +action | TElement | - | action block。Typescript: `TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +description | TNode | - | empty component description。Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +image | TNode | - | image url, or Image component props, or custom any node you need.。Typescript: `string \| ImageProps \| TNode `，[Image API Documents](./image?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/empty/type.ts) | N +imageStyle | Object | - | pass `Cascading Style Sheets` to image element。Typescript: `Styles`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +size | String | medium | size of Empty, default value is `medium`。options: small/medium/large。Typescript: `SizeEnum`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +title | TNode | - | empty component title。Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N type | String | empty | Empty component type。options: empty/success/fail/network-error/maintenance | N diff --git a/packages/components/form/form.en-US.md b/packages/components/form/form.en-US.md index 1c945b9531..d19e888232 100644 --- a/packages/components/form/form.en-US.md +++ b/packages/components/form/form.en-US.md @@ -7,12 +7,12 @@ name | type | default | description | required -- | -- | -- | -- | -- className | String | - | className of component | N -style | Object | - | CSS(Cascading Style Sheets)，Typescript：`React.CSSProperties` | N +style | Object | - | CSS(Cascading Style Sheets)，Typescript: `React.CSSProperties` | N colon | Boolean | false | \- | N disabled | Boolean | undefined | \- | N -errorMessage | Object | - | Typescript：`FormErrorMessage` | N -form | Object | - | Typescript：`FormInstanceFunctions` | N -formControlledComponents | Array | - | Typescript：`Array` | N +errorMessage | Object | - | Typescript: `FormErrorMessage` | N +form | Object | - | Typescript: `FormInstanceFunctions` | N +formControlledComponents | Array | - | Typescript: `Array` | N id | String | undefined | native id attribute of the form，which supports being used in conjunction with non-form buttons through the form attribute to trigger form events | N initialData | Object | - | \- | N labelAlign | String | right | options: left/right/top | N @@ -23,28 +23,28 @@ readonly | Boolean | undefined | \- | N requiredMark | Boolean | true | \- | N requiredMarkPosition | String | left | Display position of required symbols。options: left/right | N resetType | String | empty | options: empty/initial | N -rules | Object | - | Typescript：`FormRules` `type FormRules = { [field in keyof T]?: Array }`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/form/type.ts) | N +rules | Object | - | Typescript: `FormRules` `type FormRules = { [field in keyof T]?: Array }`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/form/type.ts) | N scrollToFirstError | String | - | options: ''/smooth/auto | N showErrorMessage | Boolean | true | \- | N -statusIcon | TNode | undefined | Typescript：`boolean \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +statusIcon | TNode | undefined | Typescript: `boolean \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N submitWithWarningMessage | Boolean | false | \- | N supportNumberKey | Boolean | true | support using numbers as form key values or not. Form supports numbers as key values since 1.9.3, set supportNumberKey as false If you still need to retain numbers as array subscripts | N -onReset | Function | | Typescript：`(context: { e?: FormResetEvent }) => void`
| N -onSubmit | Function | | Typescript：`(context: SubmitContext) => void`
[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/form/type.ts)。
`interface SubmitContext { e?: FormSubmitEvent; validateResult: FormValidateResult; firstError?: string; fields?: any }`

`type FormValidateResult = boolean \| ValidateResultObj`

`type ValidateResultObj = { [key in keyof T]: boolean \| ValidateResultList }`

`type ValidateResultList = Array`

`type AllValidateResult = CustomValidateObj \| ValidateResultType`

`interface ValidateResultType extends FormRule { result: boolean }`

`type ValidateResult = { [key in keyof T]: boolean \| ErrorList }`

`type ErrorList = Array`
| N -onValuesChange | Function | | Typescript：`(changedValues: Record, allValues: Record) => void`
| N +onReset | Function | | Typescript: `(context: { e?: FormResetEvent }) => void`
| N +onSubmit | Function | | Typescript: `(context: SubmitContext) => void`
[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/form/type.ts)。
`interface SubmitContext { e?: FormSubmitEvent; validateResult: FormValidateResult; firstError?: string; fields?: any }`

`type FormValidateResult = boolean \| ValidateResultObj`

`type ValidateResultObj = { [key in keyof T]: boolean \| ValidateResultList }`

`type ValidateResultList = Array`

`type AllValidateResult = CustomValidateObj \| ValidateResultType`

`interface ValidateResultType extends FormRule { result: boolean }`

`type ValidateResult = { [key in keyof T]: boolean \| ErrorList }`

`type ErrorList = Array`
| N +onValuesChange | Function | | Typescript: `(changedValues: Record, allValues: Record) => void`
| N ### FormInstanceFunctions 组件实例方法 name | params | return | description -- | -- | -- | -- className | String | - | className of component | N -style | Object | - | CSS(Cascading Style Sheets)，Typescript：`React.CSSProperties` | N +style | Object | - | CSS(Cascading Style Sheets)，Typescript: `React.CSSProperties` | N clearValidate | `(fields?: Array)` | \- | required currentElement | \- | `HTMLFormElement` | required getFieldValue | `(field: NamePath) ` | `unknown` | required getFieldsValue | \- | `getFieldsValue` | required。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/form/type.ts)。
`interface getFieldsValue{ (nameList: true): T; (nameList: any[]): Record;}`
reset | `(params?: FormResetParams)` | \- | required。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/form/type.ts)。
`interface FormResetParams { type?: 'initial' \| 'empty'; fields?: Array }`
-setFields | `(fields: FieldData[])` | \- | required。Typescript：`(fields: FieldData[]) => void` `interface FieldData { name: NamePath; value?: unknown, status?: string, validateMessage?: { type?: string, message?: string } }`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/form/type.ts) +setFields | `(fields: FieldData[])` | \- | required。Typescript: `(fields: FieldData[]) => void` `interface FieldData { name: NamePath; value?: unknown, status?: string, validateMessage?: { type?: string, message?: string } }`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/form/type.ts) setFieldsValue | `(field: Data)` | \- | required setValidateMessage | `(message: FormValidateMessage)` | \- | required。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/form/type.ts)。
`type FormValidateMessage = { [field in keyof FormData]: FormItemValidateMessage[] }`

`interface FormItemValidateMessage { type: 'warning' \| 'error'; message: string }`
getValidateMessage | `(fields?: Array)` | `Array \| void` | required。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/form/type.ts)。
@@ -58,23 +58,23 @@ validateOnly | `(params?: Pick)` | `P name | type | default | description | required -- | -- | -- | -- | -- className | String | - | className of component | N -style | Object | - | CSS(Cascading Style Sheets)，Typescript：`React.CSSProperties` | N +style | Object | - | CSS(Cascading Style Sheets)，Typescript: `React.CSSProperties` | N for | String | - | \- | N -help | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -initialData | String / Number / Object / Array | - | Typescript：`InitialData` `type InitialData = any`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/form/type.ts) | N -label | TNode | '' | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +help | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +initialData | String / Number / Object / Array | - | Typescript: `InitialData` `type InitialData = any`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/form/type.ts) | N +label | TNode | '' | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N labelAlign | String | - | options: left/right/top | N labelWidth | String / Number | - | \- | N name | String | - | \- | N requiredMark | Boolean | undefined | \- | N -rules | Array | - | Typescript：`Array` | N -shouldUpdate | Boolean / Function | false | Typescript：`boolean \| ((prevValue, curValue) => boolean)` | N +rules | Array | - | Typescript: `Array` | N +shouldUpdate | Boolean / Function | false | Typescript: `boolean \| ((prevValue, curValue) => boolean)` | N showErrorMessage | Boolean | undefined | \- | N -status | String | - | Typescript：`'error' \| 'warning' \| 'success' \| 'validating'` | N -statusIcon | TNode | undefined | Typescript：`boolean \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +status | String | - | Typescript: `'error' \| 'warning' \| 'success' \| 'validating'` | N +statusIcon | TNode | undefined | Typescript: `boolean \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N successBorder | Boolean | false | \- | N -tips | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -valueFormat | Function | - | Triggered when user interaction results in data changes, used to format data。Typescript：`FormItemFormatType` `type FormItemFormatType = (value: any) => any`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/form/type.ts) | N +tips | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +valueFormat | Function | - | Triggered when user interaction results in data changes, used to format data。Typescript: `FormItemFormatType` `type FormItemFormatType = (value: any) => any`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/form/type.ts) | N ### FormList Props @@ -82,33 +82,33 @@ valueFormat | Function | - | Triggered when user interaction results in data cha name | type | default | description | required -- | -- | -- | -- | -- className | String | - | className of component | N -style | Object | - | CSS(Cascading Style Sheets)，Typescript：`React.CSSProperties` | N -children | Function | - | Typescript：`(fields: FormListField[], operation: FormListFieldOperation) => React.ReactNode` `type FormListField = { key: number; name: number; isListField: boolean }` `type FormListFieldOperation = { add: (defaultValue?: any, insertIndex?: number) => void, remove: (index: number \| number[]) => void, move: (from: number, to: number) => void }`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/form/type.ts) | N -initialData | Array | - | Typescript：`Array` | N -name | String / Number / Array | - | Typescript：`NamePath` | N -rules | Object / Array | - | Typescript：`{ [field in keyof FormData]: Array } \| Array` | N +style | Object | - | CSS(Cascading Style Sheets)，Typescript: `React.CSSProperties` | N +children | Function | - | Typescript: `(fields: FormListField[], operation: FormListFieldOperation) => React.ReactNode` `type FormListField = { key: number; name: number; isListField: boolean }` `type FormListFieldOperation = { add: (defaultValue?: any, insertIndex?: number) => void, remove: (index: number \| number[]) => void, move: (from: number, to: number) => void }`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/form/type.ts) | N +initialData | Array | - | Typescript: `Array` | N +name | String / Number / Array | - | Typescript: `NamePath` | N +rules | Object / Array | - | Typescript: `{ [field in keyof FormData]: Array } \| Array` | N ### FormRule name | type | default | description | required -- | -- | -- | -- | -- boolean | Boolean | - | \- | N -date | Boolean / Object | - | Typescript：`boolean \| IsDateOptions` `interface IsDateOptions { format: string; strictMode: boolean; delimiters: string[] }`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/form/type.ts) | N -email | Boolean / Object | - | Typescript：`boolean \| IsEmailOptions` `import { IsEmailOptions } from 'validator/es/lib/isEmail'`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/form/type.ts) | N -enum | Array | - | Typescript：`Array` | N +date | Boolean / Object | - | Typescript: `boolean \| IsDateOptions` `interface IsDateOptions { format: string; strictMode: boolean; delimiters: string[] }`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/form/type.ts) | N +email | Boolean / Object | - | Typescript: `boolean \| IsEmailOptions` `import { IsEmailOptions } from 'validator/es/lib/isEmail'`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/form/type.ts) | N +enum | Array | - | Typescript: `Array` | N idcard | Boolean | - | \- | N len | Number / Boolean | - | \- | N max | Number / Boolean | - | \- | N message | String | - | \- | N min | Number / Boolean | - | \- | N number | Boolean | - | \- | N -pattern | Object | - | Typescript：`RegExp` | N +pattern | Object | - | Typescript: `RegExp` | N required | Boolean | - | \- | N telnumber | Boolean | - | \- | N -trigger | String | change | Typescript：`ValidateTriggerType` | N +trigger | String | change | Typescript: `ValidateTriggerType` | N type | String | error | options: error/warning | N -url | Boolean / Object | - | Typescript：`boolean \| IsURLOptions` `import { IsURLOptions } from 'validator/es/lib/isURL'`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/form/type.ts) | N -validator | Function | - | Typescript：`CustomValidator` `type CustomValidator = (val: ValueType) => CustomValidateResolveType \| Promise` `type CustomValidateResolveType = boolean \| CustomValidateObj` `interface CustomValidateObj { result: boolean; message: string; type?: 'error' \| 'warning' \| 'success' }` `type ValueType = any`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/form/type.ts) | N +url | Boolean / Object | - | Typescript: `boolean \| IsURLOptions` `import { IsURLOptions } from 'validator/es/lib/isURL'`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/form/type.ts) | N +validator | Function | - | Typescript: `CustomValidator` `type CustomValidator = (val: ValueType) => CustomValidateResolveType \| Promise` `type CustomValidateResolveType = boolean \| CustomValidateObj` `interface CustomValidateObj { result: boolean; message: string; type?: 'error' \| 'warning' \| 'success' }` `type ValueType = any`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/form/type.ts) | N whitespace | Boolean | - | \- | N ### FormErrorMessage diff --git a/packages/components/grid/grid.en-US.md b/packages/components/grid/grid.en-US.md index 8c76f8a42b..fbcb4ddd3e 100644 --- a/packages/components/grid/grid.en-US.md +++ b/packages/components/grid/grid.en-US.md @@ -5,10 +5,10 @@ name | type | default | description | required -- | -- | -- | -- | -- -className | String | - | 类名 | N -style | Object | - | 样式，Typescript：`React.CSSProperties` | N +className | String | - | className of component | N +style | Object | - | CSS(Cascading Style Sheets)，Typescript: `React.CSSProperties` | N align | String | top | options: start/end/center/stretch/baseline/top/middle/bottom | N -gutter | Number / Object / Array | 0 | Typescript：`number \| GutterObject \| Array` `interface GutterObject { xs: number; sm: number; md: number; lg: number, xl: number; xxl: number; } `。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/grid/type.ts) | N +gutter | Number / Object / Array | 0 | Typescript: `number \| GutterObject \| Array` `interface GutterObject { xs: number; sm: number; md: number; lg: number, xl: number; xxl: number; } `。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/grid/type.ts) | N justify | String | start | options: start/end/center/space-around/space-between | N tag | String | div | \- | N @@ -16,18 +16,18 @@ tag | String | div | \- | N name | type | default | description | required -- | -- | -- | -- | -- -className | String | - | 类名 | N -style | Object | - | 样式，Typescript：`React.CSSProperties` | N +className | String | - | className of component | N +style | Object | - | CSS(Cascading Style Sheets)，Typescript: `React.CSSProperties` | N flex | String / Number | - | \- | N -lg | Number / Object | - | Typescript：`number \| BaseColProps` | N -md | Number / Object | - | Typescript：`number \| BaseColProps` | N +lg | Number / Object | - | Typescript: `number \| BaseColProps` | N +md | Number / Object | - | Typescript: `number \| BaseColProps` | N offset | Number | 0 | \- | N order | Number | 0 | \- | N pull | Number | 0 | \- | N push | Number | 0 | \- | N -sm | Number / Object | - | Typescript：`number \| BaseColProps` | N +sm | Number / Object | - | Typescript: `number \| BaseColProps` | N span | Number | - | \- | N tag | String | div | \- | N -xl | Number / Object | - | Typescript：`number \| BaseColProps` | N -xs | Number / Object | - | Typescript：`number \| BaseColProps` `interface BaseColProps { offset: number; order: number; pull: number; push: number; span: number }`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/grid/type.ts) | N -xxl | Number / Object | - | Typescript：`number \| BaseColProps` | N +xl | Number / Object | - | Typescript: `number \| BaseColProps` | N +xs | Number / Object | - | Typescript: `number \| BaseColProps` `interface BaseColProps { offset: number; order: number; pull: number; push: number; span: number }`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/grid/type.ts) | N +xxl | Number / Object | - | Typescript: `number \| BaseColProps` | N diff --git a/packages/components/grid/grid.md b/packages/components/grid/grid.md index 6fccc7f1d6..1ca458f453 100644 --- a/packages/components/grid/grid.md +++ b/packages/components/grid/grid.md @@ -3,7 +3,7 @@ ## API ### Row Props -名称 | 类型 | 默认值 | 说明 | 必传 +名称 | 类型 | 默认值 | 描述 | 必传 -- | -- | -- | -- | -- className | String | - | 类名 | N style | Object | - | 样式，TS 类型：`React.CSSProperties` | N @@ -14,7 +14,7 @@ tag | String | div | 自定义元素标签 | N ### Col Props -名称 | 类型 | 默认值 | 说明 | 必传 +名称 | 类型 | 默认值 | 描述 | 必传 -- | -- | -- | -- | -- className | String | - | 类名 | N style | Object | - | 样式，TS 类型：`React.CSSProperties` | N diff --git a/packages/components/guide/guide.en-US.md b/packages/components/guide/guide.en-US.md index dc10de4dea..245e4994a6 100644 --- a/packages/components/guide/guide.en-US.md +++ b/packages/components/guide/guide.en-US.md @@ -5,46 +5,46 @@ name | type | default | description | required -- | -- | -- | -- | -- -className | String | - | 类名 | N -style | Object | - | 样式，Typescript：`React.CSSProperties` | N -counter | TElement | - | Typescript：`TNode<{ current: number; total: number }>`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +className | String | - | className of component | N +style | Object | - | CSS(Cascading Style Sheets)，Typescript: `React.CSSProperties` | N +counter | TElement | - | Typescript: `TNode<{ current: number; total: number }>`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N current | Number | - | \- | N defaultCurrent | Number | - | uncontrolled property | N -finishButtonProps | Object | - | Typescript：`ButtonProps` | N +finishButtonProps | Object | - | Typescript: `ButtonProps` | N hideCounter | Boolean | false | \- | N hidePrev | Boolean | false | \- | N hideSkip | Boolean | false | \- | N highlightPadding | Number | 8 | \- | N mode | String | popup | options：popup/dialog | N -nextButtonProps | Object | - | Typescript：`ButtonProps`，[Button API Documents](./button?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/guide/type.ts) | N -prevButtonProps | Object | - | Typescript：`ButtonProps` | N +nextButtonProps | Object | - | Typescript: `ButtonProps`，[Button API Documents](./button?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/guide/type.ts) | N +prevButtonProps | Object | - | Typescript: `ButtonProps` | N showOverlay | Boolean | true | \- | N -skipButtonProps | Object | - | Typescript：`ButtonProps` | N -steps | Array | - | Typescript：`Array` | N +skipButtonProps | Object | - | Typescript: `ButtonProps` | N +steps | Array | - | Typescript: `Array` | N zIndex | Number | 999999 | \- | N -onChange | Function | | Typescript：`(current: number, context?: { e: MouseEvent, total: number }) => void`
| N -onFinish | Function | | Typescript：`(context: { e: MouseEvent, current: number, total: number }) => void`
| N -onNextStepClick | Function | | Typescript：`(context: { e: MouseEvent, next: number, current: number, total: number }) => void`
| N -onPrevStepClick | Function | | Typescript：`(context: { e: MouseEvent, prev: number, current: number, total: number }) => void`
| N -onSkip | Function | | Typescript：`(context: { e: MouseEvent, current: number, total: number }) => void`
| N +onChange | Function | | Typescript: `(current: number, context?: { e: MouseEvent, total: number }) => void`
| N +onFinish | Function | | Typescript: `(context: { e: MouseEvent, current: number, total: number }) => void`
| N +onNextStepClick | Function | | Typescript: `(context: { e: MouseEvent, next: number, current: number, total: number }) => void`
| N +onPrevStepClick | Function | | Typescript: `(context: { e: MouseEvent, prev: number, current: number, total: number }) => void`
| N +onSkip | Function | | Typescript: `(context: { e: MouseEvent, current: number, total: number }) => void`
| N ### GuideStep name | type | default | description | required -- | -- | -- | -- | -- -body | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -children | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -content | TElement | - | Typescript：`TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -element | String / Function | - | required。Typescript：`AttachNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | Y -highlightContent | TElement | - | Typescript：`TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +body | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +children | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +content | TElement | - | Typescript: `TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +element | String / Function | - | required。Typescript: `AttachNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | Y +highlightContent | TElement | - | Typescript: `TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N highlightPadding | Number | - | \- | N mode | String | - | options：popup/dialog | N -nextButtonProps | Object | - | Typescript：`ButtonProps` | N -offset | Array | - | this api is in discussing. do not use it.。Typescript：`Array` | N -placement | String | 'top' | Typescript：`StepPopupPlacement \| StepDialogPlacement` `type StepPopupPlacement = 'top'\|'left'\|'right'\|'bottom'\|'top-left'\|'top-right'\|'bottom-left'\|'bottom-right'\|'left-top'\|'left-bottom'\|'right-top'\|'right-bottom'` `type StepDialogPlacement = 'top'\|'center' `。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/guide/type.ts) | N -popupProps | Object | - | Popup component props if `mode = popup`。Typescript：`PopupProps`，[Popup API Documents](./popup?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/guide/type.ts) | N -prevButtonProps | Object | - | Typescript：`ButtonProps` | N +nextButtonProps | Object | - | Typescript: `ButtonProps` | N +offset | Array | - | this api is in discussing. do not use it.。Typescript: `Array` | N +placement | String | 'top' | Typescript: `StepPopupPlacement \| StepDialogPlacement` `type StepPopupPlacement = 'top'\|'left'\|'right'\|'bottom'\|'top-left'\|'top-right'\|'bottom-left'\|'bottom-right'\|'left-top'\|'left-bottom'\|'right-top'\|'right-bottom'` `type StepDialogPlacement = 'top'\|'center' `。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/guide/type.ts) | N +popupProps | Object | - | Popup component props if `mode = popup`。Typescript: `PopupProps`，[Popup API Documents](./popup?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/guide/type.ts) | N +prevButtonProps | Object | - | Typescript: `ButtonProps` | N showOverlay | Boolean | true | \- | N -skipButtonProps | Object | - | Typescript：`ButtonProps` | N +skipButtonProps | Object | - | Typescript: `ButtonProps` | N stepOverlayClass | String | - | \- | N title | String | - | \- | N diff --git a/packages/components/guide/guide.md b/packages/components/guide/guide.md index bbcfb2f92f..3272f64d90 100644 --- a/packages/components/guide/guide.md +++ b/packages/components/guide/guide.md @@ -3,7 +3,7 @@ ## API ### Guide Props -名称 | 类型 | 默认值 | 说明 | 必传 +名称 | 类型 | 默认值 | 描述 | 必传 -- | -- | -- | -- | -- className | String | - | 类名 | N style | Object | - | 样式，TS 类型：`React.CSSProperties` | N @@ -30,7 +30,7 @@ onSkip | Function | | TS 类型：`(context: { e: MouseEvent, current: number, ### GuideStep -名称 | 类型 | 默认值 | 说明 | 必传 +名称 | 类型 | 默认值 | 描述 | 必传 -- | -- | -- | -- | -- body | TNode | - | 当前步骤提示框的内容。TS 类型：`string \| TNode`。[通用类型定义](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N children | TNode | - | 自定义内容，同 content。TS 类型：`string \| TNode`。[通用类型定义](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N diff --git a/packages/components/icon/icon.en-US.md b/packages/components/icon/icon.en-US.md index e6e4b10a7c..057e73ec78 100644 --- a/packages/components/icon/icon.en-US.md +++ b/packages/components/icon/icon.en-US.md @@ -72,7 +72,7 @@ if your project is in a no-network scenario, please use on-demand loading of ico name | type | default | description | required -- | -- | -- | -- | -- size | String | undefined | size of icon | N -onClick | Function | | Typescript：`(context: { e: MouseEvent }) => void`
| N +onClick | Function | | Typescript: `(context: { e: MouseEvent }) => void`
| N strokeWidth | Number | 2| width of icon stroke，default is 2 strokeColor | String / Array | currentColor | stroke color of the outlined icon, default value is `currentColor`, supporting up to two stroke colors at most fillColor | String / Array | | fill color for outlined icons and the fill color for filled icons. For outlined icons, the default is transparent, while for filled icons, the default is currentColor, supporting up to two fill colors at most @@ -82,38 +82,38 @@ fillColor | String / Array | | fill color for outlined icons and the fill color name | type | default | description | required -- | -- | -- | -- | -- -className | String | - | 类名 | N -style | Object | - | 样式，Typescript：`React.CSSProperties` | N +className | String | - | className of component | N +style | Object | - | CSS(Cascading Style Sheets)，Typescript: `React.CSSProperties` | N loadDefaultIcons | Boolean | true | \- | N name | String | - | required | Y size | String | undefined | \- | N style | String | - | html attribute | N -url | String / Array | - | Typescript：`string \| Array` | N -onClick | Function | | Typescript：`(context: { e: MouseEvent }) => void`
| N +url | String / Array | - | Typescript: `string \| Array` | N +onClick | Function | | Typescript: `(context: { e: MouseEvent }) => void`
| N ### IconSVG Props name | type | default | description | required -- | -- | -- | -- | -- -className | String | - | 类名 | N -style | Object | - | 样式，Typescript：`React.CSSProperties` | N +className | String | - | className of component | N +style | Object | - | CSS(Cascading Style Sheets)，Typescript: `React.CSSProperties` | N loadDefaultIcons | Boolean | true | \- | N name | String | - | required | Y size | String | undefined | \- | N style | String | - | html attribute | N -url | String / Array | - | Typescript：`string \| Array` | N -onClick | Function | | Typescript：`(context: { e: MouseEvent }) => void`
| N +url | String / Array | - | Typescript: `string \| Array` | N +onClick | Function | | Typescript: `(context: { e: MouseEvent }) => void`
| N ### Iconfont Props name | type | default | description | required -- | -- | -- | -- | -- -className | String | - | 类名 | N -style | Object | - | 样式，Typescript：`React.CSSProperties` | N +className | String | - | className of component | N +style | Object | - | CSS(Cascading Style Sheets)，Typescript: `React.CSSProperties` | N loadDefaultIcons | Boolean | true | \- | N name | String | - | required | Y size | String | undefined | \- | N style | String | - | html attribute | N tag | String | i | \- | N -url | String / Array | - | Typescript：`string \| Array` | N -onClick | Function | | Typescript：`(context: { e: MouseEvent }) => void`
| N +url | String / Array | - | Typescript: `string \| Array` | N +onClick | Function | | Typescript: `(context: { e: MouseEvent }) => void`
| N diff --git a/packages/components/icon/icon.md b/packages/components/icon/icon.md index d4a2bba6fc..f6e68b0269 100644 --- a/packages/components/icon/icon.md +++ b/packages/components/icon/icon.md @@ -80,7 +80,7 @@ ### Icon Props -名称 | 类型 | 默认值 | 说明 | 必传 +名称 | 类型 | 默认值 | 描述 | 必传 -- | -- | -- | -- | -- size | String | undefined | 图标尺寸，支持 'small', 'medium', 'large'，'35px', '3em' 等 | N onClick | Function | | TS 类型：`(context: { e: MouseEvent }) => void`
点击时触发 | N @@ -91,7 +91,7 @@ fillColor | String / Array | - | 描边图标的填充颜色和填充图标的 ### IconSVG Props -名称 | 类型 | 默认值 | 说明 | 必传 +名称 | 类型 | 默认值 | 描述 | 必传 -- | -- | -- | -- | -- className | String | - | 类名 | N style | Object | - | 样式，TS 类型：`React.CSSProperties` | N @@ -104,7 +104,7 @@ onClick | Function | | TS 类型：`(context: { e: MouseEvent }) => void`
### Iconfont Props -名称 | 类型 | 默认值 | 说明 | 必传 +名称 | 类型 | 默认值 | 描述 | 必传 -- | -- | -- | -- | -- className | String | - | 类名 | N style | Object | - | 样式，TS 类型：`React.CSSProperties` | N diff --git a/packages/components/image-viewer/image-viewer.en-US.md b/packages/components/image-viewer/image-viewer.en-US.md index 6fb5617df7..79bd869371 100644 --- a/packages/components/image-viewer/image-viewer.en-US.md +++ b/packages/components/image-viewer/image-viewer.en-US.md @@ -7,26 +7,26 @@ name | type | default | description | required -- | -- | -- | -- | -- className | String | - | className of component | N -style | Object | - | CSS(Cascading Style Sheets)，Typescript：`React.CSSProperties` | N -attach | String / Function | 'body' | Typescript：`AttachNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -closeBtn | TNode | true | Typescript：`boolean \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +style | Object | - | CSS(Cascading Style Sheets)，Typescript: `React.CSSProperties` | N +attach | String / Function | 'body' | Typescript: `AttachNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +closeBtn | TNode | true | Typescript: `boolean \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N closeOnEscKeydown | Boolean | true | trigger image viewer close event on `ESC` keydown | N closeOnOverlay | Boolean | - | \- | N draggable | Boolean | undefined | \- | N imageReferrerpolicy | String | - | attribute of ``, [MDN Definition](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Referrer-Policy)。options: no-referrer/no-referrer-when-downgrade/origin/origin-when-cross-origin/same-origin/strict-origin/strict-origin-when-cross-origin/unsafe-url | N -imageScale | Object | - | Typescript：`Partial` `interface ImageScale { max: number; min: number; step: number; defaultScale: number; }`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/image-viewer/type.ts) | N -images | Array | [] | Typescript：`Array` `interface ImageInfo { mainImage: string \| File; thumbnail?: string \| File; download?: boolean; isSvg?: boolean }`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/image-viewer/type.ts) | N +imageScale | Object | - | Typescript: `Partial` `interface ImageScale { max: number; min: number; step: number; defaultScale: number; }`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/image-viewer/type.ts) | N +images | Array | [] | Typescript: `Array` `interface ImageInfo { mainImage: string \| File; thumbnail?: string \| File; download?: boolean; isSvg?: boolean }`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/image-viewer/type.ts) | N index | Number | 0 | \- | N defaultIndex | Number | 0 | uncontrolled property | N mode | String | modal | options: modal/modeless | N -navigationArrow | TNode | true | Typescript：`boolean \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +navigationArrow | TNode | true | Typescript: `boolean \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N showOverlay | Boolean | undefined | \- | N -title | TNode | - | preview title。Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -trigger | TNode | - | trigger element。Typescript：`TNode \| TNode<{ open: (index?: number) => void }>`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -viewerScale | Object | - | Typescript：`ImageViewerScale` `interface ImageViewerScale { minWidth: number; minHeight: number }`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/image-viewer/type.ts) | N +title | TNode | - | preview title。Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +trigger | TNode | - | trigger element。Typescript: `TNode \| TNode<{ open: (index?: number) => void }>`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +viewerScale | Object | - | Typescript: `ImageViewerScale` `interface ImageViewerScale { minWidth: number; minHeight: number }`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/image-viewer/type.ts) | N visible | Boolean | false | hide or show image viewer | N defaultVisible | Boolean | false | hide or show image viewer。uncontrolled property | N zIndex | Number | - | \- | N -onClose | Function | | Typescript：`(context: { trigger: 'close-btn' \| 'overlay' \| 'esc'; e: MouseEvent \| KeyboardEvent }) => void`
| N -onDownload | Function | | Typescript：`(url: string \| File) => void`
| N -onIndexChange | Function | | Typescript：`(index: number, context: { trigger: 'prev' \| 'next' \| 'current' }) => void`
| N +onClose | Function | | Typescript: `(context: { trigger: 'close-btn' \| 'overlay' \| 'esc'; e: MouseEvent \| KeyboardEvent }) => void`
| N +onDownload | Function | | Typescript: `(url: string \| File) => void`
| N +onIndexChange | Function | | Typescript: `(index: number, context: { trigger: 'prev' \| 'next' \| 'current' }) => void`
| N diff --git a/packages/components/image/image.en-US.md b/packages/components/image/image.en-US.md index 94acc31cba..18f83b3f97 100644 --- a/packages/components/image/image.en-US.md +++ b/packages/components/image/image.en-US.md @@ -5,22 +5,22 @@ name | type | default | description | required -- | -- | -- | -- | -- -className | String | - | 类名 | N -style | Object | - | 样式，Typescript：`React.CSSProperties` | N +className | String | - | className of component | N +style | Object | - | CSS(Cascading Style Sheets)，Typescript: `React.CSSProperties` | N alt | String | - | \- | N -error | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +error | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N fallback | String | - | display `fallback` image on `src` loading failed. you can also use `error` to define more complex error content | N fit | String | fill | options: contain/cover/fill/none/scale-down | N gallery | Boolean | false | \- | N lazy | Boolean | false | \- | N -loading | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -overlayContent | TNode | - | overlay on the top of image。Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +loading | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +overlayContent | TNode | - | overlay on the top of image。Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N overlayTrigger | String | always | options: always/hover | N -placeholder | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +placeholder | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N position | String | center | \- | N referrerpolicy | String | - | attribute of ``, [MDN Definition](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Referrer-Policy)。options: no-referrer/no-referrer-when-downgrade/origin/origin-when-cross-origin/same-origin/strict-origin/strict-origin-when-cross-origin/unsafe-url | N shape | String | square | options: circle/round/square | N -src | String / Object | - | src attribute of ``. image File can also be loaded。Typescript：`string \| File` | N -srcset | Object | - | for `.avif` and `.webp` image url, load `srcset` before `src`。Typescript：`ImageSrcset` `interface ImageSrcset { 'image/avif': string; 'image/webp': string; }`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/image/type.ts) | N -onError | Function | | Typescript：`(context: { e: ImageEvent }) => void`
trigger on image load failed | N -onLoad | Function | | Typescript：`(context: { e: ImageEvent }) => void`
trigger on image loaded | N +src | String / Object | - | src attribute of ``. image File can also be loaded。Typescript: `string \| File` | N +srcset | Object | - | for `.avif` and `.webp` image url, load `srcset` before `src`。Typescript: `ImageSrcset` `interface ImageSrcset { 'image/avif': string; 'image/webp': string; }`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/image/type.ts) | N +onError | Function | | Typescript: `(context: { e: ImageEvent }) => void`
trigger on image load failed | N +onLoad | Function | | Typescript: `(context: { e: ImageEvent }) => void`
trigger on image loaded | N diff --git a/packages/components/image/image.md b/packages/components/image/image.md index 091038b2b4..e889124ca4 100644 --- a/packages/components/image/image.md +++ b/packages/components/image/image.md @@ -3,7 +3,7 @@ ## API ### Image Props -名称 | 类型 | 默认值 | 说明 | 必传 +名称 | 类型 | 默认值 | 描述 | 必传 -- | -- | -- | -- | -- className | String | - | 类名 | N style | Object | - | 样式，TS 类型：`React.CSSProperties` | N diff --git a/packages/components/input-adornment/input-adornment.en-US.md b/packages/components/input-adornment/input-adornment.en-US.md index 56f118cd53..aef98d6612 100644 --- a/packages/components/input-adornment/input-adornment.en-US.md +++ b/packages/components/input-adornment/input-adornment.en-US.md @@ -6,7 +6,7 @@ name | type | default | description | required -- | -- | -- | -- | -- -className | String | - | 类名 | N -style | Object | - | 样式，Typescript：`React.CSSProperties` | N -append | TNode | - | The suffix decoration。Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -prepend | TNode | - | The prefix decoration。Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +className | String | - | className of component | N +style | Object | - | CSS(Cascading Style Sheets)，Typescript: `React.CSSProperties` | N +append | TNode | - | The suffix decoration。Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +prepend | TNode | - | The prefix decoration。Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N diff --git a/packages/components/input-adornment/input-adornment.md b/packages/components/input-adornment/input-adornment.md index 8a8f9c2154..9ccdafaf59 100644 --- a/packages/components/input-adornment/input-adornment.md +++ b/packages/components/input-adornment/input-adornment.md @@ -3,7 +3,7 @@ ## API ### InputAdornment Props -名称 | 类型 | 默认值 | 说明 | 必传 +名称 | 类型 | 默认值 | 描述 | 必传 -- | -- | -- | -- | -- className | String | - | 类名 | N style | Object | - | 样式，TS 类型：`React.CSSProperties` | N diff --git a/packages/components/input-number/input-number.en-US.md b/packages/components/input-number/input-number.en-US.md index 55c462ab7f..dd1f5d922f 100644 --- a/packages/components/input-number/input-number.en-US.md +++ b/packages/components/input-number/input-number.en-US.md @@ -7,33 +7,33 @@ name | type | default | description | required -- | -- | -- | -- | -- className | String | - | className of component | N -style | Object | - | CSS(Cascading Style Sheets)，Typescript：`React.CSSProperties` | N +style | Object | - | CSS(Cascading Style Sheets)，Typescript: `React.CSSProperties` | N align | String | - | options: left/center/right | N allowInputOverLimit | Boolean | true | \- | N autoWidth | Boolean | false | \- | N -decimalPlaces | Number / Object | undefined | Typescript：`InputNumberDecimalPlaces` `type InputNumberDecimalPlaces = number \| { enableRound: boolean; places: number } `。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/input-number/type.ts) | N +decimalPlaces | Number / Object | undefined | Typescript: `InputNumberDecimalPlaces` `type InputNumberDecimalPlaces = number \| { enableRound: boolean; places: number } `。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/input-number/type.ts) | N disabled | Boolean | undefined | \- | N -format | Function | - | Typescript：`(value: InputNumberValue, context?: { fixedNumber?: InputNumberValue }) => InputNumberValue` | N -inputProps | Object | - | Typescript：`InputProps`，[Input API Documents](./input?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/input-number/type.ts) | N -label | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +format | Function | - | Typescript: `(value: InputNumberValue, context?: { fixedNumber?: InputNumberValue }) => InputNumberValue` | N +inputProps | Object | - | Typescript: `InputProps`，[Input API Documents](./input?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/input-number/type.ts) | N +label | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N largeNumber | Boolean | false | \- | N -max | String / Number | Infinity | Typescript：`InputNumberValue` | N -min | String / Number | -Infinity | Typescript：`InputNumberValue` | N +max | String / Number | Infinity | Typescript: `InputNumberValue` | N +min | String / Number | -Infinity | Typescript: `InputNumberValue` | N placeholder | String | undefined | \- | N readonly | Boolean | undefined | \- | N size | String | medium | options: small/medium/large | N status | String | default | options: default/success/warning/error | N -step | String / Number | 1 | Typescript：`InputNumberValue` | N -suffix | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +step | String / Number | 1 | Typescript: `InputNumberValue` | N +suffix | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N theme | String | row | options: column/row/normal | N -tips | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -value | String / Number | - | Typescript：`T` `type InputNumberValue = number \| string`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/input-number/type.ts) | N -defaultValue | String / Number | - | uncontrolled property。Typescript：`T` `type InputNumberValue = number \| string`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/input-number/type.ts) | N -onBlur | Function | | Typescript：`(value: InputNumberValue, context: { e: FocusEvent }) => void`
| N -onChange | Function | | Typescript：`(value: T, context: ChangeContext) => void`
[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/input-number/type.ts)。
`interface ChangeContext { type: ChangeSource; e: InputEvent \| MouseEvent \| FocusEvent \| KeyboardEvent \| CompositionEvent }`

`type ChangeSource = 'add' \| 'reduce' \| 'input' \| 'blur' \| 'enter' \| 'clear' \| 'props'`
| N -onEnter | Function | | Typescript：`(value: InputNumberValue, context: { e: KeyboardEvent }) => void`
| N -onFocus | Function | | Typescript：`(value: InputNumberValue, context: { e: FocusEvent }) => void`
| N -onKeydown | Function | | Typescript：`(value: InputNumberValue, context: { e: KeyboardEvent }) => void`
| N -onKeypress | Function | | Typescript：`(value: InputNumberValue, context: { e: KeyboardEvent }) => void`
| N -onKeyup | Function | | Typescript：`(value: InputNumberValue, context: { e: KeyboardEvent }) => void`
| N -onValidate | Function | | Typescript：`(context: { error?: 'exceed-maximum' \| 'below-minimum' }) => void`
| N +tips | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +value | String / Number | - | Typescript: `T` `type InputNumberValue = number \| string`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/input-number/type.ts) | N +defaultValue | String / Number | - | uncontrolled property。Typescript: `T` `type InputNumberValue = number \| string`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/input-number/type.ts) | N +onBlur | Function | | Typescript: `(value: InputNumberValue, context: { e: FocusEvent }) => void`
| N +onChange | Function | | Typescript: `(value: T, context: ChangeContext) => void`
[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/input-number/type.ts)。
`interface ChangeContext { type: ChangeSource; e: InputEvent \| MouseEvent \| FocusEvent \| KeyboardEvent \| CompositionEvent }`

`type ChangeSource = 'add' \| 'reduce' \| 'input' \| 'blur' \| 'enter' \| 'clear' \| 'props'`
| N +onEnter | Function | | Typescript: `(value: InputNumberValue, context: { e: KeyboardEvent }) => void`
| N +onFocus | Function | | Typescript: `(value: InputNumberValue, context: { e: FocusEvent }) => void`
| N +onKeydown | Function | | Typescript: `(value: InputNumberValue, context: { e: KeyboardEvent }) => void`
| N +onKeypress | Function | | Typescript: `(value: InputNumberValue, context: { e: KeyboardEvent }) => void`
| N +onKeyup | Function | | Typescript: `(value: InputNumberValue, context: { e: KeyboardEvent }) => void`
| N +onValidate | Function | | Typescript: `(context: { error?: 'exceed-maximum' \| 'below-minimum' }) => void`
| N diff --git a/packages/components/input/input.en-US.md b/packages/components/input/input.en-US.md index b5acf2d471..c8d555e82d 100644 --- a/packages/components/input/input.en-US.md +++ b/packages/components/input/input.en-US.md @@ -7,7 +7,7 @@ name | type | default | description | required -- | -- | -- | -- | -- className | String | - | className of component | N -style | Object | - | CSS(Cascading Style Sheets)，Typescript：`React.CSSProperties` | N +style | Object | - | CSS(Cascading Style Sheets)，Typescript: `React.CSSProperties` | N align | String | left | options: left/center/right | N allowInputOverMax | Boolean | false | \- | N autoWidth | Boolean | false | \- | N @@ -16,42 +16,42 @@ autofocus | Boolean | false | \- | N borderless | Boolean | false | input without border | N clearable | Boolean | false | \- | N disabled | Boolean | - | \- | N -format | Function | - | Typescript：`InputFormatType` `type InputFormatType = (value: InputValue) => string`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/input/type.ts) | N -inputClass | String / Object / Array | - | Typescript：`ClassName`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -label | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +format | Function | - | Typescript: `InputFormatType` `type InputFormatType = (value: InputValue) => string`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/input/type.ts) | N +inputClass | String / Object / Array | - | Typescript: `ClassName`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +label | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N maxcharacter | Number | - | \- | N maxlength | Number | - | \- | N name | String | - | \- | N placeholder | String | undefined | \- | N -prefixIcon | TElement | - | Typescript：`TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +prefixIcon | TElement | - | Typescript: `TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N readonly | Boolean | false | \- | N showClearIconOnEmpty | Boolean | false | \- | N showLimitNumber | Boolean | false | show limit number text on the right | N -size | String | medium | options: small/medium/large。Typescript：`SizeEnum`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +size | String | medium | options: small/medium/large。Typescript: `SizeEnum`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N spellCheck | Boolean | false | attribute of input element, [see here](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/spellcheck) | N status | String | default | options: default/success/warning/error | N -suffix | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -suffixIcon | TElement | - | Typescript：`TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -tips | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +suffix | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +suffixIcon | TElement | - | Typescript: `TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +tips | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N type | String | text | options: text/number/url/tel/password/search/submit/hidden | N -value | String | '' | Typescript：`InputValue` `type InputValue = string`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/input/type.ts) | N -defaultValue | String | '' | uncontrolled property。Typescript：`InputValue` `type InputValue = string`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/input/type.ts) | N -onBlur | Function | | Typescript：`(value: InputValue, context: { e: FocusEvent }) => void`
| N -onChange | Function | | Typescript：`(value: InputValue, context?: { e?: InputEvent \| MouseEvent \| CompositionEvent; trigger: 'input' \| 'initial' \| 'clear' }) => void`
| N -onClear | Function | | Typescript：`(context: { e: MouseEvent }) => void`
| N -onClick | Function | | Typescript：`(context: { e: MouseEvent }) => void`
| N -onCompositionend | Function | | Typescript：`(value: InputValue, context: { e: CompositionEvent }) => void`
trigger on compositionend | N -onCompositionstart | Function | | Typescript：`(value: InputValue, context: { e: CompositionEvent }) => void`
trigger on compositionstart | N -onEnter | Function | | Typescript：`(value: InputValue, context: { e: KeyboardEvent }) => void`
| N -onFocus | Function | | Typescript：`(value: InputValue, context: { e: FocusEvent }) => void`
| N -onKeydown | Function | | Typescript：`(value: InputValue, context: { e: KeyboardEvent }) => void`
| N -onKeypress | Function | | Typescript：`(value: InputValue, context: { e: KeyboardEvent }) => void`
| N -onKeyup | Function | | Typescript：`(value: InputValue, context: { e: KeyboardEvent }) => void`
| N -onMouseenter | Function | | Typescript：`(context: { e: MouseEvent }) => void`
trigger on mouseenter | N -onMouseleave | Function | | Typescript：`(context: { e: MouseEvent }) => void`
trigger on mouseleave | N -onPaste | Function | | Typescript：`(context: { e: ClipboardEvent; pasteValue: string }) => void`
| N -onValidate | Function | | Typescript：`(context: { error?: 'exceed-maximum' \| 'below-minimum' }) => void`
trigger on text length being over max length or max character | N -onWheel | Function | | Typescript：`(context: { e: WheelEvent }) => void`
trigger on mouse wheel | N +value | String | '' | Typescript: `InputValue` `type InputValue = string`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/input/type.ts) | N +defaultValue | String | '' | uncontrolled property。Typescript: `InputValue` `type InputValue = string`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/input/type.ts) | N +onBlur | Function | | Typescript: `(value: InputValue, context: { e: FocusEvent }) => void`
| N +onChange | Function | | Typescript: `(value: InputValue, context?: { e?: InputEvent \| MouseEvent \| CompositionEvent; trigger: 'input' \| 'initial' \| 'clear' }) => void`
| N +onClear | Function | | Typescript: `(context: { e: MouseEvent }) => void`
| N +onClick | Function | | Typescript: `(context: { e: MouseEvent }) => void`
| N +onCompositionend | Function | | Typescript: `(value: InputValue, context: { e: CompositionEvent }) => void`
trigger on compositionend | N +onCompositionstart | Function | | Typescript: `(value: InputValue, context: { e: CompositionEvent }) => void`
trigger on compositionstart | N +onEnter | Function | | Typescript: `(value: InputValue, context: { e: KeyboardEvent }) => void`
| N +onFocus | Function | | Typescript: `(value: InputValue, context: { e: FocusEvent }) => void`
| N +onKeydown | Function | | Typescript: `(value: InputValue, context: { e: KeyboardEvent }) => void`
| N +onKeypress | Function | | Typescript: `(value: InputValue, context: { e: KeyboardEvent }) => void`
| N +onKeyup | Function | | Typescript: `(value: InputValue, context: { e: KeyboardEvent }) => void`
| N +onMouseenter | Function | | Typescript: `(context: { e: MouseEvent }) => void`
trigger on mouseenter | N +onMouseleave | Function | | Typescript: `(context: { e: MouseEvent }) => void`
trigger on mouseleave | N +onPaste | Function | | Typescript: `(context: { e: ClipboardEvent; pasteValue: string }) => void`
| N +onValidate | Function | | Typescript: `(context: { error?: 'exceed-maximum' \| 'below-minimum' }) => void`
trigger on text length being over max length or max character | N +onWheel | Function | | Typescript: `(context: { e: WheelEvent }) => void`
trigger on mouse wheel | N ### InputGroup Props @@ -59,5 +59,5 @@ onWheel | Function | | Typescript：`(context: { e: WheelEvent }) => void`
name | type | default | description | required -- | -- | -- | -- | -- className | String | - | className of component | N -style | Object | - | CSS(Cascading Style Sheets)，Typescript：`React.CSSProperties` | N +style | Object | - | CSS(Cascading Style Sheets)，Typescript: `React.CSSProperties` | N separate | Boolean | - | need separate between multiple inputs | N diff --git a/packages/components/layout/layout.en-US.md b/packages/components/layout/layout.en-US.md index 7a0d9564d1..e4fec5894e 100644 --- a/packages/components/layout/layout.en-US.md +++ b/packages/components/layout/layout.en-US.md @@ -7,7 +7,7 @@ name | type | default | description | required -- | -- | -- | -- | -- className | String | - | className of component | N -style | Object | - | CSS(Cascading Style Sheets)，Typescript：`React.CSSProperties` | N +style | Object | - | CSS(Cascading Style Sheets)，Typescript: `React.CSSProperties` | N direction | String | - | options: vertical/horizontal | N @@ -16,7 +16,7 @@ direction | String | - | options: vertical/horizontal | N name | type | default | description | required -- | -- | -- | -- | -- className | String | - | className of component | N -style | Object | - | CSS(Cascading Style Sheets)，Typescript：`React.CSSProperties` | N +style | Object | - | CSS(Cascading Style Sheets)，Typescript: `React.CSSProperties` | N height | String | - | \- | N @@ -25,7 +25,7 @@ height | String | - | \- | N name | type | default | description | required -- | -- | -- | -- | -- className | String | - | className of component | N -style | Object | - | CSS(Cascading Style Sheets)，Typescript：`React.CSSProperties` | N +style | Object | - | CSS(Cascading Style Sheets)，Typescript: `React.CSSProperties` | N width | String | - | \- | N @@ -34,9 +34,9 @@ width | String | - | \- | N name | type | default | description | required -- | -- | -- | -- | -- className | String | - | className of component | N -style | Object | - | CSS(Cascading Style Sheets)，Typescript：`React.CSSProperties` | N -children | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -content | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +style | Object | - | CSS(Cascading Style Sheets)，Typescript: `React.CSSProperties` | N +children | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +content | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N ### Footer Props @@ -44,5 +44,5 @@ content | TNode | - | Typescript：`string \| TNode`。[see more ts definition]( name | type | default | description | required -- | -- | -- | -- | -- className | String | - | className of component | N -style | Object | - | CSS(Cascading Style Sheets)，Typescript：`React.CSSProperties` | N +style | Object | - | CSS(Cascading Style Sheets)，Typescript: `React.CSSProperties` | N height | String | - | \- | N diff --git a/packages/components/link/link.en-US.md b/packages/components/link/link.en-US.md index c72883b9ad..e5b9f272d1 100644 --- a/packages/components/link/link.en-US.md +++ b/packages/components/link/link.en-US.md @@ -5,17 +5,17 @@ name | type | default | description | required -- | -- | -- | -- | -- -className | String | - | 类名 | N -style | Object | - | 样式，Typescript：`React.CSSProperties` | N -children | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -content | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +className | String | - | className of component | N +style | Object | - | CSS(Cascading Style Sheets)，Typescript: `React.CSSProperties` | N +children | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +content | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N disabled | Boolean | - | make link to be disabled | N hover | String | underline | hover link style。options：color/underline | N href | String | - | \- | N -prefixIcon | TElement | - | Typescript：`TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -size | String | medium | options：small/medium/large。Typescript：`SizeEnum`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -suffixIcon | TElement | - | Typescript：`TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +prefixIcon | TElement | - | Typescript: `TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +size | String | medium | options：small/medium/large。Typescript: `SizeEnum`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +suffixIcon | TElement | - | Typescript: `TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N target | String | - | target is an attribute of `` | N theme | String | default | options：default/primary/danger/warning/success | N underline | Boolean | - | \- | N -onClick | Function | | Typescript：`(e: MouseEvent) => void`
click event, it won't trigger when it's disabled | N +onClick | Function | | Typescript: `(e: MouseEvent) => void`
click event, it won't trigger when it's disabled | N diff --git a/packages/components/link/link.md b/packages/components/link/link.md index 2b1b94a722..3fb0bd6623 100644 --- a/packages/components/link/link.md +++ b/packages/components/link/link.md @@ -3,7 +3,7 @@ ## API ### Link Props -名称 | 类型 | 默认值 | 说明 | 必传 +名称 | 类型 | 默认值 | 描述 | 必传 -- | -- | -- | -- | -- className | String | - | 类名 | N style | Object | - | 样式，TS 类型：`React.CSSProperties` | N diff --git a/packages/components/list/list.en-US.md b/packages/components/list/list.en-US.md index 5391d47c70..d0ee623499 100644 --- a/packages/components/list/list.en-US.md +++ b/packages/components/list/list.en-US.md @@ -7,24 +7,24 @@ name | type | default | description | required -- | -- | -- | -- | -- className | String | - | className of component | N -style | Object | - | CSS(Cascading Style Sheets)，Typescript：`React.CSSProperties` | N -asyncLoading | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -footer | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -header | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +style | Object | - | CSS(Cascading Style Sheets)，Typescript: `React.CSSProperties` | N +asyncLoading | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +footer | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +header | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N layout | String | horizontal | options: horizontal/vertical | N -scroll | Object | - | lazy load and virtual scroll。Typescript：`TScroll`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +scroll | Object | - | lazy load and virtual scroll。Typescript: `TScroll`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N size | String | medium | options: small/medium/large | N split | Boolean | false | \- | N stripe | Boolean | false | \- | N -onLoadMore | Function | | Typescript：`(options: { e: MouseEvent }) => void`
| N -onScroll | Function | | Typescript：`(options: { e: Event \| WheelEvent; scrollTop: number; scrollBottom: number }) => void`
| N +onLoadMore | Function | | Typescript: `(options: { e: MouseEvent }) => void`
| N +onScroll | Function | | Typescript: `(options: { e: Event \| WheelEvent; scrollTop: number; scrollBottom: number }) => void`
| N ### ListInstanceFunctions name | params | return | description -- | -- | -- | -- className | String | - | className of component | N -style | Object | - | CSS(Cascading Style Sheets)，Typescript：`React.CSSProperties` | N +style | Object | - | CSS(Cascading Style Sheets)，Typescript: `React.CSSProperties` | N scrollTo | `(scrollToParams: ScrollToElementParams)` | \- | support scrolling to a specific node when virtual scrolling 。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) @@ -33,10 +33,10 @@ scrollTo | `(scrollToParams: ScrollToElementParams)` | \- | support scrolling to name | type | default | description | required -- | -- | -- | -- | -- className | String | - | className of component | N -style | Object | - | CSS(Cascading Style Sheets)，Typescript：`React.CSSProperties` | N -action | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -children | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -content | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +style | Object | - | CSS(Cascading Style Sheets)，Typescript: `React.CSSProperties` | N +action | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +children | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +content | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N ### ListItemMeta Props @@ -44,7 +44,7 @@ content | TNode | - | Typescript：`string \| TNode`。[see more ts definition]( name | type | default | description | required -- | -- | -- | -- | -- className | String | - | className of component | N -style | Object | - | CSS(Cascading Style Sheets)，Typescript：`React.CSSProperties` | N -description | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -image | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -title | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +style | Object | - | CSS(Cascading Style Sheets)，Typescript: `React.CSSProperties` | N +description | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +image | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +title | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N diff --git a/packages/components/loading/loading.en-US.md b/packages/components/loading/loading.en-US.md index bf9bcd3266..aa643cba8f 100644 --- a/packages/components/loading/loading.en-US.md +++ b/packages/components/loading/loading.en-US.md @@ -6,20 +6,20 @@ name | type | default | description | required -- | -- | -- | -- | -- -className | String | - | 类名 | N -style | Object | - | 样式，Typescript：`React.CSSProperties` | N -attach | String / Function | '' | Typescript：`AttachNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -children | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -content | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +className | String | - | className of component | N +style | Object | - | CSS(Cascading Style Sheets)，Typescript: `React.CSSProperties` | N +attach | String / Function | '' | Typescript: `AttachNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +children | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +content | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N delay | Number | 0 | \- | N fullscreen | Boolean | false | \- | N -indicator | TNode | true | Typescript：`boolean \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +indicator | TNode | true | Typescript: `boolean \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N inheritColor | Boolean | false | \- | N loading | Boolean | true | \- | N preventScrollThrough | Boolean | true | \- | N showOverlay | Boolean | true | \- | N size | String | medium | \- | N -text | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +text | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N zIndex | Number | - | \- | N ### loading 或 LoadingPlugin @@ -28,6 +28,6 @@ zIndex | Number | - | \- | N name | params | default | description -- | -- | -- | -- -options | Function | - | required。Typescript：`boolean \| TdLoadingProps` +options | Function | - | required。Typescript: `boolean \| TdLoadingProps` 插件返回值：`LoadingInstance【interface LoadingInstance { hide: () => void }】` diff --git a/packages/components/loading/loading.md b/packages/components/loading/loading.md index 4065c69a84..222b321e6f 100644 --- a/packages/components/loading/loading.md +++ b/packages/components/loading/loading.md @@ -3,7 +3,7 @@ ## API ### Loading Props -名称 | 类型 | 默认值 | 说明 | 必传 +名称 | 类型 | 默认值 | 描述 | 必传 -- | -- | -- | -- | -- className | String | - | 类名 | N style | Object | - | 样式，TS 类型：`React.CSSProperties` | N diff --git a/packages/components/menu/menu.en-US.md b/packages/components/menu/menu.en-US.md index f039783257..5c6c59f5cd 100644 --- a/packages/components/menu/menu.en-US.md +++ b/packages/components/menu/menu.en-US.md @@ -6,73 +6,73 @@ name | type | default | description | required -- | -- | -- | -- | -- -className | String | - | 类名 | N -style | Object | - | 样式，Typescript：`React.CSSProperties` | N +className | String | - | className of component | N +style | Object | - | CSS(Cascading Style Sheets)，Typescript: `React.CSSProperties` | N collapsed | Boolean | false | \- | N expandMutex | Boolean | false | \- | N expandType | String | normal | options：normal/popup | N -expanded | Array | [] | Typescript：`Array` | N -defaultExpanded | Array | [] | uncontrolled property。Typescript：`Array` | N -logo | TElement | - | Typescript：`TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -operations | TElement | - | Typescript：`TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +expanded | Array | [] | Typescript: `Array` | N +defaultExpanded | Array | [] | uncontrolled property。Typescript: `Array` | N +logo | TElement | - | Typescript: `TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +operations | TElement | - | Typescript: `TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N theme | String | light | Menu can be light mode or dark mode.。options：light/dark/global/system | N -value | String / Number | - | Typescript：`MenuValue` `type MenuValue = string \| number`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/menu/type.ts) | N -defaultValue | String / Number | - | uncontrolled property。Typescript：`MenuValue` `type MenuValue = string \| number`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/menu/type.ts) | N -width | String / Number / Array | '232px' | Typescript：`string \| number \| Array` | N -onChange | Function | | Typescript：`(value: MenuValue) => void`
| N -onExpand | Function | | Typescript：`(value: Array) => void`
| N +value | String / Number | - | Typescript: `MenuValue` `type MenuValue = string \| number`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/menu/type.ts) | N +defaultValue | String / Number | - | uncontrolled property。Typescript: `MenuValue` `type MenuValue = string \| number`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/menu/type.ts) | N +width | String / Number / Array | '232px' | Typescript: `string \| number \| Array` | N +onChange | Function | | Typescript: `(value: MenuValue) => void`
| N +onExpand | Function | | Typescript: `(value: Array) => void`
| N ### HeadMenu Props name | type | default | description | required -- | -- | -- | -- | -- -className | String | - | 类名 | N -style | Object | - | 样式，Typescript：`React.CSSProperties` | N +className | String | - | className of component | N +style | Object | - | CSS(Cascading Style Sheets)，Typescript: `React.CSSProperties` | N expandType | String | normal | options：normal/popup | N -expanded | Array | [] | Typescript：`Array` | N -defaultExpanded | Array | [] | uncontrolled property。Typescript：`Array` | N -logo | TElement | - | Typescript：`TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -operations | TElement | - | Typescript：`TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +expanded | Array | [] | Typescript: `Array` | N +defaultExpanded | Array | [] | uncontrolled property。Typescript: `Array` | N +logo | TElement | - | Typescript: `TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +operations | TElement | - | Typescript: `TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N theme | String | light | options：light/dark | N -value | String / Number | - | Typescript：`MenuValue` `type MenuValue = string \| number`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/menu/type.ts) | N -defaultValue | String / Number | - | uncontrolled property。Typescript：`MenuValue` `type MenuValue = string \| number`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/menu/type.ts) | N -onChange | Function | | Typescript：`(value: MenuValue) => void`
| N -onExpand | Function | | Typescript：`(value: Array) => void`
| N +value | String / Number | - | Typescript: `MenuValue` `type MenuValue = string \| number`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/menu/type.ts) | N +defaultValue | String / Number | - | uncontrolled property。Typescript: `MenuValue` `type MenuValue = string \| number`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/menu/type.ts) | N +onChange | Function | | Typescript: `(value: MenuValue) => void`
| N +onExpand | Function | | Typescript: `(value: Array) => void`
| N ### Submenu Props name | type | default | description | required -- | -- | -- | -- | -- -className | String | - | 类名 | N -style | Object | - | 样式，Typescript：`React.CSSProperties` | N -children | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -content | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +className | String | - | className of component | N +style | Object | - | CSS(Cascading Style Sheets)，Typescript: `React.CSSProperties` | N +children | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +content | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N disabled | Boolean | - | \- | N -icon | TElement | - | Typescript：`TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -popupProps | Object | - | Transparent all feature props of the Popup。Typescript：`PopupProps`，[Popup API Documents](./popup?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/menu/type.ts) | N -title | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -value | String / Number | - | Typescript：`MenuValue` | N +icon | TElement | - | Typescript: `TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +popupProps | Object | - | Transparent all feature props of the Popup。Typescript: `PopupProps`，[Popup API Documents](./popup?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/menu/type.ts) | N +title | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +value | String / Number | - | Typescript: `MenuValue` | N ### MenuItem Props name | type | default | description | required -- | -- | -- | -- | -- -className | String | - | 类名 | N -style | Object | - | 样式，Typescript：`React.CSSProperties` | N -children | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -content | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +className | String | - | className of component | N +style | Object | - | CSS(Cascading Style Sheets)，Typescript: `React.CSSProperties` | N +children | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +content | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N disabled | Boolean | - | \- | N href | String | - | \- | N -icon | TElement | - | Typescript：`TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +icon | TElement | - | Typescript: `TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N target | String | - | options：_blank/_self/_parent/_top | N -tooltipProps | Object | - | Transparent all feature props of the Tooltip。Typescript：`TooltipProps`，[Tooltip API Documents](./tooltip?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/menu/type.ts) | N -value | String / Number | - | Typescript：`MenuValue` | N -onClick | Function | | Typescript：`(context: { e: MouseEvent }) => void`
trigger on click | N +tooltipProps | Object | - | Transparent all feature props of the Tooltip。Typescript: `TooltipProps`，[Tooltip API Documents](./tooltip?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/menu/type.ts) | N +value | String / Number | - | Typescript: `MenuValue` | N +onClick | Function | | Typescript: `(context: { e: MouseEvent }) => void`
trigger on click | N ### MenuGroup Props name | type | default | description | required -- | -- | -- | -- | -- -className | String | - | 类名 | N -style | Object | - | 样式，Typescript：`React.CSSProperties` | N -title | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +className | String | - | className of component | N +style | Object | - | CSS(Cascading Style Sheets)，Typescript: `React.CSSProperties` | N +title | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N diff --git a/packages/components/menu/menu.md b/packages/components/menu/menu.md index 78e18be89a..ceadebcbab 100644 --- a/packages/components/menu/menu.md +++ b/packages/components/menu/menu.md @@ -3,7 +3,7 @@ ## API ### Menu Props -名称 | 类型 | 默认值 | 说明 | 必传 +名称 | 类型 | 默认值 | 描述 | 必传 -- | -- | -- | -- | -- className | String | - | 类名 | N style | Object | - | 样式，TS 类型：`React.CSSProperties` | N @@ -23,7 +23,7 @@ onExpand | Function | | TS 类型：`(value: Array) => void`
展 ### HeadMenu Props -名称 | 类型 | 默认值 | 说明 | 必传 +名称 | 类型 | 默认值 | 描述 | 必传 -- | -- | -- | -- | -- className | String | - | 类名 | N style | Object | - | 样式，TS 类型：`React.CSSProperties` | N @@ -40,7 +40,7 @@ onExpand | Function | | TS 类型：`(value: Array) => void`
展 ### Submenu Props -名称 | 类型 | 默认值 | 说明 | 必传 +名称 | 类型 | 默认值 | 描述 | 必传 -- | -- | -- | -- | -- className | String | - | 类名 | N style | Object | - | 样式，TS 类型：`React.CSSProperties` | N @@ -54,7 +54,7 @@ value | String / Number | - | 菜单项唯一标识。TS 类型：`MenuValue` | ### MenuItem Props -名称 | 类型 | 默认值 | 说明 | 必传 +名称 | 类型 | 默认值 | 描述 | 必传 -- | -- | -- | -- | -- className | String | - | 类名 | N style | Object | - | 样式，TS 类型：`React.CSSProperties` | N @@ -70,7 +70,7 @@ onClick | Function | | TS 类型：`(context: { e: MouseEvent, value: MenuValue ### MenuGroup Props -名称 | 类型 | 默认值 | 说明 | 必传 +名称 | 类型 | 默认值 | 描述 | 必传 -- | -- | -- | -- | -- className | String | - | 类名 | N style | Object | - | 样式，TS 类型：`React.CSSProperties` | N diff --git a/packages/components/message/message.en-US.md b/packages/components/message/message.en-US.md index 52eaaaec09..1e6db675a3 100644 --- a/packages/components/message/message.en-US.md +++ b/packages/components/message/message.en-US.md @@ -5,26 +5,26 @@ name | type | default | description | required -- | -- | -- | -- | -- -className | String | - | 类名 | N -style | Object | - | 样式，Typescript：`React.CSSProperties` | N -closeBtn | TNode | undefined | Typescript：`string \| boolean \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -content | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +className | String | - | className of component | N +style | Object | - | CSS(Cascading Style Sheets)，Typescript: `React.CSSProperties` | N +closeBtn | TNode | undefined | Typescript: `string \| boolean \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +content | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N duration | Number | 3000 | \- | N -icon | TNode | true | Typescript：`boolean \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -theme | String | info | options：info/success/warning/error/question/loading。Typescript：`MessageThemeList` `type MessageThemeList = 'info' \| 'success' \| 'warning' \| 'error' \| 'question' \| 'loading'`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/message/type.ts) | N -onClose | Function | | Typescript：`(context: { trigger: 'close-click' \| 'duration-end', e?: MouseEvent }) => void`
close message event | N -onCloseBtnClick | Function | | Typescript：`(context: { e: MouseEvent }) => void`
| N -onDurationEnd | Function | | Typescript：`() => void`
| N +icon | TNode | true | Typescript: `boolean \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +theme | String | info | options：info/success/warning/error/question/loading。Typescript: `MessageThemeList` `type MessageThemeList = 'info' \| 'success' \| 'warning' \| 'error' \| 'question' \| 'loading'`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/message/type.ts) | N +onClose | Function | | Typescript: `(context: { trigger: 'close-click' \| 'duration-end', e?: MouseEvent }) => void`
close message event | N +onCloseBtnClick | Function | | Typescript: `(context: { e: MouseEvent }) => void`
| N +onDurationEnd | Function | | Typescript: `() => void`
| N ### MessageOptions name | type | default | description | required -- | -- | -- | -- | -- -attach | String / Function | 'body' | Typescript：`AttachNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +attach | String / Function | 'body' | Typescript: `AttachNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N className | String | - | HTMLElement class | N -offset | Array | - | Typescript：`Array` | N -placement | String | top | options：center/top/left/right/bottom/top-left/top-right/bottom-left/bottom-right。Typescript：`MessagePlacementList` `type MessagePlacementList = 'center' \| 'top' \| 'left' \| 'right' \| 'bottom' \| 'top-left' \| 'top-right' \| 'bottom-left' \| 'bottom-right'`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/message/type.ts) | N -style | Object | - | CSS style。Typescript：`CSSProperties` | N +offset | Array | - | Typescript: `Array` | N +placement | String | top | options：center/top/left/right/bottom/top-left/top-right/bottom-left/bottom-right。Typescript: `MessagePlacementList` `type MessagePlacementList = 'center' \| 'top' \| 'left' \| 'right' \| 'bottom' \| 'top-left' \| 'top-right' \| 'bottom-left' \| 'bottom-right'`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/message/type.ts) | N +style | Object | - | CSS style。Typescript: `CSSProperties` | N zIndex | Number | 5000 | \- | N `MessageProps` | \- | - | \- | N @@ -32,50 +32,50 @@ zIndex | Number | 5000 | \- | N name | params | default | description -- | -- | -- | -- -theme | String | - | required。Typescript：`MessageThemeList` -message | String / Object | - | required。Typescript：`string \| MessageOptions` +theme | String | - | required。Typescript: `MessageThemeList` +message | String / Object | - | required。Typescript: `string \| MessageOptions` duration | Number | 3000 | \- ### message.info 或 MessagePlugin.info name | params | default | description -- | -- | -- | -- -message | String / Object | - | required。Typescript：`string \| MessageInfoOptions` `type MessageInfoOptions = Omit`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/message/type.ts) +message | String / Object | - | required。Typescript: `string \| MessageInfoOptions` `type MessageInfoOptions = Omit`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/message/type.ts) duration | Number | 3000 | \- ### message.error 或 MessagePlugin.error name | params | default | description -- | -- | -- | -- -message | String / Object | - | required。Typescript：`string \| MessageInfoOptions` +message | String / Object | - | required。Typescript: `string \| MessageInfoOptions` duration | Number | 3000 | \- ### message.warning 或 MessagePlugin.warning name | params | default | description -- | -- | -- | -- -message | String / Object | - | required。Typescript：`string \| MessageInfoOptions` +message | String / Object | - | required。Typescript: `string \| MessageInfoOptions` duration | Number | 3000 | \- ### message.success 或 MessagePlugin.success name | params | default | description -- | -- | -- | -- -message | String / Object | - | required。Typescript：`string \| MessageInfoOptions` +message | String / Object | - | required。Typescript: `string \| MessageInfoOptions` duration | Number | 3000 | \- ### message.loading 或 MessagePlugin.loading name | params | default | description -- | -- | -- | -- -message | String / Object | - | required。Typescript：`string \| MessageInfoOptions` +message | String / Object | - | required。Typescript: `string \| MessageInfoOptions` duration | Number | 3000 | \- ### message.question 或 MessagePlugin.question name | params | default | description -- | -- | -- | -- -message | String / Object | - | required。Typescript：`string \| MessageInfoOptions` +message | String / Object | - | required。Typescript: `string \| MessageInfoOptions` duration | Number | 3000 | \- ### message.closeAll 或 MessagePlugin.closeAll @@ -88,4 +88,4 @@ name | params | default | description name | params | default | description -- | -- | -- | -- -message | Object | - | required。Typescript：`MessageOptions` +message | Object | - | required。Typescript: `MessageOptions` diff --git a/packages/components/message/message.md b/packages/components/message/message.md index 6ebd0fd642..50a241243e 100644 --- a/packages/components/message/message.md +++ b/packages/components/message/message.md @@ -23,7 +23,7 @@ ## API ### Message Props -名称 | 类型 | 默认值 | 说明 | 必传 +名称 | 类型 | 默认值 | 描述 | 必传 -- | -- | -- | -- | -- className | String | - | 类名 | N style | Object | - | 样式，TS 类型：`React.CSSProperties` | N @@ -38,7 +38,7 @@ onDurationEnd | Function | | TS 类型：`() => void`
计时结束后触发 ### MessageOptions -名称 | 类型 | 默认值 | 说明 | 必传 +名称 | 类型 | 默认值 | 描述 | 必传 -- | -- | -- | -- | -- attach | String / Function | 'body' | 指定弹框挂载的父节点。数据类型为 String 时，会被当作选择器处理，进行节点查询。示例：'body' 或 () => document.body。TS 类型：`AttachNode`。[通用类型定义](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N className | String | - | 类名 | N diff --git a/packages/components/notification/notification.en-US.md b/packages/components/notification/notification.en-US.md index 0885d2ce05..5742951372 100644 --- a/packages/components/notification/notification.en-US.md +++ b/packages/components/notification/notification.en-US.md @@ -5,26 +5,26 @@ name | type | default | description | required -- | -- | -- | -- | -- -className | String | - | 类名 | N -style | Object | - | 样式，Typescript：`React.CSSProperties` | N -children | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -closeBtn | TNode | undefined | Typescript：`string \| boolean \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -content | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +className | String | - | className of component | N +style | Object | - | CSS(Cascading Style Sheets)，Typescript: `React.CSSProperties` | N +children | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +closeBtn | TNode | undefined | Typescript: `string \| boolean \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +content | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N duration | Number | 3000 | \- | N -footer | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -icon | TNode | true | Typescript：`boolean \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -theme | String | info | options：info/success/warning/error。Typescript：`NotificationThemeList` `type NotificationThemeList = 'info' \| 'success' \| 'warning' \| 'error'`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/notification/type.ts) | N -title | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -onCloseBtnClick | Function | | Typescript：`(context: { e: MouseEvent }) => void`
| N -onDurationEnd | Function | | Typescript：`() => void`
| N +footer | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +icon | TNode | true | Typescript: `boolean \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +theme | String | info | options：info/success/warning/error。Typescript: `NotificationThemeList` `type NotificationThemeList = 'info' \| 'success' \| 'warning' \| 'error'`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/notification/type.ts) | N +title | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +onCloseBtnClick | Function | | Typescript: `(context: { e: MouseEvent }) => void`
| N +onDurationEnd | Function | | Typescript: `() => void`
| N ### NotificationOptions name | type | default | description | required -- | -- | -- | -- | -- -attach | String / Function | 'body' | Typescript：`AttachNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -offset | Array | - | Typescript：`Array` | N -placement | String | top-right | options：top-left/top-right/bottom-left/bottom-right。Typescript：`NotificationPlacementList` `type NotificationPlacementList = 'top-left' \| 'top-right' \| 'bottom-left' \| 'bottom-right'`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/notification/type.ts) | N +attach | String / Function | 'body' | Typescript: `AttachNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +offset | Array | - | Typescript: `Array` | N +placement | String | top-right | options：top-left/top-right/bottom-left/bottom-right。Typescript: `NotificationPlacementList` `type NotificationPlacementList = 'top-left' \| 'top-right' \| 'bottom-left' \| 'bottom-right'`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/notification/type.ts) | N zIndex | Number | 6000 | \- | N `NotificationProps` | \- | - | \- | N @@ -32,14 +32,14 @@ zIndex | Number | 6000 | \- | N name | params | default | description -- | -- | -- | -- -theme | String | info | required。options：info/success/warning/error。Typescript：`NotificationThemeList` -options | Object | - | required。Typescript：`NotificationOptions` +theme | String | info | required。options：info/success/warning/error。Typescript: `NotificationThemeList` +options | Object | - | required。Typescript: `NotificationOptions` ### notification.info 或 NotificationPlugin.info name | params | default | description -- | -- | -- | -- -options | Object | - | required。Typescript：`NotificationInfoOptions` `type NotificationInfoOptions = Omit`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/notification/type.ts) +options | Object | - | required。Typescript: `NotificationInfoOptions` `type NotificationInfoOptions = Omit`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/notification/type.ts) 插件返回值：`Promise` @@ -47,7 +47,7 @@ options | Object | - | required。Typescript：`NotificationInfoOptions` `type N name | params | default | description -- | -- | -- | -- -options | Object | - | required。Typescript：`NotificationInfoOptions` +options | Object | - | required。Typescript: `NotificationInfoOptions` 插件返回值：`Promise` @@ -55,7 +55,7 @@ options | Object | - | required。Typescript：`NotificationInfoOptions` name | params | default | description -- | -- | -- | -- -options | Object | - | required。Typescript：`NotificationInfoOptions` +options | Object | - | required。Typescript: `NotificationInfoOptions` 插件返回值：`Promise` @@ -63,7 +63,7 @@ options | Object | - | required。Typescript：`NotificationInfoOptions` name | params | default | description -- | -- | -- | -- -options | Object | - | required。Typescript：`NotificationInfoOptions` +options | Object | - | required。Typescript: `NotificationInfoOptions` 插件返回值：`Promise` @@ -71,7 +71,7 @@ options | Object | - | required。Typescript：`NotificationInfoOptions` name | params | default | description -- | -- | -- | -- -options | Object | - | required。Typescript：`Promise` +options | Object | - | required。Typescript: `Promise` ### notification.closeAll 或 NotificationPlugin.closeAll @@ -83,4 +83,4 @@ name | params | default | description name | params | default | description -- | -- | -- | -- -notify | Object | - | required。Typescript：`NotificationOptions` +notify | Object | - | required。Typescript: `NotificationOptions` diff --git a/packages/components/notification/notification.md b/packages/components/notification/notification.md index 6e98bae5af..9a8429b8bb 100644 --- a/packages/components/notification/notification.md +++ b/packages/components/notification/notification.md @@ -10,7 +10,7 @@ ## API ### Notification Props -名称 | 类型 | 默认值 | 说明 | 必传 +名称 | 类型 | 默认值 | 描述 | 必传 -- | -- | -- | -- | -- className | String | - | 类名 | N style | Object | - | 样式，TS 类型：`React.CSSProperties` | N @@ -27,7 +27,7 @@ onDurationEnd | Function | | TS 类型：`() => void`
计时结束时触发 ### NotificationOptions -名称 | 类型 | 默认值 | 说明 | 必传 +名称 | 类型 | 默认值 | 描述 | 必传 -- | -- | -- | -- | -- attach | String / Function | 'body' | 指定消息通知挂载的父节点。数据类型为 String 时，会被当作选择器处理，进行节点查询。示例：'body' 或 () => document.body。TS 类型：`AttachNode`。[通用类型定义](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N offset | Array | - | 相对于 placement 的偏移量，示例：[-10, 20] 或 ['10em', '8rem']。TS 类型：`Array` | N diff --git a/packages/components/pagination/pagination.en-US.md b/packages/components/pagination/pagination.en-US.md index 501ba02e3b..bbac002636 100644 --- a/packages/components/pagination/pagination.en-US.md +++ b/packages/components/pagination/pagination.en-US.md @@ -5,8 +5,8 @@ name | type | default | description | required -- | -- | -- | -- | -- -className | String | - | 类名 | N -style | Object | - | 样式，Typescript：`React.CSSProperties` | N +className | String | - | className of component | N +style | Object | - | CSS(Cascading Style Sheets)，Typescript: `React.CSSProperties` | N current | Number | 1 | \- | N defaultCurrent | Number | 1 | uncontrolled property | N disabled | Boolean | - | \- | N @@ -15,8 +15,8 @@ maxPageBtn | Number | 10 | \- | N pageEllipsisMode | String | mid | options：mid/both-ends | N pageSize | Number | 10 | each page count | N defaultPageSize | Number | 10 | each page count。uncontrolled property | N -pageSizeOptions | Array | [5, 10, 20, 50] | Typescript：`Array` | N -selectProps | Object | - | Typescript：`SelectProps`，[Select API Documents](./select?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/pagination/type.ts) | N +pageSizeOptions | Array | [5, 10, 20, 50] | Typescript: `Array` | N +selectProps | Object | - | Typescript: `SelectProps`，[Select API Documents](./select?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/pagination/type.ts) | N showFirstAndLastPageBtn | Boolean | false | \- | N showJumper | Boolean | false | \- | N showPageNumber | Boolean | true | \- | N @@ -25,21 +25,21 @@ showPreviousAndNextBtn | Boolean | true | \- | N size | String | medium | options：small/medium | N theme | String | default | options：default/simple | N total | Number | 0 | \- | N -totalContent | TNode | true | Typescript：`boolean \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -onChange | Function | | Typescript：`(pageInfo: PageInfo) => void`
[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/pagination/type.ts)。
`interface PageInfo { current: number; previous: number; pageSize: number }`
| N -onCurrentChange | Function | | Typescript：`(current: number, pageInfo: PageInfo) => void`
| N -onPageSizeChange | Function | | Typescript：`(pageSize: number, pageInfo: PageInfo) => void`
| N +totalContent | TNode | true | Typescript: `boolean \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +onChange | Function | | Typescript: `(pageInfo: PageInfo) => void`
[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/pagination/type.ts)。
`interface PageInfo { current: number; previous: number; pageSize: number }`
| N +onCurrentChange | Function | | Typescript: `(current: number, pageInfo: PageInfo) => void`
| N +onPageSizeChange | Function | | Typescript: `(pageSize: number, pageInfo: PageInfo) => void`
| N ### PaginationMini Props name | type | default | description | required -- | -- | -- | -- | -- -className | String | - | 类名 | N -style | Object | - | 样式，Typescript：`React.CSSProperties` | N -disabled | Boolean / Object | - | Typescript：`boolean \| JumperDisabledConfig` `type JumperDisabledConfig = { prev?: boolean; current?: boolean; next?: boolean; }`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/pagination/type.ts) | N +className | String | - | className of component | N +style | Object | - | CSS(Cascading Style Sheets)，Typescript: `React.CSSProperties` | N +disabled | Boolean / Object | - | Typescript: `boolean \| JumperDisabledConfig` `type JumperDisabledConfig = { prev?: boolean; current?: boolean; next?: boolean; }`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/pagination/type.ts) | N layout | String | horizontal | horizontal or vertical。options：horizontal/vertical | N -showCurrent | Boolean | true | Typescript：`boolean` | N -size | String | medium | Button size。options：small/medium/large。Typescript：`SizeEnum`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -tips | Object | - | Typescript：`boolean \| JumperTipsConfig` `type JumperTipsConfig = { prev?: string; current?: string; next?: string; }`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/pagination/type.ts) | N +showCurrent | Boolean | true | Typescript: `boolean` | N +size | String | medium | Button size。options：small/medium/large。Typescript: `SizeEnum`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +tips | Object | - | Typescript: `boolean \| JumperTipsConfig` `type JumperTipsConfig = { prev?: string; current?: string; next?: string; }`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/pagination/type.ts) | N variant | String | text | options：text/outline | N -onChange | Function | | Typescript：`(context: {e: MouseEvent, trigger: JumperTrigger}) => void`
[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/pagination/type.ts)。
`type JumperTrigger = 'prev' \| 'current' \| 'next'`
| N +onChange | Function | | Typescript: `(context: {e: MouseEvent, trigger: JumperTrigger}) => void`
[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/pagination/type.ts)。
`type JumperTrigger = 'prev' \| 'current' \| 'next'`
| N diff --git a/packages/components/pagination/pagination.md b/packages/components/pagination/pagination.md index 447e457fca..94438350f2 100644 --- a/packages/components/pagination/pagination.md +++ b/packages/components/pagination/pagination.md @@ -3,7 +3,7 @@ ## API ### Pagination Props -名称 | 类型 | 默认值 | 说明 | 必传 +名称 | 类型 | 默认值 | 描述 | 必传 -- | -- | -- | -- | -- className | String | - | 类名 | N style | Object | - | 样式，TS 类型：`React.CSSProperties` | N @@ -32,7 +32,7 @@ onPageSizeChange | Function | | TS 类型：`(pageSize: number, pageInfo: PageI ### PaginationMini Props -名称 | 类型 | 默认值 | 说明 | 必传 +名称 | 类型 | 默认值 | 描述 | 必传 -- | -- | -- | -- | -- className | String | - | 类名 | N style | Object | - | 样式，TS 类型：`React.CSSProperties` | N diff --git a/packages/components/popconfirm/popconfirm.en-US.md b/packages/components/popconfirm/popconfirm.en-US.md index c42861caea..0cc74ab48d 100644 --- a/packages/components/popconfirm/popconfirm.en-US.md +++ b/packages/components/popconfirm/popconfirm.en-US.md @@ -20,21 +20,21 @@ Currently, this can be solved by `Fragment` or other `HTML` elements name | type | default | description | required -- | -- | -- | -- | -- -className | String | - | 类名 | N -style | Object | - | 样式，Typescript：`React.CSSProperties` | N -cancelBtn | TNode | '' | Typescript：`string \| ButtonProps \| TNode`，[Button API Documents](./button?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/popconfirm/type.ts) | N -children | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -confirmBtn | TNode | '' | Typescript：`string \| ButtonProps \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -content | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +className | String | - | className of component | N +style | Object | - | CSS(Cascading Style Sheets)，Typescript: `React.CSSProperties` | N +cancelBtn | TNode | '' | Typescript: `string \| ButtonProps \| TNode`，[Button API Documents](./button?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/popconfirm/type.ts) | N +children | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +confirmBtn | TNode | '' | Typescript: `string \| ButtonProps \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +content | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N destroyOnClose | Boolean | true | \- | N -icon | TElement | - | Typescript：`TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +icon | TElement | - | Typescript: `TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N placement | String | top | options：top/left/right/bottom/top-left/top-right/bottom-left/bottom-right/left-top/left-bottom/right-top/right-bottom | N -popupProps | Object | - | Typescript：`PopupProps`，[Popup API Documents](./popup?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/popconfirm/type.ts) | N +popupProps | Object | - | Typescript: `PopupProps`，[Popup API Documents](./popup?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/popconfirm/type.ts) | N showArrow | Boolean | true | \- | N theme | String | default | options：default/warning/danger | N -triggerElement | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +triggerElement | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N visible | Boolean | - | \- | N defaultVisible | Boolean | - | uncontrolled property | N -onCancel | Function | | Typescript：`(options: { e: MouseEvent }) => void`
| N -onConfirm | Function | | Typescript：`(options: { e: MouseEvent }) => void`
| N -onVisibleChange | Function | | Typescript：`(visible: boolean, context?: PopconfirmVisibleChangeContext) => void`
[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/popconfirm/type.ts)。
`interface PopconfirmVisibleChangeContext { trigger?: TriggerSource; e?: MouseEvent }`

`type TriggerSource = 'cancel' \| 'confirm' \| 'document' \| 'trigger-element-click'`
| N +onCancel | Function | | Typescript: `(options: { e: MouseEvent }) => void`
| N +onConfirm | Function | | Typescript: `(options: { e: MouseEvent }) => void`
| N +onVisibleChange | Function | | Typescript: `(visible: boolean, context?: PopconfirmVisibleChangeContext) => void`
[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/popconfirm/type.ts)。
`interface PopconfirmVisibleChangeContext { trigger?: TriggerSource; e?: MouseEvent }`

`type TriggerSource = 'cancel' \| 'confirm' \| 'document' \| 'trigger-element-click'`
| N diff --git a/packages/components/popconfirm/popconfirm.md b/packages/components/popconfirm/popconfirm.md index 35c6cb02e9..8b0d39e5c0 100644 --- a/packages/components/popconfirm/popconfirm.md +++ b/packages/components/popconfirm/popconfirm.md @@ -17,7 +17,7 @@ ## API ### Popconfirm Props -名称 | 类型 | 默认值 | 说明 | 必传 +名称 | 类型 | 默认值 | 描述 | 必传 -- | -- | -- | -- | -- className | String | - | 类名 | N style | Object | - | 样式，TS 类型：`React.CSSProperties` | N diff --git a/packages/components/popup/popup.en-US.md b/packages/components/popup/popup.en-US.md index 1af623b62e..fd47b8ba86 100644 --- a/packages/components/popup/popup.en-US.md +++ b/packages/components/popup/popup.en-US.md @@ -43,26 +43,26 @@ Currently, this can be solved by `Fragment` or other `HTML` elements name | type | default | description | required -- | -- | -- | -- | -- -attach | String / Function | 'body' | Typescript：`AttachNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -children | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -content | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -delay | Number / Array | - | delay to show or hide popover。Typescript：`number \| Array` | N +attach | String / Function | 'body' | Typescript: `AttachNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +children | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +content | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +delay | Number / Array | - | delay to show or hide popover。Typescript: `number \| Array` | N destroyOnClose | Boolean | false | \- | N disabled | Boolean | - | \- | N hideEmptyPopup | Boolean | false | \- | N -overlayClassName | String / Object / Array | - | Typescript：`ClassName`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -overlayInnerClassName | String / Object / Array | - | Typescript：`ClassName`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -overlayInnerStyle | Boolean / Object / Function | - | Typescript：`Styles \| ((triggerElement: HTMLElement, popupElement: HTMLElement) => Styles)`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -overlayStyle | Boolean / Object / Function | - | Typescript：`Styles \| ((triggerElement: HTMLElement, popupElement: HTMLElement) => Styles)`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -placement | String | top | Typescript：`PopupPlacement` `type PopupPlacement = 'top'\|'left'\|'right'\|'bottom'\|'top-left'\|'top-right'\|'bottom-left'\|'bottom-right'\|'left-top'\|'left-bottom'\|'right-top'\|'right-bottom'`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/popup/type.ts) | N +overlayClassName | String / Object / Array | - | Typescript: `ClassName`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +overlayInnerClassName | String / Object / Array | - | Typescript: `ClassName`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +overlayInnerStyle | Boolean / Object / Function | - | Typescript: `Styles \| ((triggerElement: HTMLElement, popupElement: HTMLElement) => Styles)`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +overlayStyle | Boolean / Object / Function | - | Typescript: `Styles \| ((triggerElement: HTMLElement, popupElement: HTMLElement) => Styles)`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +placement | String | top | Typescript: `PopupPlacement` `type PopupPlacement = 'top'\|'left'\|'right'\|'bottom'\|'top-left'\|'top-right'\|'bottom-left'\|'bottom-right'\|'left-top'\|'left-bottom'\|'right-top'\|'right-bottom'`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/popup/type.ts) | N popperOptions | Object | - | popper initial options，details refer to https://popper.js.org/docs | N showArrow | Boolean | false | \- | N trigger | String | hover | options：hover/click/focus/mousedown/context-menu | N -triggerElement | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -visible | Boolean | - | Typescript：`boolean` | N -defaultVisible | Boolean | - | uncontrolled property。Typescript：`boolean` | N +triggerElement | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +visible | Boolean | - | Typescript: `boolean` | N +defaultVisible | Boolean | - | uncontrolled property。Typescript: `boolean` | N zIndex | Number | - | \- | N -onOverlayClick | Function | | Typescript：`(context: { e: MouseEvent }) => void`
trigger on popup content click | N -onScroll | Function | | Typescript：`(context: { e: WheelEvent }) => void`
| N -onScrollToBottom | Function | | Typescript：`(context: { e: WheelEvent }) => void`
| N -onVisibleChange | Function | | Typescript：`(visible: boolean, context: PopupVisibleChangeContext) => void`
[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/popup/type.ts)。
`interface PopupVisibleChangeContext { e?: PopupTriggerEvent; trigger?: PopupTriggerSource }`

`type PopupTriggerEvent = MouseEvent \| FocusEvent \| KeyboardEvent`

`type PopupTriggerSource = 'document' \| 'trigger-element-click' \| 'trigger-element-hover' \| 'trigger-element-blur' \| 'trigger-element-focus' \| 'trigger-element-mousedown' \| 'context-menu' \| 'keydown-esc'`
| N +onOverlayClick | Function | | Typescript: `(context: { e: MouseEvent }) => void`
trigger on popup content click | N +onScroll | Function | | Typescript: `(context: { e: WheelEvent }) => void`
| N +onScrollToBottom | Function | | Typescript: `(context: { e: WheelEvent }) => void`
| N +onVisibleChange | Function | | Typescript: `(visible: boolean, context: PopupVisibleChangeContext) => void`
[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/popup/type.ts)。
`interface PopupVisibleChangeContext { e?: PopupTriggerEvent; trigger?: PopupTriggerSource }`

`type PopupTriggerEvent = MouseEvent \| FocusEvent \| KeyboardEvent`

`type PopupTriggerSource = 'document' \| 'trigger-element-click' \| 'trigger-element-hover' \| 'trigger-element-blur' \| 'trigger-element-focus' \| 'trigger-element-mousedown' \| 'context-menu' \| 'keydown-esc'`
| N diff --git a/packages/components/progress/progress.en-US.md b/packages/components/progress/progress.en-US.md index 8036654f75..e20c6f7274 100644 --- a/packages/components/progress/progress.en-US.md +++ b/packages/components/progress/progress.en-US.md @@ -6,13 +6,13 @@ name | type | default | description | required -- | -- | -- | -- | -- -className | String | - | 类名 | N -style | Object | - | 样式，Typescript：`React.CSSProperties` | N -color | String / Object / Array | '' | Typescript：`string \| Array \| Record` | N -label | TNode | true | Typescript：`string \| boolean \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +className | String | - | className of component | N +style | Object | - | CSS(Cascading Style Sheets)，Typescript: `React.CSSProperties` | N +color | String / Object / Array | '' | Typescript: `string \| Array \| Record` | N +label | TNode | true | Typescript: `string \| boolean \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N percentage | Number | 0 | \- | N size | String / Number | 'medium' | \- | N -status | String | - | options：success/error/warning/active。Typescript：`StatusEnum` `type StatusEnum = 'success' \| 'error' \| 'warning' \| 'active'`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/progress/type.ts) | N +status | String | - | options：success/error/warning/active。Typescript: `StatusEnum` `type StatusEnum = 'success' \| 'error' \| 'warning' \| 'active'`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/progress/type.ts) | N strokeWidth | String / Number | - | \- | N -theme | String | line | options：line/plump/circle。Typescript：`ThemeEnum` `type ThemeEnum = 'line' \| 'plump' \| 'circle'`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/progress/type.ts) | N +theme | String | line | options：line/plump/circle。Typescript: `ThemeEnum` `type ThemeEnum = 'line' \| 'plump' \| 'circle'`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/progress/type.ts) | N trackColor | String | '' | \- | N diff --git a/packages/components/progress/progress.md b/packages/components/progress/progress.md index e4447bc3b6..75682f46e3 100644 --- a/packages/components/progress/progress.md +++ b/packages/components/progress/progress.md @@ -3,7 +3,7 @@ ## API ### Progress Props -名称 | 类型 | 默认值 | 说明 | 必传 +名称 | 类型 | 默认值 | 描述 | 必传 -- | -- | -- | -- | -- className | String | - | 类名 | N style | Object | - | 样式，TS 类型：`React.CSSProperties` | N diff --git a/packages/components/qrcode/qrcode.en-US.md b/packages/components/qrcode/qrcode.en-US.md index 2b5853584a..f8917b2da7 100644 --- a/packages/components/qrcode/qrcode.en-US.md +++ b/packages/components/qrcode/qrcode.en-US.md @@ -7,16 +7,16 @@ name | type | default | description | required -- | -- | -- | -- | -- className | String | - | className of component | N -style | Object | - | CSS(Cascading Style Sheets)，Typescript：`React.CSSProperties` | N +style | Object | - | CSS(Cascading Style Sheets)，Typescript: `React.CSSProperties` | N bgColor | String | - | QR code background color | N borderless | Boolean | false | Is there a border | N color | String | - | QR code color | N icon | String | - | The address of the picture in the QR code | N -iconSize | Number / Object | 40 | The size of the picture in the QR code。Typescript：`number \| { width: number; height: number }` | N +iconSize | Number / Object | 40 | The size of the picture in the QR code。Typescript: `number \| { width: number; height: number }` | N level | String | M | QR code error correction level。options: L/M/Q/H | N size | Number | 160 | QR code size | N -status | String | active | QR code status。options: active/expired/loading/scanned。Typescript：`QRStatus` `type QRStatus = "active" \| "expired" \| "loading" \| "scanned"`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/qrcode/type.ts) | N -statusRender | TElement | - | Custom state renderer。Typescript：`(info:StatusRenderInfo) => TNode` `type StatusRenderInfo = {status:QRStatus;onRefresh?: () => void;}`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/qrcode/type.ts) | N +status | String | active | QR code status。options: active/expired/loading/scanned。Typescript: `QRStatus` `type QRStatus = "active" \| "expired" \| "loading" \| "scanned"`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/qrcode/type.ts) | N +statusRender | TElement | - | Custom state renderer。Typescript: `(info:StatusRenderInfo) => TNode` `type StatusRenderInfo = {status:QRStatus;onRefresh?: () => void;}`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/qrcode/type.ts) | N type | String | canvas | render type。options: canvas/svg | N value | String | - | scanned text | N -onRefresh | Function | | Typescript：`() => void`
Click the "Click to refresh" callback | N +onRefresh | Function | | Typescript: `() => void`
Click the "Click to refresh" callback | N diff --git a/packages/components/radio/radio.en-US.md b/packages/components/radio/radio.en-US.md index 60601d656b..bbdfce9d32 100644 --- a/packages/components/radio/radio.en-US.md +++ b/packages/components/radio/radio.en-US.md @@ -7,18 +7,18 @@ name | type | default | description | required -- | -- | -- | -- | -- className | String | - | className of component | N -style | Object | - | CSS(Cascading Style Sheets)，Typescript：`React.CSSProperties` | N +style | Object | - | CSS(Cascading Style Sheets)，Typescript: `React.CSSProperties` | N allowUncheck | Boolean | false | \- | N checked | Boolean | false | \- | N defaultChecked | Boolean | false | uncontrolled property | N -children | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +children | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N disabled | Boolean | undefined | \- | N -label | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +label | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N name | String | - | \- | N readonly | Boolean | undefined | \- | N -value | String / Number / Boolean | undefined | Typescript：`T` | N -onChange | Function | | Typescript：`(checked: boolean, context: { e: ChangeEvent }) => void`
| N -onClick | Function | | Typescript：`(context: { e: MouseEvent }) => void`
trigger on click | N +value | String / Number / Boolean | undefined | Typescript: `T` | N +onChange | Function | | Typescript: `(checked: boolean, context: { e: ChangeEvent }) => void`
| N +onClick | Function | | Typescript: `(context: { e: MouseEvent }) => void`
trigger on click | N ### RadioGroup Props @@ -26,15 +26,15 @@ onClick | Function | | Typescript：`(context: { e: MouseEvent }) => void`
name | type | default | description | required -- | -- | -- | -- | -- className | String | - | className of component | N -style | Object | - | CSS(Cascading Style Sheets)，Typescript：`React.CSSProperties` | N +style | Object | - | CSS(Cascading Style Sheets)，Typescript: `React.CSSProperties` | N allowUncheck | Boolean | false | \- | N disabled | Boolean | undefined | \- | N name | String | - | \- | N -options | Array | - | Typescript：`Array` `type RadioOption = string \| number \| RadioOptionObj` `interface RadioOptionObj { label?: string \| TNode; value?: string \| number \| boolean; disabled?: boolean }`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/radio/type.ts) | N +options | Array | - | Typescript: `Array` `type RadioOption = string \| number \| RadioOptionObj` `interface RadioOptionObj { label?: string \| TNode; value?: string \| number \| boolean; disabled?: boolean }`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/radio/type.ts) | N readonly | Boolean | undefined | \- | N theme | String | radio | options：radio/button。 | N -size | String | medium | options: small/medium/large。Typescript：`SizeEnum`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -value | String / Number / Boolean | - | Typescript：`T` `type RadioValue = string \| number \| boolean`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/radio/type.ts) | N -defaultValue | String / Number / Boolean | - | uncontrolled property。Typescript：`T` `type RadioValue = string \| number \| boolean`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/radio/type.ts) | N +size | String | medium | options: small/medium/large。Typescript: `SizeEnum`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +value | String / Number / Boolean | - | Typescript: `T` `type RadioValue = string \| number \| boolean`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/radio/type.ts) | N +defaultValue | String / Number / Boolean | - | uncontrolled property。Typescript: `T` `type RadioValue = string \| number \| boolean`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/radio/type.ts) | N variant | String | outline | options: outline/primary-filled/default-filled | N -onChange | Function | | Typescript：`(value: T, context: { e: ChangeEvent; name?: string }) => void`
| N +onChange | Function | | Typescript: `(value: T, context: { e: ChangeEvent; name?: string }) => void`
| N diff --git a/packages/components/range-input/range-input.en-US.md b/packages/components/range-input/range-input.en-US.md index d195d5d024..807c48c92b 100644 --- a/packages/components/range-input/range-input.en-US.md +++ b/packages/components/range-input/range-input.en-US.md @@ -7,41 +7,41 @@ name | type | default | description | required -- | -- | -- | -- | -- className | String | - | className of component | N -style | Object | - | CSS(Cascading Style Sheets)，Typescript：`React.CSSProperties` | N +style | Object | - | CSS(Cascading Style Sheets)，Typescript: `React.CSSProperties` | N activeIndex | Number | - | \- | N borderless | Boolean | false | \- | N clearable | Boolean | false | \- | N disabled | Boolean | - | \- | N -format | Array / Function | - | Typescript：`InputFormatType \| Array` | N -inputProps | Object / Array | - | Typescript：`InputProps \| Array`，[Input API Documents](./input?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/range-input/type.ts) | N -label | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -placeholder | String / Array | - | Typescript：`string \| Array` | N -prefixIcon | TElement | - | Typescript：`TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +format | Array / Function | - | Typescript: `InputFormatType \| Array` | N +inputProps | Object / Array | - | Typescript: `InputProps \| Array`，[Input API Documents](./input?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/range-input/type.ts) | N +label | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +placeholder | String / Array | - | Typescript: `string \| Array` | N +prefixIcon | TElement | - | Typescript: `TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N readonly | Boolean | false | \- | N -separator | TNode | '-' | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +separator | TNode | '-' | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N showClearIconOnEmpty | Boolean | false | \- | N size | String | medium | options: small/medium/large | N status | String | default | options: default/success/warning/error | N -suffix | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -suffixIcon | TElement | - | Typescript：`TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -tips | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -value | Array | [] | Typescript：`RangeInputValue` `type RangeInputValue = Array`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/range-input/type.ts) | N -defaultValue | Array | [] | uncontrolled property。Typescript：`RangeInputValue` `type RangeInputValue = Array`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/range-input/type.ts) | N -onBlur | Function | | Typescript：`(value: RangeInputValue, context?: { e?: FocusEvent; position?: RangeInputPosition }) => void`
| N -onChange | Function | | Typescript：`(value: RangeInputValue, context?: { e?: InputEvent \| MouseEvent \| CompositionEvent; position?: RangeInputPosition; trigger?: 'input' \| 'initial' \| 'clear' }) => void`
[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/range-input/type.ts)。
`type RangeInputPosition = 'first' \| 'second' \| 'all'`
| N -onClear | Function | | Typescript：`(context: { e: MouseEvent }) => void`
| N -onClick | Function | | Typescript：`(context?: { e?: MouseEvent; position?: RangeInputPosition }) => void`
| N -onEnter | Function | | Typescript：`(value: RangeInputValue, context?: { e?: InputEvent \| MouseEvent; position?: RangeInputPosition }) => void`
| N -onFocus | Function | | Typescript：`(value: RangeInputValue, context?: { e?: FocusEvent; position?: RangeInputPosition }) => void`
| N -onMouseenter | Function | | Typescript：`(context: { e: MouseEvent }) => void`
trigger on mouseenter | N -onMouseleave | Function | | Typescript：`(context: { e: MouseEvent }) => void`
| N +suffix | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +suffixIcon | TElement | - | Typescript: `TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +tips | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +value | Array | [] | Typescript: `RangeInputValue` `type RangeInputValue = Array`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/range-input/type.ts) | N +defaultValue | Array | [] | uncontrolled property。Typescript: `RangeInputValue` `type RangeInputValue = Array`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/range-input/type.ts) | N +onBlur | Function | | Typescript: `(value: RangeInputValue, context?: { e?: FocusEvent; position?: RangeInputPosition }) => void`
| N +onChange | Function | | Typescript: `(value: RangeInputValue, context?: { e?: InputEvent \| MouseEvent \| CompositionEvent; position?: RangeInputPosition; trigger?: 'input' \| 'initial' \| 'clear' }) => void`
[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/range-input/type.ts)。
`type RangeInputPosition = 'first' \| 'second' \| 'all'`
| N +onClear | Function | | Typescript: `(context: { e: MouseEvent }) => void`
| N +onClick | Function | | Typescript: `(context?: { e?: MouseEvent; position?: RangeInputPosition }) => void`
| N +onEnter | Function | | Typescript: `(value: RangeInputValue, context?: { e?: InputEvent \| MouseEvent; position?: RangeInputPosition }) => void`
| N +onFocus | Function | | Typescript: `(value: RangeInputValue, context?: { e?: FocusEvent; position?: RangeInputPosition }) => void`
| N +onMouseenter | Function | | Typescript: `(context: { e: MouseEvent }) => void`
trigger on mouseenter | N +onMouseleave | Function | | Typescript: `(context: { e: MouseEvent }) => void`
| N ### RangeInputInstanceFunctions 组件实例方法 name | params | return | description -- | -- | -- | -- className | String | - | className of component | N -style | Object | - | CSS(Cascading Style Sheets)，Typescript：`React.CSSProperties` | N +style | Object | - | CSS(Cascading Style Sheets)，Typescript: `React.CSSProperties` | N blur | `(options?: {position?: RangeInputPosition})` | \- | \- focus | `(options?: {position?: RangeInputPosition})` | \- | \- select | `(options?: {position?: RangeInputPosition})` | \- | \- @@ -52,18 +52,18 @@ select | `(options?: {position?: RangeInputPosition})` | \- | \- name | type | default | description | required -- | -- | -- | -- | -- className | String | - | className of component | N -style | Object | - | CSS(Cascading Style Sheets)，Typescript：`React.CSSProperties` | N +style | Object | - | CSS(Cascading Style Sheets)，Typescript: `React.CSSProperties` | N autoWidth | Boolean | false | \- | N disabled | Boolean | - | \- | N -inputValue | Array | - | Typescript：`RangeInputValue` | N -defaultInputValue | Array | - | uncontrolled property。Typescript：`RangeInputValue` | N -label | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -panel | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -popupProps | Object | - | Typescript：`PopupProps`，[Popup API Documents](./popup?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/range-input/type.ts) | N +inputValue | Array | - | Typescript: `RangeInputValue` | N +defaultInputValue | Array | - | uncontrolled property。Typescript: `RangeInputValue` | N +label | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +panel | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +popupProps | Object | - | Typescript: `PopupProps`，[Popup API Documents](./popup?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/range-input/type.ts) | N popupVisible | Boolean | - | \- | N -rangeInputProps | Object | - | Typescript：`RangeInputProps`，[RangeInput API Documents](./range-input?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/range-input/type.ts) | N +rangeInputProps | Object | - | Typescript: `RangeInputProps`，[RangeInput API Documents](./range-input?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/range-input/type.ts) | N readonly | Boolean | false | \- | N status | String | default | options: default/success/warning/error | N -tips | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -onInputChange | Function | | Typescript：`(value: RangeInputValue, context?: RangeInputValueChangeContext) => void`
[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/range-input/type.ts)。
`type RangeInputValueChangeContext = { e?: InputEvent \| MouseEvent; trigger?: 'input' \| 'clear', position?: RangeInputPosition }`
| N -onPopupVisibleChange | Function | | Typescript：`(visible: boolean, context: PopupVisibleChangeContext) => void`
[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/range-input/type.ts)。
`import { PopupVisibleChangeContext } from '@Popup'`
| N +tips | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +onInputChange | Function | | Typescript: `(value: RangeInputValue, context?: RangeInputValueChangeContext) => void`
[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/range-input/type.ts)。
`type RangeInputValueChangeContext = { e?: InputEvent \| MouseEvent; trigger?: 'input' \| 'clear', position?: RangeInputPosition }`
| N +onPopupVisibleChange | Function | | Typescript: `(visible: boolean, context: PopupVisibleChangeContext) => void`
[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/range-input/type.ts)。
`import { PopupVisibleChangeContext } from '@Popup'`
| N diff --git a/packages/components/rate/rate.en-US.md b/packages/components/rate/rate.en-US.md index 995c5eb1ed..b8e457ee1a 100644 --- a/packages/components/rate/rate.en-US.md +++ b/packages/components/rate/rate.en-US.md @@ -7,17 +7,17 @@ name | type | default | description | required -- | -- | -- | -- | -- className | String | - | className of component | N -style | Object | - | CSS(Cascading Style Sheets)，Typescript：`React.CSSProperties` | N +style | Object | - | CSS(Cascading Style Sheets)，Typescript: `React.CSSProperties` | N allowHalf | Boolean | false | \- | N clearable | Boolean | false | \- | N -color | String / Array | '#ED7B2F' | Typescript：`string \| Array` | N +color | String / Array | '#ED7B2F' | Typescript: `string \| Array` | N count | Number | 5 | \- | N disabled | Boolean | undefined | \- | N gap | Number | 4 | \- | N -icon | TElement | - | Typescript：`TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +icon | TElement | - | Typescript: `TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N showText | Boolean | false | \- | N size | String | 24px | \- | N -texts | Array | [] | Typescript：`Array` | N +texts | Array | [] | Typescript: `Array` | N value | Number | 0 | \- | N defaultValue | Number | 0 | uncontrolled property | N -onChange | Function | | Typescript：`(value: number) => void`
| N +onChange | Function | | Typescript: `(value: number) => void`
| N diff --git a/packages/components/search/search.en-US.md b/packages/components/search/search.en-US.md index 52dbc0eb7f..c42e084158 100644 --- a/packages/components/search/search.en-US.md +++ b/packages/components/search/search.en-US.md @@ -6,31 +6,31 @@ name | type | default | description | required -- | -- | -- | -- | -- -className | String | - | 类名 | N -style | Object | - | 样式，Typescript：`React.CSSProperties` | N +className | String | - | className of component | N +style | Object | - | CSS(Cascading Style Sheets)，Typescript: `React.CSSProperties` | N autoWidth | Boolean | false | \- | N -autocompleteOptions | Array | - | autocomplete words list。Typescript：`Array` `type AutocompleteOption = string \| { label: string \| TNode; group?: boolean }`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/search/type.ts) | N +autocompleteOptions | Array | - | autocomplete words list。Typescript: `Array` `type AutocompleteOption = string \| { label: string \| TNode; group?: boolean }`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/search/type.ts) | N autofocus | Boolean | false | auto focus as default | N borderless | Boolean | true | \- | N clearable | Boolean | true | \- | N disabled | Boolean | - | \- | N -filter | Function | - | Typescript：`(keyword: string, option: any) => boolean \| Promise` | N -inputProps | Object | - | Typescript：`InputProps`，[Input API Documents](./input?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/search/type.ts) | N -label | TNode | '' | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +filter | Function | - | Typescript: `(keyword: string, option: any) => boolean \| Promise` | N +inputProps | Object | - | Typescript: `InputProps`，[Input API Documents](./input?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/search/type.ts) | N +label | TNode | '' | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N multiline | Boolean | false | \- | N placeholder | String | '' | \- | N -popupProps | Object | - | Typescript：`PopupProps`，[Popup API Documents](./popup?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/search/type.ts) | N -prefixIcon | TElement | - | Typescript：`TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +popupProps | Object | - | Typescript: `PopupProps`，[Popup API Documents](./popup?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/search/type.ts) | N +prefixIcon | TElement | - | Typescript: `TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N readonly | Boolean | false | \- | N -selectInputProps | Object | - | Typescript：`SelectInputProps`，[SelectInput API Documents](./select-input?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/search/type.ts) | N -suffix | TNode | '' | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -suffixIcon | TElement | - | Typescript：`TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -textareaProps | Object | - | Typescript：`TextareaProps`，[Textarea API Documents](./textarea?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/search/type.ts) | N +selectInputProps | Object | - | Typescript: `SelectInputProps`，[SelectInput API Documents](./select-input?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/search/type.ts) | N +suffix | TNode | '' | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +suffixIcon | TElement | - | Typescript: `TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +textareaProps | Object | - | Typescript: `TextareaProps`，[Textarea API Documents](./textarea?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/search/type.ts) | N value | String | - | \- | N defaultValue | String | - | uncontrolled property | N -onBlur | Function | | Typescript：`(context: { value: string; e: FocusEvent }) => void`
| N -onChange | Function | | Typescript：`(value: string, context: { trigger: 'input-change' \| 'option-click'; e?: InputEvent \| MouseEvent }) => void`
| N -onClear | Function | | Typescript：`(context: { e: MouseEvent }) => void`
| N -onEnter | Function | | Typescript：`(context: { value: string; e: KeyboardEvent }) => void`
| N -onFocus | Function | | Typescript：`(context: { value: string; e: FocusEvent }) => void`
| N -onSearch | Function | | Typescript：`(context?: { value: string; trigger: 'enter' \| 'option-click' \| 'clear' \| 'suffix-click' \| 'prefix-click'; e?: InputEvent \| MouseEvent }) => void`
| N +onBlur | Function | | Typescript: `(context: { value: string; e: FocusEvent }) => void`
| N +onChange | Function | | Typescript: `(value: string, context: { trigger: 'input-change' \| 'option-click'; e?: InputEvent \| MouseEvent }) => void`
| N +onClear | Function | | Typescript: `(context: { e: MouseEvent }) => void`
| N +onEnter | Function | | Typescript: `(context: { value: string; e: KeyboardEvent }) => void`
| N +onFocus | Function | | Typescript: `(context: { value: string; e: FocusEvent }) => void`
| N +onSearch | Function | | Typescript: `(context?: { value: string; trigger: 'enter' \| 'option-click' \| 'clear' \| 'suffix-click' \| 'prefix-click'; e?: InputEvent \| MouseEvent }) => void`
| N diff --git a/packages/components/search/search.md b/packages/components/search/search.md index 97daada285..6857a02347 100644 --- a/packages/components/search/search.md +++ b/packages/components/search/search.md @@ -3,7 +3,7 @@ ## API ### Search Props -名称 | 类型 | 默认值 | 说明 | 必传 +名称 | 类型 | 默认值 | 描述 | 必传 -- | -- | -- | -- | -- className | String | - | 类名 | N style | Object | - | 样式，TS 类型：`React.CSSProperties` | N diff --git a/packages/components/select-input/select-input.en-US.md b/packages/components/select-input/select-input.en-US.md index b3a265a4cd..7f2acc4df6 100644 --- a/packages/components/select-input/select-input.en-US.md +++ b/packages/components/select-input/select-input.en-US.md @@ -7,47 +7,47 @@ name | type | default | description | required -- | -- | -- | -- | -- className | String | - | className of component | N -style | Object | - | CSS(Cascading Style Sheets)，Typescript：`React.CSSProperties` | N +style | Object | - | CSS(Cascading Style Sheets)，Typescript: `React.CSSProperties` | N allowInput | Boolean | false | \- | N autoWidth | Boolean | false | \- | N autofocus | Boolean | false | \- | N borderless | Boolean | false | \- | N clearable | Boolean | false | \- | N -collapsedItems | TElement | - | Typescript：`TNode<{ value: SelectInputValue; collapsedSelectedItems: SelectInputValue; count: number; onClose: (context: { index: number, e?: MouseEvent }) => void }>`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +collapsedItems | TElement | - | Typescript: `TNode<{ value: SelectInputValue; collapsedSelectedItems: SelectInputValue; count: number; onClose: (context: { index: number, e?: MouseEvent }) => void }>`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N disabled | Boolean | - | \- | N -inputProps | Object | - | Typescript：`InputProps`，[Input API Documents](./input?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/select-input/type.ts) | N -inputValue | String / Number | - | input value。Typescript：`string` | N -defaultInputValue | String / Number | - | input value。uncontrolled property。Typescript：`string` | N -keys | Object | - | Typescript：`SelectInputKeys` `interface SelectInputKeys { label?: string; value?: string; children?: string }`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/select-input/type.ts) | N -label | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +inputProps | Object | - | Typescript: `InputProps`，[Input API Documents](./input?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/select-input/type.ts) | N +inputValue | String / Number | - | input value。Typescript: `string` | N +defaultInputValue | String / Number | - | input value。uncontrolled property。Typescript: `string` | N +keys | Object | - | Typescript: `SelectInputKeys` `interface SelectInputKeys { label?: string; value?: string; children?: string }`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/select-input/type.ts) | N +label | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N loading | Boolean | false | \- | N minCollapsedNum | Number | 0 | \- | N multiple | Boolean | false | \- | N -panel | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +panel | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N placeholder | String | - | placeholder description | N -popupProps | Object | - | Typescript：`PopupProps`，[Popup API Documents](./popup?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/select-input/type.ts) | N +popupProps | Object | - | Typescript: `PopupProps`，[Popup API Documents](./popup?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/select-input/type.ts) | N popupVisible | Boolean | - | \- | N defaultPopupVisible | Boolean | - | uncontrolled property | N -prefixIcon | TElement | - | Typescript：`TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +prefixIcon | TElement | - | Typescript: `TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N readonly | Boolean | false | \- | N reserveKeyword | Boolean | false | \- | N -size | String | medium | options: small/medium/large。Typescript：`SizeEnum`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +size | String | medium | options: small/medium/large。Typescript: `SizeEnum`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N status | String | default | options: default/success/warning/error | N -suffix | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -suffixIcon | TElement | - | Typescript：`TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -tag | TNode | - | Typescript：`string \| TNode<{ value: string \| number }>`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -tagInputProps | Object | - | Typescript：`TagInputProps`，[TagInput API Documents](./tag-input?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/select-input/type.ts) | N -tagProps | Object | - | Typescript：`TagProps`，[Tag API Documents](./tag?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/select-input/type.ts) | N -tips | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -value | String / Number / Boolean / Object / Array / Date | undefined | Typescript：`SelectInputValue` `type SelectInputValue = string \| number \| boolean \| Date \| Object \| Array \| Array`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/select-input/type.ts) | N -valueDisplay | TNode | - | Typescript：`string \| TNode<{ value: TagInputValue; onClose: (index: number, item?: any) => void }>`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -onBlur | Function | | Typescript：`(value: SelectInputValue, context: SelectInputBlurContext) => void`
trigger on blur。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/select-input/type.ts)。
`type SelectInputBlurContext = PopupVisibleChangeContext & { inputValue: string; tagInputValue?: TagInputValue; }`
| N -onClear | Function | | Typescript：`(context: { e: MouseEvent }) => void`
| N -onEnter | Function | | Typescript：`(value: SelectInputValue, context: { e: KeyboardEvent; inputValue: string; tagInputValue?: TagInputValue }) => void`
| N -onFocus | Function | | Typescript：`(value: SelectInputValue, context: SelectInputFocusContext) => void`
trigger on focus。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/select-input/type.ts)。
`interface SelectInputFocusContext { inputValue: string; tagInputValue?: TagInputValue; e: FocusEvent }`
| N -onInputChange | Function | | Typescript：`(value: string, context?: SelectInputValueChangeContext) => void`
[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/select-input/type.ts)。
`interface SelectInputValueChangeContext { e?: Event \| InputEvent \| MouseEvent \| FocusEvent \| KeyboardEvent \| CompositionEvent; trigger: 'input' \| 'clear' \| 'blur' \| 'focus' \| 'initial' \| 'change' }`
| N -onMouseenter | Function | | Typescript：`(context: { e: MouseEvent }) => void`
trigger on mouseenter | N -onMouseleave | Function | | Typescript：`(context: { e: MouseEvent }) => void`
trigger on mouseleave | N -onPaste | Function | | Typescript：`(context: { e: ClipboardEvent; pasteValue: string }) => void`
| N -onPopupVisibleChange | Function | | Typescript：`(visible: boolean, context: PopupVisibleChangeContext) => void`
[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/select-input/type.ts)。
`import { PopupVisibleChangeContext } from '@Popup'`
| N -onTagChange | Function | | Typescript：`(value: TagInputValue, context: SelectInputChangeContext) => void`
[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/select-input/type.ts)。
`type SelectInputChangeContext = TagInputChangeContext`
| N +suffix | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +suffixIcon | TElement | - | Typescript: `TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +tag | TNode | - | Typescript: `string \| TNode<{ value: string \| number }>`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +tagInputProps | Object | - | Typescript: `TagInputProps`，[TagInput API Documents](./tag-input?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/select-input/type.ts) | N +tagProps | Object | - | Typescript: `TagProps`，[Tag API Documents](./tag?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/select-input/type.ts) | N +tips | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +value | String / Number / Boolean / Object / Array / Date | undefined | Typescript: `SelectInputValue` `type SelectInputValue = string \| number \| boolean \| Date \| Object \| Array \| Array`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/select-input/type.ts) | N +valueDisplay | TNode | - | Typescript: `string \| TNode<{ value: TagInputValue; onClose: (index: number, item?: any) => void }>`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +onBlur | Function | | Typescript: `(value: SelectInputValue, context: SelectInputBlurContext) => void`
trigger on blur。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/select-input/type.ts)。
`type SelectInputBlurContext = PopupVisibleChangeContext & { inputValue: string; tagInputValue?: TagInputValue; }`
| N +onClear | Function | | Typescript: `(context: { e: MouseEvent }) => void`
| N +onEnter | Function | | Typescript: `(value: SelectInputValue, context: { e: KeyboardEvent; inputValue: string; tagInputValue?: TagInputValue }) => void`
| N +onFocus | Function | | Typescript: `(value: SelectInputValue, context: SelectInputFocusContext) => void`
trigger on focus。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/select-input/type.ts)。
`interface SelectInputFocusContext { inputValue: string; tagInputValue?: TagInputValue; e: FocusEvent }`
| N +onInputChange | Function | | Typescript: `(value: string, context?: SelectInputValueChangeContext) => void`
[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/select-input/type.ts)。
`interface SelectInputValueChangeContext { e?: Event \| InputEvent \| MouseEvent \| FocusEvent \| KeyboardEvent \| CompositionEvent; trigger: 'input' \| 'clear' \| 'blur' \| 'focus' \| 'initial' \| 'change' }`
| N +onMouseenter | Function | | Typescript: `(context: { e: MouseEvent }) => void`
trigger on mouseenter | N +onMouseleave | Function | | Typescript: `(context: { e: MouseEvent }) => void`
trigger on mouseleave | N +onPaste | Function | | Typescript: `(context: { e: ClipboardEvent; pasteValue: string }) => void`
| N +onPopupVisibleChange | Function | | Typescript: `(visible: boolean, context: PopupVisibleChangeContext) => void`
[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/select-input/type.ts)。
`import { PopupVisibleChangeContext } from '@Popup'`
| N +onTagChange | Function | | Typescript: `(value: TagInputValue, context: SelectInputChangeContext) => void`
[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/select-input/type.ts)。
`type SelectInputChangeContext = TagInputChangeContext`
| N diff --git a/packages/components/select/select.en-US.md b/packages/components/select/select.en-US.md index 640a7d6df0..88d4a27b5c 100644 --- a/packages/components/select/select.en-US.md +++ b/packages/components/select/select.en-US.md @@ -7,62 +7,62 @@ name | type | default | description | required -- | -- | -- | -- | -- className | String | - | className of component | N -style | Object | - | CSS(Cascading Style Sheets)，Typescript：`React.CSSProperties` | N +style | Object | - | CSS(Cascading Style Sheets)，Typescript: `React.CSSProperties` | N autoWidth | Boolean | false | \- | N autofocus | Boolean | false | \- | N borderless | Boolean | false | \- | N clearable | Boolean | false | \- | N -collapsedItems | TElement | - | Typescript：`TNode<{ value: T[]; collapsedSelectedItems: T[]; count: number; onClose: (context: { index: number, e?: MouseEvent }) => void }>`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +collapsedItems | TElement | - | Typescript: `TNode<{ value: T[]; collapsedSelectedItems: T[]; count: number; onClose: (context: { index: number, e?: MouseEvent }) => void }>`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N creatable | Boolean | false | \- | N disabled | Boolean | - | \- | N -empty | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -filter | Function | - | Typescript：`(filterWords: string, option: T) => boolean \| Promise` | N +empty | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +filter | Function | - | Typescript: `(filterWords: string, option: T) => boolean \| Promise` | N filterable | Boolean | false | \- | N -inputProps | Object | - | Typescript：`InputProps`，[Input API Documents](./input?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/select/type.ts) | N -inputValue | String / Number | - | input value。Typescript：`string` | N -defaultInputValue | String / Number | - | input value。uncontrolled property。Typescript：`string` | N -keys | Object | - | alias option field。Typescript：`SelectKeysType` `interface SelectKeysType { value?: string \| ((option: SelectOption) => string); label?: string \| ((option: SelectOption) => string); disabled?: string }`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/select/type.ts) | N -label | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +inputProps | Object | - | Typescript: `InputProps`，[Input API Documents](./input?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/select/type.ts) | N +inputValue | String / Number | - | input value。Typescript: `string` | N +defaultInputValue | String / Number | - | input value。uncontrolled property。Typescript: `string` | N +keys | Object | - | alias option field。Typescript: `SelectKeysType` `interface SelectKeysType { value?: string \| ((option: SelectOption) => string); label?: string \| ((option: SelectOption) => string); disabled?: string }`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/select/type.ts) | N +label | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N loading | Boolean | false | \- | N -loadingText | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +loadingText | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N max | Number | 0 | \- | N minCollapsedNum | Number | 0 | \- | N multiple | Boolean | false | \- | N -options | Array | - | Typescript：`Array` | N -optionsLayout | String | vertical | layout of options in popup。Typescript：`vertical \| horizontal` | N -panelBottomContent | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -panelTopContent | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +options | Array | - | Typescript: `Array` | N +optionsLayout | String | vertical | layout of options in popup。Typescript: `vertical \| horizontal` | N +panelBottomContent | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +panelTopContent | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N placeholder | String | undefined | \- | N -popupProps | Object | - | Typescript：`PopupProps`，[Popup API Documents](./popup?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/select/type.ts) | N +popupProps | Object | - | Typescript: `PopupProps`，[Popup API Documents](./popup?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/select/type.ts) | N popupVisible | Boolean | - | \- | N defaultPopupVisible | Boolean | - | uncontrolled property | N -prefixIcon | TElement | - | Typescript：`TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +prefixIcon | TElement | - | Typescript: `TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N readonly | Boolean | false | \- | N reserveKeyword | Boolean | false | \- | N -scroll | Object | - | lazy load and virtual scroll。Typescript：`TScroll`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -selectInputProps | Object | - | Typescript：`SelectInputProps`，[SelectInput API Documents](./select-input?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/select/type.ts) | N +scroll | Object | - | lazy load and virtual scroll。Typescript: `TScroll`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +selectInputProps | Object | - | Typescript: `SelectInputProps`，[SelectInput API Documents](./select-input?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/select/type.ts) | N showArrow | Boolean | true | \- | N -size | String | medium | options: small/medium/large。Typescript：`SizeEnum`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +size | String | medium | options: small/medium/large。Typescript: `SizeEnum`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N status | String | default | options: default/success/warning/error | N -suffix | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -suffixIcon | TElement | - | Typescript：`TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -tagInputProps | Object | - | Typescript：`TagInputProps`，[TagInput API Documents](./tag-input?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/select/type.ts) | N -tagProps | Object | - | Typescript：`TagProps`，[Tag API Documents](./tag?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/select/type.ts) | N -tips | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -value | String / Number / Boolean / Object / Array | - | Typescript：`SelectValue` `type SelectValue = string \| number \| boolean \| T \| Array>`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/select/type.ts) | N -defaultValue | String / Number / Boolean / Object / Array | - | uncontrolled property。Typescript：`SelectValue` `type SelectValue = string \| number \| boolean \| T \| Array>`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/select/type.ts) | N -valueDisplay | TNode | - | `MouseEvent`。Typescript：`string \| TNode<{ value: SelectValue; onClose: (index: number) => void; displayValue?: SelectValue }>`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +suffix | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +suffixIcon | TElement | - | Typescript: `TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +tagInputProps | Object | - | Typescript: `TagInputProps`，[TagInput API Documents](./tag-input?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/select/type.ts) | N +tagProps | Object | - | Typescript: `TagProps`，[Tag API Documents](./tag?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/select/type.ts) | N +tips | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +value | String / Number / Boolean / Object / Array | - | Typescript: `SelectValue` `type SelectValue = string \| number \| boolean \| T \| Array>`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/select/type.ts) | N +defaultValue | String / Number / Boolean / Object / Array | - | uncontrolled property。Typescript: `SelectValue` `type SelectValue = string \| number \| boolean \| T \| Array>`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/select/type.ts) | N +valueDisplay | TNode | - | `MouseEvent`。Typescript: `string \| TNode<{ value: SelectValue; onClose: (index: number) => void; displayValue?: SelectValue }>`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N valueType | String | value | options: value/object | N -onBlur | Function | | Typescript：`(context: { value: SelectValue; e: FocusEvent \| KeyboardEvent }) => void`
| N -onChange | Function | | Typescript：`(value: SelectValue, context: { option?: T, selectedOptions: T[], trigger: SelectValueChangeTrigger; e?: MouseEvent \| KeyboardEvent }) => void`
[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/select/type.ts)。
`type SelectValueChangeTrigger = 'clear' \| 'tag-remove' \| 'backspace' \| 'check' \| 'uncheck' \| 'default'`
| N -onClear | Function | | Typescript：`(context: { e: MouseEvent }) => void`
| N -onCreate | Function | | Typescript：`(value: string \| number) => void`
| N -onEnter | Function | | Typescript：`(context: { inputValue: string; e: KeyboardEvent; value: SelectValue }) => void`
| N -onFocus | Function | | Typescript：`(context: { value: SelectValue; e: FocusEvent \| KeyboardEvent }) => void`
| N -onInputChange | Function | | Typescript：`(value: string, context?: SelectInputValueChangeContext) => void`
[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/select/type.ts)。
`import { SelectInputValueChangeContext } from '@SelectInput'`
| N -onPopupVisibleChange | Function | | Typescript：`(visible: boolean, context: PopupVisibleChangeContext) => void`
[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/select/type.ts)。
`import { PopupVisibleChangeContext } from '@Popup'`
| N -onRemove | Function | | Typescript：`(options: SelectRemoveContext) => void`
[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/select/type.ts)。
`interface SelectRemoveContext { value: string \| number; data: T; e: MouseEvent \| KeyboardEvent }`
| N -onSearch | Function | | Typescript：`(filterWords: string, context: { e: KeyboardEvent }) => void`
| N +onBlur | Function | | Typescript: `(context: { value: SelectValue; e: FocusEvent \| KeyboardEvent }) => void`
| N +onChange | Function | | Typescript: `(value: SelectValue, context: { option?: T, selectedOptions: T[], trigger: SelectValueChangeTrigger; e?: MouseEvent \| KeyboardEvent }) => void`
[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/select/type.ts)。
`type SelectValueChangeTrigger = 'clear' \| 'tag-remove' \| 'backspace' \| 'check' \| 'uncheck' \| 'default'`
| N +onClear | Function | | Typescript: `(context: { e: MouseEvent }) => void`
| N +onCreate | Function | | Typescript: `(value: string \| number) => void`
| N +onEnter | Function | | Typescript: `(context: { inputValue: string; e: KeyboardEvent; value: SelectValue }) => void`
| N +onFocus | Function | | Typescript: `(context: { value: SelectValue; e: FocusEvent \| KeyboardEvent }) => void`
| N +onInputChange | Function | | Typescript: `(value: string, context?: SelectInputValueChangeContext) => void`
[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/select/type.ts)。
`import { SelectInputValueChangeContext } from '@SelectInput'`
| N +onPopupVisibleChange | Function | | Typescript: `(visible: boolean, context: PopupVisibleChangeContext) => void`
[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/select/type.ts)。
`import { PopupVisibleChangeContext } from '@Popup'`
| N +onRemove | Function | | Typescript: `(options: SelectRemoveContext) => void`
[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/select/type.ts)。
`interface SelectRemoveContext { value: string \| number; data: T; e: MouseEvent \| KeyboardEvent }`
| N +onSearch | Function | | Typescript: `(filterWords: string, context: { e: KeyboardEvent }) => void`
| N ### Option Props @@ -70,10 +70,10 @@ onSearch | Function | | Typescript：`(filterWords: string, context: { e: Keybo name | type | default | description | required -- | -- | -- | -- | -- className | String | - | className of component | N -style | Object | - | CSS(Cascading Style Sheets)，Typescript：`React.CSSProperties` | N +style | Object | - | CSS(Cascading Style Sheets)，Typescript: `React.CSSProperties` | N checkAll | Boolean | false | check all option, which can be both top of the panel and bottom of the panel | N -children | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -content | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +children | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +content | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N disabled | Boolean | false | \- | N label | String | - | \- | N title | String | - | \- | N @@ -85,7 +85,7 @@ value | String / Number | - | \- | N name | type | default | description | required -- | -- | -- | -- | -- className | String | - | className of component | N -style | Object | - | CSS(Cascading Style Sheets)，Typescript：`React.CSSProperties` | N +style | Object | - | CSS(Cascading Style Sheets)，Typescript: `React.CSSProperties` | N divider | Boolean | true | \- | N label | String | - | \- | N diff --git a/packages/components/skeleton/skeleton.en-US.md b/packages/components/skeleton/skeleton.en-US.md index 390c8049d2..51cf6d1025 100644 --- a/packages/components/skeleton/skeleton.en-US.md +++ b/packages/components/skeleton/skeleton.en-US.md @@ -7,11 +7,11 @@ name | type | default | description | required -- | -- | -- | -- | -- className | String | - | className of component | N -style | Object | - | CSS(Cascading Style Sheets)，Typescript：`React.CSSProperties` | N +style | Object | - | CSS(Cascading Style Sheets)，Typescript: `React.CSSProperties` | N animation | String | none | options: gradient/flashed/none | N -children | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -content | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +children | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +content | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N delay | Number | 0 | \- | N loading | Boolean | true | \- | N -rowCol | Array | - | Typescript：`SkeletonRowCol` `type SkeletonRowCol = Array>` `interface SkeletonRowColObj { width?: string; height?: string; size?: string; marginRight?: string; marginLeft?: string; margin?: string; content?: string \| TNode; type?: 'rect' \| 'circle' \| 'text' }`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/skeleton/type.ts) | N +rowCol | Array | - | Typescript: `SkeletonRowCol` `type SkeletonRowCol = Array>` `interface SkeletonRowColObj { width?: string; height?: string; size?: string; marginRight?: string; marginLeft?: string; margin?: string; content?: string \| TNode; type?: 'rect' \| 'circle' \| 'text' }`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/skeleton/type.ts) | N theme | String | text | options: text/avatar/paragraph/avatar-text/tab/article | N diff --git a/packages/components/slider/slider.en-US.md b/packages/components/slider/slider.en-US.md index 1aae632639..578d45de4b 100644 --- a/packages/components/slider/slider.en-US.md +++ b/packages/components/slider/slider.en-US.md @@ -6,19 +6,19 @@ name | type | default | description | required -- | -- | -- | -- | -- -className | String | - | 类名 | N -style | Object | - | 样式，Typescript：`React.CSSProperties` | N +className | String | - | className of component | N +style | Object | - | CSS(Cascading Style Sheets)，Typescript: `React.CSSProperties` | N disabled | Boolean | false | \- | N -inputNumberProps | Boolean / Object | false | Typescript：`boolean \| InputNumberProps`，[InputNumber API Documents](./input-number?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/slider/type.ts) | N -label | TNode | true | Typescript：`string \| boolean \| TNode<{ value: SliderValue; position?: 'start' \| 'end' }>`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +inputNumberProps | Boolean / Object | false | Typescript: `boolean \| InputNumberProps`，[InputNumber API Documents](./input-number?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/slider/type.ts) | N +label | TNode | true | Typescript: `string \| boolean \| TNode<{ value: SliderValue; position?: 'start' \| 'end' }>`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N layout | String | horizontal | options：vertical/horizontal | N -marks | Object / Array | - | Typescript：`Array \| SliderMarks` `interface SliderMarks { [mark: number]: string \| TNode<{ value: number }> }`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/slider/type.ts) | N +marks | Object / Array | - | Typescript: `Array \| SliderMarks` `interface SliderMarks { [mark: number]: string \| TNode<{ value: number }> }`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/slider/type.ts) | N max | Number | 100 | \- | N min | Number | 0 | \- | N range | Boolean | false | \- | N showStep | Boolean | false | \- | N step | Number | 1 | \- | N -tooltipProps | Object | - | Typescript：`TooltipProps`，[Tooltip API Documents](./tooltip?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/slider/type.ts) | N -value | Number / Array | - | Typescript：`SliderValue` `type SliderValue = number \| Array`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/slider/type.ts) | N -defaultValue | Number / Array | - | uncontrolled property。Typescript：`SliderValue` `type SliderValue = number \| Array`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/slider/type.ts) | N -onChange | Function | | Typescript：`(value: SliderValue) => void`
| N +tooltipProps | Object | - | Typescript: `TooltipProps`，[Tooltip API Documents](./tooltip?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/slider/type.ts) | N +value | Number / Array | - | Typescript: `SliderValue` `type SliderValue = number \| Array`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/slider/type.ts) | N +defaultValue | Number / Array | - | uncontrolled property。Typescript: `SliderValue` `type SliderValue = number \| Array`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/slider/type.ts) | N +onChange | Function | | Typescript: `(value: SliderValue) => void`
| N diff --git a/packages/components/slider/slider.md b/packages/components/slider/slider.md index 87009dde38..b94d055279 100644 --- a/packages/components/slider/slider.md +++ b/packages/components/slider/slider.md @@ -3,7 +3,7 @@ ## API ### Slider Props -名称 | 类型 | 默认值 | 说明 | 必传 +名称 | 类型 | 默认值 | 描述 | 必传 -- | -- | -- | -- | -- className | String | - | 类名 | N style | Object | - | 样式，TS 类型：`React.CSSProperties` | N diff --git a/packages/components/space/space.en-US.md b/packages/components/space/space.en-US.md index 5b8087fe47..239815a643 100644 --- a/packages/components/space/space.en-US.md +++ b/packages/components/space/space.en-US.md @@ -5,10 +5,10 @@ name | type | default | description | required -- | -- | -- | -- | -- -className | String | - | 类名 | N -style | Object | - | 样式，Typescript：`React.CSSProperties` | N +className | String | - | className of component | N +style | Object | - | CSS(Cascading Style Sheets)，Typescript: `React.CSSProperties` | N align | String | - | alignment。options: start/end/center/baseline | N breakLine | Boolean | false | Whether to wrap, valid only in horizontal | N direction | String | horizontal | Spacing direction。options: vertical/horizontal | N -separator | TNode | - | separator。Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -size | String / Number / Array | 'medium' | Spacing。Typescript：`SpaceSize \| SpaceSize[]` `type SpaceSize = number \| string \| SizeEnum`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/space/type.ts) | N +separator | TNode | - | separator。Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +size | String / Number / Array | 'medium' | Spacing。Typescript: `SpaceSize \| SpaceSize[]` `type SpaceSize = number \| string \| SizeEnum`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/space/type.ts) | N diff --git a/packages/components/space/space.md b/packages/components/space/space.md index 15f6d2081b..5b79085006 100644 --- a/packages/components/space/space.md +++ b/packages/components/space/space.md @@ -3,7 +3,7 @@ ## API ### Space Props -名称 | 类型 | 默认值 | 说明 | 必传 +名称 | 类型 | 默认值 | 描述 | 必传 -- | -- | -- | -- | -- className | String | - | 类名 | N style | Object | - | 样式，TS 类型：`React.CSSProperties` | N diff --git a/packages/components/statistic/statistic.en-US.md b/packages/components/statistic/statistic.en-US.md index 2df6812a49..bff6b05bd1 100644 --- a/packages/components/statistic/statistic.en-US.md +++ b/packages/components/statistic/statistic.en-US.md @@ -7,21 +7,21 @@ name | type | default | description | required -- | -- | -- | -- | -- className | String | - | className of component | N -style | Object | - | CSS(Cascading Style Sheets)，Typescript：`React.CSSProperties` | N -animation | Object | - | Animation effect control, `duration` refers to the transition time of the animation `unit: millisecond`, `valueFrom` refers to the initial value of the animation. `{ duration, valueFrom }`。Typescript：`animation` `interface animation { duration: number; valueFrom: number; }`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/statistic/type.ts) | N +style | Object | - | CSS(Cascading Style Sheets)，Typescript: `React.CSSProperties` | N +animation | Object | - | Animation effect control, `duration` refers to the transition time of the animation `unit: millisecond`, `valueFrom` refers to the initial value of the animation. `{ duration, valueFrom }`。Typescript: `animation` `interface animation { duration: number; valueFrom: number; }`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/statistic/type.ts) | N animationStart | Boolean | false | Whether to start animation | N color | String | - | The color style can support TDesign's light and dark modes with the following options: black, blue, red, orange, and green. Alternatively, it can be any [CSS color](https://developer.mozilla.org/en-US/docs/Web/CSS/color_value) value, but in this case, TDesign's light and dark modes will not be supported. | N decimalPlaces | Number | - | Decimal places | N -extra | TNode | - | Additional display content。Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -format | Function | - | Format numeric display value。Typescript：`(value: number) => number` | N +extra | TNode | - | Additional display content。Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +format | Function | - | Format numeric display value。Typescript: `(value: number) => number` | N loading | Boolean | false | Loading | N -prefix | TNode | - | Prefix content, display priority is higher than trend。Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +prefix | TNode | - | Prefix content, display priority is higher than trend。Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N separator | String | , | Thousands separator is displayed by default, and can be customized to other content, and the default separator is displayed when `separator = ''` is set to an empty string/null/undefined | N -suffix | TNode | - | Suffix content, display priority is higher than trend。Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -title | TNode | - | The title of Statistic。Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +suffix | TNode | - | Suffix content, display priority is higher than trend。Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +title | TNode | - | The title of Statistic。Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N trend | String | - | trend。options: increase/decrease | N trendPlacement | String | left | Position of trending placements。options: left/right | N -unit | TNode | - | Unit content。Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +unit | TNode | - | Unit content。Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N value | Number | - | The value of Statistic | N ### StatisticInstanceFunctions 组件实例方法 @@ -29,5 +29,5 @@ value | Number | - | The value of Statistic | N name | params | return | description -- | -- | -- | -- className | String | - | className of component | N -style | Object | - | CSS(Cascading Style Sheets)，Typescript：`React.CSSProperties` | N +style | Object | - | CSS(Cascading Style Sheets)，Typescript: `React.CSSProperties` | N start | \- | \- | required。start animation diff --git a/packages/components/steps/steps.en-US.md b/packages/components/steps/steps.en-US.md index f9ea957515..fbce23058a 100644 --- a/packages/components/steps/steps.en-US.md +++ b/packages/components/steps/steps.en-US.md @@ -6,28 +6,28 @@ name | type | default | description | required -- | -- | -- | -- | -- -className | String | - | 类名 | N -style | Object | - | 样式，Typescript：`React.CSSProperties` | N +className | String | - | className of component | N +style | Object | - | CSS(Cascading Style Sheets)，Typescript: `React.CSSProperties` | N current | String / Number | - | \- | N defaultCurrent | String / Number | - | uncontrolled property | N layout | String | horizontal | options：horizontal/vertical | N -options | Array | - | Typescript：`Array` | N +options | Array | - | Typescript: `Array` | N readonly | Boolean | false | \- | N separator | String | line | options：line/dashed/arrow | N sequence | String | positive | options：positive/reverse | N theme | String | default | options：default/dot | N -onChange | Function | | Typescript：`(current: string \| number, previous: string \| number, context?: { e?: MouseEvent }) => void`
| N +onChange | Function | | Typescript: `(current: string \| number, previous: string \| number, context?: { e?: MouseEvent }) => void`
| N ### StepItem Props name | type | default | description | required -- | -- | -- | -- | -- -className | String | - | 类名 | N -style | Object | - | 样式，Typescript：`React.CSSProperties` | N -children | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -content | TNode | '' | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -extra | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -icon | TNode | true | Typescript：`boolean \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -status | String | default | options：default/process/finish/error。Typescript：`StepStatus` `type StepStatus = 'default' \| 'process' \| 'finish' \| 'error'`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/steps/type.ts) | N -title | TNode | '' | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +className | String | - | className of component | N +style | Object | - | CSS(Cascading Style Sheets)，Typescript: `React.CSSProperties` | N +children | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +content | TNode | '' | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +extra | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +icon | TNode | true | Typescript: `boolean \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +status | String | default | options：default/process/finish/error。Typescript: `StepStatus` `type StepStatus = 'default' \| 'process' \| 'finish' \| 'error'`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/steps/type.ts) | N +title | TNode | '' | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N value | String / Number | - | \- | N diff --git a/packages/components/steps/steps.md b/packages/components/steps/steps.md index 42aa74e55f..51e661076d 100644 --- a/packages/components/steps/steps.md +++ b/packages/components/steps/steps.md @@ -3,7 +3,7 @@ ## API ### Steps Props -名称 | 类型 | 默认值 | 说明 | 必传 +名称 | 类型 | 默认值 | 描述 | 必传 -- | -- | -- | -- | -- className | String | - | 类名 | N style | Object | - | 样式，TS 类型：`React.CSSProperties` | N @@ -19,7 +19,7 @@ onChange | Function | | TS 类型：`(current: string \| number, previous: stri ### StepItem Props -名称 | 类型 | 默认值 | 说明 | 必传 +名称 | 类型 | 默认值 | 描述 | 必传 -- | -- | -- | -- | -- className | String | - | 类名 | N style | Object | - | 样式，TS 类型：`React.CSSProperties` | N diff --git a/packages/components/sticky-tool/sticky-tool.en-US.md b/packages/components/sticky-tool/sticky-tool.en-US.md index 5b575e3ba0..890d54d49c 100644 --- a/packages/components/sticky-tool/sticky-tool.en-US.md +++ b/packages/components/sticky-tool/sticky-tool.en-US.md @@ -5,26 +5,26 @@ name | type | default | description | required -- | -- | -- | -- | -- -className | String | - | 类名 | N -style | Object | - | 样式，Typescript：`React.CSSProperties` | N -list | Array | [] | Typescript：`Array` | N -offset | Array | - | Typescript：`Array` | N +className | String | - | className of component | N +style | Object | - | CSS(Cascading Style Sheets)，Typescript: `React.CSSProperties` | N +list | Array | [] | Typescript: `Array` | N +offset | Array | - | Typescript: `Array` | N placement | String | right-bottom | options：right-top/right-center/right-bottom/left-top/left-center/left-bottom | N -popupProps | Object | - | Typescript：`PopupProps`，[Popup API Documents](./popup?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/sticky-tool/type.ts) | N +popupProps | Object | - | Typescript: `PopupProps`，[Popup API Documents](./popup?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/sticky-tool/type.ts) | N shape | String | square | stickytool shape。options：square/round | N type | String | normal | stickytool type。options：normal/compact | N width | String / Number | - | \- | N -onClick | Function | | Typescript：`(context: { e: MouseEvent; item: TdStickyItemProps }) => void`
| N -onHover | Function | | Typescript：`(context: { e: MouseEvent; item: TdStickyItemProps }) => void`
| N +onClick | Function | | Typescript: `(context: { e: MouseEvent; item: TdStickyItemProps }) => void`
| N +onHover | Function | | Typescript: `(context: { e: MouseEvent; item: TdStickyItemProps }) => void`
| N ### StickyItem Props name | type | default | description | required -- | -- | -- | -- | -- -className | String | - | 类名 | N -style | Object | - | 样式，Typescript：`React.CSSProperties` | N -icon | TElement | - | Typescript：`TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -label | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -popup | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -popupProps | Object | - | Typescript：`PopupProps`，[Popup API Documents](./popup?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/sticky-tool/type.ts) | N +className | String | - | className of component | N +style | Object | - | CSS(Cascading Style Sheets)，Typescript: `React.CSSProperties` | N +icon | TElement | - | Typescript: `TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +label | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +popup | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +popupProps | Object | - | Typescript: `PopupProps`，[Popup API Documents](./popup?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/sticky-tool/type.ts) | N trigger | String | hover | options：hover/click | N diff --git a/packages/components/sticky-tool/sticky-tool.md b/packages/components/sticky-tool/sticky-tool.md index 1ac5c30980..fe596a0dda 100644 --- a/packages/components/sticky-tool/sticky-tool.md +++ b/packages/components/sticky-tool/sticky-tool.md @@ -3,7 +3,7 @@ ## API ### StickyTool Props -名称 | 类型 | 默认值 | 说明 | 必传 +名称 | 类型 | 默认值 | 描述 | 必传 -- | -- | -- | -- | -- className | String | - | 类名 | N style | Object | - | 样式，TS 类型：`React.CSSProperties` | N @@ -19,7 +19,7 @@ onHover | Function | | TS 类型：`(context: { e: MouseEvent; item: TdStickyIt ### StickyItem Props -名称 | 类型 | 默认值 | 说明 | 必传 +名称 | 类型 | 默认值 | 描述 | 必传 -- | -- | -- | -- | -- className | String | - | 类名 | N style | Object | - | 样式，TS 类型：`React.CSSProperties` | N diff --git a/packages/components/swiper/swiper.en-US.md b/packages/components/swiper/swiper.en-US.md index 2f5d345e32..b6cb5576c3 100644 --- a/packages/components/swiper/swiper.en-US.md +++ b/packages/components/swiper/swiper.en-US.md @@ -6,8 +6,8 @@ name | type | default | description | required -- | -- | -- | -- | -- -className | String | - | 类名 | N -style | Object | - | 样式，Typescript：`React.CSSProperties` | N +className | String | - | className of component | N +style | Object | - | CSS(Cascading Style Sheets)，Typescript: `React.CSSProperties` | N animation | String | slide | options：slide/fade | N autoplay | Boolean | true | \- | N current | Number | 0 | \- | N @@ -17,12 +17,12 @@ duration | Number | 300 | \- | N height | Number | - | \- | N interval | Number | 5000 | \- | N loop | Boolean | true | \- | N -navigation | TNode | - | Typescript：`SwiperNavigation \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +navigation | TNode | - | Typescript: `SwiperNavigation \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N stopOnHover | Boolean | true | \- | N theme | String | light | options：light/dark | N trigger | String | hover | options：hover/click | N type | String | default | options：default/card | N -onChange | Function | | Typescript：`(current: number, context: { source: SwiperChangeSource }) => void`
[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/swiper/type.ts)。
`type SwiperChangeSource = 'autoplay' \| 'click' \| 'hover'`
| N +onChange | Function | | Typescript: `(current: number, context: { source: SwiperChangeSource }) => void`
[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/swiper/type.ts)。
`type SwiperChangeSource = 'autoplay' \| 'click' \| 'hover'`
| N ### SwiperNavigation @@ -31,4 +31,4 @@ name | type | default | description | required placement | String | inside | options：inside/outside | N showSlideBtn | String | always | options：always/hover/never | N size | String | medium | options：small/medium/large | N -type | String | - | Typescript：`SwiperNavigationType` `type SwiperNavigationType = 'dots' \| 'dots-bar' \| 'bars' \| 'fraction'`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/swiper/type.ts) | N +type | String | - | Typescript: `SwiperNavigationType` `type SwiperNavigationType = 'dots' \| 'dots-bar' \| 'bars' \| 'fraction'`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/swiper/type.ts) | N diff --git a/packages/components/swiper/swiper.md b/packages/components/swiper/swiper.md index 95f4df6e95..b3e77739b1 100644 --- a/packages/components/swiper/swiper.md +++ b/packages/components/swiper/swiper.md @@ -3,7 +3,7 @@ ## API ### Swiper Props -名称 | 类型 | 默认值 | 说明 | 必传 +名称 | 类型 | 默认值 | 描述 | 必传 -- | -- | -- | -- | -- className | String | - | 类名 | N style | Object | - | 样式，TS 类型：`React.CSSProperties` | N @@ -25,7 +25,7 @@ onChange | Function | | TS 类型：`(current: number, context: { source: Swipe ### SwiperNavigation -名称 | 类型 | 默认值 | 说明 | 必传 +名称 | 类型 | 默认值 | 描述 | 必传 -- | -- | -- | -- | -- placement | String | inside | 导航器位置，位于主体的内侧或是外侧。可选项：inside/outside | N showSlideBtn | String | always | 何时显示导航器的翻页按钮：始终显示、悬浮显示、永不显示。可选项：always/hover/never | N diff --git a/packages/components/switch/switch.en-US.md b/packages/components/switch/switch.en-US.md index 64346513e3..94e6d529fd 100644 --- a/packages/components/switch/switch.en-US.md +++ b/packages/components/switch/switch.en-US.md @@ -5,14 +5,14 @@ name | type | default | description | required -- | -- | -- | -- | -- -className | String | - | 类名 | N -style | Object | - | 样式，Typescript：`React.CSSProperties` | N -beforeChange | Function | - | stop checked change。Typescript：`() => boolean \| Promise` | N -customValue | Array | - | Typescript：`Array` | N +className | String | - | className of component | N +style | Object | - | CSS(Cascading Style Sheets)，Typescript: `React.CSSProperties` | N +beforeChange | Function | - | stop checked change。Typescript: `() => boolean \| Promise` | N +customValue | Array | - | Typescript: `Array` | N disabled | Boolean | - | \- | N -label | TNode | [] | Typescript：`Array \| TNode<{ value: SwitchValue }>`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +label | TNode | [] | Typescript: `Array \| TNode<{ value: SwitchValue }>`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N loading | Boolean | false | \- | N size | String | medium | options：small/medium/large | N -value | String / Number / Boolean | - | Typescript：`T` `type SwitchValue = string \| number \| boolean`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/switch/type.ts) | N -defaultValue | String / Number / Boolean | - | uncontrolled property。Typescript：`T` `type SwitchValue = string \| number \| boolean`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/switch/type.ts) | N -onChange | Function | | Typescript：`(value: T, context: { e: MouseEvent }) => void`
| N +value | String / Number / Boolean | - | Typescript: `T` `type SwitchValue = string \| number \| boolean`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/switch/type.ts) | N +defaultValue | String / Number / Boolean | - | uncontrolled property。Typescript: `T` `type SwitchValue = string \| number \| boolean`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/switch/type.ts) | N +onChange | Function | | Typescript: `(value: T, context: { e: MouseEvent }) => void`
| N diff --git a/packages/components/switch/switch.md b/packages/components/switch/switch.md index a917ab17c7..b0eb603947 100644 --- a/packages/components/switch/switch.md +++ b/packages/components/switch/switch.md @@ -3,7 +3,7 @@ ## API ### Switch Props -名称 | 类型 | 默认值 | 说明 | 必传 +名称 | 类型 | 默认值 | 描述 | 必传 -- | -- | -- | -- | -- className | String | - | 类名 | N style | Object | - | 样式，TS 类型：`React.CSSProperties` | N diff --git a/packages/components/table/table.en-US.md b/packages/components/table/table.en-US.md index 28b4cb61dc..440e955445 100644 --- a/packages/components/table/table.en-US.md +++ b/packages/components/table/table.en-US.md @@ -5,68 +5,68 @@ name | type | default | description | required -- | -- | -- | -- | -- -className | String | - | 类名 | N -style | Object | - | 样式，Typescript：`React.CSSProperties` | N -attach | String / Function | - | elements with popup would be attached to `attach`。Typescript：`AttachNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +className | String | - | className of component | N +style | Object | - | CSS(Cascading Style Sheets)，Typescript: `React.CSSProperties` | N +attach | String / Function | - | elements with popup would be attached to `attach`。Typescript: `AttachNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N bordered | Boolean | false | show table bordered | N -bottomContent | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -cellEmptyContent | TNode | - | Typescript：`string \| TNode>`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -columns | Array | [] | table column configs。Typescript：`Array>` | N -data | Array | [] | table data。Typescript：`Array` | N +bottomContent | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +cellEmptyContent | TNode | - | Typescript: `string \| TNode>`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +columns | Array | [] | table column configs。Typescript: `Array>` | N +data | Array | [] | table data。Typescript: `Array` | N disableDataPage | Boolean | false | \- | N -empty | TNode | '' | empty text or empty element。Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -firstFullRow | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -fixedRows | Array | - | Typescript：`Array` | N -footData | Array | [] | table foot data。Typescript：`Array` | N -footerAffixProps | Object | - | `deprecated`。affix props。Typescript：`Partial` | N -footerAffixedBottom | Boolean / Object | false | affix foot to viewport bottom。Typescript：`boolean \| Partial` | N -footerSummary | TNode | - | footer summary content。Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -headerAffixProps | Object | - | `deprecated`。affix props。Typescript：`Partial`，[Affix API Documents](./affix?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/table/type.ts) | N -headerAffixedTop | Boolean / Object | false | affix header to viewport top。Typescript：`boolean \| Partial` | N +empty | TNode | '' | empty text or empty element。Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +firstFullRow | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +fixedRows | Array | - | Typescript: `Array` | N +footData | Array | [] | table foot data。Typescript: `Array` | N +footerAffixProps | Object | - | `deprecated`。affix props。Typescript: `Partial` | N +footerAffixedBottom | Boolean / Object | false | affix foot to viewport bottom。Typescript: `boolean \| Partial` | N +footerSummary | TNode | - | footer summary content。Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +headerAffixProps | Object | - | `deprecated`。affix props。Typescript: `Partial`，[Affix API Documents](./affix?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/table/type.ts) | N +headerAffixedTop | Boolean / Object | false | affix header to viewport top。Typescript: `boolean \| Partial` | N height | String / Number | - | table height | N -horizontalScrollAffixedBottom | Boolean / Object | - | affix props。Typescript：`boolean \| Partial` | N +horizontalScrollAffixedBottom | Boolean / Object | - | affix props。Typescript: `boolean \| Partial` | N hover | Boolean | false | show hover style | N -lastFullRow | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +lastFullRow | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N lazyLoad | Boolean | false | load table content when it entering the visible area, all elements in table are not rendered before it become visible | N -loading | TNode | undefined | loading state table。Typescript：`boolean \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -loadingProps | Object | - | Typescript：`Partial`，[Loading API Documents](./loading?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/table/type.ts) | N +loading | TNode | undefined | loading state table。Typescript: `boolean \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +loadingProps | Object | - | Typescript: `Partial`，[Loading API Documents](./loading?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/table/type.ts) | N maxHeight | String / Number | - | table max height | N -pagination | Object | - | you can use all props of pagination component with paginationProps。Typescript：`PaginationProps`，[Pagination API Documents](./pagination?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/table/type.ts) | N -paginationAffixedBottom | Boolean / Object | - | affix props。Typescript：`boolean \| Partial` | N +pagination | Object | - | you can use all props of pagination component with paginationProps。Typescript: `PaginationProps`，[Pagination API Documents](./pagination?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/table/type.ts) | N +paginationAffixedBottom | Boolean / Object | - | affix props。Typescript: `boolean \| Partial` | N resizable | Boolean | false | allow to resize column width, set `tableLayout=fixed` would be better | N -rowAttributes | Object / Array / Function | - | `tr` attributes。Typescript：`TableRowAttributes` `type TableRowAttributes = HTMLElementAttributes \| ((params: { row: T; rowIndex: number; type: 'body' \| 'foot' }) => HTMLElementAttributes) \| Array>`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/table/type.ts) | N -rowClassName | String / Object / Array / Function | - | table `th` classname。Typescript：`ClassName \| ((params: RowClassNameParams) => ClassName)` `interface RowClassNameParams { row: T; rowIndex: number; type?: 'body' \| 'foot' }`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/table/type.ts) | N +rowAttributes | Object / Array / Function | - | `tr` attributes。Typescript: `TableRowAttributes` `type TableRowAttributes = HTMLElementAttributes \| ((params: { row: T; rowIndex: number; type: 'body' \| 'foot' }) => HTMLElementAttributes) \| Array>`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/table/type.ts) | N +rowClassName | String / Object / Array / Function | - | table `th` classname。Typescript: `ClassName \| ((params: RowClassNameParams) => ClassName)` `interface RowClassNameParams { row: T; rowIndex: number; type?: 'body' \| 'foot' }`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/table/type.ts) | N rowKey | String | 'id' | required。unique key for each row data | Y -rowspanAndColspan | Function | - | rowspan and colspan。Typescript：`TableRowspanAndColspanFunc` `type TableRowspanAndColspanFunc = (params: BaseTableCellParams) => RowspanColspan` `interface RowspanColspan { colspan?: number; rowspan?: number }`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/table/type.ts) | N -rowspanAndColspanInFooter | Function | - | rowspan and colspan for footer。Typescript：`TableRowspanAndColspanFunc` | N -scroll | Object | - | lazy load and virtual scroll。Typescript：`TScroll`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +rowspanAndColspan | Function | - | rowspan and colspan。Typescript: `TableRowspanAndColspanFunc` `type TableRowspanAndColspanFunc = (params: BaseTableCellParams) => RowspanColspan` `interface RowspanColspan { colspan?: number; rowspan?: number }`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/table/type.ts) | N +rowspanAndColspanInFooter | Function | - | rowspan and colspan for footer。Typescript: `TableRowspanAndColspanFunc` | N +scroll | Object | - | lazy load and virtual scroll。Typescript: `TScroll`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N showHeader | Boolean | true | show table header | N -size | String | medium | options: small/medium/large。Typescript：`SizeEnum`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +size | String | medium | options: small/medium/large。Typescript: `SizeEnum`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N stripe | Boolean | false | show stripe style | N tableContentWidth | String | - | \- | N tableLayout | String | fixed | table-layout css properties, [MDN](https://developer.mozilla.org/en-US/docs/Web/CSS/table-layout). set value to be `fixed` on `resizable=true` please。options: auto/fixed | N -topContent | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +topContent | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N verticalAlign | String | middle | vertical align。options: top/middle/bottom | N -onCellClick | Function | | Typescript：`(context: BaseTableCellEventContext) => void`
trigger on cell clicked。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/table/type.ts)。
`interface BaseTableCellEventContext { row: T; col: BaseTableCol; rowIndex: number; colIndex: number; e: MouseEvent }`
| N -onColumnResizeChange | Function | | Typescript：`(context: { columnsWidth: { [colKey: string]: number }; }) => void`
| N -onPageChange | Function | | Typescript：`(pageInfo: PageInfo, newDataSource: Array) => void`
trigger on pagination changing | N -onRowClick | Function | | Typescript：`(context: RowEventContext) => void`
trigger on row click。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/table/type.ts)。
`interface RowEventContext { row: T; index: number; e: MouseEvent }`
| N -onRowDblclick | Function | | Typescript：`(context: RowEventContext) => void`
trigger on double click | N -onRowMousedown | Function | | Typescript：`(context: RowEventContext) => void`
trigger on row mousedown | N -onRowMouseenter | Function | | Typescript：`(context: RowEventContext) => void`
trigger on row mouseenter | N -onRowMouseleave | Function | | Typescript：`(context: RowEventContext) => void`
trigger on row mouseenter | N -onRowMouseover | Function | | Typescript：`(context: RowEventContext) => void`
trigger on row mouseover | N -onRowMouseup | Function | | Typescript：`(context: RowEventContext) => void`
trigger on row mouseup | N -onScroll | Function | | Typescript：`(params: { e: WheelEvent }) => void`
trigger on table content scroll | N -onScrollX | Function | | Typescript：`(params: { e: WheelEvent }) => void`
`deprecated`。trigger on scroll horizontal | N -onScrollY | Function | | Typescript：`(params: { e: WheelEvent }) => void`
`deprecated`。trigger on scroll vertical | N +onCellClick | Function | | Typescript: `(context: BaseTableCellEventContext) => void`
trigger on cell clicked。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/table/type.ts)。
`interface BaseTableCellEventContext { row: T; col: BaseTableCol; rowIndex: number; colIndex: number; e: MouseEvent }`
| N +onColumnResizeChange | Function | | Typescript: `(context: { columnsWidth: { [colKey: string]: number }; }) => void`
| N +onPageChange | Function | | Typescript: `(pageInfo: PageInfo, newDataSource: Array) => void`
trigger on pagination changing | N +onRowClick | Function | | Typescript: `(context: RowEventContext) => void`
trigger on row click。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/table/type.ts)。
`interface RowEventContext { row: T; index: number; e: MouseEvent }`
| N +onRowDblclick | Function | | Typescript: `(context: RowEventContext) => void`
trigger on double click | N +onRowMousedown | Function | | Typescript: `(context: RowEventContext) => void`
trigger on row mousedown | N +onRowMouseenter | Function | | Typescript: `(context: RowEventContext) => void`
trigger on row mouseenter | N +onRowMouseleave | Function | | Typescript: `(context: RowEventContext) => void`
trigger on row mouseenter | N +onRowMouseover | Function | | Typescript: `(context: RowEventContext) => void`
trigger on row mouseover | N +onRowMouseup | Function | | Typescript: `(context: RowEventContext) => void`
trigger on row mouseup | N +onScroll | Function | | Typescript: `(params: { e: WheelEvent }) => void`
trigger on table content scroll | N +onScrollX | Function | | Typescript: `(params: { e: WheelEvent }) => void`
`deprecated`。trigger on scroll horizontal | N +onScrollY | Function | | Typescript: `(params: { e: WheelEvent }) => void`
`deprecated`。trigger on scroll vertical | N ### BaseTableInstanceFunctions 组件实例方法 name | params | return | description -- | -- | -- | -- -className | String | - | 类名 | N -style | Object | - | 样式，Typescript：`React.CSSProperties` | N +className | String | - | className of component | N +style | Object | - | CSS(Cascading Style Sheets)，Typescript: `React.CSSProperties` | N refreshTable | \- | \- | required scrollColumnIntoView | `(colKey: string)` | \- | required scrollToElement | `(params: ScrollToElementParams)` | \- | required @@ -76,85 +76,85 @@ scrollToElement | `(params: ScrollToElementParams)` | \- | required name | type | default | description | required -- | -- | -- | -- | -- align | String | left | align type。options: left/right/center | N -attrs | Object / Function | - | html attributes。Typescript：`BaseTableColumnAttributes` `type BaseTableColumnAttributes = { [key: string]: any } \| ((context: CellData) => { [key: string]: any })`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/table/type.ts) | N -cell | String / Function | - | use cell to render table cell。Typescript：`string \| TNode>` `interface BaseTableCellParams { row: T; rowIndex: number; col: BaseTableCol; colIndex: number }`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/table/type.ts) | N -children | Array | - | grouping table head。Typescript：`Array>` | N -className | String / Object / Array / Function | - | cell classnames。Typescript：`TableColumnClassName \| TableColumnClassName[]` `type TableColumnClassName = ClassName \| ((context: CellData) => ClassName)` `interface CellData extends BaseTableCellParams { type: 'th' \| 'td' }`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/table/type.ts) | N +attrs | Object / Function | - | html attributes。Typescript: `BaseTableColumnAttributes` `type BaseTableColumnAttributes = { [key: string]: any } \| ((context: CellData) => { [key: string]: any })`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/table/type.ts) | N +cell | String / Function | - | use cell to render table cell。Typescript: `string \| TNode>` `interface BaseTableCellParams { row: T; rowIndex: number; col: BaseTableCol; colIndex: number }`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/table/type.ts) | N +children | Array | - | grouping table head。Typescript: `Array>` | N +className | String / Object / Array / Function | - | cell classnames。Typescript: `TableColumnClassName \| TableColumnClassName[]` `type TableColumnClassName = ClassName \| ((context: CellData) => ClassName)` `interface CellData extends BaseTableCellParams { type: 'th' \| 'td' }`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/table/type.ts) | N colKey | String | - | unique key for column | N colspan | Number | - | one line head colspan | N -ellipsis | TNode | false | ellipsis cell content。Typescript：`boolean \| TNode> \| TooltipProps \| { props: TooltipProps; content: TNode> }`，[Tooltip API Documents](./tooltip?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/table/type.ts) | N -ellipsisTitle | TNode | undefined | ellipsis title content。Typescript：`boolean \| TNode> \| TooltipProps \| { props: TooltipProps; content: TNode> }` `interface BaseTableColParams { col: BaseTableCol; colIndex: number }`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/table/type.ts) | N +ellipsis | TNode | false | ellipsis cell content。Typescript: `boolean \| TNode> \| TooltipProps \| { props: TooltipProps; content: TNode> }`，[Tooltip API Documents](./tooltip?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/table/type.ts) | N +ellipsisTitle | TNode | undefined | ellipsis title content。Typescript: `boolean \| TNode> \| TooltipProps \| { props: TooltipProps; content: TNode> }` `interface BaseTableColParams { col: BaseTableCol; colIndex: number }`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/table/type.ts) | N fixed | String | left | fixed current column to left or right。options: left/right | N -foot | String / Function | - | tfoot content。Typescript：`string \| TNode \| TNode<{ col: BaseTableCol; colIndex: number }>`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +foot | String / Function | - | tfoot content。Typescript: `string \| TNode \| TNode<{ col: BaseTableCol; colIndex: number }>`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N minWidth | String / Number | - | add CSS property `min-width` to HTML Element ``，Browsers with [TablesNG](https://docs.google.com/document/d/16PFD1GtMI9Zgwu0jtPaKZJ75Q2wyZ9EZnVbBacOfiNA/preview) support `minWidth` | N -render | Function | - | render function can be used to render cell or head。Typescript：`TNode>` `interface BaseTableRenderParams extends BaseTableCellParams { type: RenderType }` `type RenderType = 'cell' \| 'title'`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/table/type.ts) | N +render | Function | - | render function can be used to render cell or head。Typescript: `TNode>` `interface BaseTableRenderParams extends BaseTableCellParams { type: RenderType }` `type RenderType = 'cell' \| 'title'`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/table/type.ts) | N resizable | Boolean | true | resize current column width | N -resize | Object | - | Typescript：`TableColumnResizeConfig` `interface TableColumnResizeConfig { minWidth: number; maxWidth: number }`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/table/type.ts) | N +resize | Object | - | Typescript: `TableColumnResizeConfig` `interface TableColumnResizeConfig { minWidth: number; maxWidth: number }`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/table/type.ts) | N stopPropagation | Boolean | - | stop cells of current col to propagation | N -thClassName | String / Object / Array / Function | - | th classnames。Typescript：`TableColumnClassName \| TableColumnClassName[]`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -title | String / Function | - | th content。Typescript：`string \| TNode \| TNode<{ col: BaseTableCol; colIndex: number }>`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +thClassName | String / Object / Array / Function | - | th classnames。Typescript: `TableColumnClassName \| TableColumnClassName[]`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +title | String / Function | - | th content。Typescript: `string \| TNode \| TNode<{ col: BaseTableCol; colIndex: number }>`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N width | String / Number | - | column width | N ### PrimaryTable Props name | type | default | description | required -- | -- | -- | -- | -- -className | String | - | 类名 | N -style | Object | - | 样式，Typescript：`React.CSSProperties` | N -asyncLoading | TNode | - | async loading state。Typescript：`'loading' \| 'load-more' \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -columnController | Object | - | Typescript：`TableColumnController` | N +className | String | - | className of component | N +style | Object | - | CSS(Cascading Style Sheets)，Typescript: `React.CSSProperties` | N +asyncLoading | TNode | - | async loading state。Typescript: `'loading' \| 'load-more' \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +columnController | Object | - | Typescript: `TableColumnController` | N columnControllerVisible | Boolean | undefined | \- | N -columns | Array | [] | table column configs。Typescript：`Array>` | N -displayColumns | Array | - | Typescript：`CheckboxGroupValue` | N -defaultDisplayColumns | Array | - | uncontrolled property。Typescript：`CheckboxGroupValue` | N +columns | Array | [] | table column configs。Typescript: `Array>` | N +displayColumns | Array | - | Typescript: `CheckboxGroupValue` | N +defaultDisplayColumns | Array | - | uncontrolled property。Typescript: `CheckboxGroupValue` | N dragSort | String | - | dag sort。options: row/row-handler/col/row-handler-col/drag-col | N -dragSortOptions | Object | - | drag sort params。Typescript：`SortableOptions` | N -editableCellState | Function | - | Typescript：`EditableCellType` `type EditableCellType = (params: PrimaryTableCellParams) => boolean`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/table/type.ts) | N -editableRowKeys | Array | - | editable row keys, row key value is from data[rowKey]。Typescript：`Array` | N -expandIcon | TNode | true | to show expand icon. expand icon is set in first column。Typescript：`boolean \| TNode>` `interface ExpandArrowRenderParams { row: T; index: number }`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/table/type.ts) | N +dragSortOptions | Object | - | drag sort params。Typescript: `SortableOptions` | N +editableCellState | Function | - | Typescript: `EditableCellType` `type EditableCellType = (params: PrimaryTableCellParams) => boolean`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/table/type.ts) | N +editableRowKeys | Array | - | editable row keys, row key value is from data[rowKey]。Typescript: `Array` | N +expandIcon | TNode | true | to show expand icon. expand icon is set in first column。Typescript: `boolean \| TNode>` `interface ExpandArrowRenderParams { row: T; index: number }`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/table/type.ts) | N expandOnRowClick | Boolean | - | expand row on click | N -expandedRow | TNode | - | table expanded row, to show more detail information。Typescript：`TNode>` `interface TableExpandedRowParams { row: T; index: number; columns: PrimaryTableCol[] \| BaseTableCol[] }`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/table/type.ts) | N -expandedRowKeys | Array | [] | expanded row keys, row key value is from data[rowKey]。Typescript：`Array` | N -defaultExpandedRowKeys | Array | [] | expanded row keys, row key value is from data[rowKey]。uncontrolled property。Typescript：`Array` | N -filterIcon | TElement | - | filter icon。Typescript：`TNode<{ col: PrimaryTableCol; colIndex: number }>`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -filterRow | TNode | - | filter value。Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -filterValue | Object | - | filter value。Typescript：`FilterValue` `type FilterValue = { [key: string]: any }`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/table/type.ts) | N -defaultFilterValue | Object | - | filter value。uncontrolled property。Typescript：`FilterValue` `type FilterValue = { [key: string]: any }`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/table/type.ts) | N +expandedRow | TNode | - | table expanded row, to show more detail information。Typescript: `TNode>` `interface TableExpandedRowParams { row: T; index: number; columns: PrimaryTableCol[] \| BaseTableCol[] }`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/table/type.ts) | N +expandedRowKeys | Array | [] | expanded row keys, row key value is from data[rowKey]。Typescript: `Array` | N +defaultExpandedRowKeys | Array | [] | expanded row keys, row key value is from data[rowKey]。uncontrolled property。Typescript: `Array` | N +filterIcon | TElement | - | filter icon。Typescript: `TNode<{ col: PrimaryTableCol; colIndex: number }>`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +filterRow | TNode | - | filter value。Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +filterValue | Object | - | filter value。Typescript: `FilterValue` `type FilterValue = { [key: string]: any }`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/table/type.ts) | N +defaultFilterValue | Object | - | filter value。uncontrolled property。Typescript: `FilterValue` `type FilterValue = { [key: string]: any }`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/table/type.ts) | N hideSortTips | Boolean | - | hide sort tips | N -indeterminateSelectedRowKeys | Array | - | indeterminate selected row keys, row key is from data[rowKey]。Typescript：`Array` | N +indeterminateSelectedRowKeys | Array | - | indeterminate selected row keys, row key is from data[rowKey]。Typescript: `Array` | N multipleSort | Boolean | false | support multiple column fields sort | N reserveSelectedRowOnPaginate | Boolean | true | \- | N selectOnRowClick | Boolean | - | select row data on row click | N -selectedRowKeys | Array | [] | selected row keys, row key is from data[rowKey]。Typescript：`Array` | N -defaultSelectedRowKeys | Array | [] | selected row keys, row key is from data[rowKey]。uncontrolled property。Typescript：`Array` | N +selectedRowKeys | Array | [] | selected row keys, row key is from data[rowKey]。Typescript: `Array` | N +defaultSelectedRowKeys | Array | [] | selected row keys, row key is from data[rowKey]。uncontrolled property。Typescript: `Array` | N showSortColumnBgColor | Boolean | false | column shows sort bg color | N -sort | Object / Array | - | sort configs。Typescript：`TableSort` `type TableSort = SortInfo \| Array` `interface SortInfo { sortBy: string; descending: boolean }`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/table/type.ts) | N -defaultSort | Object / Array | - | sort configs。uncontrolled property。Typescript：`TableSort` `type TableSort = SortInfo \| Array` `interface SortInfo { sortBy: string; descending: boolean }`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/table/type.ts) | N -sortIcon | TElement | - | sort icon。Typescript：`TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +sort | Object / Array | - | sort configs。Typescript: `TableSort` `type TableSort = SortInfo \| Array` `interface SortInfo { sortBy: string; descending: boolean }`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/table/type.ts) | N +defaultSort | Object / Array | - | sort configs。uncontrolled property。Typescript: `TableSort` `type TableSort = SortInfo \| Array` `interface SortInfo { sortBy: string; descending: boolean }`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/table/type.ts) | N +sortIcon | TElement | - | sort icon。Typescript: `TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N sortOnRowDraggable | Boolean | false | `deprecated`。sort on row draggable | N `Omit, 'columns' \| 'onCellClick'>` | \- | - | extends `Omit, 'columns' \| 'onCellClick'>` | N -onAsyncLoadingClick | Function | | Typescript：`(context: { status: 'loading' \| 'load-more' }) => void`
trigger on async loading text clicked | N -onCellClick | Function | | Typescript：`(context: PrimaryTableCellEventContext) => void`
trigger on cell clicked。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/table/type.ts)。
`interface PrimaryTableCellEventContext { row: T; col: PrimaryTableCol; rowIndex: number; colIndex: number; e: MouseEvent }`
| N -onChange | Function | | Typescript：`(data: TableChangeData, context: TableChangeContext) => void`
[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/table/type.ts)。
`interface TableChangeData { sorter?: TableSort; filter?: FilterValue; pagination?: PaginationProps }`

`interface TableChangeContext { trigger: TableChangeTrigger; currentData?: T[] }`

`type TableChangeTrigger = 'filter' \| 'sorter' \| 'pagination'`
| N -onColumnChange | Function | | Typescript：`(context: PrimaryTableColumnChange) => void`
[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/table/type.ts)。
`interface PrimaryTableColumnChange { columns?: CheckboxGroupValue; currentColumn?: PrimaryTableCol; type?: 'check' \| 'uncheck'; e?: ChangeEvent }`
| N -onColumnControllerVisibleChange | Function | | Typescript：`(visible: boolean, context: { trigger: 'cancel' \| 'confirm' }) => void`
| N -onDataChange | Function | | Typescript：`(data: Array, context: TableDataChangeContext) => void`
trigger on data changing。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/table/type.ts)。
`interface TableDataChangeContext { trigger: 'sort' }`
| N -onDisplayColumnsChange | Function | | Typescript：`(value: CheckboxGroupValue) => void`
[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/table/type.ts)。
`import { CheckboxGroupValue } from '@Checkbox'`
| N -onDragSort | Function | | Typescript：`(context: DragSortContext) => void`
trigger on drag sort。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/table/type.ts)。
`interface DragSortContext { currentIndex: number; current: T; targetIndex: number; target: T; data: T[]; newData: T[]; currentData?: T[]; e: SortableEvent; sort: 'row' \| 'col' }`

`import { SortableEvent, SortableOptions } from 'sortablejs'`
| N -onExpandChange | Function | | Typescript：`(expandedRowKeys: Array, options: ExpandOptions) => void`
trigger on expand row keys changing。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/table/type.ts)。
`interface ExpandOptions { expandedRowData: Array; currentRowData: T }`
| N -onFilterChange | Function | | Typescript：`(filterValue: FilterValue, context: TableFilterChangeContext) => void`
trigger on filter value changing。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/table/type.ts)。
`interface TableFilterChangeContext { col?: PrimaryTableCol; trigger: 'filter-change' \| 'confirm' \| 'reset' \| 'clear' }`
| N -onRowEdit | Function | | Typescript：`(context: PrimaryTableRowEditContext) => void`
trigger on row data is editing。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/table/type.ts)。
`type PrimaryTableRowEditContext = PrimaryTableCellParams & { value: any; editedRow: T }`
| N -onRowValidate | Function | | Typescript：`(context: PrimaryTableRowValidateContext) => void`
trigger after row data validated。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/table/type.ts)。
`type PrimaryTableRowValidateContext = { result: TableRowValidateResult[]; trigger: TableValidateTrigger }`

`type TableValidateTrigger = 'self' \| 'parent'`

`export type TableRowValidateResult = PrimaryTableCellParams & { errorList: AllValidateResult[]; value: any }`
| N -onSelectChange | Function | | Typescript：`(selectedRowKeys: Array, options: SelectOptions) => void`
trigger on select changing。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/table/type.ts)。
`interface SelectOptions { selectedRowData: Array; type: 'uncheck' \| 'check'; currentRowKey?: string; currentRowData?: T }`
| N -onSortChange | Function | | Typescript：`(sort: TableSort, options: SortOptions) => void`
trigger on sort changing。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/table/type.ts)。
`interface SortOptions { currentDataSource?: Array; col: PrimaryTableCol }`
| N -onValidate | Function | | Typescript：`(context: PrimaryTableValidateContext) => void`
trigger after row data validated。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/table/type.ts)。
`interface PrimaryTableValidateContext { result: TableErrorListMap }`

`type TableErrorListMap = { [key: string]: AllValidateResult[] }`
| N +onAsyncLoadingClick | Function | | Typescript: `(context: { status: 'loading' \| 'load-more' }) => void`
trigger on async loading text clicked | N +onCellClick | Function | | Typescript: `(context: PrimaryTableCellEventContext) => void`
trigger on cell clicked。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/table/type.ts)。
`interface PrimaryTableCellEventContext { row: T; col: PrimaryTableCol; rowIndex: number; colIndex: number; e: MouseEvent }`
| N +onChange | Function | | Typescript: `(data: TableChangeData, context: TableChangeContext) => void`
[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/table/type.ts)。
`interface TableChangeData { sorter?: TableSort; filter?: FilterValue; pagination?: PaginationProps }`

`interface TableChangeContext { trigger: TableChangeTrigger; currentData?: T[] }`

`type TableChangeTrigger = 'filter' \| 'sorter' \| 'pagination'`
| N +onColumnChange | Function | | Typescript: `(context: PrimaryTableColumnChange) => void`
[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/table/type.ts)。
`interface PrimaryTableColumnChange { columns?: CheckboxGroupValue; currentColumn?: PrimaryTableCol; type?: 'check' \| 'uncheck'; e?: ChangeEvent }`
| N +onColumnControllerVisibleChange | Function | | Typescript: `(visible: boolean, context: { trigger: 'cancel' \| 'confirm' }) => void`
| N +onDataChange | Function | | Typescript: `(data: Array, context: TableDataChangeContext) => void`
trigger on data changing。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/table/type.ts)。
`interface TableDataChangeContext { trigger: 'sort' }`
| N +onDisplayColumnsChange | Function | | Typescript: `(value: CheckboxGroupValue) => void`
[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/table/type.ts)。
`import { CheckboxGroupValue } from '@Checkbox'`
| N +onDragSort | Function | | Typescript: `(context: DragSortContext) => void`
trigger on drag sort。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/table/type.ts)。
`interface DragSortContext { currentIndex: number; current: T; targetIndex: number; target: T; data: T[]; newData: T[]; currentData?: T[]; e: SortableEvent; sort: 'row' \| 'col' }`

`import { SortableEvent, SortableOptions } from 'sortablejs'`
| N +onExpandChange | Function | | Typescript: `(expandedRowKeys: Array, options: ExpandOptions) => void`
trigger on expand row keys changing。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/table/type.ts)。
`interface ExpandOptions { expandedRowData: Array; currentRowData: T }`
| N +onFilterChange | Function | | Typescript: `(filterValue: FilterValue, context: TableFilterChangeContext) => void`
trigger on filter value changing。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/table/type.ts)。
`interface TableFilterChangeContext { col?: PrimaryTableCol; trigger: 'filter-change' \| 'confirm' \| 'reset' \| 'clear' }`
| N +onRowEdit | Function | | Typescript: `(context: PrimaryTableRowEditContext) => void`
trigger on row data is editing。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/table/type.ts)。
`type PrimaryTableRowEditContext = PrimaryTableCellParams & { value: any; editedRow: T }`
| N +onRowValidate | Function | | Typescript: `(context: PrimaryTableRowValidateContext) => void`
trigger after row data validated。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/table/type.ts)。
`type PrimaryTableRowValidateContext = { result: TableRowValidateResult[]; trigger: TableValidateTrigger }`

`type TableValidateTrigger = 'self' \| 'parent'`

`export type TableRowValidateResult = PrimaryTableCellParams & { errorList: AllValidateResult[]; value: any }`
| N +onSelectChange | Function | | Typescript: `(selectedRowKeys: Array, options: SelectOptions) => void`
trigger on select changing。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/table/type.ts)。
`interface SelectOptions { selectedRowData: Array; type: 'uncheck' \| 'check'; currentRowKey?: string; currentRowData?: T }`
| N +onSortChange | Function | | Typescript: `(sort: TableSort, options: SortOptions) => void`
trigger on sort changing。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/table/type.ts)。
`interface SortOptions { currentDataSource?: Array; col: PrimaryTableCol }`
| N +onValidate | Function | | Typescript: `(context: PrimaryTableValidateContext) => void`
trigger after row data validated。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/table/type.ts)。
`interface PrimaryTableValidateContext { result: TableErrorListMap }`

`type TableErrorListMap = { [key: string]: AllValidateResult[] }`
| N ### PrimaryTableInstanceFunctions 组件实例方法 name | params | return | description -- | -- | -- | -- -className | String | - | 类名 | N -style | Object | - | 样式，Typescript：`React.CSSProperties` | N +className | String | - | className of component | N +style | Object | - | CSS(Cascading Style Sheets)，Typescript: `React.CSSProperties` | N validateRowData | `(rowValue: any)` | `Promise<{ trigger: TableValidateTrigger, result: ErrorListObjectType[] }>` | required。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/table/type.ts)。
`type ErrorListObjectType = PrimaryTableRowEditContext & { errorList: AllValidateResult[] }`
validateTableData | \- | `Promise<{ result: TableErrorListMap }>` | required @@ -162,17 +162,17 @@ validateTableData | \- | `Promise<{ result: TableErrorListMap }>` | required name | type | default | description | required -- | -- | -- | -- | -- -cell | String / Function | - | to render table cell。Typescript：`string \| TNode>` `interface PrimaryTableCellParams { row: T; rowIndex: number; col: PrimaryTableCol; colIndex: number }`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/table/type.ts) | N -checkProps | Object / Function | - | checkbox or radio component properties。Typescript：`CheckProps` `type CheckProps = CheckboxProps \| RadioProps \| ((options: { row: T; rowIndex: number }) => CheckboxProps \| RadioProps)` `import { CheckboxProps } from '@Checkbox'`，[Radio API Documents](./radio?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/table/type.ts) | N -children | Array | - | grouping table head。Typescript：`Array>` | N +cell | String / Function | - | to render table cell。Typescript: `string \| TNode>` `interface PrimaryTableCellParams { row: T; rowIndex: number; col: PrimaryTableCol; colIndex: number }`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/table/type.ts) | N +checkProps | Object / Function | - | checkbox or radio component properties。Typescript: `CheckProps` `type CheckProps = CheckboxProps \| RadioProps \| ((options: { row: T; rowIndex: number }) => CheckboxProps \| RadioProps)` `import { CheckboxProps } from '@Checkbox'`，[Radio API Documents](./radio?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/table/type.ts) | N +children | Array | - | grouping table head。Typescript: `Array>` | N colKey | String | - | unique key for column | N -disabled | Function | - | disable table select action。Typescript：`(options: {row: T; rowIndex: number }) => boolean` | N -edit | Object | - | Typescript：`TableEditableCellConfig` | N -filter | Object | - | filter rules config。Typescript：`TableColumnFilter` | N -render | Function | - | to render cell or head。Typescript：`TNode>` `interface PrimaryTableRenderParams extends PrimaryTableCellParams { type: RenderType }`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/table/type.ts) | N -sortType | String | all | sort options。options: desc/asc/all。Typescript：`SortType` `type SortType = 'desc' \| 'asc' \| 'all'`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/table/type.ts) | N -sorter | Boolean / Function | false | sort configs。Typescript：`boolean \| SorterFun` `type SorterFun = (a: T, b: T) => number`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/table/type.ts) | N -title | String / Function | - | to render table head。Typescript：`string \| TNode<{ col: PrimaryTableCol; colIndex: number }>`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +disabled | Function | - | disable table select action。Typescript: `(options: {row: T; rowIndex: number }) => boolean` | N +edit | Object | - | Typescript: `TableEditableCellConfig` | N +filter | Object | - | filter rules config。Typescript: `TableColumnFilter` | N +render | Function | - | to render cell or head。Typescript: `TNode>` `interface PrimaryTableRenderParams extends PrimaryTableCellParams { type: RenderType }`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/table/type.ts) | N +sortType | String | all | sort options。options: desc/asc/all。Typescript: `SortType` `type SortType = 'desc' \| 'asc' \| 'all'`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/table/type.ts) | N +sorter | Boolean / Function | false | sort configs。Typescript: `boolean \| SorterFun` `type SorterFun = (a: T, b: T) => number`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/table/type.ts) | N +title | String / Function | - | to render table head。Typescript: `string \| TNode<{ col: PrimaryTableCol; colIndex: number }>`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N type | String | single | row select type。options: single/multiple | N `Omit` | \- | - | extends `Omit` | N @@ -180,24 +180,24 @@ type | String | single | row select type。options: single/multiple | N name | type | default | description | required -- | -- | -- | -- | -- -className | String | - | 类名 | N -style | Object | - | 样式，Typescript：`React.CSSProperties` | N -beforeDragSort | Function | - | stop to drag sort。Typescript：`(context: DragSortContext) => boolean` | N -expandedTreeNodes | Array | [] | expanded tree node row keys, row key value is from data[rowKey]。Typescript：`Array` | N -defaultExpandedTreeNodes | Array | [] | expanded tree node row keys, row key value is from data[rowKey]。uncontrolled property。Typescript：`Array` | N -tree | Object | - | tree data configs。Typescript：`TableTreeConfig` | N -treeExpandAndFoldIcon | Function | - | sort icon。Typescript：`TNode<{ type: 'expand' \| 'fold' }>`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +className | String | - | className of component | N +style | Object | - | CSS(Cascading Style Sheets)，Typescript: `React.CSSProperties` | N +beforeDragSort | Function | - | stop to drag sort。Typescript: `(context: DragSortContext) => boolean` | N +expandedTreeNodes | Array | [] | expanded tree node row keys, row key value is from data[rowKey]。Typescript: `Array` | N +defaultExpandedTreeNodes | Array | [] | expanded tree node row keys, row key value is from data[rowKey]。uncontrolled property。Typescript: `Array` | N +tree | Object | - | tree data configs。Typescript: `TableTreeConfig` | N +treeExpandAndFoldIcon | Function | - | sort icon。Typescript: `TNode<{ type: 'expand' \| 'fold' }>`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N `PrimaryTableProps` | \- | - | extends `PrimaryTableProps` | N -onAbnormalDragSort | Function | | Typescript：`(context: TableAbnormalDragSortContext) => void`
[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/table/type.ts)。
`interface TableAbnormalDragSortContext { code: number; reason: string }`
| N -onExpandedTreeNodesChange | Function | | Typescript：`(expandedTreeNodes: Array, options: TableTreeNodeExpandOptions ) => void`
trigger on tree node expanded or folded。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/table/type.ts)。
`interface TableTreeNodeExpandOptions { row: T; rowIndex: number; rowState: TableRowState; type: 'fold' \| 'expand'; trigger?: 'expand-fold-icon' \| 'row-click' \| 'default-expand-all' \| 'expand-all' \| 'fold-all' }`
| N -onTreeExpandChange | Function | | Typescript：`(context: TableTreeExpandChangeContext) => void`
`deprecated`。trigger on tree node expanded or folded, use `expandedTreeNodesChange` please。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/table/type.ts)。
`interface TableTreeExpandChangeContext { row: T; rowIndex: number; rowState: TableRowState; trigger?: 'expand-fold-icon' \| 'row-click' }`
| N +onAbnormalDragSort | Function | | Typescript: `(context: TableAbnormalDragSortContext) => void`
[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/table/type.ts)。
`interface TableAbnormalDragSortContext { code: number; reason: string }`
| N +onExpandedTreeNodesChange | Function | | Typescript: `(expandedTreeNodes: Array, options: TableTreeNodeExpandOptions ) => void`
trigger on tree node expanded or folded。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/table/type.ts)。
`interface TableTreeNodeExpandOptions { row: T; rowIndex: number; rowState: TableRowState; type: 'fold' \| 'expand'; trigger?: 'expand-fold-icon' \| 'row-click' \| 'default-expand-all' \| 'expand-all' \| 'fold-all' }`
| N +onTreeExpandChange | Function | | Typescript: `(context: TableTreeExpandChangeContext) => void`
`deprecated`。trigger on tree node expanded or folded, use `expandedTreeNodesChange` please。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/table/type.ts)。
`interface TableTreeExpandChangeContext { row: T; rowIndex: number; rowState: TableRowState; trigger?: 'expand-fold-icon' \| 'row-click' }`
| N ### EnhancedTableInstanceFunctions 组件实例方法 name | params | return | description -- | -- | -- | -- -className | String | - | 类名 | N -style | Object | - | 样式，Typescript：`React.CSSProperties` | N +className | String | - | className of component | N +style | Object | - | CSS(Cascading Style Sheets)，Typescript: `React.CSSProperties` | N appendTo | `(key: TableRowValue, newData: T)` | \- | required expandAll | \- | \- | required foldAll | \- | \- | required @@ -221,37 +221,37 @@ disabled | Boolean | false | \- | N expandChildrenLength | Number | - | \- | N expanded | Boolean | false | required | Y id | String / Number | - | required | Y -level | Number | - | Typescript：`number` | N -parent | \- | - | Typescript：`TableRowState` | N -path | Array | - | Typescript：`TableRowState[]` | N -row | \- | - | required。Typescript：`T` | Y +level | Number | - | Typescript: `number` | N +parent | \- | - | Typescript: `TableRowState` | N +path | Array | - | Typescript: `TableRowState[]` | N +row | \- | - | required。Typescript: `T` | Y rowIndex | Number | - | required | Y ### TableColumnFilter name | type | default | description | required -- | -- | -- | -- | -- -attrs | Object | - | html attributes of component。Typescript：`HTMLElementAttributes`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -classNames | String | - | component class names。Typescript：`ClassName`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -component | TElement | - | Typescript：`ComponentType`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -confirmEvents | Array | - | Typescript：`string[]` | N -list | Array | - | Typescript：`Array`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -popupProps | Object | - | Typescript：`PopupProps`，[Popup API Documents](./popup?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/table/type.ts) | N -props | Object | - | Typescript：`FilterProps` `type FilterProps = RadioProps \| CheckboxProps \| InputProps \| { [key: string]: any }`，[Input API Documents](./input?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/table/type.ts) | N -resetValue | \- | - | Typescript：`any` | N +attrs | Object | - | html attributes of component。Typescript: `HTMLElementAttributes`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +classNames | String | - | component class names。Typescript: `ClassName`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +component | TElement | - | Typescript: `ComponentType`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +confirmEvents | Array | - | Typescript: `string[]` | N +list | Array | - | Typescript: `Array`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +popupProps | Object | - | Typescript: `PopupProps`，[Popup API Documents](./popup?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/table/type.ts) | N +props | Object | - | Typescript: `FilterProps` `type FilterProps = RadioProps \| CheckboxProps \| InputProps \| { [key: string]: any }`，[Input API Documents](./input?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/table/type.ts) | N +resetValue | \- | - | Typescript: `any` | N showConfirmAndReset | Boolean | false | \- | N -style | Object | - | styles of component。Typescript：`Styles`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -type | String | - | Typescript：`FilterType` `type FilterType = 'input' \| 'single' \| 'multiple'`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/table/type.ts) | N +style | Object | - | styles of component。Typescript: `Styles`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +type | String | - | Typescript: `FilterType` `type FilterType = 'input' \| 'single' \| 'multiple'`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/table/type.ts) | N ### TableColumnController name | type | default | description | required -- | -- | -- | -- | -- -buttonProps | Object | - | Typescript：`ButtonProps`，[Button API Documents](./button?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/table/type.ts) | N -checkboxProps | Object | - | Typescript：`CheckboxGroupProps`，[Checkbox API Documents](./checkbox?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/table/type.ts) | N -dialogProps | Object | - | Typescript：`DialogProps`，[Dialog API Documents](./dialog?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/table/type.ts) | N +buttonProps | Object | - | Typescript: `ButtonProps`，[Button API Documents](./button?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/table/type.ts) | N +checkboxProps | Object | - | Typescript: `CheckboxGroupProps`，[Checkbox API Documents](./checkbox?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/table/type.ts) | N +dialogProps | Object | - | Typescript: `DialogProps`，[Dialog API Documents](./dialog?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/table/type.ts) | N displayType | String | auto-width | options: fixed-width/auto-width | N -fields | Array | - | Typescript：`string[]` | N +fields | Array | - | Typescript: `string[]` | N hideTriggerButton | Boolean | false | \- | N placement | String | top-right | options: top-left/top-right/bottom-left/bottom-right | N @@ -259,16 +259,16 @@ placement | String | top-right | options: top-left/top-right/bottom-left/bottom- name | type | default | description | required -- | -- | -- | -- | -- -abortEditOnEvent | Array | - | Typescript：`string[]` | N -component | \- | - | component definition。Typescript：`ComponentType`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +abortEditOnEvent | Array | - | Typescript: `string[]` | N +component | \- | - | component definition。Typescript: `ComponentType`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N defaultEditable | Boolean | false | set default editable once | N keepEditMode | Boolean | false | set table cell always to be editable | N -on | Function | - | Typescript：`(context: TableEditableCellPropsParams) => { [eventName: string]: Function }` | N -onEdited | Function | - | trigger on finishing editing。Typescript：`(context: PrimaryTableOnEditedContext) => void` `type PrimaryTableOnEditedContext = PrimaryTableCellParams & { trigger: string; newRowData: T; }`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/table/type.ts) | N -props | Object | - | props of `edit.component`。Typescript：`TableEditableCellProps` `type TableEditableCellProps = TablePlainObject \| ((params: TableEditableCellPropsParams) => TablePlainObject)` `interface TableEditableCellPropsParams extends PrimaryTableCellParams { editedRow: T; updateEditedCellValue: (val: any) => void }` `interface TablePlainObject{ [key: string]: any }`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/table/type.ts) | N -rules | Array | - | form rules。Typescript：`TableEditableCellRules` `type TableEditableCellRules = FormRule[] \| ((params: PrimaryTableCellParams) => FormRule[])`，[Form API Documents](./form?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/table/type.ts) | N +on | Function | - | Typescript: `(context: TableEditableCellPropsParams) => { [eventName: string]: Function }` | N +onEdited | Function | - | trigger on finishing editing。Typescript: `(context: PrimaryTableOnEditedContext) => void` `type PrimaryTableOnEditedContext = PrimaryTableCellParams & { trigger: string; newRowData: T; }`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/table/type.ts) | N +props | Object | - | props of `edit.component`。Typescript: `TableEditableCellProps` `type TableEditableCellProps = TablePlainObject \| ((params: TableEditableCellPropsParams) => TablePlainObject)` `interface TableEditableCellPropsParams extends PrimaryTableCellParams { editedRow: T; updateEditedCellValue: (val: any) => void }` `interface TablePlainObject{ [key: string]: any }`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/table/type.ts) | N +rules | Array | - | form rules。Typescript: `TableEditableCellRules` `type TableEditableCellRules = FormRule[] \| ((params: PrimaryTableCellParams) => FormRule[])`，[Form API Documents](./form?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/table/type.ts) | N showEditIcon | Boolean | true | show edit icon | N -validateTrigger | String | 'exit' | when to trigger validate。Typescript：`'exit' \| 'change'` | N +validateTrigger | String | 'exit' | when to trigger validate。Typescript: `'exit' \| 'change'` | N ### TableTreeConfig diff --git a/packages/components/table/table.md b/packages/components/table/table.md index 1d1903dd7f..83828ad48a 100644 --- a/packages/components/table/table.md +++ b/packages/components/table/table.md @@ -3,7 +3,7 @@ ## API ### BaseTable Props -名称 | 类型 | 默认值 | 说明 | 必传 +名称 | 类型 | 默认值 | 描述 | 必传 -- | -- | -- | -- | -- className | String | - | 类名 | N style | Object | - | 样式，TS 类型：`React.CSSProperties` | N @@ -73,7 +73,7 @@ scrollToElement | `(params: ScrollToElementParams)` | \- | 必需。虚拟滚动 ### BaseTableCol -名称 | 类型 | 默认值 | 说明 | 必传 +名称 | 类型 | 默认值 | 描述 | 必传 -- | -- | -- | -- | -- align | String | left | 列横向对齐方式。可选项：left/right/center | N attrs | Object / Function | - | 透传 HTML 属性到列元素。TS 类型：`BaseTableColumnAttributes` `type BaseTableColumnAttributes = { [key: string]: any } \| ((context: CellData) => { [key: string]: any })`。[详细类型定义](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/table/type.ts) | N @@ -97,7 +97,7 @@ width | String / Number | - | 列宽，可以作为最小宽度使用。当列 ### PrimaryTable Props -名称 | 类型 | 默认值 | 说明 | 必传 +名称 | 类型 | 默认值 | 描述 | 必传 -- | -- | -- | -- | -- className | String | - | 类名 | N style | Object | - | 样式，TS 类型：`React.CSSProperties` | N @@ -160,7 +160,7 @@ validateTableData | \- | `Promise<{ result: TableErrorListMap }>` | 必需。校 ### PrimaryTableCol -名称 | 类型 | 默认值 | 说明 | 必传 +名称 | 类型 | 默认值 | 描述 | 必传 -- | -- | -- | -- | -- cell | String / Function | - | 自定义单元格渲染，优先级高于 render。泛型 T 指表格数据类型。TS 类型：`string \| TNode>` `interface PrimaryTableCellParams { row: T; rowIndex: number; col: PrimaryTableCol; colIndex: number }`。[通用类型定义](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts)。[详细类型定义](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/table/type.ts) | N checkProps | Object / Function | - | 透传参数，`colKey` 值为 `row-select` 时，配置有效。具体定义参考 Checkbox 组件 和 Radio 组件。泛型 T 指表格数据类型。TS 类型：`CheckProps` `type CheckProps = CheckboxProps \| RadioProps \| ((options: { row: T; rowIndex: number }) => CheckboxProps \| RadioProps)` `import { CheckboxProps } from '@Checkbox'`，[Radio API Documents](./radio?tab=api)。[详细类型定义](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/table/type.ts) | N @@ -178,7 +178,7 @@ type | String | single | `colKey` 值为 `row-select` 时表示行选中列， ### EnhancedTable Props -名称 | 类型 | 默认值 | 说明 | 必传 +名称 | 类型 | 默认值 | 描述 | 必传 -- | -- | -- | -- | -- className | String | - | 类名 | N style | Object | - | 样式，TS 类型：`React.CSSProperties` | N @@ -215,7 +215,7 @@ toggleExpandData | `(p: { row: T, rowIndex: number})` | \- | 必需。展开或 ### TableRowState -名称 | 类型 | 默认值 | 说明 | 必传 +名称 | 类型 | 默认值 | 描述 | 必传 -- | -- | -- | -- | -- disabled | Boolean | false | 表格行是否禁用选中 | N expandChildrenLength | Number | - | 当前节点展开的子节点数量 | N @@ -229,7 +229,7 @@ rowIndex | Number | - | 必需。表格行下标，值为 `-1` 标识当前行 ### TableColumnFilter -名称 | 类型 | 默认值 | 说明 | 必传 +名称 | 类型 | 默认值 | 描述 | 必传 -- | -- | -- | -- | -- attrs | Object | - | 用于透传筛选器属性到自定义组件 `component`，HTML 原生属性。TS 类型：`HTMLElementAttributes`。[通用类型定义](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N classNames | String | - | 透传类名到自定义组件 `component`。TS 类型：`ClassName`。[通用类型定义](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N @@ -245,7 +245,7 @@ type | String | - | 用于设置筛选器类型：单选按钮筛选器、复选 ### TableColumnController -名称 | 类型 | 默认值 | 说明 | 必传 +名称 | 类型 | 默认值 | 描述 | 必传 -- | -- | -- | -- | -- buttonProps | Object | - | 自定义列配置按钮，包括 Button 组件的全部属性。比如：按钮颜色和文本。TS 类型：`ButtonProps`，[Button API Documents](./button?tab=api)。[详细类型定义](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/table/type.ts) | N checkboxProps | Object | - | 透传复选框组件全部特性。TS 类型：`CheckboxGroupProps`，[Checkbox API Documents](./checkbox?tab=api)。[详细类型定义](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/table/type.ts) | N @@ -257,7 +257,7 @@ placement | String | top-right | 列配置按钮基于表格的放置位置： ### TableEditableCellConfig -名称 | 类型 | 默认值 | 说明 | 必传 +名称 | 类型 | 默认值 | 描述 | 必传 -- | -- | -- | -- | -- abortEditOnEvent | Array | - | 除了点击非自身元素退出编辑态之外，还有哪些事件退出编辑态。示例：`abortEditOnEvent: ['onChange']`。TS 类型：`string[]` | N component | \- | - | 组件定义，如：`Input` `Select`。对于完全自定义的组件（非组件库内的组件），组件需要支持 `value` 和 `onChange` ；如果还需要支持校验规则，则组件还需实现 `tips` 和 `status` 两个 API，实现规则可参考 `Input` 组件。TS 类型：`ComponentType`。[通用类型定义](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N @@ -272,7 +272,7 @@ validateTrigger | String | 'exit' | 触发校验的时机，有 2 种：退出 ### TableTreeConfig -名称 | 类型 | 默认值 | 说明 | 必传 +名称 | 类型 | 默认值 | 描述 | 必传 -- | -- | -- | -- | -- checkStrictly | Boolean | false | 表示树形结构的行选中（多选），父子行选中是否独立 | N childrenKey | String | children | 树形结构子节点字段，示例：`childrenKey='list'`。一般应用在数据 `data` 的子节点字段不是 `children` 的场景 | N @@ -283,7 +283,7 @@ treeNodeColumnIndex | Number | 0 | 树结点在第几列渲染，默认为第一 ### TScroll -名称 | 类型 | 默认值 | 说明 | 必传 +名称 | 类型 | 默认值 | 描述 | 必传 -- | -- | -- | -- | -- bufferSize | Number | 20 | 表示除可视区域外，额外渲染的行数，避免快速滚动过程中，新出现的内容来不及渲染从而出现空白 | N isFixedRowHeight | Boolean | false | 表示每行内容是否同一个固定高度，仅在 `scroll.type` 为 `virtual` 时有效，该属性设置为 `true` 时，可用于简化虚拟滚动内部计算逻辑，提升性能，此时则需要明确指定 `scroll.rowHeight` 属性的值 | N diff --git a/packages/components/tabs/tabs.en-US.md b/packages/components/tabs/tabs.en-US.md index ca7b52f67d..68cb6d6281 100644 --- a/packages/components/tabs/tabs.en-US.md +++ b/packages/components/tabs/tabs.en-US.md @@ -7,22 +7,22 @@ name | type | default | description | required -- | -- | -- | -- | -- className | String | - | className of component | N -style | Object | - | CSS(Cascading Style Sheets)，Typescript：`React.CSSProperties` | N -action | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +style | Object | - | CSS(Cascading Style Sheets)，Typescript: `React.CSSProperties` | N +action | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N addable | Boolean | false | \- | N disabled | Boolean | false | \- | N dragSort | Boolean | false | \- | N -list | Array | - | Typescript：`Array` | N +list | Array | - | Typescript: `Array` | N placement | String | top | options: left/top/bottom/right | N scrollPosition | String | auto | The final position where the tab item stops scrolling after being selected.。options: auto/start/center/end | N size | String | medium | options: medium/large | N theme | String | normal | options: normal/card | N -value | String / Number | - | Typescript：`TabValue` `type TabValue = string \| number`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/tabs/type.ts) | N -defaultValue | String / Number | - | uncontrolled property。Typescript：`TabValue` `type TabValue = string \| number`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/tabs/type.ts) | N -onAdd | Function | | Typescript：`(context: { e: MouseEvent }) => void`
| N -onChange | Function | | Typescript：`(value: TabValue) => void`
| N -onDragSort | Function | | Typescript：`(context: TabsDragSortContext) => void`
trigger on drag sort。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/tabs/type.ts)。
`interface TabsDragSortContext { currentIndex: number; current: TabValue; targetIndex: number; target: TabValue }`
| N -onRemove | Function | | Typescript：`(options: { value: TabValue; index: number; e: MouseEvent }) => void`
| N +value | String / Number | - | Typescript: `TabValue` `type TabValue = string \| number`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/tabs/type.ts) | N +defaultValue | String / Number | - | uncontrolled property。Typescript: `TabValue` `type TabValue = string \| number`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/tabs/type.ts) | N +onAdd | Function | | Typescript: `(context: { e: MouseEvent }) => void`
| N +onChange | Function | | Typescript: `(value: TabValue) => void`
| N +onDragSort | Function | | Typescript: `(context: TabsDragSortContext) => void`
trigger on drag sort。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/tabs/type.ts)。
`interface TabsDragSortContext { currentIndex: number; current: TabValue; targetIndex: number; target: TabValue }`
| N +onRemove | Function | | Typescript: `(options: { value: TabValue; index: number; e: MouseEvent }) => void`
| N ### TabPanel Props @@ -30,13 +30,13 @@ onRemove | Function | | Typescript：`(options: { value: TabValue; index: numbe name | type | default | description | required -- | -- | -- | -- | -- className | String | - | className of component | N -style | Object | - | CSS(Cascading Style Sheets)，Typescript：`React.CSSProperties` | N +style | Object | - | CSS(Cascading Style Sheets)，Typescript: `React.CSSProperties` | N destroyOnHide | Boolean | true | \- | N disabled | Boolean | false | \- | N draggable | Boolean | true | \- | N -label | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +label | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N lazy | Boolean | | Enable tab lazy loading | N -panel | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +panel | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N removable | Boolean | false | \- | N -value | String / Number | - | Typescript：`TabValue` | N -onRemove | Function | | Typescript：`(options: { value: TabValue; e: MouseEvent }) => void`
| N +value | String / Number | - | Typescript: `TabValue` | N +onRemove | Function | | Typescript: `(options: { value: TabValue; e: MouseEvent }) => void`
| N diff --git a/packages/components/tag-input/tag-input.en-US.md b/packages/components/tag-input/tag-input.en-US.md index 2610ca6507..a9ee2e6e1c 100644 --- a/packages/components/tag-input/tag-input.en-US.md +++ b/packages/components/tag-input/tag-input.en-US.md @@ -7,43 +7,43 @@ name | type | default | description | required -- | -- | -- | -- | -- className | String | - | className of component | N -style | Object | - | CSS(Cascading Style Sheets)，Typescript：`React.CSSProperties` | N +style | Object | - | CSS(Cascading Style Sheets)，Typescript: `React.CSSProperties` | N autoWidth | Boolean | false | \- | N borderless | Boolean | false | \- | N clearable | Boolean | false | \- | N -collapsedItems | TElement | - | Typescript：`TNode<{ value: TagInputValue; collapsedSelectedItems: TagInputValue; count: number; onClose: (context: { index: number, e?: MouseEvent }) => void }>`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +collapsedItems | TElement | - | Typescript: `TNode<{ value: TagInputValue; collapsedSelectedItems: TagInputValue; count: number; onClose: (context: { index: number, e?: MouseEvent }) => void }>`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N disabled | Boolean | - | \- | N dragSort | Boolean | false | \- | N excessTagsDisplayType | String | break-line | options: scroll/break-line | N -inputProps | Object | - | Typescript：`InputProps`，[Input API Documents](./input?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/tag-input/type.ts) | N -inputValue | String / Number | '' | input value。Typescript：`string` | N -defaultInputValue | String / Number | '' | input value。uncontrolled property。Typescript：`string` | N -label | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +inputProps | Object | - | Typescript: `InputProps`，[Input API Documents](./input?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/tag-input/type.ts) | N +inputValue | String / Number | '' | input value。Typescript: `string` | N +defaultInputValue | String / Number | '' | input value。uncontrolled property。Typescript: `string` | N +label | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N max | Number | - | max tag number | N maxRows | Number | - | max tag rows | N minCollapsedNum | Number | 0 | \- | N placeholder | String | undefined | placeholder description | N -prefixIcon | TElement | - | Typescript：`TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +prefixIcon | TElement | - | Typescript: `TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N readonly | Boolean | false | \- | N -size | String | medium | options: small/medium/large。Typescript：`SizeEnum`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +size | String | medium | options: small/medium/large。Typescript: `SizeEnum`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N status | String | - | options: default/success/warning/error | N -suffix | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -suffixIcon | TElement | - | Typescript：`TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -tag | TNode | - | Typescript：`string \| TNode<{ value: string \| number }>`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -tagProps | Object | - | Typescript：`TagProps`，[Tag API Documents](./tag?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/tag-input/type.ts) | N -tips | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -value | Array | [] | value。Typescript：`TagInputValue` `type TagInputValue = Array`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/tag-input/type.ts) | N -defaultValue | Array | [] | value。uncontrolled property。Typescript：`TagInputValue` `type TagInputValue = Array`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/tag-input/type.ts) | N -valueDisplay | TNode | - | Typescript：`string \| TNode<{ value: TagInputValue; onClose: (index: number, item?: any) => void }>`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -onBlur | Function | | Typescript：`(value: TagInputValue, context: { inputValue: string; e: FocusEvent }) => void`
trigger on blur | N -onChange | Function | | Typescript：`(value: TagInputValue, context: TagInputChangeContext) => void`
[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/tag-input/type.ts)。
`interface TagInputChangeContext { trigger: TagInputTriggerSource; index?: number; item?: string \| number; e?: MouseEvent \| KeyboardEvent }`

`type TagInputTriggerSource = 'enter' \| 'tag-remove' \| 'backspace' \| 'clear'`
| N -onClear | Function | | Typescript：`(context: { e: MouseEvent }) => void`
| N -onClick | Function | | Typescript：`(context: { e: MouseEvent }) => void`
| N -onDragSort | Function | | Typescript：`(context: TagInputDragSortContext) => void`
trigger on drag sort。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/tag-input/type.ts)。
`interface TagInputDragSortContext { newTags: TagInputValue; currentIndex: number; current: string \| number; targetIndex: number; target: string \| number }`
| N -onEnter | Function | | Typescript：`(value: TagInputValue, context: { e: KeyboardEvent; inputValue: string }) => void`
| N -onFocus | Function | | Typescript：`(value: TagInputValue, context: { inputValue: string; e: FocusEvent }) => void`
trigger on focus | N -onInputChange | Function | | Typescript：`(value: string, context?: InputValueChangeContext) => void`
[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/tag-input/type.ts)。
`interface InputValueChangeContext { e?: InputEvent \| MouseEvent \| CompositionEvent \| KeyboardEvent; trigger: 'input' \| 'clear' \| 'enter' \| 'blur' }`
| N -onMouseenter | Function | | Typescript：`(context: { e: MouseEvent }) => void`
trigger on mouseenter | N -onMouseleave | Function | | Typescript：`(context: { e: MouseEvent }) => void`
trigger on mouseleave | N -onPaste | Function | | Typescript：`(context: { e: ClipboardEvent; pasteValue: string }) => void`
| N -onRemove | Function | | Typescript：`(context: TagInputRemoveContext) => void`
[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/tag-input/type.ts)。
`interface TagInputRemoveContext { value: TagInputValue; index: number; item: string \| number; e?: MouseEvent \| KeyboardEvent; trigger: TagInputRemoveTrigger }`

`type TagInputRemoveTrigger = 'tag-remove' \| 'backspace'`
| N +suffix | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +suffixIcon | TElement | - | Typescript: `TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +tag | TNode | - | Typescript: `string \| TNode<{ value: string \| number }>`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +tagProps | Object | - | Typescript: `TagProps`，[Tag API Documents](./tag?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/tag-input/type.ts) | N +tips | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +value | Array | [] | value。Typescript: `TagInputValue` `type TagInputValue = Array`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/tag-input/type.ts) | N +defaultValue | Array | [] | value。uncontrolled property。Typescript: `TagInputValue` `type TagInputValue = Array`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/tag-input/type.ts) | N +valueDisplay | TNode | - | Typescript: `string \| TNode<{ value: TagInputValue; onClose: (index: number, item?: any) => void }>`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +onBlur | Function | | Typescript: `(value: TagInputValue, context: { inputValue: string; e: FocusEvent }) => void`
trigger on blur | N +onChange | Function | | Typescript: `(value: TagInputValue, context: TagInputChangeContext) => void`
[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/tag-input/type.ts)。
`interface TagInputChangeContext { trigger: TagInputTriggerSource; index?: number; item?: string \| number; e?: MouseEvent \| KeyboardEvent }`

`type TagInputTriggerSource = 'enter' \| 'tag-remove' \| 'backspace' \| 'clear'`
| N +onClear | Function | | Typescript: `(context: { e: MouseEvent }) => void`
| N +onClick | Function | | Typescript: `(context: { e: MouseEvent }) => void`
| N +onDragSort | Function | | Typescript: `(context: TagInputDragSortContext) => void`
trigger on drag sort。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/tag-input/type.ts)。
`interface TagInputDragSortContext { newTags: TagInputValue; currentIndex: number; current: string \| number; targetIndex: number; target: string \| number }`
| N +onEnter | Function | | Typescript: `(value: TagInputValue, context: { e: KeyboardEvent; inputValue: string }) => void`
| N +onFocus | Function | | Typescript: `(value: TagInputValue, context: { inputValue: string; e: FocusEvent }) => void`
trigger on focus | N +onInputChange | Function | | Typescript: `(value: string, context?: InputValueChangeContext) => void`
[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/tag-input/type.ts)。
`interface InputValueChangeContext { e?: InputEvent \| MouseEvent \| CompositionEvent \| KeyboardEvent; trigger: 'input' \| 'clear' \| 'enter' \| 'blur' }`
| N +onMouseenter | Function | | Typescript: `(context: { e: MouseEvent }) => void`
trigger on mouseenter | N +onMouseleave | Function | | Typescript: `(context: { e: MouseEvent }) => void`
trigger on mouseleave | N +onPaste | Function | | Typescript: `(context: { e: ClipboardEvent; pasteValue: string }) => void`
| N +onRemove | Function | | Typescript: `(context: TagInputRemoveContext) => void`
[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/tag-input/type.ts)。
`interface TagInputRemoveContext { value: TagInputValue; index: number; item: string \| number; e?: MouseEvent \| KeyboardEvent; trigger: TagInputRemoveTrigger }`

`type TagInputRemoveTrigger = 'tag-remove' \| 'backspace'`
| N diff --git a/packages/components/tag/tag.en-US.md b/packages/components/tag/tag.en-US.md index 29fac5e844..bec2a8e0fa 100644 --- a/packages/components/tag/tag.en-US.md +++ b/packages/components/tag/tag.en-US.md @@ -7,21 +7,21 @@ name | type | default | description | required -- | -- | -- | -- | -- className | String | - | className of component | N -style | Object | - | CSS(Cascading Style Sheets)，Typescript：`React.CSSProperties` | N -children | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +style | Object | - | CSS(Cascading Style Sheets)，Typescript: `React.CSSProperties` | N +children | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N closable | Boolean | false | \- | N color | String | - | self-defined tag color | N -content | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +content | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N disabled | Boolean | false | \- | N -icon | TElement | undefined | Typescript：`TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +icon | TElement | undefined | Typescript: `TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N maxWidth | String / Number | - | \- | N shape | String | square | options: square/round/mark | N -size | String | medium | options: small/medium/large。Typescript：`SizeEnum`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +size | String | medium | options: small/medium/large。Typescript: `SizeEnum`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N theme | String | default | options: default/primary/warning/danger/success | N title | String | - | title of tag | N variant | String | dark | options: dark/light/outline/light-outline | N -onClick | Function | | Typescript：`(context: { e: MouseEvent }) => void`
| N -onClose | Function | | Typescript：`(context: { e: MouseEvent }) => void`
| N +onClick | Function | | Typescript: `(context: { e: MouseEvent }) => void`
| N +onClose | Function | | Typescript: `(context: { e: MouseEvent }) => void`
| N ### CheckTag Props @@ -29,18 +29,18 @@ onClose | Function | | Typescript：`(context: { e: MouseEvent }) => void`
name | type | default | description | required -- | -- | -- | -- | -- className | String | - | className of component | N -style | Object | - | CSS(Cascading Style Sheets)，Typescript：`React.CSSProperties` | N +style | Object | - | CSS(Cascading Style Sheets)，Typescript: `React.CSSProperties` | N checked | Boolean | - | \- | N defaultChecked | Boolean | - | uncontrolled property | N -checkedProps | Object | - | used to set checked tag props。Typescript：`TdTagProps` | N -children | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -content | TNode | - | Typescript：`string \| number \| string[] \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +checkedProps | Object | - | used to set checked tag props。Typescript: `TdTagProps` | N +children | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +content | TNode | - | Typescript: `string \| number \| string[] \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N disabled | Boolean | false | \- | N -size | String | medium | options: small/medium/large。Typescript：`SizeEnum`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -uncheckedProps | Object | - | used to set unchecked tag props。Typescript：`TdTagProps` | N +size | String | medium | options: small/medium/large。Typescript: `SizeEnum`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +uncheckedProps | Object | - | used to set unchecked tag props。Typescript: `TdTagProps` | N value | String / Number | - | tag unique key | N -onChange | Function | | Typescript：`(checked: boolean, context: CheckTagChangeContext) => void`
[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/tag/type.ts)。
`interface CheckTagChangeContext { e: MouseEvent \| KeyboardEvent; value: string \| number }`
| N -onClick | Function | | Typescript：`(context: { e: MouseEvent }) => void`
| N +onChange | Function | | Typescript: `(checked: boolean, context: CheckTagChangeContext) => void`
[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/tag/type.ts)。
`interface CheckTagChangeContext { e: MouseEvent \| KeyboardEvent; value: string \| number }`
| N +onClick | Function | | Typescript: `(context: { e: MouseEvent }) => void`
| N ### CheckTagGroup Props @@ -48,11 +48,11 @@ onClick | Function | | Typescript：`(context: { e: MouseEvent }) => void`
name | type | default | description | required -- | -- | -- | -- | -- className | String | - | className of component | N -style | Object | - | CSS(Cascading Style Sheets)，Typescript：`React.CSSProperties` | N -checkedProps | Object | - | used to set checked tag props。Typescript：`TdTagProps` | N +style | Object | - | CSS(Cascading Style Sheets)，Typescript: `React.CSSProperties` | N +checkedProps | Object | - | used to set checked tag props。Typescript: `TdTagProps` | N multiple | Boolean | false | allow to select multiple tags | N -options | Array | - | tag list。Typescript：`CheckTagGroupOption[]` `interface CheckTagGroupOption extends TdCheckTagProps { label: string \| TNode; value: string \| number }`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/tag/type.ts) | N -uncheckedProps | Object | - | used to set unchecked tag props。Typescript：`TdTagProps` | N -value | Array | [] | selected tag value list。Typescript：`CheckTagGroupValue` `type CheckTagGroupValue = Array`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/tag/type.ts) | N -defaultValue | Array | [] | selected tag value list。uncontrolled property。Typescript：`CheckTagGroupValue` `type CheckTagGroupValue = Array`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/tag/type.ts) | N -onChange | Function | | Typescript：`(value: CheckTagGroupValue, context: CheckTagGroupChangeContext) => void`
[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/tag/type.ts)。
`interface CheckTagGroupChangeContext { type: 'check' \| 'uncheck'; e: MouseEvent \| KeyboardEvent; value: string \| number }`
| N +options | Array | - | tag list。Typescript: `CheckTagGroupOption[]` `interface CheckTagGroupOption extends TdCheckTagProps { label: string \| TNode; value: string \| number }`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/tag/type.ts) | N +uncheckedProps | Object | - | used to set unchecked tag props。Typescript: `TdTagProps` | N +value | Array | [] | selected tag value list。Typescript: `CheckTagGroupValue` `type CheckTagGroupValue = Array`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/tag/type.ts) | N +defaultValue | Array | [] | selected tag value list。uncontrolled property。Typescript: `CheckTagGroupValue` `type CheckTagGroupValue = Array`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/tag/type.ts) | N +onChange | Function | | Typescript: `(value: CheckTagGroupValue, context: CheckTagGroupChangeContext) => void`
[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/tag/type.ts)。
`interface CheckTagGroupChangeContext { type: 'check' \| 'uncheck'; e: MouseEvent \| KeyboardEvent; value: string \| number }`
| N diff --git a/packages/components/textarea/textarea.en-US.md b/packages/components/textarea/textarea.en-US.md index afcc90dbfd..07676401ea 100644 --- a/packages/components/textarea/textarea.en-US.md +++ b/packages/components/textarea/textarea.en-US.md @@ -5,25 +5,25 @@ name | type | default | description | required -- | -- | -- | -- | -- -className | String | - | 类名 | N -style | Object | - | 样式，Typescript：`React.CSSProperties` | N +className | String | - | className of component | N +style | Object | - | CSS(Cascading Style Sheets)，Typescript: `React.CSSProperties` | N allowInputOverMax | Boolean | false | \- | N autofocus | Boolean | false | \- | N -autosize | Boolean / Object | false | Typescript：`boolean \| { minRows?: number; maxRows?: number }` | N +autosize | Boolean / Object | false | Typescript: `boolean \| { minRows?: number; maxRows?: number }` | N disabled | Boolean | false | \- | N -label | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +label | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N maxcharacter | Number | - | \- | N maxlength | Number | - | \- | N name | String | - | \- | N placeholder | String | undefined | \- | N readonly | Boolean | false | \- | N status | String | - | options：default/success/warning/error | N -tips | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -value | String / Number | - | Typescript：`TextareaValue` `type TextareaValue = string`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/textarea/type.ts) | N -defaultValue | String / Number | - | uncontrolled property。Typescript：`TextareaValue` `type TextareaValue = string`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/textarea/type.ts) | N -onBlur | Function | | Typescript：`(value: TextareaValue, context: { e: FocusEvent }) => void`
| N -onChange | Function | | Typescript：`(value: TextareaValue, context?: { e?: InputEvent }) => void`
| N -onFocus | Function | | Typescript：`(value: TextareaValue, context : { e: FocusEvent }) => void`
| N -onKeydown | Function | | Typescript：`(value: TextareaValue, context: { e: KeyboardEvent }) => void`
| N -onKeypress | Function | | Typescript：`(value: TextareaValue, context: { e: KeyboardEvent }) => void`
| N -onKeyup | Function | | Typescript：`(value: TextareaValue, context: { e: KeyboardEvent }) => void`
| N +tips | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +value | String / Number | - | Typescript: `TextareaValue` `type TextareaValue = string`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/textarea/type.ts) | N +defaultValue | String / Number | - | uncontrolled property。Typescript: `TextareaValue` `type TextareaValue = string`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/textarea/type.ts) | N +onBlur | Function | | Typescript: `(value: TextareaValue, context: { e: FocusEvent }) => void`
| N +onChange | Function | | Typescript: `(value: TextareaValue, context?: { e?: InputEvent }) => void`
| N +onFocus | Function | | Typescript: `(value: TextareaValue, context : { e: FocusEvent }) => void`
| N +onKeydown | Function | | Typescript: `(value: TextareaValue, context: { e: KeyboardEvent }) => void`
| N +onKeypress | Function | | Typescript: `(value: TextareaValue, context: { e: KeyboardEvent }) => void`
| N +onKeyup | Function | | Typescript: `(value: TextareaValue, context: { e: KeyboardEvent }) => void`
| N diff --git a/packages/components/textarea/textarea.md b/packages/components/textarea/textarea.md index fa69ce30ec..13762b06bd 100644 --- a/packages/components/textarea/textarea.md +++ b/packages/components/textarea/textarea.md @@ -3,7 +3,7 @@ ## API ### Textarea Props -名称 | 类型 | 默认值 | 说明 | 必传 +名称 | 类型 | 默认值 | 描述 | 必传 -- | -- | -- | -- | -- className | String | - | 类名 | N style | Object | - | 样式，TS 类型：`React.CSSProperties` | N diff --git a/packages/components/time-picker/time-picker.en-US.md b/packages/components/time-picker/time-picker.en-US.md index 57553b6b49..bad47aab28 100644 --- a/packages/components/time-picker/time-picker.en-US.md +++ b/packages/components/time-picker/time-picker.en-US.md @@ -7,33 +7,33 @@ name | type | default | description | required -- | -- | -- | -- | -- className | String | - | className of component | N -style | Object | - | CSS(Cascading Style Sheets)，Typescript：`React.CSSProperties` | N +style | Object | - | CSS(Cascading Style Sheets)，Typescript: `React.CSSProperties` | N allowInput | Boolean | false | \- | N borderless | Boolean | false | \- | N clearable | Boolean | false | \- | N -disableTime | Function | - | disable time config function。Typescript：`(h: number, m: number, s: number, ms: number) => Partial<{ hour: Array, minute: Array, second: Array, millisecond: Array }>` | N +disableTime | Function | - | disable time config function。Typescript: `(h: number, m: number, s: number, ms: number) => Partial<{ hour: Array, minute: Array, second: Array, millisecond: Array }>` | N disabled | Boolean | false | \- | N format | String | HH:mm:ss | \- | N hideDisabledTime | Boolean | true | \- | N -inputProps | Object | - | Typescript：`InputProps`，[Input API Documents](./input?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/time-picker/type.ts) | N -label | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +inputProps | Object | - | Typescript: `InputProps`，[Input API Documents](./input?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/time-picker/type.ts) | N +label | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N placeholder | String | undefined | \- | N -popupProps | Object | - | Typescript：`PopupProps`，[Popup API Documents](./popup?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/time-picker/type.ts) | N -presets | Object | - | Typescript：`PresetTime` `interface PresetTime { [presetName: string]: TimePickerValue \| (() => TimePickerValue) }`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/time-picker/type.ts) | N +popupProps | Object | - | Typescript: `PopupProps`，[Popup API Documents](./popup?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/time-picker/type.ts) | N +presets | Object | - | Typescript: `PresetTime` `interface PresetTime { [presetName: string]: TimePickerValue \| (() => TimePickerValue) }`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/time-picker/type.ts) | N size | String | medium | options: small/medium/large | N status | String | default | options: default/success/warning/error | N -steps | Array | [1, 1, 1] | Typescript：`Array` | N -tips | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -value | String | - | Typescript：`TimePickerValue` `type TimePickerValue = string`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/time-picker/type.ts) | N -defaultValue | String | - | uncontrolled property。Typescript：`TimePickerValue` `type TimePickerValue = string`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/time-picker/type.ts) | N -onBlur | Function | | Typescript：`(context: { value: TimePickerValue; e: FocusEvent }) => void`
| N -onChange | Function | | Typescript：`(value: TimePickerValue) => void`
| N -onClear | Function | | Typescript：`(context: { e: MouseEvent }) => void`
Triggered when the clear button is clicked | N -onClose | Function | | Typescript：`(context: { e: MouseEvent }) => void`
| N -onFocus | Function | | Typescript：`(context: { value: TimePickerValue; e: FocusEvent }) => void`
| N -onInput | Function | | Typescript：`(context: { value: TimePickerValue; e: InputEvent }) => void`
| N -onOpen | Function | | Typescript：`(context: { e: MouseEvent }) => void`
| N -onPick | Function | | Typescript：`(value: TimePickerValue, context: { e: MouseEvent }) => void`
| N +steps | Array | [1, 1, 1] | Typescript: `Array` | N +tips | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +value | String | - | Typescript: `TimePickerValue` `type TimePickerValue = string`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/time-picker/type.ts) | N +defaultValue | String | - | uncontrolled property。Typescript: `TimePickerValue` `type TimePickerValue = string`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/time-picker/type.ts) | N +onBlur | Function | | Typescript: `(context: { value: TimePickerValue; e: FocusEvent }) => void`
| N +onChange | Function | | Typescript: `(value: TimePickerValue) => void`
| N +onClear | Function | | Typescript: `(context: { e: MouseEvent }) => void`
Triggered when the clear button is clicked | N +onClose | Function | | Typescript: `(context: { e: MouseEvent }) => void`
| N +onFocus | Function | | Typescript: `(context: { value: TimePickerValue; e: FocusEvent }) => void`
| N +onInput | Function | | Typescript: `(context: { value: TimePickerValue; e: InputEvent }) => void`
| N +onOpen | Function | | Typescript: `(context: { e: MouseEvent }) => void`
| N +onPick | Function | | Typescript: `(value: TimePickerValue, context: { e: MouseEvent }) => void`
| N ### TimeRangePicker Props @@ -41,28 +41,28 @@ onPick | Function | | Typescript：`(value: TimePickerValue, context: { e: Mous name | type | default | description | required -- | -- | -- | -- | -- className | String | - | className of component | N -style | Object | - | CSS(Cascading Style Sheets)，Typescript：`React.CSSProperties` | N +style | Object | - | CSS(Cascading Style Sheets)，Typescript: `React.CSSProperties` | N allowInput | Boolean | false | \- | N autoSwap | Boolean | true | \- | N borderless | Boolean | false | \- | N clearable | Boolean | false | \- | N -disableTime | Function | - | Typescript：`(h: number, m: number, s: number, context: { partial: TimeRangePickerPartial }) =>Partial<{ hour: Array, minute: Array, second: Array }>` `type TimeRangePickerPartial = 'start' \| 'end'`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/time-picker/type.ts) | N -disabled | Boolean / Array | false | Typescript：`boolean \| Array` | N +disableTime | Function | - | Typescript: `(h: number, m: number, s: number, context: { partial: TimeRangePickerPartial }) =>Partial<{ hour: Array, minute: Array, second: Array }>` `type TimeRangePickerPartial = 'start' \| 'end'`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/time-picker/type.ts) | N +disabled | Boolean / Array | false | Typescript: `boolean \| Array` | N format | String | HH:mm:ss | \- | N hideDisabledTime | Boolean | true | \- | N -label | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -placeholder | String / Array | undefined | Typescript：`string \| Array` | N -popupProps | Object | - | Typescript：`PopupProps`，[Popup API Documents](./popup?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/time-picker/type.ts) | N -presets | Object | - | Typescript：`PresetTimeRange` `interface PresetTimeRange { [presetRageName: string]: TimeRangeValue \| (() => TimeRangeValue)}`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/time-picker/type.ts) | N -rangeInputProps | Object | - | Typescript：`RangeInputProps`，[RangeInput API Documents](./range-input?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/time-picker/type.ts) | N +label | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +placeholder | String / Array | undefined | Typescript: `string \| Array` | N +popupProps | Object | - | Typescript: `PopupProps`，[Popup API Documents](./popup?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/time-picker/type.ts) | N +presets | Object | - | Typescript: `PresetTimeRange` `interface PresetTimeRange { [presetRageName: string]: TimeRangeValue \| (() => TimeRangeValue)}`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/time-picker/type.ts) | N +rangeInputProps | Object | - | Typescript: `RangeInputProps`，[RangeInput API Documents](./range-input?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/time-picker/type.ts) | N size | String | medium | options: small/medium/large | N status | String | default | options: default/success/warning/error | N -steps | Array | [1, 1, 1] | Typescript：`Array` | N -tips | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -value | Array | - | Typescript：`TimeRangeValue` `type TimeRangeValue = Array`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/time-picker/type.ts) | N -defaultValue | Array | - | uncontrolled property。Typescript：`TimeRangeValue` `type TimeRangeValue = Array`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/time-picker/type.ts) | N -onBlur | Function | | Typescript：`(context: { value: TimeRangeValue; e?: FocusEvent; position?: TimeRangePickerPartial }) => void`
[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/time-picker/type.ts)。
`type TimeRangePickerPartial = 'start' \| 'end'`
| N -onChange | Function | | Typescript：`(value: TimeRangeValue) => void`
| N -onFocus | Function | | Typescript：`(context?: { value: TimeRangeValue; e?: FocusEvent; position?: TimeRangePickerPartial }) => void`
[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/time-picker/type.ts)。
`type TimeRangePickerPartial = 'start' \| 'end'`
| N -onInput | Function | | Typescript：`(context: { value: TimeRangeValue; e?: InputEvent; position?: TimeRangePickerPartial }) => void`
[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/time-picker/type.ts)。
`type TimeRangePickerPartial = 'start' \| 'end'`
| N -onPick | Function | | Typescript：`(value: TimeRangeValue, context: { e: MouseEvent, position?: TimeRangePickerPartial }) => void`
| N +steps | Array | [1, 1, 1] | Typescript: `Array` | N +tips | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +value | Array | - | Typescript: `TimeRangeValue` `type TimeRangeValue = Array`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/time-picker/type.ts) | N +defaultValue | Array | - | uncontrolled property。Typescript: `TimeRangeValue` `type TimeRangeValue = Array`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/time-picker/type.ts) | N +onBlur | Function | | Typescript: `(context: { value: TimeRangeValue; e?: FocusEvent; position?: TimeRangePickerPartial }) => void`
[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/time-picker/type.ts)。
`type TimeRangePickerPartial = 'start' \| 'end'`
| N +onChange | Function | | Typescript: `(value: TimeRangeValue) => void`
| N +onFocus | Function | | Typescript: `(context?: { value: TimeRangeValue; e?: FocusEvent; position?: TimeRangePickerPartial }) => void`
[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/time-picker/type.ts)。
`type TimeRangePickerPartial = 'start' \| 'end'`
| N +onInput | Function | | Typescript: `(context: { value: TimeRangeValue; e?: InputEvent; position?: TimeRangePickerPartial }) => void`
[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/time-picker/type.ts)。
`type TimeRangePickerPartial = 'start' \| 'end'`
| N +onPick | Function | | Typescript: `(value: TimeRangeValue, context: { e: MouseEvent, position?: TimeRangePickerPartial }) => void`
| N diff --git a/packages/components/timeline/timeline.en-US.md b/packages/components/timeline/timeline.en-US.md index a01d2838c3..ca0640d9cf 100644 --- a/packages/components/timeline/timeline.en-US.md +++ b/packages/components/timeline/timeline.en-US.md @@ -5,8 +5,8 @@ name | type | default | description | required -- | -- | -- | -- | -- -className | String | - | 类名 | N -style | Object | - | 样式，Typescript：`React.CSSProperties` | N +className | String | - | className of component | N +style | Object | - | CSS(Cascading Style Sheets)，Typescript: `React.CSSProperties` | N labelAlign | String | left | label info placement。options：left/right/alternate/top/bottom | N layout | String | vertical | time line layout。options：horizontal/vertical | N mode | String | alternate | The position relationship between the label and the content text, 'alternate' is displayed on both sides of the axis, and 'same' is displayed on the same side。options：alternate/same | N @@ -17,13 +17,13 @@ theme | String | default | options：default/dot | N name | type | default | description | required -- | -- | -- | -- | -- -className | String | - | 类名 | N -style | Object | - | 样式，Typescript：`React.CSSProperties` | N -children | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -content | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -dot | TElement | - | Typescript：`TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -dotColor | String | primary | Typescript：`string` | N -label | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +className | String | - | className of component | N +style | Object | - | CSS(Cascading Style Sheets)，Typescript: `React.CSSProperties` | N +children | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +content | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +dot | TElement | - | Typescript: `TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +dotColor | String | primary | Typescript: `string` | N +label | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N labelAlign | String | - | options：left/right/top/bottom | N loading | Boolean | - | Whether it is in the loading state | N -onClick | Function | | Typescript：`(context: { e: MouseEvent; item: TdTimelineItemProps }) => void` [TdTimelineItemProps 详细类型定义](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/timeline/type.ts)
trigger on click. | N +onClick | Function | | Typescript: `(context: { e: MouseEvent; item: TdTimelineItemProps }) => void` [TdTimelineItemProps 详细类型定义](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/timeline/type.ts)
trigger on click. | N diff --git a/packages/components/timeline/timeline.md b/packages/components/timeline/timeline.md index 190bf3282b..70fe485651 100644 --- a/packages/components/timeline/timeline.md +++ b/packages/components/timeline/timeline.md @@ -3,7 +3,7 @@ ## API ### Timeline Props -名称 | 类型 | 默认值 | 说明 | 必传 +名称 | 类型 | 默认值 | 描述 | 必传 -- | -- | -- | -- | -- className | String | - | 类名 | N style | Object | - | 样式，TS 类型：`React.CSSProperties` | N @@ -15,7 +15,7 @@ theme | String | default | 时间轴风格。可选项：default/dot | N ### TimelineItem Props -名称 | 类型 | 默认值 | 说明 | 必传 +名称 | 类型 | 默认值 | 描述 | 必传 -- | -- | -- | -- | -- className | String | - | 类名 | N style | Object | - | 样式，TS 类型：`React.CSSProperties` | N diff --git a/packages/components/tooltip/tooltip.en-US.md b/packages/components/tooltip/tooltip.en-US.md index c4b8fb3f57..0bd1ae4e88 100644 --- a/packages/components/tooltip/tooltip.en-US.md +++ b/packages/components/tooltip/tooltip.en-US.md @@ -27,10 +27,10 @@ Currently, this can be solved by `Fragment` or other `HTML` elements name | type | default | description | required -- | -- | -- | -- | -- -delay | Number / Array | - | delay to show or hide popover。Typescript：`number \| Array` | N +delay | Number / Array | - | delay to show or hide popover。Typescript: `number \| Array` | N destroyOnClose | Boolean | true | \- | N duration | Number | - | \- | N -placement | String | top | Typescript：`PopupPlacement`，[Popup API Documents](./popup?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/tooltip/type.ts) | N +placement | String | top | Typescript: `PopupPlacement`，[Popup API Documents](./popup?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/tooltip/type.ts) | N showArrow | Boolean | true | \- | N theme | String | default | options：default/primary/success/danger/warning/light | N `PopupProps` | \- | - | \- | N @@ -39,12 +39,12 @@ theme | String | default | options：default/primary/success/danger/warning/ligh name | type | default | description | required -- | -- | -- | -- | -- -className | String | - | 类名 | N -style | Object | - | 样式，Typescript：`React.CSSProperties` | N -children | TNode | - | trigger element。Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -content | TNode | - | tip content。Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +className | String | - | className of component | N +style | Object | - | CSS(Cascading Style Sheets)，Typescript: `React.CSSProperties` | N +children | TNode | - | trigger element。Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +content | TNode | - | tip content。Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N placement | String | top | options：top/bottom/mouse | N showArrow | Boolean | true | \- | N showShadow | Boolean | true | \- | N theme | String | default | options：light/default | N -triggerElement | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +triggerElement | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N diff --git a/packages/components/tooltip/tooltip.md b/packages/components/tooltip/tooltip.md index 1c19265196..d56cc24179 100644 --- a/packages/components/tooltip/tooltip.md +++ b/packages/components/tooltip/tooltip.md @@ -25,7 +25,7 @@ ## API ### Tooltip Props -名称 | 类型 | 默认值 | 说明 | 必传 +名称 | 类型 | 默认值 | 描述 | 必传 -- | -- | -- | -- | -- delay | Number / Array | - | 延时显示或隐藏浮层，[延迟显示的时间，延迟隐藏的时间]，单位：毫秒。直接透传到 Popup 组件。如果只有一个时间，则表示显示和隐藏的延迟时间相同。示例 `'300'` 或者 `[200, 200]`。默认为：[250, 150]。TS 类型：`number \| Array` | N destroyOnClose | Boolean | true | 是否在关闭浮层时销毁浮层 | N @@ -37,7 +37,7 @@ theme | String | default | 文字提示风格。可选项：default/primary/succ ### TooltipLite Props -名称 | 类型 | 默认值 | 说明 | 必传 +名称 | 类型 | 默认值 | 描述 | 必传 -- | -- | -- | -- | -- className | String | - | 类名 | N style | Object | - | 样式，TS 类型：`React.CSSProperties` | N diff --git a/packages/components/transfer/transfer.en-US.md b/packages/components/transfer/transfer.en-US.md index 8ae11e5a80..2411eb2ab7 100644 --- a/packages/components/transfer/transfer.en-US.md +++ b/packages/components/transfer/transfer.en-US.md @@ -6,29 +6,29 @@ name | type | default | description | required -- | -- | -- | -- | -- -className | String | - | 类名 | N -style | Object | - | 样式，Typescript：`React.CSSProperties` | N -checkboxProps | Object | - | Typescript：`CheckboxProps`，[Checkbox API Documents](./checkbox?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/transfer/type.ts) | N -checked | Array | [] | Typescript：`Array` | N -defaultChecked | Array | [] | uncontrolled property。Typescript：`Array` | N -data | Array | [] | Typescript：`Array` | N +className | String | - | className of component | N +style | Object | - | CSS(Cascading Style Sheets)，Typescript: `React.CSSProperties` | N +checkboxProps | Object | - | Typescript: `CheckboxProps`，[Checkbox API Documents](./checkbox?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/transfer/type.ts) | N +checked | Array | [] | Typescript: `Array` | N +defaultChecked | Array | [] | uncontrolled property。Typescript: `Array` | N +data | Array | [] | Typescript: `Array` | N direction | String | both | options：left/right/both | N -disabled | Boolean / Array | false | Typescript：`boolean \| Array` | N -empty | TNode | '' | Typescript：`EmptyType \| Array \| TNode` `type EmptyType = string \| TNode `。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/transfer/type.ts) | N -footer | TNode | - | Typescript：`Array \| TNode<{ type: TransferListType }>`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -keys | Object | - | Typescript：`KeysType`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -operation | TNode | - | Typescript：`Array \| TNode<{ direction: 'left' \| 'right' }>`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -pagination | Object / Array | - | Typescript：`PaginationProps \| Array`，[Pagination API Documents](./pagination?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/transfer/type.ts) | N -search | Boolean / Object / Array | false | Typescript：`SearchOption \| Array` `type SearchOption = boolean \| InputProps`，[Input API Documents](./input?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/transfer/type.ts) | N -showCheckAll | Boolean / Array | true | Typescript：`boolean \| Array` | N +disabled | Boolean / Array | false | Typescript: `boolean \| Array` | N +empty | TNode | '' | Typescript: `EmptyType \| Array \| TNode` `type EmptyType = string \| TNode `。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/transfer/type.ts) | N +footer | TNode | - | Typescript: `Array \| TNode<{ type: TransferListType }>`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +keys | Object | - | Typescript: `KeysType`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +operation | TNode | - | Typescript: `Array \| TNode<{ direction: 'left' \| 'right' }>`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +pagination | Object / Array | - | Typescript: `PaginationProps \| Array`，[Pagination API Documents](./pagination?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/transfer/type.ts) | N +search | Boolean / Object / Array | false | Typescript: `SearchOption \| Array` `type SearchOption = boolean \| InputProps`，[Input API Documents](./input?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/transfer/type.ts) | N +showCheckAll | Boolean / Array | true | Typescript: `boolean \| Array` | N targetSort | String | original | options：original/push/unshift | N -title | TNode | [] | Typescript：`Array \| TNode<{ type: TransferListType }>` `type TitleType = string \| TNode` `type TransferListType = 'source' \| 'target'`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/transfer/type.ts) | N -transferItem | TElement | - | Typescript：`TNode>` `interface TransferItem { data: T; index: number; type: TransferListType}`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/transfer/type.ts) | N -tree | TElement | 传入 Tree 组件定义树形结构 | Typescript：`(tree: TreeProps) => TNode`，[Tree API Documents](./tree?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/transfer/type.ts) | N -value | Array | [] | Typescript：`Array` | N -defaultValue | Array | [] | uncontrolled property。Typescript：`Array` | N -onChange | Function | | Typescript：`(targetValue: Array, context: TargetParams) => void`
Typescript：`TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/transfer/type.ts)。
`interface TargetParams { type: TransferListType; movedValue: Array }`
| N -onCheckedChange | Function | | Typescript：`(options: CheckedOptions) => void`
Typescript：`TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/transfer/type.ts)。
`interface CheckedOptions { checked: Array; sourceChecked: Array; targetChecked: Array; type: TransferListType }`
| N -onPageChange | Function | | Typescript：`(page: PageInfo, context: { type: TransferListType }) => void`
| N -onScroll | Function | | Typescript：`(options: { e: Event; bottomDistance: number; type: TransferListType }) => void`
Typescript：`TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -onSearch | Function | | Typescript：`(options: SearchContext) => void`
Typescript：`TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/transfer/type.ts)。
`interface SearchContext { query: string; type: TransferListType; trigger: 'input' \| 'enter'; e: InputEvent \| KeyboardEvent }`
| N +title | TNode | [] | Typescript: `Array \| TNode<{ type: TransferListType }>` `type TitleType = string \| TNode` `type TransferListType = 'source' \| 'target'`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/transfer/type.ts) | N +transferItem | TElement | - | Typescript: `TNode>` `interface TransferItem { data: T; index: number; type: TransferListType}`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/transfer/type.ts) | N +tree | TElement | 传入 Tree 组件定义树形结构 | Typescript: `(tree: TreeProps) => TNode`，[Tree API Documents](./tree?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/transfer/type.ts) | N +value | Array | [] | Typescript: `Array` | N +defaultValue | Array | [] | uncontrolled property。Typescript: `Array` | N +onChange | Function | | Typescript: `(targetValue: Array, context: TargetParams) => void`
Typescript: `TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/transfer/type.ts)。
`interface TargetParams { type: TransferListType; movedValue: Array }`
| N +onCheckedChange | Function | | Typescript: `(options: CheckedOptions) => void`
Typescript: `TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/transfer/type.ts)。
`interface CheckedOptions { checked: Array; sourceChecked: Array; targetChecked: Array; type: TransferListType }`
| N +onPageChange | Function | | Typescript: `(page: PageInfo, context: { type: TransferListType }) => void`
| N +onScroll | Function | | Typescript: `(options: { e: Event; bottomDistance: number; type: TransferListType }) => void`
Typescript: `TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +onSearch | Function | | Typescript: `(options: SearchContext) => void`
Typescript: `TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/transfer/type.ts)。
`interface SearchContext { query: string; type: TransferListType; trigger: 'input' \| 'enter'; e: InputEvent \| KeyboardEvent }`
| N diff --git a/packages/components/transfer/transfer.md b/packages/components/transfer/transfer.md index 2e38503865..dd07a669f5 100644 --- a/packages/components/transfer/transfer.md +++ b/packages/components/transfer/transfer.md @@ -3,7 +3,7 @@ ## API ### Transfer Props -名称 | 类型 | 默认值 | 说明 | 必传 +名称 | 类型 | 默认值 | 描述 | 必传 -- | -- | -- | -- | -- className | String | - | 类名 | N style | Object | - | 样式，TS 类型：`React.CSSProperties` | N diff --git a/packages/components/tree-select/tree-select.en-US.md b/packages/components/tree-select/tree-select.en-US.md index 6ac5a9c269..78c267ac58 100644 --- a/packages/components/tree-select/tree-select.en-US.md +++ b/packages/components/tree-select/tree-select.en-US.md @@ -7,54 +7,54 @@ name | type | default | description | required -- | -- | -- | -- | -- className | String | - | className of component | N -style | Object | - | CSS(Cascading Style Sheets)，Typescript：`React.CSSProperties` | N +style | Object | - | CSS(Cascading Style Sheets)，Typescript: `React.CSSProperties` | N autoWidth | Boolean | false | \- | N autofocus | Boolean | false | \- | N borderless | Boolean | false | \- | N clearable | Boolean | false | \- | N -collapsedItems | TElement | - | Typescript：`TNode<{ value: DataOption[]; collapsedSelectedItems: DataOption[]; count: number; onClose: (context: { index: number, e?: MouseEvent }) => void }>`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -data | Array | [] | Typescript：`Array` | N +collapsedItems | TElement | - | Typescript: `TNode<{ value: DataOption[]; collapsedSelectedItems: DataOption[]; count: number; onClose: (context: { index: number, e?: MouseEvent }) => void }>`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +data | Array | [] | Typescript: `Array` | N disabled | Boolean | - | \- | N -empty | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -filter | Function | - | Typescript：`(filterWords: string, option: DataOption) => boolean` | N +empty | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +filter | Function | - | Typescript: `(filterWords: string, option: DataOption) => boolean` | N filterable | Boolean | false | \- | N -inputProps | Object | - | Typescript：`InputProps`，[Input API Documents](./input?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/tree-select/type.ts) | N -inputValue | String / Number | - | input value。Typescript：`string` | N -defaultInputValue | String / Number | - | input value。uncontrolled property。Typescript：`string` | N -keys | Object | - | alias filed name in data。Typescript：`TreeKeysType`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -label | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +inputProps | Object | - | Typescript: `InputProps`，[Input API Documents](./input?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/tree-select/type.ts) | N +inputValue | String / Number | - | input value。Typescript: `string` | N +defaultInputValue | String / Number | - | input value。uncontrolled property。Typescript: `string` | N +keys | Object | - | alias filed name in data。Typescript: `TreeKeysType`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +label | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N loading | Boolean | false | \- | N -loadingText | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +loadingText | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N max | Number | 0 | \- | N minCollapsedNum | Number | 0 | \- | N multiple | Boolean | false | \- | N -panelBottomContent | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -panelTopContent | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +panelBottomContent | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +panelTopContent | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N placeholder | String | undefined | \- | N -popupProps | Object | - | Typescript：`PopupProps`，[Popup API Documents](./popup?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/tree-select/type.ts) | N +popupProps | Object | - | Typescript: `PopupProps`，[Popup API Documents](./popup?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/tree-select/type.ts) | N popupVisible | Boolean | undefined | show popup | N defaultPopupVisible | Boolean | undefined | show popup。uncontrolled property | N -prefixIcon | TElement | - | Typescript：`TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +prefixIcon | TElement | - | Typescript: `TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N readonly | Boolean | false | \- | N reserveKeyword | Boolean | false | \- | N -selectInputProps | Object | - | Typescript：`SelectInputProps`，[SelectInput API Documents](./select-input?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/tree-select/type.ts) | N +selectInputProps | Object | - | Typescript: `SelectInputProps`，[SelectInput API Documents](./select-input?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/tree-select/type.ts) | N size | String | medium | options: small/medium/large | N status | String | default | options: default/success/warning/error | N -suffix | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -suffixIcon | TElement | - | Typescript：`TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -tagProps | Object | - | Typescript：`TagProps`，[Tag API Documents](./tag?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/tree-select/type.ts) | N -tips | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -treeProps | Object | - | Typescript：`TreeProps`，[Tree API Documents](./tree?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/tree-select/type.ts) | N -value | String / Number / Object / Array | - | Typescript：`TreeValueType` `type TreeSelectValue = string \| number \| TreeOptionData \| Array`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/tree-select/type.ts) | N -defaultValue | String / Number / Object / Array | - | uncontrolled property。Typescript：`TreeValueType` `type TreeSelectValue = string \| number \| TreeOptionData \| Array`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/tree-select/type.ts) | N -valueDisplay | TElement | - | Typescript：`string \| TNode<{ value: TreeOptionData \| TreeOptionData[]; onClose: (index: number) => void }>`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +suffix | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +suffixIcon | TElement | - | Typescript: `TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +tagProps | Object | - | Typescript: `TagProps`，[Tag API Documents](./tag?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/tree-select/type.ts) | N +tips | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +treeProps | Object | - | Typescript: `TreeProps`，[Tree API Documents](./tree?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/tree-select/type.ts) | N +value | String / Number / Object / Array | - | Typescript: `TreeValueType` `type TreeSelectValue = string \| number \| TreeOptionData \| Array`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/tree-select/type.ts) | N +defaultValue | String / Number / Object / Array | - | uncontrolled property。Typescript: `TreeValueType` `type TreeSelectValue = string \| number \| TreeOptionData \| Array`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/tree-select/type.ts) | N +valueDisplay | TElement | - | Typescript: `string \| TNode<{ value: TreeOptionData \| TreeOptionData[]; onClose: (index: number) => void }>`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N valueType | String | value | options: value/object | N -onBlur | Function | | Typescript：`(context: SelectInputBlurContext & { value: TreeSelectValue }) => void`
| N -onChange | Function | | Typescript：`(value: TreeValueType, context: TreeSelectChangeContext) => void`
[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/tree-select/type.ts)。
`interface TreeSelectChangeContext { node: TreeNodeModel; data: DataOption; index?: number; trigger: TreeSelectValueChangeTrigger; e?: MouseEvent \| KeyboardEvent \| Event }`

`type TreeSelectValueChangeTrigger = 'clear' \| 'tag-remove' \| 'backspace' \| 'check' \| 'uncheck'`
| N -onClear | Function | | Typescript：`(context: { e: MouseEvent }) => void`
| N -onEnter | Function | | Typescript：`(context: { inputValue: string; e: KeyboardEvent; value: TreeValueType }) => void`
| N -onFocus | Function | | Typescript：`(context: { value: TreeSelectValue; e: FocusEvent }) => void`
| N -onInputChange | Function | | Typescript：`(value: string, context: SelectInputValueChangeContext) => void`
| N -onPopupVisibleChange | Function | | Typescript：`(visible: boolean, context: TreeSelectPopupVisibleContext) => void`
[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/tree-select/type.ts)。
`import { PopupVisibleChangeContext, PopupTriggerEvent, PopupTriggerSource } from '@Popup'`

`interface TreeSelectPopupVisibleContext { e?: PopupTriggerEvent \| Event; node?: TreeNodeModel; trigger?: PopupTriggerSource \| 'clear'; }`
| N -onRemove | Function | | Typescript：`(options: RemoveOptions) => void`
[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/tree-select/type.ts)。
`export interface RemoveOptions { value: N; data: T; index: number; node: TreeNodeModel; e?: MouseEvent \| KeyboardEvent; trigger: 'tag-remove' \| 'backspace'; }`
| N -onSearch | Function | | Typescript：`(filterWords: string, context: { e: KeyboardEvent \| SelectInputValueChangeContext['e'] }) => void`
| N +onBlur | Function | | Typescript: `(context: SelectInputBlurContext & { value: TreeSelectValue }) => void`
| N +onChange | Function | | Typescript: `(value: TreeValueType, context: TreeSelectChangeContext) => void`
[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/tree-select/type.ts)。
`interface TreeSelectChangeContext { node: TreeNodeModel; data: DataOption; index?: number; trigger: TreeSelectValueChangeTrigger; e?: MouseEvent \| KeyboardEvent \| Event }`

`type TreeSelectValueChangeTrigger = 'clear' \| 'tag-remove' \| 'backspace' \| 'check' \| 'uncheck'`
| N +onClear | Function | | Typescript: `(context: { e: MouseEvent }) => void`
| N +onEnter | Function | | Typescript: `(context: { inputValue: string; e: KeyboardEvent; value: TreeValueType }) => void`
| N +onFocus | Function | | Typescript: `(context: { value: TreeSelectValue; e: FocusEvent }) => void`
| N +onInputChange | Function | | Typescript: `(value: string, context: SelectInputValueChangeContext) => void`
| N +onPopupVisibleChange | Function | | Typescript: `(visible: boolean, context: TreeSelectPopupVisibleContext) => void`
[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/tree-select/type.ts)。
`import { PopupVisibleChangeContext, PopupTriggerEvent, PopupTriggerSource } from '@Popup'`

`interface TreeSelectPopupVisibleContext { e?: PopupTriggerEvent \| Event; node?: TreeNodeModel; trigger?: PopupTriggerSource \| 'clear'; }`
| N +onRemove | Function | | Typescript: `(options: RemoveOptions) => void`
[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/tree-select/type.ts)。
`export interface RemoveOptions { value: N; data: T; index: number; node: TreeNodeModel; e?: MouseEvent \| KeyboardEvent; trigger: 'tag-remove' \| 'backspace'; }`
| N +onSearch | Function | | Typescript: `(filterWords: string, context: { e: KeyboardEvent \| SelectInputValueChangeContext['e'] }) => void`
| N diff --git a/packages/components/tree/tree.en-US.md b/packages/components/tree/tree.en-US.md index 99571454f5..2dd7a3c281 100644 --- a/packages/components/tree/tree.en-US.md +++ b/packages/components/tree/tree.en-US.md @@ -7,58 +7,58 @@ name | type | default | description | required -- | -- | -- | -- | -- className | String | - | className of component | N -style | Object | - | CSS(Cascading Style Sheets)，Typescript：`React.CSSProperties` | N +style | Object | - | CSS(Cascading Style Sheets)，Typescript: `React.CSSProperties` | N activable | Boolean | false | make nodes can be highlight | N activeMultiple | Boolean | false | \- | N -actived | Array | - | Typescript：`Array` | N -allowDrop | Function | - | Determine whether the node can execute the drop operation。Typescript：`(context: { e: DragEvent; dragNode: TreeNodeModel; dropNode: TreeNodeModel; dropPosition: number; }) => boolean` | N +actived | Array | - | Typescript: `Array` | N +allowDrop | Function | - | Determine whether the node can execute the drop operation。Typescript: `(context: { e: DragEvent; dragNode: TreeNodeModel; dropNode: TreeNodeModel; dropPosition: number; }) => boolean` | N allowFoldNodeOnFilter | Boolean | false | \- | N -checkProps | Object / Function | - | Typescript：`CheckboxProps \| ((node: TreeNodeModel) => CheckboxProps)`，[Checkbox API Documents](./checkbox?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/tree/type.ts) | N +checkProps | Object / Function | - | Typescript: `CheckboxProps \| ((node: TreeNodeModel) => CheckboxProps)`，[Checkbox API Documents](./checkbox?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/tree/type.ts) | N checkStrictly | Boolean | false | \- | N checkable | Boolean | false | \- | N -data | Array | [] | Typescript：`Array` | N -disableCheck | Boolean / Function | false | Typescript：`boolean \| ((node: TreeNodeModel) => boolean)` | N +data | Array | [] | Typescript: `Array` | N +disableCheck | Boolean / Function | false | Typescript: `boolean \| ((node: TreeNodeModel) => boolean)` | N disabled | Boolean | - | \- | N draggable | Boolean | - | \- | N -empty | TNode | '' | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +empty | TNode | '' | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N expandAll | Boolean | false | \- | N expandLevel | Number | 0 | \- | N expandMutex | Boolean | false | \- | N expandOnClickNode | Boolean | false | \- | N expandParent | Boolean | false | \- | N -expanded | Array | [] | Typescript：`Array` | N -filter | Function | - | Typescript：`(node: TreeNodeModel) => boolean` | N +expanded | Array | [] | Typescript: `Array` | N +filter | Function | - | Typescript: `(node: TreeNodeModel) => boolean` | N hover | Boolean | - | \- | N -icon | TNode | true | Typescript：`boolean \| TNode>`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -keys | Object | - | alias field name in data。Typescript：`TreeKeysType`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -label | TNode | true | Typescript：`string \| boolean \| TNode>`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +icon | TNode | true | Typescript: `boolean \| TNode>`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +keys | Object | - | alias field name in data。Typescript: `TreeKeysType`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +label | TNode | true | Typescript: `string \| boolean \| TNode>`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N lazy | Boolean | true | \- | N -line | TNode | false | Typescript：`boolean \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -load | Function | - | Typescript：`(node: TreeNodeModel) => Promise>` | N -operations | TElement | - | Typescript：`TNode>`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -scroll | Object | - | lazy load and virtual scroll。Typescript：`TScroll`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +line | TNode | false | Typescript: `boolean \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +load | Function | - | Typescript: `(node: TreeNodeModel) => Promise>` | N +operations | TElement | - | Typescript: `TNode>`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +scroll | Object | - | lazy load and virtual scroll。Typescript: `TScroll`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N transition | Boolean | true | \- | N -value | Array | [] | Typescript：`Array` `type TreeNodeValue = string \| number`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/tree/type.ts) | N -defaultValue | Array | [] | uncontrolled property。Typescript：`Array` `type TreeNodeValue = string \| number`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/tree/type.ts) | N +value | Array | [] | Typescript: `Array` `type TreeNodeValue = string \| number`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/tree/type.ts) | N +defaultValue | Array | [] | uncontrolled property。Typescript: `Array` `type TreeNodeValue = string \| number`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/tree/type.ts) | N valueMode | String | onlyLeaf | options: onlyLeaf/parentFirst/all | N -onActive | Function | | Typescript：`(value: Array, context: { node: TreeNodeModel; e?: MouseEvent; trigger: 'node-click' \| 'setItem' }) => void`
| N -onChange | Function | | Typescript：`(value: Array, context: { node: TreeNodeModel; e?: any; trigger: 'node-click' \| 'setItem' }) => void`
| N -onClick | Function | | Typescript：`(context: { node: TreeNodeModel; e: MouseEvent }) => void`
| N -onDragEnd | Function | | Typescript：`(context: { e: DragEvent; node: TreeNodeModel }) => void`
| N -onDragLeave | Function | | Typescript：`(context: { e: DragEvent; node: TreeNodeModel; dragNode: TreeNodeModel; dropPosition: number; }) => void`
| N -onDragOver | Function | | Typescript：`(context: { e: DragEvent; node: TreeNodeModel; dragNode: TreeNodeModel; dropPosition: number; }) => void`
| N -onDragStart | Function | | Typescript：`(context: { e: DragEvent; node: TreeNodeModel }) => void`
| N -onDrop | Function | | Typescript：`(context: { e: DragEvent; dragNode: TreeNodeModel; dropNode: TreeNodeModel; dropPosition: number; }) => void`
| N -onExpand | Function | | Typescript：`(value: Array, context: { node: TreeNodeModel; e?: MouseEvent; trigger: 'node-click' \| 'icon-click' \| 'setItem' }) => void`
| N -onLoad | Function | | Typescript：`(context: { node: TreeNodeModel }) => void`
| N -onScroll | Function | | Typescript：`(params: { e: WheelEvent }) => void`
trigger on content scroll | N +onActive | Function | | Typescript: `(value: Array, context: { node: TreeNodeModel; e?: MouseEvent; trigger: 'node-click' \| 'setItem' }) => void`
| N +onChange | Function | | Typescript: `(value: Array, context: { node: TreeNodeModel; e?: any; trigger: 'node-click' \| 'setItem' }) => void`
| N +onClick | Function | | Typescript: `(context: { node: TreeNodeModel; e: MouseEvent }) => void`
| N +onDragEnd | Function | | Typescript: `(context: { e: DragEvent; node: TreeNodeModel }) => void`
| N +onDragLeave | Function | | Typescript: `(context: { e: DragEvent; node: TreeNodeModel; dragNode: TreeNodeModel; dropPosition: number; }) => void`
| N +onDragOver | Function | | Typescript: `(context: { e: DragEvent; node: TreeNodeModel; dragNode: TreeNodeModel; dropPosition: number; }) => void`
| N +onDragStart | Function | | Typescript: `(context: { e: DragEvent; node: TreeNodeModel }) => void`
| N +onDrop | Function | | Typescript: `(context: { e: DragEvent; dragNode: TreeNodeModel; dropNode: TreeNodeModel; dropPosition: number; }) => void`
| N +onExpand | Function | | Typescript: `(value: Array, context: { node: TreeNodeModel; e?: MouseEvent; trigger: 'node-click' \| 'icon-click' \| 'setItem' }) => void`
| N +onLoad | Function | | Typescript: `(context: { node: TreeNodeModel }) => void`
| N +onScroll | Function | | Typescript: `(params: { e: WheelEvent }) => void`
trigger on content scroll | N ### TreeInstanceFunctions 组件实例方法 name | params | return | description -- | -- | -- | -- className | String | - | className of component | N -style | Object | - | CSS(Cascading Style Sheets)，Typescript：`React.CSSProperties` | N +style | Object | - | CSS(Cascading Style Sheets)，Typescript: `React.CSSProperties` | N appendTo | `(value: TreeNodeValue, newData: T \| Array)` | \- | required getIndex | `(value: TreeNodeValue)` | `number` | required getItem | `(value: TreeNodeValue)` | `TreeNodeModel` | required @@ -96,7 +96,7 @@ name | type | default | description | required -- | -- | -- | -- | -- actived | Boolean | - | required | Y checked | Boolean | - | required | Y -data | Object | - | required。node data, extends `TreeOptionData`。Typescript：`T` | Y +data | Object | - | required。node data, extends `TreeOptionData`。Typescript: `T` | Y expanded | Boolean | - | required | Y indeterminate | Boolean | - | required | Y loading | Boolean | - | required | Y diff --git a/packages/components/typography/typography.en-US.md b/packages/components/typography/typography.en-US.md index 9f9cf1c7fa..6ca89dec81 100644 --- a/packages/components/typography/typography.en-US.md +++ b/packages/components/typography/typography.en-US.md @@ -5,14 +5,14 @@ name | type | default | description | required -- | -- | -- | -- | -- -className | String | - | 类名 | N -style | Object | - | 样式，Typescript：`React.CSSProperties` | N -children | TNode | - | children of text。Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +className | String | - | className of component | N +style | Object | - | CSS(Cascading Style Sheets)，Typescript: `React.CSSProperties` | N +children | TNode | - | children of text。Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N code | Boolean | false | add code style | N -copyable | Boolean / Object | false | add copyable style。Typescript：`boolean \| TypographyCopyable` | N +copyable | Boolean / Object | false | add copyable style。Typescript: `boolean \| TypographyCopyable` | N delete | Boolean | false | add delete line style | N disabled | Boolean | false | add disabled style | N -ellipsis | Boolean / Object | false | add ellipsis style。Typescript：`boolean \| TypographyEllipsis` | N +ellipsis | Boolean / Object | false | add ellipsis style。Typescript: `boolean \| TypographyEllipsis` | N italic | Boolean | false | add italic style | N keyboard | Boolean | false | add keyboard style | N mark | String / Boolean | false | add mark style | N @@ -24,22 +24,22 @@ underline | Boolean | false | add underline style | N name | type | default | description | required -- | -- | -- | -- | -- -className | String | - | 类名 | N -style | Object | - | 样式，Typescript：`React.CSSProperties` | N -children | TNode | - | children of title。Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -content | TNode | - | content of title。Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -ellipsis | Boolean / Object | false | add ellipsis style。Typescript：`boolean \| TypographyEllipsis` | N +className | String | - | className of component | N +style | Object | - | CSS(Cascading Style Sheets)，Typescript: `React.CSSProperties` | N +children | TNode | - | children of title。Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +content | TNode | - | content of title。Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +ellipsis | Boolean / Object | false | add ellipsis style。Typescript: `boolean \| TypographyEllipsis` | N level | String | h1 | level of title。options: h1/h2/h3/h4/h5/h6 | N ### Paragraph Props name | type | default | description | required -- | -- | -- | -- | -- -className | String | - | 类名 | N -style | Object | - | 样式，Typescript：`React.CSSProperties` | N -children | TNode | - | children of paragraph。Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -content | TNode | - | content of paragraph。Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -ellipsis | Boolean / Object | false | add ellipsis style。Typescript：`boolean \| TypographyEllipsis` | N +className | String | - | className of component | N +style | Object | - | CSS(Cascading Style Sheets)，Typescript: `React.CSSProperties` | N +children | TNode | - | children of paragraph。Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +content | TNode | - | content of paragraph。Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +ellipsis | Boolean / Object | false | add ellipsis style。Typescript: `boolean \| TypographyEllipsis` | N ### TypographyEllipsis @@ -48,15 +48,15 @@ name | type | default | description | required collapsible | Boolean | true | collapsible after expanding | N expandable | Boolean | true | expandable | N row | Number | 1 | default row number of ellipsis | N -suffix | TElement | - | custom element configuration for ellipsis and collapse icon。Typescript：`TNode<{ expanded: boolean }>`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -tooltipProps | Object | - | Configuration of the tooltip that appears on the ellipsis icon when the cursor is over it.。Typescript：`tooltipProps`，[Tooltip API Documents](./tooltip?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/typography/type.ts) | N -onExpand | Function | | Typescript：`(expanded:boolean) => void`
| N +suffix | TElement | - | custom element configuration for ellipsis and collapse icon。Typescript: `TNode<{ expanded: boolean }>`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +tooltipProps | Object | - | Configuration of the tooltip that appears on the ellipsis icon when the cursor is over it.。Typescript: `tooltipProps`，[Tooltip API Documents](./tooltip?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/typography/type.ts) | N +onExpand | Function | | Typescript: `(expanded:boolean) => void`
| N ### TypographyCopyable name | type | default | description | required -- | -- | -- | -- | -- text | String | - | copied content | N -suffix | TElement | - | custom element configuration for copy icon。Typescript：`TNode<{ copied: boolean }>`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -tooltipProps | Object | - | Configuration of the tooltip that appears on the copy icon when the cursor is over it.。Typescript：`tooltipProps`，[Tooltip API Documents](./tooltip?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/typography/type.ts) | N -onCopy | Function | | Typescript：`() => void`
| N \ No newline at end of file +suffix | TElement | - | custom element configuration for copy icon。Typescript: `TNode<{ copied: boolean }>`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +tooltipProps | Object | - | Configuration of the tooltip that appears on the copy icon when the cursor is over it.。Typescript: `tooltipProps`，[Tooltip API Documents](./tooltip?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/typography/type.ts) | N +onCopy | Function | | Typescript: `() => void`
| N \ No newline at end of file diff --git a/packages/components/typography/typography.md b/packages/components/typography/typography.md index 5c3c5f6df2..41af81f64b 100644 --- a/packages/components/typography/typography.md +++ b/packages/components/typography/typography.md @@ -3,7 +3,7 @@ ## API ### Text Props -名称 | 类型 | 默认值 | 说明 | 必传 +名称 | 类型 | 默认值 | 描述 | 必传 -- | -- | -- | -- | -- className | String | - | 类名 | N style | Object | - | 样式，TS 类型：`React.CSSProperties` | N @@ -22,7 +22,7 @@ underline | Boolean | false | 是否添加下划线样式 | N ### Title Props -名称 | 类型 | 默认值 | 说明 | 必传 +名称 | 类型 | 默认值 | 描述 | 必传 -- | -- | -- | -- | -- className | String | - | 类名 | N style | Object | - | 样式，TS 类型：`React.CSSProperties` | N @@ -33,7 +33,7 @@ level | String | h1 | 标题等级。可选项：h1/h2/h3/h4/h5/h6 | N ### Paragraph Props -名称 | 类型 | 默认值 | 说明 | 必传 +名称 | 类型 | 默认值 | 描述 | 必传 -- | -- | -- | -- | -- className | String | - | 类名 | N style | Object | - | 样式，TS 类型：`React.CSSProperties` | N @@ -43,7 +43,7 @@ ellipsis | Boolean / Object | false | 是否省略展示，可通过配置参数 ### TypographyEllipsis -名称 | 类型 | 默认值 | 说明 | 必传 +名称 | 类型 | 默认值 | 描述 | 必传 -- | -- | -- | -- | -- collapsible | Boolean | true | 展开后是否可以重新收起 | N expandable | Boolean | true | 是否可展开 | N @@ -54,7 +54,7 @@ onExpand | Function | | TS 类型：`(expanded:boolean) => void`
点击省 ### TypographyCopyable -名称 | 类型 | 默认值 | 说明 | 必传 +名称 | 类型 | 默认值 | 描述 | 必传 -- | -- | -- | -- | -- text | String | - | 复制的文本内容，默认为全部文本 | N suffix | TElement | - | 自定义复制触发元素，一般用于自定义复制图标。TS 类型：`TNode<{ copied: boolean }>`。[通用类型定义](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N diff --git a/packages/components/upload/upload.en-US.md b/packages/components/upload/upload.en-US.md index ca6166321f..ebf9c0c817 100644 --- a/packages/components/upload/upload.en-US.md +++ b/packages/components/upload/upload.en-US.md @@ -5,76 +5,76 @@ name | type | default | description | required -- | -- | -- | -- | -- -className | String | - | 类名 | N -style | Object | - | 样式，Typescript：`React.CSSProperties` | N -abridgeName | Array | - | ellipsis text of medium file name。Typescript：`Array` | N +className | String | - | className of component | N +style | Object | - | CSS(Cascading Style Sheets)，Typescript: `React.CSSProperties` | N +abridgeName | Array | - | ellipsis text of medium file name。Typescript: `Array` | N accept | String | - | File types that can be accepted. [W3C](https://www.w3schools.com/tags/att_input_accept.asp)，[MDN](https://developer.mozilla.org/zh-CN/docs/Web/HTML/Element/Input/file) | N action | String | - | Uploading URL | N allowUploadDuplicateFile | Boolean | false | allow to upload duplicate name files | N autoUpload | Boolean | true | post upload request automatically after files being selected | N -beforeAllFilesUpload | Function | - | before all files upload, return false can stop uploading file。Typescript：`(file: UploadFile[]) => boolean \| Promise` | N -beforeUpload | Function | - | stop one of files to upload。Typescript：`(file: UploadFile) => boolean \| Promise` | N -cancelUploadButton | TNode | - | cancel upload button props, which showed on `autoUpload=false` and multiple files/images upload。Typescript：`null \| ButtonProps \| TNode<{ disabled: boolean; cancelUploadText: string; cancelUpload: (ctx: { e: MouseEvent }) => void }>`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -children | TNode | - | to define upload trigger elements if `draggable=false`, to define drag elements if `draggable=true`。Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -data | Object | - | extra request data of uploading. `formatRequest` can redefine all request data。Typescript：`Record \| ((files: UploadFile[]) => Record)` | N +beforeAllFilesUpload | Function | - | before all files upload, return false can stop uploading file。Typescript: `(file: UploadFile[]) => boolean \| Promise` | N +beforeUpload | Function | - | stop one of files to upload。Typescript: `(file: UploadFile) => boolean \| Promise` | N +cancelUploadButton | TNode | - | cancel upload button props, which showed on `autoUpload=false` and multiple files/images upload。Typescript: `null \| ButtonProps \| TNode<{ disabled: boolean; cancelUploadText: string; cancelUpload: (ctx: { e: MouseEvent }) => void }>`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +children | TNode | - | to define upload trigger elements if `draggable=false`, to define drag elements if `draggable=true`。Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +data | Object | - | extra request data of uploading. `formatRequest` can redefine all request data。Typescript: `Record \| ((files: UploadFile[]) => Record)` | N disabled | Boolean | - | make upload to be disabled | N -dragContent | TNode | - | define drag content nodes, it works on `theme=custom`。Typescript：`TNode \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +dragContent | TNode | - | define drag content nodes, it works on `theme=custom`。Typescript: `TNode \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N draggable | Boolean | undefined | if drag uploading allowed, works on `theme=file` or `theme=image` | N -fileListDisplay | TElement | - | used to render file list UI。Typescript：`TNode<{ files: UploadFile[]; dragEvents?: UploadDisplayDragEvents }>`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -files | Array | [] | Typescript：`Array` | N -defaultFiles | Array | [] | uncontrolled property。Typescript：`Array` | N -format | Function | - | to redefine `UploadFile` data structure。Typescript：`(file: File) => UploadFile` | N -formatRequest | Function | - | redefine request data。Typescript：`(requestData: { [key: string]: any }) => { [key: string]: any }` | N -formatResponse | Function | - | redefine response data structure。Typescript：`(response: any, context: FormatResponseContext) => ResponseType ` `type ResponseType = { error?: string; url?: string; status?: 'fail' \| 'success'; files?: UploadFile[] } & Record` `interface FormatResponseContext { file: UploadFile; currentFiles?: UploadFile[] }`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/upload/type.ts) | N -headers | Object | - | HTTP Request Header。Typescript：`{[key: string]: string}` | N +fileListDisplay | TElement | - | used to render file list UI。Typescript: `TNode<{ files: UploadFile[]; dragEvents?: UploadDisplayDragEvents }>`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +files | Array | [] | Typescript: `Array` | N +defaultFiles | Array | [] | uncontrolled property。Typescript: `Array` | N +format | Function | - | to redefine `UploadFile` data structure。Typescript: `(file: File) => UploadFile` | N +formatRequest | Function | - | redefine request data。Typescript: `(requestData: { [key: string]: any }) => { [key: string]: any }` | N +formatResponse | Function | - | redefine response data structure。Typescript: `(response: any, context: FormatResponseContext) => ResponseType ` `type ResponseType = { error?: string; url?: string; status?: 'fail' \| 'success'; files?: UploadFile[] } & Record` `interface FormatResponseContext { file: UploadFile; currentFiles?: UploadFile[] }`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/upload/type.ts) | N +headers | Object | - | HTTP Request Header。Typescript: `{[key: string]: string}` | N imageProps | Object | - | \- | N -imageViewerProps | Object | - | ImageViewer Component Props。Typescript：`ImageViewerProps`，[ImageViewer API Documents](./image-viewer?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/upload/type.ts) | N -inputAttributes | Object | - | add attributes to HTML element `input`。Typescript：`CSSProperties` | N +imageViewerProps | Object | - | ImageViewer Component Props。Typescript: `ImageViewerProps`，[ImageViewer API Documents](./image-viewer?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/upload/type.ts) | N +inputAttributes | Object | - | add attributes to HTML element `input`。Typescript: `CSSProperties` | N isBatchUpload | Boolean | false | make all files to be a whole package, files can only be replaced or deleted together, can not add more files | N -locale | Object | - | upload language config, priority of `locale` is higher than global language config。Typescript：`UploadConfig` `import { UploadConfig } from '../config-provider/type'`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/upload/type.ts) | N +locale | Object | - | upload language config, priority of `locale` is higher than global language config。Typescript: `UploadConfig` `import { UploadConfig } from '../config-provider/type'`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/upload/type.ts) | N max | Number | 0 | max count of files limit | N method | String | POST | HTTP request method。options: POST/GET/PUT/OPTIONS/PATCH/post/get/put/options/patch | N mockProgressDuration | Number | - | mock progress duration time. more large files more duration time | N multiple | Boolean | false | multiple files uploading | N name | String | file | field name of files in upload request data | N placeholder | String | - | placeholder | N -requestMethod | Function | - | custom upload request method。Typescript：`(files: UploadFile \| UploadFile[]) => Promise` `interface RequestMethodResponse { status: 'success' \| 'fail'; error?: string; response: { url?: string; files?: UploadFile[]; [key: string]: any } }`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/upload/type.ts) | N +requestMethod | Function | - | custom upload request method。Typescript: `(files: UploadFile \| UploadFile[]) => Promise` `interface RequestMethodResponse { status: 'success' \| 'fail'; error?: string; response: { url?: string; files?: UploadFile[]; [key: string]: any } }`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/upload/type.ts) | N showImageFileName | Boolean | true | show image's name | N showThumbnail | Boolean | false | show thumbnail before file name, only works on `theme=file-flow` | N showUploadProgress | Boolean | true | show upload progress nodes | N -sizeLimit | Number / Object | - | files size limit。Typescript：`number \| SizeLimitObj` `interface SizeLimitObj { size: number; unit: SizeUnit ; message?: string }` `type SizeUnitArray = ['B', 'KB', 'MB', 'GB']` `type SizeUnit = SizeUnitArray[number]`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/upload/type.ts) | N +sizeLimit | Number / Object | - | files size limit。Typescript: `number \| SizeLimitObj` `interface SizeLimitObj { size: number; unit: SizeUnit ; message?: string }` `type SizeUnitArray = ['B', 'KB', 'MB', 'GB']` `type SizeUnit = SizeUnitArray[number]`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/upload/type.ts) | N status | String | - | tips status。options: default/success/warning/error | N theme | String | file | different upload UI styles。options: custom/file/file-input/file-flow/image/image-flow | N -tips | TNode | - | tips text below upload component, define it's color with `status`。Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -trigger | TElement | - | trigger elements UI。Typescript：`TNode` `interface TriggerContext { dragActive?: boolean; files: UploadFile[] }`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/upload/type.ts) | N -triggerButtonProps | Object | - | trigger button props, it can be used to change color/size/href/... of the trigger button。Typescript：`ButtonProps`，[Button API Documents](./button?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/upload/type.ts) | N +tips | TNode | - | tips text below upload component, define it's color with `status`。Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +trigger | TElement | - | trigger elements UI。Typescript: `TNode` `interface TriggerContext { dragActive?: boolean; files: UploadFile[] }`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/upload/type.ts) | N +triggerButtonProps | Object | - | trigger button props, it can be used to change color/size/href/... of the trigger button。Typescript: `ButtonProps`，[Button API Documents](./button?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/upload/type.ts) | N uploadAllFilesInOneRequest | Boolean | false | uploading all files in one request | N -uploadButton | TNode | - | upload button props, which showed on `autoUpload=false` and multiple files/images upload。Typescript：`null \| ButtonProps \| TNode<{ disabled: boolean; uploading: boolean; uploadFiles: () => void; uploadText: string }>`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +uploadButton | TNode | - | upload button props, which showed on `autoUpload=false` and multiple files/images upload。Typescript: `null \| ButtonProps \| TNode<{ disabled: boolean; uploading: boolean; uploadFiles: () => void; uploadText: string }>`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N uploadPastedFiles | Boolean | true | allow to upload files in clipboard after pasting | N useMockProgress | Boolean | true | use mock progress, instead of real progress | N withCredentials | Boolean | false | uploading request with cookie | N -onCancelUpload | Function | | Typescript：`() => void`
trigger on cancel button click | N -onChange | Function | | Typescript：`(value: Array, context: UploadChangeContext) => void`
trigger on uploaded files change。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/upload/type.ts)。
`interface UploadChangeContext { e?: MouseEvent \| ProgressEvent; response?: any; trigger: UploadChangeTrigger; index?: number; file?: UploadFile; files?: UploadFile[] }`

`type UploadChangeTrigger = 'add' \| 'remove' \| 'abort' \| 'progress-success' \| 'progress' \| 'progress-fail' \| 'default'`
| N -onDragenter | Function | | Typescript：`(context: { e: DragEvent }) => void`
trigger on file dragged into drag elements | N -onDragleave | Function | | Typescript：`(context: { e: DragEvent }) => void`
trigger on file dragged leave drag elements | N -onDrop | Function | | Typescript：`(context: { e: DragEvent }) => void`
trigger on file dropped | N -onFail | Function | | Typescript：`(options: UploadFailContext) => void`
`response.error` used for error tips, `formatResponse` can format `response`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/upload/type.ts)。
`interface UploadFailContext { e?: ProgressEvent; failedFiles: UploadFile[]; currentFiles: UploadFile[]; response?: any; file: UploadFile; XMLHttpRequest?: XMLHttpRequest}`
| N -onOneFileFail | Function | | Typescript：`(options: UploadFailContext) => void`
trigger on one file upload failed | N -onOneFileSuccess | Function | | Typescript：`(context: Pick) => void`
trigger on file uploaded successfully | N -onPreview | Function | | Typescript：`(options: { file: UploadFile; index: number; e: MouseEvent }) => void`
trigger on preview elements click | N -onProgress | Function | | Typescript：`(options: ProgressContext) => void`
uploading request progress event。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/upload/type.ts)。
`interface ProgressContext { e?: ProgressEvent; file?: UploadFile; currentFiles: UploadFile[]; percent: number; type: UploadProgressType; XMLHttpRequest?: XMLHttpRequest }`

`type UploadProgressType = 'real' \| 'mock'`
| N -onRemove | Function | | Typescript：`(context: UploadRemoveContext) => void`
trigger on file removed。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/upload/type.ts)。
`interface UploadRemoveContext { index?: number; file?: UploadFile; e: MouseEvent }`
| N -onSelectChange | Function | | Typescript：`(files: File[], context: UploadSelectChangeContext) => void`
trigger after file choose and before upload。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/upload/type.ts)。
`interface UploadSelectChangeContext { currentSelectedFiles: UploadFile[] }`
| N -onSuccess | Function | | Typescript：`(context: SuccessContext) => void`
trigger on all files uploaded successfully。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/upload/type.ts)。
`interface SuccessContext { e?: ProgressEvent; file?: UploadFile; fileList?: UploadFile[]; currentFiles?: UploadFile[]; response?: any; results?: SuccessContext[]; XMLHttpRequest?: XMLHttpRequest }`
| N -onValidate | Function | | Typescript：`(context: { type: UploadValidateType, files: UploadFile[] }) => void`
trigger on length over limit, or trigger on file size over limit。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/upload/type.ts)。
`type UploadValidateType = 'FILE_OVER_SIZE_LIMIT' \| 'FILES_OVER_LENGTH_LIMIT' \| 'FILTER_FILE_SAME_NAME' \| 'BEFORE_ALL_FILES_UPLOAD' \| 'CUSTOM_BEFORE_UPLOAD'`
| N -onWaitingUploadFilesChange | Function | | Typescript：`(context: { files: Array, trigger: 'validate' \| 'remove' \| 'uploaded' }) => void`
trigger on waiting upload files changed | N +onCancelUpload | Function | | Typescript: `() => void`
trigger on cancel button click | N +onChange | Function | | Typescript: `(value: Array, context: UploadChangeContext) => void`
trigger on uploaded files change。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/upload/type.ts)。
`interface UploadChangeContext { e?: MouseEvent \| ProgressEvent; response?: any; trigger: UploadChangeTrigger; index?: number; file?: UploadFile; files?: UploadFile[] }`

`type UploadChangeTrigger = 'add' \| 'remove' \| 'abort' \| 'progress-success' \| 'progress' \| 'progress-fail' \| 'default'`
| N +onDragenter | Function | | Typescript: `(context: { e: DragEvent }) => void`
trigger on file dragged into drag elements | N +onDragleave | Function | | Typescript: `(context: { e: DragEvent }) => void`
trigger on file dragged leave drag elements | N +onDrop | Function | | Typescript: `(context: { e: DragEvent }) => void`
trigger on file dropped | N +onFail | Function | | Typescript: `(options: UploadFailContext) => void`
`response.error` used for error tips, `formatResponse` can format `response`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/upload/type.ts)。
`interface UploadFailContext { e?: ProgressEvent; failedFiles: UploadFile[]; currentFiles: UploadFile[]; response?: any; file: UploadFile; XMLHttpRequest?: XMLHttpRequest}`
| N +onOneFileFail | Function | | Typescript: `(options: UploadFailContext) => void`
trigger on one file upload failed | N +onOneFileSuccess | Function | | Typescript: `(context: Pick) => void`
trigger on file uploaded successfully | N +onPreview | Function | | Typescript: `(options: { file: UploadFile; index: number; e: MouseEvent }) => void`
trigger on preview elements click | N +onProgress | Function | | Typescript: `(options: ProgressContext) => void`
uploading request progress event。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/upload/type.ts)。
`interface ProgressContext { e?: ProgressEvent; file?: UploadFile; currentFiles: UploadFile[]; percent: number; type: UploadProgressType; XMLHttpRequest?: XMLHttpRequest }`

`type UploadProgressType = 'real' \| 'mock'`
| N +onRemove | Function | | Typescript: `(context: UploadRemoveContext) => void`
trigger on file removed。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/upload/type.ts)。
`interface UploadRemoveContext { index?: number; file?: UploadFile; e: MouseEvent }`
| N +onSelectChange | Function | | Typescript: `(files: File[], context: UploadSelectChangeContext) => void`
trigger after file choose and before upload。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/upload/type.ts)。
`interface UploadSelectChangeContext { currentSelectedFiles: UploadFile[] }`
| N +onSuccess | Function | | Typescript: `(context: SuccessContext) => void`
trigger on all files uploaded successfully。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/upload/type.ts)。
`interface SuccessContext { e?: ProgressEvent; file?: UploadFile; fileList?: UploadFile[]; currentFiles?: UploadFile[]; response?: any; results?: SuccessContext[]; XMLHttpRequest?: XMLHttpRequest }`
| N +onValidate | Function | | Typescript: `(context: { type: UploadValidateType, files: UploadFile[] }) => void`
trigger on length over limit, or trigger on file size over limit。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/upload/type.ts)。
`type UploadValidateType = 'FILE_OVER_SIZE_LIMIT' \| 'FILES_OVER_LENGTH_LIMIT' \| 'FILTER_FILE_SAME_NAME' \| 'BEFORE_ALL_FILES_UPLOAD' \| 'CUSTOM_BEFORE_UPLOAD'`
| N +onWaitingUploadFilesChange | Function | | Typescript: `(context: { files: Array, trigger: 'validate' \| 'remove' \| 'uploaded' }) => void`
trigger on waiting upload files changed | N ### UploadInstanceFunctions 组件实例方法 name | params | return | description -- | -- | -- | -- -className | String | - | 类名 | N -style | Object | - | 样式，Typescript：`React.CSSProperties` | N +className | String | - | className of component | N +style | Object | - | CSS(Cascading Style Sheets)，Typescript: `React.CSSProperties` | N triggerUpload | \- | \- | required。instance function: trigger system file select uploadFilePercent | `(params: { file: UploadFile; percent: number })` | \- | required。instance function: set uploading file progress percent uploadFiles | `(files?: UploadFile[])` | \- | required。instance function: upload all files which status are not success @@ -86,10 +86,10 @@ name | type | default | description | required lastModified | Number | - | \- | N name | String | - | \- | N percent | Number | - | \- | N -raw | Object | - | Typescript：`File` | N -response | Object | - | Typescript：`{ [key: string]: any }` | N +raw | Object | - | Typescript: `File` | N +response | Object | - | Typescript: `{ [key: string]: any }` | N size | Number | - | \- | N -status | String | - | Typescript：` 'success' \| 'fail' \| 'progress' \| 'waiting'` | N +status | String | - | Typescript: ` 'success' \| 'fail' \| 'progress' \| 'waiting'` | N type | String | - | \- | N uploadTime | String | - | upload time | N url | String | - | \- | N diff --git a/packages/components/upload/upload.md b/packages/components/upload/upload.md index cb9dccc3c2..fb65225f11 100644 --- a/packages/components/upload/upload.md +++ b/packages/components/upload/upload.md @@ -3,7 +3,7 @@ ## API ### Upload Props -名称 | 类型 | 默认值 | 说明 | 必传 +名称 | 类型 | 默认值 | 描述 | 必传 -- | -- | -- | -- | -- className | String | - | 类名 | N style | Object | - | 样式，TS 类型：`React.CSSProperties` | N @@ -81,7 +81,7 @@ uploadFiles | `(files?: UploadFile[])` | \- | 必需。组件实例方法，默 ### UploadFile -名称 | 类型 | 默认值 | 说明 | 必传 +名称 | 类型 | 默认值 | 描述 | 必传 -- | -- | -- | -- | -- lastModified | Number | - | 上一次变更的时间 | N name | String | - | 文件名称 | N diff --git a/packages/components/watermark/watermark.en-US.md b/packages/components/watermark/watermark.en-US.md index ad12639c0f..255b9d6ceb 100644 --- a/packages/components/watermark/watermark.en-US.md +++ b/packages/components/watermark/watermark.en-US.md @@ -7,20 +7,20 @@ name | type | default | description | required -- | -- | -- | -- | -- className | String | - | className of component | N -style | Object | - | CSS(Cascading Style Sheets)，Typescript：`React.CSSProperties` | N +style | Object | - | CSS(Cascading Style Sheets)，Typescript: `React.CSSProperties` | N alpha | Number | 1 | \- | N -children | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N -content | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +children | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N +content | TNode | - | Typescript: `string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N height | Number | - | \- | N isRepeat | Boolean | true | \- | N layout | String | rectangular | options: rectangular/hexagonal | N lineSpace | Number | 16 | \- | N movable | Boolean | false | \- | N moveInterval | Number | 3000 | \- | N -offset | Array | - | Typescript：`Array` | N +offset | Array | - | Typescript: `Array` | N removable | Boolean | false | \- | N rotate | Number | -22 | \- | N -watermarkContent | Object / Array | - | Typescript：`WatermarkText\|WatermarkImage\|Array` | N +watermarkContent | Object / Array | - | Typescript: `WatermarkText\|WatermarkImage\|Array` | N width | Number | - | \- | N x | Number | - | \- | N y | Number | - | \- | N