mirror/ant-design
1
0
Fork 0
mirror of https://github.com/ant-design/ant-design.git synced 2025-06-07 17:44:35 +08:00
Code Issues Actions 18 Packages Projects Releases Wiki Activity

docs(update): removed 3.x version description in 4.0-prepare (#19827)

Browse Source 
* docs(update): removed 3.x version description in 4.0-prepare

ref #19815

* docs(update): update docs

remove carousel/index.zh-CN.md empty version column

* docs(update): update docs

remove carousel/index.en-US.md empty version column
This commit is contained in:
seognil LC 2019-11-20 20:31:43 +08:00 committed by 二货机器人
parent 4be963d973
commit c93bd326f4
22 changed files with 141 additions and 141 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
components/avatar/index.en-US.md
View File

@ -14,6 +14,6 @@ Avatars can be used to represent people or objects. It supports images, `Icon`s,
| shape | the shape of avatar | `circle` \| `square` | `circle` | | | shape | the shape of avatar | `circle` \| `square` | `circle` | |
| size | the size of the avatar | number \| string: `large` `small` `default` | `default` | | | size | the size of the avatar | number \| string: `large` `small` `default` | `default` | |
| src | the address of the image for an image avatar | string | - | | | src | the address of the image for an image avatar | string | - | |
| srcSet | a list of sources to use for different screen resolutions | string | - | 3.11.0 | | srcSet | a list of sources to use for different screen resolutions | string | - | |
| alt | This attribute defines the alternative text describing the image | string | - | 3.7.0 | | alt | This attribute defines the alternative text describing the image | string | - | |
| onError | handler when img load error, return false to prevent default fallback behavior | () => boolean | - | 3.8.0 | | onError | handler when img load error, return false to prevent default fallback behavior | () => boolean | - | |

6
components/avatar/index.zh-CN.md
View File

@ -19,6 +19,6 @@ title: Avatar
| shape | 指定头像的形状 | Enum{ 'circle', 'square' } | `circle` | | | shape | 指定头像的形状 | Enum{ 'circle', 'square' } | `circle` | |
| size | 设置头像的大小 | number \| Enum{ 'large', 'small', 'default' } | `default` | | | size | 设置头像的大小 | number \| Enum{ 'large', 'small', 'default' } | `default` | |
| src | 图片类头像的资源地址 | string | - | | | src | 图片类头像的资源地址 | string | - | |
| srcSet | 设置图片类头像响应式资源地址 | string | - | 3.11.0 | | srcSet | 设置图片类头像响应式资源地址 | string | - | |
| alt | 图像无法显示时的替代文本 | string | - | 3.7.0 | | alt | 图像无法显示时的替代文本 | string | - | |
| onError | 图片加载失败的事件，返回 false 会关闭组件默认的 fallback 行为 | () => boolean | - | 3.8.0 | | onError | 图片加载失败的事件，返回 false 会关闭组件默认的 fallback 行为 | () => boolean | - | |

4
components/badge/index.en-US.md
View File

@ -24,7 +24,7 @@ Badge normally appears in proximity to notifications or user avatars with eye-ca
| Property | Description | Type | Default | Version | | Property | Description | Type | Default | Version |
| --- | --- | --- | --- | --- | | --- | --- | --- | --- | --- |
| color | Customize Badge dot color | string | - | 3.16.0 | | color | Customize Badge dot color | string | - | |
| count | Number to show in badge | ReactNode | | | | count | Number to show in badge | ReactNode | | |
| dot | Whether to display a red dot instead of `count` | boolean | `false` | | | dot | Whether to display a red dot instead of `count` | boolean | `false` | |
| offset | set offset of the badge dot, like`[x, y]` | `[number, number]` | - | | | offset | set offset of the badge dot, like`[x, y]` | `[number, number]` | - | |
@ -32,4 +32,4 @@ Badge normally appears in proximity to notifications or user avatars with eye-ca
| showZero | Whether to show badge when `count` is zero | boolean | `false` | | | showZero | Whether to show badge when `count` is zero | boolean | `false` | |
| status | Set Badge as a status dot | `success` \| `processing` \| `default` \| `error` \| `warning` | `''` | | | status | Set Badge as a status dot | `success` \| `processing` \| `default` \| `error` \| `warning` | `''` | |
| text | If `status` is set, `text` sets the display text of the status `dot` | string | `''` | | | text | If `status` is set, `text` sets the display text of the status `dot` | string | `''` | |
| title | Text to show when hovering over the badge | string | `count` | 3.5.0 | | title | Text to show when hovering over the badge | string | `count` | |

4
components/badge/index.zh-CN.md
View File

@ -25,7 +25,7 @@ title: Badge
| 参数 | 说明 | 类型 | 默认值 | 版本 | | 参数 | 说明 | 类型 | 默认值 | 版本 |
| --- | --- | --- | --- | --- | | --- | --- | --- | --- | --- |
| color | 自定义小圆点的颜色 | string | - | 3.16.0 | | color | 自定义小圆点的颜色 | string | - | |
| count | 展示的数字，大于 overflowCount 时显示为 `${overflowCount}+`，为 0 时隐藏 | ReactNode | | | | count | 展示的数字，大于 overflowCount 时显示为 `${overflowCount}+`，为 0 时隐藏 | ReactNode | | |
| dot | 不展示数字，只有一个小红点 | boolean | false | | | dot | 不展示数字，只有一个小红点 | boolean | false | |
| offset | 设置状态点的位置偏移，格式为 `[x, y]` | `[number, number]` | - | | | offset | 设置状态点的位置偏移，格式为 `[x, y]` | `[number, number]` | - | |
@ -33,4 +33,4 @@ title: Badge
| showZero | 当数值为 0 时，是否展示 Badge | boolean | false | | | showZero | 当数值为 0 时，是否展示 Badge | boolean | false | |
| status | 设置 Badge 为状态点 | Enum{ 'success', 'processing, 'default', 'error', 'warning' } | '' | | | status | 设置 Badge 为状态点 | Enum{ 'success', 'processing, 'default', 'error', 'warning' } | '' | |
| text | 在设置了 `status` 的前提下有效，设置状态点的文本 | string | '' | | | text | 在设置了 `status` 的前提下有效，设置状态点的文本 | string | '' | |
| title | 设置鼠标放在状态点上时显示的文字 | string | `count` | 3.5.0 | | title | 设置鼠标放在状态点上时显示的文字 | string | `count` | |

6
components/calendar/index.en-US.md
View File

@ -40,9 +40,9 @@ When data is in the form of dates, such as schedules, timetables, prices calenda
| mode | The display mode of the calendar | `month` \| `year` | `month` | | | mode | The display mode of the calendar | `month` \| `year` | `month` | |
| monthCellRender | Customize the display of the month cell, the returned content will be appended to the cell | function(date: moment): ReactNode | - | | | monthCellRender | Customize the display of the month cell, the returned content will be appended to the cell | function(date: moment): ReactNode | - | |
| monthFullCellRender | Customize the display of the month cell, the returned content will override the cell | function(date: moment): ReactNode | - | | | monthFullCellRender | Customize the display of the month cell, the returned content will override the cell | function(date: moment): ReactNode | - | |
| validRange | to set valid range | \[[moment](http://momentjs.com/), [moment](http://momentjs.com/)] | - | 3.3.0 | | validRange | to set valid range | \[[moment](http://momentjs.com/), [moment](http://momentjs.com/)] | - | |
| value | The current selected date | [moment](http://momentjs.com/) | current date | | | value | The current selected date | [moment](http://momentjs.com/) | current date | |
| onPanelChange | Callback for when panel changes | function(date: moment, mode: string) | - | | | onPanelChange | Callback for when panel changes | function(date: moment, mode: string) | - | |
| onSelect | Callback for when a date is selected | function(date: moment） | - | | | onSelect | Callback for when a date is selected | function(date: moment） | - | |
| onChange | Callback for when date changes | function(date: moment） | - | 3.8.0 | | onChange | Callback for when date changes | function(date: moment） | - | |
| headerRender | render custom header in panel | function(object:{value: moment, type: string, onChange: f(), onTypeChange: f()}) | - | 3.19.0 | | headerRender | render custom header in panel | function(object:{value: moment, type: string, onChange: f(), onTypeChange: f()}) | - | |

6
components/calendar/index.zh-CN.md
View File

@ -41,9 +41,9 @@ title: Calendar
| mode | 初始模式，`month/year` | string | month | | | mode | 初始模式，`month/year` | string | month | |
| monthCellRender | 自定义渲染月单元格，返回内容会被追加到单元格 | function(date: moment): ReactNode | 无 | | | monthCellRender | 自定义渲染月单元格，返回内容会被追加到单元格 | function(date: moment): ReactNode | 无 | |
| monthFullCellRender | 自定义渲染月单元格，返回内容覆盖单元格 | function(date: moment): ReactNode | 无 | | | monthFullCellRender | 自定义渲染月单元格，返回内容覆盖单元格 | function(date: moment): ReactNode | 无 | |
| validRange | 设置可以显示的日期 | \[[moment](http://momentjs.com/), [moment](http://momentjs.com/)] | 无 | 3.3.0 | | validRange | 设置可以显示的日期 | \[[moment](http://momentjs.com/), [moment](http://momentjs.com/)] | 无 | |
| value | 展示日期 | [moment](http://momentjs.com/) | 当前日期 | | | value | 展示日期 | [moment](http://momentjs.com/) | 当前日期 | |
| onPanelChange | 日期面板变化回调 | function(date: moment, mode: string) | 无 | | | onPanelChange | 日期面板变化回调 | function(date: moment, mode: string) | 无 | |
| onSelect | 点击选择日期回调 | function(date: moment） | 无 | | | onSelect | 点击选择日期回调 | function(date: moment） | 无 | |
| onChange | 日期变化回调 | function(date: moment） | 无 | 3.8.0 | | onChange | 日期变化回调 | function(date: moment） | 无 | |
| headerRender | 自定义头部内容 | function(object:{value: moment, type: string, onChange: f(), onTypeChange: f()}) | 无 | 3.19.0 | | headerRender | 自定义头部内容 | function(object:{value: moment, type: string, onChange: f(), onTypeChange: f()}) | 无 | |

10
components/card/index.en-US.md
View File

@ -22,18 +22,18 @@ A card can be used to display content related to a single subject. The content c
| Property | Description | Type | Default | Version | | Property | Description | Type | Default | Version |
| --- | --- | --- | --- | --- | | --- | --- | --- | --- | --- |
| actions | The action list, shows at the bottom of the Card. | Array<ReactNode> | - | | | actions | The action list, shows at the bottom of the Card. | Array<ReactNode> | - | |
| activeTabKey | Current TabPane's key | string | - | 3.3.0 | | activeTabKey | Current TabPane's key | string | - | |
| headStyle | Inline style to apply to the card head | object | - | 3.8.0 | | headStyle | Inline style to apply to the card head | object | - | |
| bodyStyle | Inline style to apply to the card content | object | - | | | bodyStyle | Inline style to apply to the card content | object | - | |
| bordered | Toggles rendering of the border around the card | boolean | `true` | | | bordered | Toggles rendering of the border around the card | boolean | `true` | |
| cover | Card cover | ReactNode | - | | | cover | Card cover | ReactNode | - | |
| defaultActiveTabKey | Initial active TabPane's key, if `activeTabKey` is not set. | string | - | 3.3.0 | | defaultActiveTabKey | Initial active TabPane's key, if `activeTabKey` is not set. | string | - | |
| extra | Content to render in the top-right corner of the card | string\|ReactNode | - | | | extra | Content to render in the top-right corner of the card | string\|ReactNode | - | |
| hoverable | Lift up when hovering card | boolean | false | | | hoverable | Lift up when hovering card | boolean | false | |
| loading | Shows a loading indicator while the contents of the card are being fetched | boolean | false | | | loading | Shows a loading indicator while the contents of the card are being fetched | boolean | false | |
| tabList | List of TabPane's head. | Array<{key: string, tab: ReactNode}> | - | | | tabList | List of TabPane's head. | Array<{key: string, tab: ReactNode}> | - | |
| tabBarExtraContent | Extra content in tab bar | React.ReactNode | - | | | tabBarExtraContent | Extra content in tab bar | React.ReactNode | - | |
| size | Size of card | `default` \| `small` | `default` | 3.12.0 | | size | Size of card | `default` \| `small` | `default` | |
| title | Card title | string\|ReactNode | - | | | title | Card title | string\|ReactNode | - | |
| type | Card style type, can be set to `inner` or not set | string | - | | | type | Card style type, can be set to `inner` or not set | string | - | |
| onTabChange | Callback when tab is switched | (key) => void | - | | | onTabChange | Callback when tab is switched | (key) => void | - | |
@ -43,7 +43,7 @@ A card can be used to display content related to a single subject. The content c
| Property | Description | Type | Default | Version | | Property | Description | Type | Default | Version |
| --------- | ------------------------------- | ------- | ------- | ------- | | --------- | ------------------------------- | ------- | ------- | ------- |
| className | className of container | string | - | | | className | className of container | string | - | |
| hoverable | Lift up when hovering card grid | boolean | true | 3.23.0 | | hoverable | Lift up when hovering card grid | boolean | true | |
| style | style object of container | object | - | | | style | style object of container | object | - | |
### Card.Meta ### Card.Meta

18
components/card/index.zh-CN.md
View File

@ -23,29 +23,29 @@ cols: 1
| 参数 | 说明 | 类型 | 默认值 | 版本 | | 参数 | 说明 | 类型 | 默认值 | 版本 |
| --- | --- | --- | --- | --- | | --- | --- | --- | --- | --- |
| actions | 卡片操作组，位置在卡片底部 | Array<ReactNode> | - | | | actions | 卡片操作组，位置在卡片底部 | Array<ReactNode> | - | |
| activeTabKey | 当前激活页签的 key | string | - | 3.3.0 | | activeTabKey | 当前激活页签的 key | string | - | |
| headStyle | 自定义标题区域样式 | object | - | 3.8.0 | | headStyle | 自定义标题区域样式 | object | - | |
| bodyStyle | 内容区域自定义样式 | object | - | | | bodyStyle | 内容区域自定义样式 | object | - | |
| bordered | 是否有边框 | boolean | true | | | bordered | 是否有边框 | boolean | true | |
| cover | 卡片封面 | ReactNode | - | | | cover | 卡片封面 | ReactNode | - | |
| defaultActiveTabKey | 初始化选中页签的 key，如果没有设置 activeTabKey | string | 第一个页签 | 3.3.0 | | defaultActiveTabKey | 初始化选中页签的 key，如果没有设置 activeTabKey | string | 第一个页签 | |
| extra | 卡片右上角的操作区域 | string\|ReactNode | - | | | extra | 卡片右上角的操作区域 | string\|ReactNode | - | |
| hoverable | 鼠标移过时可浮起 | boolean | false | | | hoverable | 鼠标移过时可浮起 | boolean | false | |
| loading | 当卡片内容还在加载中时，可以用 loading 展示一个占位 | boolean | false | | | loading | 当卡片内容还在加载中时，可以用 loading 展示一个占位 | boolean | false | |
| tabList | 页签标题列表 | Array<{key: string, tab: ReactNode}> | - | | | tabList | 页签标题列表 | Array<{key: string, tab: ReactNode}> | - | |
| tabBarExtraContent | tab bar 上额外的元素 | React.ReactNode | 无 | | | tabBarExtraContent | tab bar 上额外的元素 | React.ReactNode | 无 | |
| size | card 的尺寸 | `default` \| `small` | `default` | 3.12.0 | | size | card 的尺寸 | `default` \| `small` | `default` | |
| title | 卡片标题 | string\|ReactNode | - | | | title | 卡片标题 | string\|ReactNode | - | |
| type | 卡片类型，可设置为 `inner` 或 不设置 | string | - | | | type | 卡片类型，可设置为 `inner` 或 不设置 | string | - | |
| onTabChange | 页签切换的回调 | (key) => void | - | | | onTabChange | 页签切换的回调 | (key) => void | - | |
### Card.Grid ### Card.Grid
| 参数 | 说明 | 类型 | 默认值 | 版本 | | 参数 | 说明 | 类型 | 默认值 | 版本 |
| --------- | ---------------------- | ------- | ------ | ------ | | --------- | ---------------------- | ------- | ------ | ---- |
| className | 网格容器类名 | string | - | | | className | 网格容器类名 | string | - | |
| hoverable | 鼠标移过时可浮起 | boolean | true | 3.23.0 | | hoverable | 鼠标移过时可浮起 | boolean | true | |
| style | 定义网格容器类名的样式 | object | - | | | style | 定义网格容器类名的样式 | object | - | |
### Card.Meta ### Card.Meta

12
components/carousel/index.en-US.md
View File

@ -19,17 +19,17 @@ A carousel component. Scales with its container.
| afterChange | Callback function called after the current index changes | function(current) | - | | | afterChange | Callback function called after the current index changes | function(current) | - | |
| autoplay | Whether to scroll automatically | boolean | `false` | | | autoplay | Whether to scroll automatically | boolean | `false` | |
| beforeChange | Callback function called before the current index changes | function(from, to) | - | | | beforeChange | Callback function called before the current index changes | function(from, to) | - | |
| dotPosition | The position of the dots, which can be one of `top` `bottom` `left` `right` | string | bottom | 3.17.0 | | dotPosition | The position of the dots, which can be one of `top` `bottom` `left` `right` | string | bottom | |
| dots | Whether to show the dots at the bottom of the gallery | boolean | `true` | | | dots | Whether to show the dots at the bottom of the gallery | boolean | `true` | |
| easing | Transition interpolation function name | string | `linear` | | | easing | Transition interpolation function name | string | `linear` | |
| effect | Transition effect | `scrollx` \| `fade` | `scrollx` | | | effect | Transition effect | `scrollx` \| `fade` | `scrollx` | |
## Methods ## Methods
| Name | Description | Version | | Name | Description |
| --- | --- | --- | | --- | --- |
| goTo(slideNumber, dontAnimate) | Go to slide index, if dontAnimate=true, it happens without animation | 3.9.3 | | goTo(slideNumber, dontAnimate) | Go to slide index, if dontAnimate=true, it happens without animation |
| next() | Change current slide to next slide | | | next() | Change current slide to next slide |
| prev() | Change current slide to previous slide | | | prev() | Change current slide to previous slide |
For more info on the parameters, refer to the <https://github.com/akiran/react-slick> For more info on the parameters, refer to the <https://github.com/akiran/react-slick>

8
components/carousel/index.zh-CN.md
View File

@ -20,7 +20,7 @@ subtitle: 走马灯
| afterChange | 切换面板的回调 | function(current) | 无 | | | | afterChange | 切换面板的回调 | function(current) | 无 | | |
| autoplay | 是否自动切换 | boolean | false | | | | autoplay | 是否自动切换 | boolean | false | | |
| beforeChange | 切换面板的回调 | function(from, to) | 无 | | | | beforeChange | 切换面板的回调 | function(from, to) | 无 | | |
| dotPosition | 面板指示点位置，可选 `top` `bottom` `left` `right` | string | bottom | 3.17.0 | 3.17.0 | | dotPosition | 面板指示点位置，可选 `top` `bottom` `left` `right` | string | bottom | |
| dots | 是否显示面板指示点 | boolean | true | | | | dots | 是否显示面板指示点 | boolean | true | | |
| easing | 动画效果 | string | linear | | | | easing | 动画效果 | string | linear | | |
| effect | 动画效果函数，可取 scrollx, fade | string | scrollx | | | | effect | 动画效果函数，可取 scrollx, fade | string | scrollx | | |
@ -29,8 +29,8 @@ subtitle: 走马灯
| 名称 | 描述 | | 名称 | 描述 |
| ------------------------------ | ------------------------------------------------- | | ------------------------------ | ------------------------------------------------- |
| goTo(slideNumber, dontAnimate) | 切换到指定面板, dontAnimate = true 时，不使用动画 | 3.9.3 | | goTo(slideNumber, dontAnimate) | 切换到指定面板, dontAnimate = true 时，不使用动画 |
| next() | 切换到下一面板 | | | next() | 切换到下一面板 |
| prev() | 切换到上一面板 | | | prev() | 切换到上一面板 |
更多参数可参考：<https://github.com/akiran/react-slick> 更多参数可参考：<https://github.com/akiran/react-slick>

16
components/collapse/index.en-US.md
View File

@ -20,20 +20,20 @@ A content area which can be collapsed and expanded.
| --- | --- | --- | --- | --- | | --- | --- | --- | --- | --- |
| activeKey | Key of the active panel | string\[]\|string\| number\[]\|number | No default value. In `accordion` mode, it's the key of the first panel. | | | activeKey | Key of the active panel | string\[]\|string\| number\[]\|number | No default value. In `accordion` mode, it's the key of the first panel. | |
| defaultActiveKey | Key of the initial active panel | string\[]\|string\| number\[]\|number | - | | | defaultActiveKey | Key of the initial active panel | string\[]\|string\| number\[]\|number | - | |
| bordered | Toggles rendering of the border around the collapse block | boolean | `true` | 3.6.5 | | bordered | Toggles rendering of the border around the collapse block | boolean | `true` | |
| accordion | If `true`, `Collapse` renders as `Accordion` | boolean | `false` | 3.6.5 | | accordion | If `true`, `Collapse` renders as `Accordion` | boolean | `false` | |
| onChange | Callback function executed when active panel is changed | Function | - | | | onChange | Callback function executed when active panel is changed | Function | - | |
| expandIcon | allow to customize collapse icon | (panelProps) => ReactNode | - | 3.13.0 | | expandIcon | allow to customize collapse icon | (panelProps) => ReactNode | - | |
| expandIconPosition | Set expand icon position: `left`, `right` | `left` | - | 3.17.0 | | expandIconPosition | Set expand icon position: `left`, `right` | `left` | - | |
| destroyInactivePanel | Destroy Inactive Panel | boolean | `false` | 3.6.5 | | destroyInactivePanel | Destroy Inactive Panel | boolean | `false` | |
### Collapse.Panel ### Collapse.Panel
| Property | Description | Type | Default | Version | | Property | Description | Type | Default | Version |
| --- | --- | --- | --- | --- | | --- | --- | --- | --- | --- |
| disabled | If `true`, panel cannot be opened or closed | boolean | `false` | | | disabled | If `true`, panel cannot be opened or closed | boolean | `false` | |
| forceRender | Forced render of content on panel, instead of lazy rending after clicking on header | boolean | `false` | 3.2.0 | | forceRender | Forced render of content on panel, instead of lazy rending after clicking on header | boolean | `false` | |
| header | Title of the panel | string\|ReactNode | - | | | header | Title of the panel | string\|ReactNode | - | |
| key | Unique key identifying the panel from among its siblings | string\|number | - | | | key | Unique key identifying the panel from among its siblings | string\|number | - | |
| showArrow | If `false`, panel will not show arrow icon | boolean | `true` | 3.1.0 | | showArrow | If `false`, panel will not show arrow icon | boolean | `true` | |
| extra | extra element in the corner | ReactNode | - | 3.14.0 | | extra | extra element in the corner | ReactNode | - | |

26
components/collapse/index.zh-CN.md
View File

@ -21,20 +21,20 @@ cols: 1
| --- | --- | --- | --- | --- | | --- | --- | --- | --- | --- |
| activeKey | 当前激活 tab 面板的 key | string\[]\|string\| number\[]\|number | 默认无，accordion 模式下默认第一个元素 | | | activeKey | 当前激活 tab 面板的 key | string\[]\|string\| number\[]\|number | 默认无，accordion 模式下默认第一个元素 | |
| defaultActiveKey | 初始化选中面板的 key | string\[]\|string\| number\[]\|number | 无 | | | defaultActiveKey | 初始化选中面板的 key | string\[]\|string\| number\[]\|number | 无 | |
| bordered | 带边框风格的折叠面板 | boolean | `true` | 3.13.0 | | bordered | 带边框风格的折叠面板 | boolean | `true` | |
| accordion | 手风琴模式 | boolean | `false` | 3.13.0 | | accordion | 手风琴模式 | boolean | `false` | |
| onChange | 切换面板的回调 | Function | 无 | | | onChange | 切换面板的回调 | Function | 无 | |
| expandIcon | 自定义切换图标 | (panelProps) => ReactNode | - | 3.13.0 | | expandIcon | 自定义切换图标 | (panelProps) => ReactNode | - | |
| expandIconPosition | 设置图标位置： `left`, `right` | `left` | - | 3.17.0 | | expandIconPosition | 设置图标位置： `left`, `right` | `left` | - | |
| destroyInactivePanel | 销毁折叠隐藏的面板 | boolean | `false` | 3.13.0 | | destroyInactivePanel | 销毁折叠隐藏的面板 | boolean | `false` | |
### Collapse.Panel ### Collapse.Panel
| 参数 | 说明 | 类型 | 默认值 | 版本 | | 参数 | 说明 | 类型 | 默认值 | 版本 |
| ----------- | ------------------------------------------ | ----------------- | ------ | ------ | | ----------- | ------------------------------------------ | ----------------- | ------ | ---- |
| disabled | 禁用后的面板展开与否将无法通过用户交互改变 | boolean | false | | | disabled | 禁用后的面板展开与否将无法通过用户交互改变 | boolean | false | |
| forceRender | 被隐藏时是否渲染 DOM 结构 | boolean | false | 3.2.0 | | forceRender | 被隐藏时是否渲染 DOM 结构 | boolean | false | |
| header | 面板头内容 | string\|ReactNode | 无 | | | header | 面板头内容 | string\|ReactNode | 无 | |
| key | 对应 activeKey | string\|number | 无 | | | key | 对应 activeKey | string\|number | 无 | |
| showArrow | 是否展示当前面板上的箭头 | boolean | `true` | 3.13.0 | | showArrow | 是否展示当前面板上的箭头 | boolean | `true` | |
| extra | 自定义渲染每个面板右上角的内容 | ReactNode | - | 3.14.0 | | extra | 自定义渲染每个面板右上角的内容 | ReactNode | - | |

12
components/comment/index.en-US.md
View File

@ -15,9 +15,9 @@ Comments can be used to enable discussions on an entity such as a page, blog pos
| Property | Description | Type | Default | Version | | Property | Description | Type | Default | Version |
| --- | --- | --- | --- | --- | | --- | --- | --- | --- | --- |
| actions | List of action items rendered below the comment content | Array<ReactNode> | - | 3.11.0 | | actions | List of action items rendered below the comment content | Array<ReactNode> | - | |
| author | The element to display as the comment author | string\|ReactNode | - | 3.11.0 | | author | The element to display as the comment author | string\|ReactNode | - | |
| avatar | The element to display as the comment avatar - generally an antd `Avatar` or src | string\|ReactNode | - | 3.11.0 | | avatar | The element to display as the comment avatar - generally an antd `Avatar` or src | string\|ReactNode | - | |
| children | Nested comments should be provided as children of the Comment | ReactNode | - | 3.11.0 | | children | Nested comments should be provided as children of the Comment | ReactNode | - | |
| content | The main content of the comment | string\|ReactNode | - | 3.11.0 | | content | The main content of the comment | string\|ReactNode | - | |
| datetime | A datetime element containing the time to be displayed | string\|ReactNode | - | 3.11.0 | | datetime | A datetime element containing the time to be displayed | string\|ReactNode | - | |

12
components/comment/index.zh-CN.md
View File

@ -16,9 +16,9 @@ cols: 1
| 参数 | 说明 | 类型 | 默认值 | 版本 | | 参数 | 说明 | 类型 | 默认值 | 版本 |
| --- | --- | --- | --- | --- | | --- | --- | --- | --- | --- |
| actions | 在评论内容下面呈现的操作项列表 | Array<ReactNode> | - | 3.11.0 | | actions | 在评论内容下面呈现的操作项列表 | Array<ReactNode> | - | |
| author | 要显示为注释作者的元素 | string\|ReactNode | - | 3.11.0 | | author | 要显示为注释作者的元素 | string\|ReactNode | - | |
| avatar | 要显示为评论头像的元素 - 通常是 antd `Avatar` 或者 src | string\|ReactNode | - | 3.11.0 | | avatar | 要显示为评论头像的元素 - 通常是 antd `Avatar` 或者 src | string\|ReactNode | - | |
| children | 嵌套注释应作为注释的子项提供 | ReactNode | - | 3.11.0 | | children | 嵌套注释应作为注释的子项提供 | ReactNode | - | |
| content | 评论的主要内容 | string\|ReactNode | - | 3.11.0 | | content | 评论的主要内容 | string\|ReactNode | - | |
| datetime | 展示时间描述 | string\|ReactNode | - | 3.11.0 | | datetime | 展示时间描述 | string\|ReactNode | - | |

16
components/descriptions/index.en-US.md
View File

@ -17,18 +17,18 @@ Commonly displayed on the details page.
| Property | Description | Type | Default | Version | | Property | Description | Type | Default | Version |
| --- | --- | --- | --- | --- | | --- | --- | --- | --- | --- |
| title | The title of the description list, placed at the top | ReactNode | - | 3.19.0 | | title | The title of the description list, placed at the top | ReactNode | - | |
| bordered | whether to display the border | boolean | false | 3.19.0 | | bordered | whether to display the border | boolean | false | |
| column | the number of `DescriptionItems` in a row,could be a number or a object like `{ xs: 8, sm: 16, md: 24}`,(Only set `bordered={true}` to take effect) | number | 3 | 3.19.0 | | column | the number of `DescriptionItems` in a row,could be a number or a object like `{ xs: 8, sm: 16, md: 24}`,(Only set `bordered={true}` to take effect) | number | 3 | |
| size | set the size of the list. Can be set to `middle`,`small`, or not filled | `default | middle | small` | false | 3.19.0 | | size | set the size of the list. Can be set to `middle`,`small`, or not filled | `default | middle | small` | false | |
| layout | Define description layout | `horizontal | vertical` | `horizontal` | 3.19.8 | | layout | Define description layout | `horizontal | vertical` | `horizontal` | |
| colon | change default props `colon` value of `Descriptions.Item` | boolean | true | 3.21.0 | | colon | change default props `colon` value of `Descriptions.Item` | boolean | true | |
### DescriptionItem ### DescriptionItem
| Property | Description | Type | Default | Version | | Property | Description | Type | Default | Version |
| -------- | ------------------------------ | --------- | ------- | ------- | | -------- | ------------------------------ | --------- | ------- | ------- |
| label | description of the content | ReactNode | - | 3.19.0 | | label | description of the content | ReactNode | - | |
| span | The number of columns included | number | 1 | 3.19.0 | | span | The number of columns included | number | 1 | |
> The number of span Description.Item. Span={2} takes up the width of two DescriptionItems. > The number of span Description.Item. Span={2} takes up the width of two DescriptionItems.

20
components/descriptions/index.zh-CN.md
View File

@ -18,18 +18,18 @@ cols: 1
| 参数 | 说明 | 类型 | 默认值 | 版本 | | 参数 | 说明 | 类型 | 默认值 | 版本 |
| --- | --- | --- | --- | --- | | --- | --- | --- | --- | --- |
| title | 描述列表的标题，显示在最顶部 | ReactNode | - | 3.19.0 | | title | 描述列表的标题，显示在最顶部 | ReactNode | - | |
| bordered | 是否展示边框 | boolean | false | 3.19.0 | | bordered | 是否展示边框 | boolean | false | |
| column | 一行的 `DescriptionItems` 数量，可以写成像素值或支持响应式的对象写法 `{ xs: 8, sm: 16, md: 24}` | number | 3 | 3.19.0 | | column | 一行的 `DescriptionItems` 数量，可以写成像素值或支持响应式的对象写法 `{ xs: 8, sm: 16, md: 24}` | number | 3 | |
| size | 设置列表的大小。可以设置为 `middle` 、`small`, 或不填（只有设置 `bordered={true}` 生效） | `default | middle | small` | false | 3.19.0 | | size | 设置列表的大小。可以设置为 `middle` 、`small`, 或不填（只有设置 `bordered={true}` 生效） | `default | middle | small` | false | |
| layout | 描述布局 | `horizontal | vertical` | `horizontal` | 3.19.8 | | layout | 描述布局 | `horizontal | vertical` | `horizontal` | |
| colon | 配置 `Descriptions.Item` 的 `colon` 的默认值 | boolean | true | 3.21.0 | | colon | 配置 `Descriptions.Item` 的 `colon` 的默认值 | boolean | true | |
### DescriptionItem ### DescriptionItem
| 参数 | 说明 | 类型 | 默认值 | 版本 | | 参数 | 说明 | 类型 | 默认值 | 版本 |
| ----- | ------------ | --------- | ------ | ------ | | ----- | ------------ | --------- | ------ | ---- |
| label | 内容的描述 | ReactNode | - | 3.19.0 | | label | 内容的描述 | ReactNode | - | |
| span | 包含列的数量 | number | 1 | 3.19.0 | | span | 包含列的数量 | number | 1 | |
> span 是 Description.Item 的数量。 span={2} 会占用两个 DescriptionItem 的宽度。 > span 是 Description.Item 的数量。 span={2} 会占用两个 DescriptionItem 的宽度。

6
components/empty/index.en-US.md
View File

@ -22,9 +22,9 @@ Empty state placeholder.
| Property | Description | Type | Default | Version | | Property | Description | Type | Default | Version |
| --- | --- | --- | --- | --- | | --- | --- | --- | --- | --- |
| description | Customize description | string \| ReactNode | - | 3.12.0 | | description | Customize description | string \| ReactNode | - | |
| imageStyle | style of image | CSSProperties | - | 3.16.0 | | imageStyle | style of image | CSSProperties | - | |
| image | Customize image. Will tread as image url when string provided. | string \| ReactNode | `Empty.PRESENTED_IMAGE_DEFAULT` | 3.12.0 | | image | Customize image. Will tread as image url when string provided. | string \| ReactNode | `Empty.PRESENTED_IMAGE_DEFAULT` | |
## Built-in images ## Built-in images

8
components/empty/index.zh-CN.md
View File

@ -23,11 +23,11 @@ cols: 1
| 参数 | 说明 | 类型 | 默认值 | 版本 | | 参数 | 说明 | 类型 | 默认值 | 版本 |
| --- | --- | --- | --- | --- | | --- | --- | --- | --- | --- |
| description | 自定义描述内容 | string \| ReactNode | - | 3.12.0 | | description | 自定义描述内容 | string \| ReactNode | - | |
| imageStyle | 图片样式 | CSSProperties | - | 3.16.0 | | imageStyle | 图片样式 | CSSProperties | - | |
| image | 设置显示图片，为 string 时表示自定义图片地址。 | string \| ReactNode | `Empty.PRESENTED_IMAGE_DEFAULT` | 3.12.0 | | image | 设置显示图片，为 string 时表示自定义图片地址。 | string \| ReactNode | `Empty.PRESENTED_IMAGE_DEFAULT` | |
## 内置图片 (3.16.0 以上版本) ## 内置图片
- Empty.PRESENTED_IMAGE_SIMPLE - Empty.PRESENTED_IMAGE_SIMPLE

10
components/list/index.en-US.md
View File

@ -22,14 +22,14 @@ A list can be used to display content related to a single subject. The content c
| grid | The grid type of list. You can set grid to something like {gutter: 16, column: 4} | object | - | | | grid | The grid type of list. You can set grid to something like {gutter: 16, column: 4} | object | - | |
| header | List header renderer | string\|ReactNode | - | | | header | List header renderer | string\|ReactNode | - | |
| itemLayout | The layout of list, default is `horizontal`, If a vertical list is desired, set the itemLayout property to `vertical` | string | - | | | itemLayout | The layout of list, default is `horizontal`, If a vertical list is desired, set the itemLayout property to `vertical` | string | - | |
| rowKey | Item's unique key, could be a string or function that returns a string | string\|Function(record):string | `key` | 3.12.0 | | rowKey | Item's unique key, could be a string or function that returns a string | string\|Function(record):string | `key` | |
| loading | Shows a loading indicator while the contents of the list are being fetched | boolean\|[object](https://ant.design/components/spin-cn/#API) ([more](https://github.com/ant-design/ant-design/issues/8659)) | false | | | loading | Shows a loading indicator while the contents of the list are being fetched | boolean\|[object](https://ant.design/components/spin-cn/#API) ([more](https://github.com/ant-design/ant-design/issues/8659)) | false | |
| loadMore | Shows a load more content | string\|ReactNode | - | | | loadMore | Shows a load more content | string\|ReactNode | - | |
| locale | i18n text including empty text | object | emptyText: 'No Data' <br> | 3.4.2 | | locale | i18n text including empty text | object | emptyText: 'No Data' <br> | |
| pagination | Pagination [config](https://ant.design/components/pagination/), hide it by setting it to false | boolean \| object | false | | | pagination | Pagination [config](https://ant.design/components/pagination/), hide it by setting it to false | boolean \| object | false | |
| split | Toggles rendering of the split under the list item | boolean | true | | | split | Toggles rendering of the split under the list item | boolean | true | |
| dataSource | dataSource array for list | any[] | - | 3.20.1 | | dataSource | dataSource array for list | any[] | - | |
| renderItem | customize list item when using `dataSource` | `item => ReactNode` | - | 3.20.1 | | renderItem | customize list item when using `dataSource` | `item => ReactNode` | - | |
### pagination ### pagination
@ -37,7 +37,7 @@ Properties for pagination.
| Property | Description | Type | Default | | Property | Description | Type | Default |
| -------- | ------------------------------------ | --------------------------- | -------- | | -------- | ------------------------------------ | --------------------------- | -------- |
| position | specify the position of `Pagination` | 'top' \| 'bottom' \| 'both' | 'bottom' | 3.6.0 | | position | specify the position of `Pagination` | 'top' \| 'bottom' \| 'both' | 'bottom' |
More about pagination, please check [`Pagination`](/components/pagination/). More about pagination, please check [`Pagination`](/components/pagination/).

8
components/list/index.zh-CN.md
View File

@ -25,12 +25,12 @@ cols: 1
| itemLayout | 设置 `List.Item` 布局, 设置成 `vertical` 则竖直样式显示, 默认横排 | string | - | | | itemLayout | 设置 `List.Item` 布局, 设置成 `vertical` 则竖直样式显示, 默认横排 | string | - | |
| loading | 当卡片内容还在加载中时，可以用 `loading` 展示一个占位 | boolean\|[object](https://ant.design/components/spin-cn/#API) ([更多](https://github.com/ant-design/ant-design/issues/8659)) | false | | | loading | 当卡片内容还在加载中时，可以用 `loading` 展示一个占位 | boolean\|[object](https://ant.design/components/spin-cn/#API) ([更多](https://github.com/ant-design/ant-design/issues/8659)) | false | |
| loadMore | 加载更多 | string\|ReactNode | - | | | loadMore | 加载更多 | string\|ReactNode | - | |
| locale | 默认文案设置，目前包括空数据文案 | object | emptyText: '暂无数据' | 3.4.2 | | locale | 默认文案设置，目前包括空数据文案 | object | emptyText: '暂无数据' | |
| pagination | 对应的 `pagination` 配置, 设置 `false` 不显示 | boolean\|object | false | | | pagination | 对应的 `pagination` 配置, 设置 `false` 不显示 | boolean\|object | false | |
| size | list 的尺寸 | `default` \| `middle` \| `small` | `default` | | | size | list 的尺寸 | `default` \| `middle` \| `small` | `default` | |
| split | 是否展示分割线 | boolean | true | | | split | 是否展示分割线 | boolean | true | |
| dataSource | 列表数据源 | any[] | - | 3.20.1 | | dataSource | 列表数据源 | any[] | - | |
| renderItem | 当使用 dataSource 时，可以用 `renderItem` 自定义渲染列表项 | `item => ReactNode` | - | 3.20.1 | | renderItem | 当使用 dataSource 时，可以用 `renderItem` 自定义渲染列表项 | `item => ReactNode` | - | |
### pagination ### pagination
@ -38,7 +38,7 @@ cols: 1
| 参数 | 说明 | 类型 | 默认值 | | 参数 | 说明 | 类型 | 默认值 |
| -------- | ------------------ | --------------------------- | -------- | | -------- | ------------------ | --------------------------- | -------- |
| position | 指定分页显示的位置 | 'top' \| 'bottom' \| 'both' | 'bottom' | 3.6.0 | | position | 指定分页显示的位置 | 'top' \| 'bottom' \| 'both' | 'bottom' |
更多配置项，请查看 [`Pagination`](/components/pagination/)。 更多配置项，请查看 [`Pagination`](/components/pagination/)。

32
components/statistic/index.en-US.md
View File

@ -17,24 +17,24 @@ Display statistic number.
| Property | Description | Type | Default | Version | | Property | Description | Type | Default | Version |
| ---------------- | ----------------------------- | -------------------- | ------- | ------- | | ---------------- | ----------------------------- | -------------------- | ------- | ------- |
| decimalSeparator | decimal separator | string | . | 3.13.0 | | decimalSeparator | decimal separator | string | . | |
| formatter | customize value display logic | (value) => ReactNode | - | 3.13.0 | | formatter | customize value display logic | (value) => ReactNode | - | |
| groupSeparator | group separator | string | , | 3.13.0 | | groupSeparator | group separator | string | , | |
| precision | precision of input value | number | - | 3.13.0 | | precision | precision of input value | number | - | |
| prefix | prefix node of value | string \| ReactNode | - | 3.13.0 | | prefix | prefix node of value | string \| ReactNode | - | |
| suffix | suffix node of value | string \| ReactNode | - | 3.13.0 | | suffix | suffix node of value | string \| ReactNode | - | |
| title | Display title | string \| ReactNode | - | 3.13.0 | | title | Display title | string \| ReactNode | - | |
| value | Display value | string \| number | - | 3.13.0 | | value | Display value | string \| number | - | |
| valueStyle | Set value css style | style | - | 3.13.0 | | valueStyle | Set value css style | style | - | |
#### Statistic.Countdown #### Statistic.Countdown
| Property | Description | Type | Default | Version | | Property | Description | Type | Default | Version |
| --- | --- | --- | --- | --- | | --- | --- | --- | --- | --- |
| format | Format as [moment](http://momentjs.com/) | string | 'HH:mm:ss' | 3.13.0 | | format | Format as [moment](http://momentjs.com/) | string | 'HH:mm:ss' | |
| onFinish | Trigger when time's up | () => void | - | 3.14.0 | | onFinish | Trigger when time's up | () => void | - | |
| prefix | prefix node of value | string \| ReactNode | - | 3.13.0 | | prefix | prefix node of value | string \| ReactNode | - | |
| suffix | suffix node of value | string \| ReactNode | - | 3.13.0 | | suffix | suffix node of value | string \| ReactNode | - | |
| title | Display title | string \| ReactNode | - | 3.13.0 | | title | Display title | string \| ReactNode | - | |
| value | Set target countdown time | number \| moment | - | 3.13.0 | | value | Set target countdown time | number \| moment | - | |
| valueStyle | Set value css style | style | - | 3.13.0 | | valueStyle | Set value css style | style | - | |

36
components/statistic/index.zh-CN.md
View File

@ -16,26 +16,26 @@ title: Statistic
#### Statistic #### Statistic
| 参数 | 说明 | 类型 | 默认值 | 版本 | | 参数 | 说明 | 类型 | 默认值 | 版本 |
| ---------------- | ---------------- | -------------------- | ------ | ------ | | ---------------- | ---------------- | -------------------- | ------ | ---- |
| decimalSeparator | 设置小数点 | string | . | 3.13.0 | | decimalSeparator | 设置小数点 | string | . | |
| formatter | 自定义数值展示 | (value) => ReactNode | - | 3.13.0 | | formatter | 自定义数值展示 | (value) => ReactNode | - | |
| groupSeparator | 设置千分位标识符 | string | , | 3.13.0 | | groupSeparator | 设置千分位标识符 | string | , | |
| precision | 数值精度 | number | - | 3.13.0 | | precision | 数值精度 | number | - | |
| prefix | 设置数值的前缀 | string \| ReactNode | - | 3.13.0 | | prefix | 设置数值的前缀 | string \| ReactNode | - | |
| suffix | 设置数值的后缀 | string \| ReactNode | - | 3.13.0 | | suffix | 设置数值的后缀 | string \| ReactNode | - | |
| title | 数值的标题 | string \| ReactNode | - | 3.13.0 | | title | 数值的标题 | string \| ReactNode | - | |
| value | 数值内容 | string \| number | - | 3.13.0 | | value | 数值内容 | string \| number | - | |
| valueStyle | 设置数值的样式 | style | - | 3.13.0 | | valueStyle | 设置数值的样式 | style | - | |
#### Statistic.Countdown #### Statistic.Countdown
| 参数 | 说明 | 类型 | 默认值 | 版本 | | 参数 | 说明 | 类型 | 默认值 | 版本 |
| --- | --- | --- | --- | --- | | --- | --- | --- | --- | --- |
| format | 格式化倒计时展示，参考 [moment](http://momentjs.com/) | string | 'HH:mm:ss' | 3.13.0 | | format | 格式化倒计时展示，参考 [moment](http://momentjs.com/) | string | 'HH:mm:ss' | |
| onFinish | 倒计时完成时触发 | () => void | - | 3.14.0 | | onFinish | 倒计时完成时触发 | () => void | - | |
| prefix | 设置数值的前缀 | string \| ReactNode | - | 3.13.0 | | prefix | 设置数值的前缀 | string \| ReactNode | - | |
| suffix | 设置数值的后缀 | string \| ReactNode | - | 3.13.0 | | suffix | 设置数值的后缀 | string \| ReactNode | - | |
| title | 数值的标题 | string \| ReactNode | - | 3.13.0 | | title | 数值的标题 | string \| ReactNode | - | |
| value | 数值内容 | number \| moment | - | 3.13.0 | | value | 数值内容 | number \| moment | - | |
| valueStyle | 设置数值的样式 | style | - | 3.13.0 | | valueStyle | 设置数值的样式 | style | - | |