From fa376f9c8285c008cc25d4c3c7ce711d234964da Mon Sep 17 00:00:00 2001 From: einq7 <50612752+AlanCutFlim@users.noreply.github.com> Date: Thu, 24 Dec 2020 12:02:57 +0800 Subject: [PATCH] docs: prettier markdown (#28510) --- .prettierignore | 1 + components/anchor/index.en-US.md | 10 +++--- components/anchor/index.zh-CN.md | 10 +++--- components/card/index.en-US.md | 24 +++++++-------- components/card/index.zh-CN.md | 24 +++++++-------- components/carousel/index.zh-CN.md | 8 ++--- components/cascader/index.en-US.md | 8 ++--- components/cascader/index.zh-CN.md | 8 ++--- components/checkbox/index.en-US.md | 8 ++--- components/checkbox/index.zh-CN.md | 24 +++++++-------- components/collapse/index.zh-CN.md | 16 +++++----- components/date-picker/index.en-US.md | 8 ++--- components/date-picker/index.zh-CN.md | 8 ++--- components/descriptions/index.en-US.md | 17 +++++------ components/descriptions/index.zh-CN.md | 17 +++++------ components/divider/index.zh-CN.md | 16 +++++----- components/icon/index.en-US.md | 2 +- components/icon/index.zh-CN.md | 16 +++++----- components/input-number/index.en-US.md | 8 ++--- components/input-number/index.zh-CN.md | 6 ++-- components/input/TextArea.tsx | 4 ++- components/list/index.en-US.md | 34 ++++++++++----------- components/list/index.zh-CN.md | 34 ++++++++++----------- components/mentions/index.en-US.md | 8 ++--- components/mentions/index.zh-CN.md | 14 ++++----- components/menu/index.en-US.md | 22 +++++++------- components/menu/index.zh-CN.md | 22 +++++++------- components/message/index.zh-CN.md | 10 +++--- components/popover/index.en-US.md | 8 ++--- components/popover/index.zh-CN.md | 8 ++--- components/progress/index.zh-CN.md | 10 +++--- components/radio/index.en-US.md | 8 ++--- components/radio/index.zh-CN.md | 20 ++++++------ components/rate/index.en-US.md | 8 ++--- components/rate/index.zh-CN.md | 6 ++-- components/select/index.en-US.md | 28 ++++++++--------- components/select/index.zh-CN.md | 30 +++++++++--------- components/skeleton/index.en-US.md | 24 +++++++-------- components/skeleton/index.zh-CN.md | 24 +++++++-------- components/slider/index.en-US.md | 8 ++--- components/slider/index.zh-CN.md | 8 ++--- components/spin/index.zh-CN.md | 16 +++++----- components/statistic/index.en-US.md | 42 +++++++++++++------------- components/statistic/index.zh-CN.md | 24 +++++++-------- components/switch/index.en-US.md | 8 ++--- components/switch/index.zh-CN.md | 6 ++-- components/tabs/index.zh-CN.md | 12 ++++---- components/tag/index.en-US.md | 24 +++++++-------- components/tag/index.zh-CN.md | 24 +++++++-------- components/time-picker/index.en-US.md | 14 ++++----- components/time-picker/index.zh-CN.md | 14 ++++----- components/tooltip/index.en-US.md | 6 ++-- components/tooltip/index.zh-CN.md | 6 ++-- components/transfer/index.en-US.md | 16 +++++----- components/transfer/index.zh-CN.md | 16 +++++----- components/tree-select/index.en-US.md | 8 ++--- components/tree-select/index.zh-CN.md | 28 ++++++++--------- components/typography/index.en-US.md | 16 +++++----- components/typography/index.zh-CN.md | 16 +++++----- docs/react/migration-v4.zh-CN.md | 2 -- docs/spec/data-format.en-US.md | 10 +++--- docs/spec/data-format.zh-CN.md | 22 +++++++------- docs/spec/research-list.zh-CN.md | 12 ++++---- docs/spec/research-workbench.zh-CN.md | 11 ++++--- 64 files changed, 466 insertions(+), 464 deletions(-) diff --git a/.prettierignore b/.prettierignore index 915ee45abe..19cca96c3d 100644 --- a/.prettierignore +++ b/.prettierignore @@ -27,5 +27,6 @@ components/*/*.jsx .DS_Store .editorconfig .eslintignore +.history **/*.yml components/style/color/*.less diff --git a/components/anchor/index.en-US.md b/components/anchor/index.en-US.md index 88cd56c209..6958f9cefe 100644 --- a/components/anchor/index.en-US.md +++ b/components/anchor/index.en-US.md @@ -30,8 +30,8 @@ For displaying anchor hyperlinks on page and jumping between them. ### Link Props -| Property | Description | Type | Default | Version | -| --- | --- | --- | --- | --- | -| href | The target of hyperlink | string | | | -| target | Specifies where to display the linked URL | string | | | -| title | The content of hyperlink | ReactNode | | | +| Property | Description | Type | Default | Version | +| -------- | ----------------------------------------- | --------- | ------- | ------- | +| href | The target of hyperlink | string | | | +| target | Specifies where to display the linked URL | string | | | +| title | The content of hyperlink | ReactNode | | | diff --git a/components/anchor/index.zh-CN.md b/components/anchor/index.zh-CN.md index e23d113489..5dec52f374 100644 --- a/components/anchor/index.zh-CN.md +++ b/components/anchor/index.zh-CN.md @@ -31,8 +31,8 @@ cover: https://gw.alipayobjects.com/zos/alicdn/_1-C1JwsC/Anchor.svg ### Link Props -| 成员 | 说明 | 类型 | 默认值 | 版本 | -| --- | --- | --- | --- | --- | -| href | 锚点链接 | string | - | | -| target | 该属性指定在何处显示链接的资源。 | string | - | | -| title | 文字内容 | ReactNode | - | | +| 成员 | 说明 | 类型 | 默认值 | 版本 | +| ------ | -------------------------------- | --------- | ------ | ---- | +| href | 锚点链接 | string | - | | +| target | 该属性指定在何处显示链接的资源。 | string | - | | +| title | 文字内容 | ReactNode | - | | diff --git a/components/card/index.en-US.md b/components/card/index.en-US.md index c5821dd796..13ebbca8e2 100644 --- a/components/card/index.en-US.md +++ b/components/card/index.en-US.md @@ -42,18 +42,18 @@ A card can be used to display content related to a single subject. The content c ### Card.Grid -| Property | Description | Type | Default | Version | -| --- | --- | --- | --- | --- | -| className | The className of container | string | - | | -| hoverable | Lift up when hovering card grid | boolean | true | | -| style | The style object of container | CSSProperties | - | | +| Property | Description | Type | Default | Version | +| --------- | ------------------------------- | ------------- | ------- | ------- | +| className | The className of container | string | - | | +| hoverable | Lift up when hovering card grid | boolean | true | | +| style | The style object of container | CSSProperties | - | | ### Card.Meta -| Property | Description | Type | Default | Version | -| --- | --- | --- | --- | --- | -| avatar | Avatar or icon | ReactNode | - | | -| className | The className of container | string | - | | -| description | Description content | ReactNode | - | | -| style | The style object of container | CSSProperties | - | | -| title | Title content | ReactNode | - | | +| Property | Description | Type | Default | Version | +| ----------- | ----------------------------- | ------------- | ------- | ------- | +| avatar | Avatar or icon | ReactNode | - | | +| className | The className of container | string | - | | +| description | Description content | ReactNode | - | | +| style | The style object of container | CSSProperties | - | | +| title | Title content | ReactNode | - | | diff --git a/components/card/index.zh-CN.md b/components/card/index.zh-CN.md index 029e88a8ab..a96f07705f 100644 --- a/components/card/index.zh-CN.md +++ b/components/card/index.zh-CN.md @@ -43,18 +43,18 @@ cover: https://gw.alipayobjects.com/zos/antfincdn/NqXt8DJhky/Card.svg ### Card.Grid -| 参数 | 说明 | 类型 | 默认值 | 版本 | -| --- | --- | --- | --- | --- | -| className | 网格容器类名 | string | - | | -| hoverable | 鼠标移过时可浮起 | boolean | true | | -| style | 定义网格容器类名的样式 | CSSProperties | - | | +| 参数 | 说明 | 类型 | 默认值 | 版本 | +| --------- | ---------------------- | ------------- | ------ | ---- | +| className | 网格容器类名 | string | - | | +| hoverable | 鼠标移过时可浮起 | boolean | true | | +| style | 定义网格容器类名的样式 | CSSProperties | - | | ### Card.Meta -| 参数 | 说明 | 类型 | 默认值 | 版本 | -| --- | --- | --- | --- | --- | -| avatar | 头像/图标 | ReactNode | - | | -| className | 容器类名 | string | - | | -| description | 描述内容 | ReactNode | - | | -| style | 定义容器类名的样式 | CSSProperties | - | | -| title | 标题内容 | ReactNode | - | | +| 参数 | 说明 | 类型 | 默认值 | 版本 | +| ----------- | ------------------ | ------------- | ------ | ---- | +| avatar | 头像/图标 | ReactNode | - | | +| className | 容器类名 | string | - | | +| description | 描述内容 | ReactNode | - | | +| style | 定义容器类名的样式 | CSSProperties | - | | +| title | 标题内容 | ReactNode | - | | diff --git a/components/carousel/index.zh-CN.md b/components/carousel/index.zh-CN.md index c4aee00d10..52cb411e91 100644 --- a/components/carousel/index.zh-CN.md +++ b/components/carousel/index.zh-CN.md @@ -28,10 +28,10 @@ cover: https://gw.alipayobjects.com/zos/antfincdn/%24C9tmj978R/Carousel.svg ## 方法 -| 名称 | 描述 | -| --- | --- | +| 名称 | 描述 | +| ------------------------------ | ------------------------------------------------- | | goTo(slideNumber, dontAnimate) | 切换到指定面板, dontAnimate = true 时，不使用动画 | -| next() | 切换到下一面板 | -| prev() | 切换到上一面板 | +| next() | 切换到下一面板 | +| prev() | 切换到上一面板 | 更多 API 可参考： diff --git a/components/cascader/index.en-US.md b/components/cascader/index.en-US.md index 5b3de3ab27..09b6511ab7 100644 --- a/components/cascader/index.en-US.md +++ b/components/cascader/index.en-US.md @@ -72,7 +72,7 @@ interface Option { ## Methods -| Name | Description | Version | -| --- | --- | --- | -| blur() | Remove focus | | -| focus() | Get focus | | +| Name | Description | Version | +| ------- | ------------ | ------- | +| blur() | Remove focus | | +| focus() | Get focus | | diff --git a/components/cascader/index.zh-CN.md b/components/cascader/index.zh-CN.md index 97c18c5c7c..15d7a55f7b 100644 --- a/components/cascader/index.zh-CN.md +++ b/components/cascader/index.zh-CN.md @@ -75,9 +75,9 @@ interface Option { ## 方法 -| 名称 | 描述 | 版本 | -| --- | --- | --- | -| blur() | 移除焦点 | | -| focus() | 获取焦点 | | +| 名称 | 描述 | 版本 | +| ------- | -------- | ---- | +| blur() | 移除焦点 | | +| focus() | 获取焦点 | | > 注意，如果需要获得中国省市区数据，可以参考 [china-division](https://gist.github.com/afc163/7582f35654fd03d5be7009444345ea17)。 diff --git a/components/checkbox/index.en-US.md b/components/checkbox/index.en-US.md index 230d188c5e..e5f1c8dc42 100644 --- a/components/checkbox/index.en-US.md +++ b/components/checkbox/index.en-US.md @@ -42,7 +42,7 @@ Checkbox component. #### Checkbox -| Name | Description | Version | -| --- | --- | --- | -| blur() | Remove focus | | -| focus() | Get focus | | +| Name | Description | Version | +| ------- | ------------ | ------- | +| blur() | Remove focus | | +| focus() | Get focus | | diff --git a/components/checkbox/index.zh-CN.md b/components/checkbox/index.zh-CN.md index 3bb66a7af8..a8c621354d 100644 --- a/components/checkbox/index.zh-CN.md +++ b/components/checkbox/index.zh-CN.md @@ -19,14 +19,14 @@ cover: https://gw.alipayobjects.com/zos/alicdn/8nbVbHEm_/CheckBox.svg #### Checkbox -| 参数 | 说明 | 类型 | 默认值 | 版本 | -| --- | --- | --- | --- | --- | -| autoFocus | 自动获取焦点 | boolean | false | | -| checked | 指定当前是否选中 | boolean | false | | -| defaultChecked | 初始是否选中 | boolean | false | | -| disabled | 失效状态 | boolean | false | | -| indeterminate | 设置 indeterminate 状态，只负责样式控制 | boolean | false | | -| onChange | 变化时回调函数 | function(e:Event) | - | | +| 参数 | 说明 | 类型 | 默认值 | 版本 | +| -------------- | --------------------------------------- | ----------------- | ------ | ---- | +| autoFocus | 自动获取焦点 | boolean | false | | +| checked | 指定当前是否选中 | boolean | false | | +| defaultChecked | 初始是否选中 | boolean | false | | +| disabled | 失效状态 | boolean | false | | +| indeterminate | 设置 indeterminate 状态，只负责样式控制 | boolean | false | | +| onChange | 变化时回调函数 | function(e:Event) | - | | #### Checkbox Group @@ -53,7 +53,7 @@ interface Option { #### Checkbox -| 名称 | 描述 | 版本 | -| --- | --- | --- | -| blur() | 移除焦点 | | -| focus() | 获取焦点 | | +| 名称 | 描述 | 版本 | +| ------- | -------- | ---- | +| blur() | 移除焦点 | | +| focus() | 获取焦点 | | diff --git a/components/collapse/index.zh-CN.md b/components/collapse/index.zh-CN.md index 4711736f60..2154aa4f86 100644 --- a/components/collapse/index.zh-CN.md +++ b/components/collapse/index.zh-CN.md @@ -33,11 +33,11 @@ cover: https://gw.alipayobjects.com/zos/alicdn/IxH16B9RD/Collapse.svg ### Collapse.Panel -| 参数 | 说明 | 类型 | 默认值 | 版本 | -| --- | --- | --- | --- | --- | -| collapsible | 是否可折叠或指定可折叠触发区域 | `header` \| `disabled` | - | 4.9.0 | -| extra | 自定义渲染每个面板右上角的内容 | ReactNode | - | | -| forceRender | 被隐藏时是否渲染 DOM 结构 | boolean | false | | -| header | 面板头内容 | ReactNode | - | | -| key | 对应 activeKey | string \| number | - | | -| showArrow | 是否展示当前面板上的箭头 | boolean | true | | +| 参数 | 说明 | 类型 | 默认值 | 版本 | +| ----------- | ------------------------------ | ---------------------- | ------ | ----- | +| collapsible | 是否可折叠或指定可折叠触发区域 | `header` \| `disabled` | - | 4.9.0 | +| extra | 自定义渲染每个面板右上角的内容 | ReactNode | - | | +| forceRender | 被隐藏时是否渲染 DOM 结构 | boolean | false | | +| header | 面板头内容 | ReactNode | - | | +| key | 对应 activeKey | string \| number | - | | +| showArrow | 是否展示当前面板上的箭头 | boolean | true | | diff --git a/components/date-picker/index.en-US.md b/components/date-picker/index.en-US.md index 4c36123177..c7283d76c9 100644 --- a/components/date-picker/index.en-US.md +++ b/components/date-picker/index.en-US.md @@ -77,10 +77,10 @@ The following APIs are shared by DatePicker, RangePicker. ### Common Methods -| Name | Description | Version | -| --- | --- | --- | -| blur() | Remove focus | | -| focus() | Get focus | | +| Name | Description | Version | +| ------- | ------------ | ------- | +| blur() | Remove focus | | +| focus() | Get focus | | ### DatePicker diff --git a/components/date-picker/index.zh-CN.md b/components/date-picker/index.zh-CN.md index d101ea1233..9dfdc2426f 100644 --- a/components/date-picker/index.zh-CN.md +++ b/components/date-picker/index.zh-CN.md @@ -78,10 +78,10 @@ import locale from 'antd/lib/locale/zh_CN'; ### 共同的方法 -| 名称 | 描述 | 版本 | -| --- | --- | --- | -| blur() | 移除焦点 | | -| focus() | 获取焦点 | | +| 名称 | 描述 | 版本 | +| ------- | -------- | ---- | +| blur() | 移除焦点 | | +| focus() | 获取焦点 | | ### DatePicker diff --git a/components/descriptions/index.en-US.md b/components/descriptions/index.en-US.md index 3cf3da3011..c4c7d7d44c 100644 --- a/components/descriptions/index.en-US.md +++ b/components/descriptions/index.en-US.md @@ -28,12 +28,11 @@ Commonly displayed on the details page. ### DescriptionItem -| Property | Description | Type | Default | Version | -| --- | --- | --- | --- | --- | -| contentStyle | Customize label style | CSSProperties | - | 4.9.0 | -| label | The description of the content | ReactNode | - | | -| labelStyle | Customize label style | CSSProperties | - | 4.9.0 | -| span | The number of columns included | number | 1 | | - -> The number of span Description.Item. Span={2} takes up the width of two DescriptionItems. -> When both `style` and `labelStyle`(or `contentStyle`) configured, both of them will work. And next one will overwrite first when conflict. +| Property | Description | Type | Default | Version | +| ------------ | ------------------------------ | ------------- | ------- | ------- | +| contentStyle | Customize label style | CSSProperties | - | 4.9.0 | +| label | The description of the content | ReactNode | - | | +| labelStyle | Customize label style | CSSProperties | - | 4.9.0 | +| span | The number of columns included | number | 1 | | + +> The number of span Description.Item. Span={2} takes up the width of two DescriptionItems. When both `style` and `labelStyle`(or `contentStyle`) configured, both of them will work. And next one will overwrite first when conflict. diff --git a/components/descriptions/index.zh-CN.md b/components/descriptions/index.zh-CN.md index 447e629b15..66696dc333 100644 --- a/components/descriptions/index.zh-CN.md +++ b/components/descriptions/index.zh-CN.md @@ -29,12 +29,11 @@ cover: https://gw.alipayobjects.com/zos/alicdn/MjtG9_FOI/Descriptions.svg ### DescriptionItem -| 参数 | 说明 | 类型 | 默认值 | 版本 | -| --- | --- | --- | --- | --- | -| contentStyle | 自定义内容样式 | CSSProperties | - | 4.9.0 | -| label | 内容的描述 | ReactNode | - | | -| labelStyle | 自定义标签样式 | CSSProperties | - | 4.9.0 | -| span | 包含列的数量 | number | 1 | | - -> span 是 Description.Item 的数量。 span={2} 会占用两个 DescriptionItem 的宽度。 -> 当同时配置 `style` 和 `labelStyle`（或 `contentStyle`）时，两者会同时作用。样式冲突时，后者会覆盖前者。 +| 参数 | 说明 | 类型 | 默认值 | 版本 | +| ------------ | -------------- | ------------- | ------ | ----- | +| contentStyle | 自定义内容样式 | CSSProperties | - | 4.9.0 | +| label | 内容的描述 | ReactNode | - | | +| labelStyle | 自定义标签样式 | CSSProperties | - | 4.9.0 | +| span | 包含列的数量 | number | 1 | | + +> span 是 Description.Item 的数量。 span={2} 会占用两个 DescriptionItem 的宽度。当同时配置 `style` 和 `labelStyle`（或 `contentStyle`）时，两者会同时作用。样式冲突时，后者会覆盖前者。 diff --git a/components/divider/index.zh-CN.md b/components/divider/index.zh-CN.md index 8d9e4811c2..19d81b8830 100644 --- a/components/divider/index.zh-CN.md +++ b/components/divider/index.zh-CN.md @@ -15,11 +15,11 @@ cover: https://gw.alipayobjects.com/zos/alicdn/5swjECahe/Divider.svg ## API -| 参数 | 说明 | 类型 | 默认值 | 版本 | -| --- | --- | --- | --- | --- | -| className | 分割线样式类 | string | - | | -| dashed | 是否虚线 | boolean | false | | -| orientation | 分割线标题的位置 | `left` \| `right` \| `center` | `center` | | -| plain | 文字是否显示为普通正文样式 | boolean | false | 4.2.0 | -| style | 分割线样式对象 | CSSProperties | - | | -| type | 水平还是垂直类型 | `horizontal` \| `vertical` | `horizontal` | | +| 参数 | 说明 | 类型 | 默认值 | 版本 | +| ----------- | -------------------------- | ----------------------------- | ------------ | ----- | +| className | 分割线样式类 | string | - | | +| dashed | 是否虚线 | boolean | false | | +| orientation | 分割线标题的位置 | `left` \| `right` \| `center` | `center` | | +| plain | 文字是否显示为普通正文样式 | boolean | false | 4.2.0 | +| style | 分割线样式对象 | CSSProperties | - | | +| type | 水平还是垂直类型 | `horizontal` \| `vertical` | `horizontal` | | diff --git a/components/icon/index.en-US.md b/components/icon/index.en-US.md index 2711dae984..585a893ebd 100644 --- a/components/icon/index.en-US.md +++ b/components/icon/index.en-US.md @@ -14,7 +14,7 @@ npm install --save @ant-design/icons ## List of icons -```_\_react +```__react import IconDisplay from 'site/theme/template/IconDisplay'; ReactDOM.render(, mountNode); ``` diff --git a/components/icon/index.zh-CN.md b/components/icon/index.zh-CN.md index cc85feb603..0427f76b27 100644 --- a/components/icon/index.zh-CN.md +++ b/components/icon/index.zh-CN.md @@ -19,7 +19,7 @@ npm install --save @ant-design/icons ## 图标列表 -```_\_react +```__react import IconDisplay from 'site/theme/template/IconDisplay'; ReactDOM.render(, mountNode); ``` @@ -148,10 +148,10 @@ ReactDOM.render(, mountNode); `Icon` 中的 `component` 组件的接受的属性如下： -| 字段 | 说明 | 类型 | 只读值 | 版本 | -| --- | --- | --- | --- | --- | -| className | 计算后的 `svg` 类名 | string | - | | -| fill | `svg` 元素填充的颜色 | string | `currentColor` | | -| height | `svg` 元素高度 | string \| number | `1em` | | -| style | 计算后的 `svg` 元素样式 | CSSProperties | - | | -| width | `svg` 元素宽度 | string \| number | `1em` | | +| 字段 | 说明 | 类型 | 只读值 | 版本 | +| --------- | ----------------------- | ---------------- | -------------- | ---- | +| className | 计算后的 `svg` 类名 | string | - | | +| fill | `svg` 元素填充的颜色 | string | `currentColor` | | +| height | `svg` 元素高度 | string \| number | `1em` | | +| style | 计算后的 `svg` 元素样式 | CSSProperties | - | | +| width | `svg` 元素宽度 | string \| number | `1em` | | diff --git a/components/input-number/index.en-US.md b/components/input-number/index.en-US.md index 63a786b2fe..30f60932da 100644 --- a/components/input-number/index.en-US.md +++ b/components/input-number/index.en-US.md @@ -34,10 +34,10 @@ When a numeric value needs to be provided. ## Methods -| Name | Description | -| --- | --- | -| blur() | Remove focus | -| focus() | Get focus | +| Name | Description | +| ------- | ------------ | +| blur() | Remove focus | +| focus() | Get focus | ## Notes diff --git a/components/input-number/index.zh-CN.md b/components/input-number/index.zh-CN.md index eb00ec9eb6..6cdd86df02 100644 --- a/components/input-number/index.zh-CN.md +++ b/components/input-number/index.zh-CN.md @@ -37,7 +37,7 @@ cover: https://gw.alipayobjects.com/zos/alicdn/XOS8qZ0kU/InputNumber.svg ## 方法 -| 名称 | 描述 | -| --- | --- | -| blur() | 移除焦点 | +| 名称 | 描述 | +| ------- | -------- | +| blur() | 移除焦点 | | focus() | 获取焦点 | diff --git a/components/input/TextArea.tsx b/components/input/TextArea.tsx index 7961169356..e99e8701ba 100644 --- a/components/input/TextArea.tsx +++ b/components/input/TextArea.tsx @@ -114,7 +114,9 @@ const TextArea = React.forwardRef( // Only show text area wrapper when needed if (showCount) { - const valueLength = hasMaxLength ? Math.min(Number(maxLength), [...val].length) : [...val].length; + const valueLength = hasMaxLength + ? Math.min(Number(maxLength), [...val].length) + : [...val].length; const dataCount = `${valueLength}${hasMaxLength ? ` / ${maxLength}` : ''}`; return ( diff --git a/components/list/index.en-US.md b/components/list/index.en-US.md index d594253f8b..7ab485c79a 100644 --- a/components/list/index.en-US.md +++ b/components/list/index.en-US.md @@ -37,24 +37,24 @@ A list can be used to display content related to a single subject. The content c Properties for pagination. -| Property | Description | Type | Default | -| --- | --- | --- | --- | +| Property | Description | Type | Default | +| -------- | ---------------------------------------- | --------------------------- | -------- | | position | The specify the position of `Pagination` | `top` \| `bottom` \| `both` | `bottom` | More about pagination, please check [`Pagination`](/components/pagination/). ### List grid props -| Property | Description | Type | Default | Version | -| --- | --- | --- | --- | --- | -| column | The column of grid | number | - | | -| gutter | The spacing between grid | number | 0 | | -| xs | `<576px` column of grid | number | - | | -| sm | `≥576px` column of grid | number | - | | -| md | `≥768px` column of grid | number | - | | -| lg | `≥992px` column of grid | number | - | | -| xl | `≥1200px` column of grid | number | - | | -| xxl | `≥1600px` column of grid | number | - | | +| Property | Description | Type | Default | Version | +| -------- | ------------------------ | ------ | ------- | ------- | +| column | The column of grid | number | - | | +| gutter | The spacing between grid | number | 0 | | +| xs | `<576px` column of grid | number | - | | +| sm | `≥576px` column of grid | number | - | | +| md | `≥768px` column of grid | number | - | | +| lg | `≥992px` column of grid | number | - | | +| xl | `≥1200px` column of grid | number | - | | +| xxl | `≥1600px` column of grid | number | - | | ### List.Item @@ -65,8 +65,8 @@ More about pagination, please check [`Pagination`](/components/pagination/). ### List.Item.Meta -| Property | Description | Type | Default | Version | -| --- | --- | --- | --- | --- | -| avatar | The avatar of list item | ReactNode | - | | -| description | The description of list item | ReactNode | - | | -| title | The title of list item | ReactNode | - | | +| Property | Description | Type | Default | Version | +| ----------- | ---------------------------- | --------- | ------- | ------- | +| avatar | The avatar of list item | ReactNode | - | | +| description | The description of list item | ReactNode | - | | +| title | The title of list item | ReactNode | - | | diff --git a/components/list/index.zh-CN.md b/components/list/index.zh-CN.md index 05508ada30..a67fd14928 100644 --- a/components/list/index.zh-CN.md +++ b/components/list/index.zh-CN.md @@ -39,24 +39,24 @@ cover: https://gw.alipayobjects.com/zos/alicdn/5FrZKStG_/List.svg 分页的配置项。 -| 参数 | 说明 | 类型 | 默认值 | -| --- | --- | --- | --- | +| 参数 | 说明 | 类型 | 默认值 | +| -------- | ------------------ | --------------------------- | -------- | | position | 指定分页显示的位置 | `top` \| `bottom` \| `both` | `bottom` | 更多配置项，请查看 [`Pagination`](/components/pagination/)。 ### List grid props -| 参数 | 说明 | 类型 | 默认值 | 版本 | -| --- | --- | --- | --- | --- | -| column | 列数 | number | - | | -| gutter | 栅格间隔 | number | 0 | | -| xs | `<576px` 展示的列数 | number | - | | -| sm | `≥576px` 展示的列数 | number | - | | -| md | `≥768px` 展示的列数 | number | - | | -| lg | `≥992px` 展示的列数 | number | - | | -| xl | `≥1200px` 展示的列数 | number | - | | -| xxl | `≥1600px` 展示的列数 | number | - | | +| 参数 | 说明 | 类型 | 默认值 | 版本 | +| ------ | -------------------- | ------ | ------ | ---- | +| column | 列数 | number | - | | +| gutter | 栅格间隔 | number | 0 | | +| xs | `<576px` 展示的列数 | number | - | | +| sm | `≥576px` 展示的列数 | number | - | | +| md | `≥768px` 展示的列数 | number | - | | +| lg | `≥992px` 展示的列数 | number | - | | +| xl | `≥1200px` 展示的列数 | number | - | | +| xxl | `≥1600px` 展示的列数 | number | - | | ### List.Item @@ -67,8 +67,8 @@ cover: https://gw.alipayobjects.com/zos/alicdn/5FrZKStG_/List.svg ### List.Item.Meta -| 参数 | 说明 | 类型 | 默认值 | 版本 | -| --- | --- | --- | --- | --- | -| avatar | 列表元素的图标 | ReactNode | - | | -| description | 列表元素的描述内容 | ReactNode | - | | -| title | 列表元素的标题 | ReactNode | - | | +| 参数 | 说明 | 类型 | 默认值 | 版本 | +| ----------- | ------------------ | --------- | ------ | ---- | +| avatar | 列表元素的图标 | ReactNode | - | | +| description | 列表元素的描述内容 | ReactNode | - | | +| title | 列表元素的标题 | ReactNode | - | | diff --git a/components/mentions/index.en-US.md b/components/mentions/index.en-US.md index e413737749..21df93456b 100644 --- a/components/mentions/index.en-US.md +++ b/components/mentions/index.en-US.md @@ -43,10 +43,10 @@ When need to mention someone or something. ### Mention methods -| Name | Description | -| --- | --- | -| blur() | Remove focus | -| focus() | Get focus | +| Name | Description | +| ------- | ------------ | +| blur() | Remove focus | +| focus() | Get focus | ### Option diff --git a/components/mentions/index.zh-CN.md b/components/mentions/index.zh-CN.md index 7876603712..f678f78db6 100644 --- a/components/mentions/index.zh-CN.md +++ b/components/mentions/index.zh-CN.md @@ -44,14 +44,14 @@ cover: https://gw.alipayobjects.com/zos/alicdn/jPE-itMFM/Mentions.svg ### Mentions 方法 -| 名称 | 描述 | -| --- | --- | -| blur() | 移除焦点 | +| 名称 | 描述 | +| ------- | -------- | +| blur() | 移除焦点 | | focus() | 获取焦点 | ### Option -| 参数 | 说明 | 类型 | 默认值 | -| --- | --- | --- | --- | -| children | 选项内容 | ReactNode | - | -| value | 选择时填充的值 | string | - | +| 参数 | 说明 | 类型 | 默认值 | +| -------- | -------------- | --------- | ------ | +| children | 选项内容 | ReactNode | - | +| value | 选择时填充的值 | string | - | diff --git a/components/menu/index.en-US.md b/components/menu/index.en-US.md index b1da33ddc4..b8972cfd3c 100644 --- a/components/menu/index.en-US.md +++ b/components/menu/index.en-US.md @@ -55,13 +55,13 @@ More layouts with navigation: [Layout](/components/layout). ### Menu.Item -| Param | Description | Type | Default value | Version | -| --- | --- | --- | --- | --- | -| danger | Display the danger style | boolean | false | 4.3.0 | -| disabled | Whether menu item is disabled | boolean | false | | -| icon | The icon of the menu item | ReactNode | - | 4.2.0 | -| key | Unique ID of the menu item | string | - | | -| title | Set display title for collapsed item | string | - | | +| Param | Description | Type | Default value | Version | +| -------- | ------------------------------------ | --------- | ------------- | ------- | +| danger | Display the danger style | boolean | false | 4.3.0 | +| disabled | Whether menu item is disabled | boolean | false | | +| icon | The icon of the menu item | ReactNode | - | 4.2.0 | +| key | Unique ID of the menu item | string | - | | +| title | Set display title for collapsed item | string | - | | > Note: `icon` is a newly added prop in `4.2.0`. For previous versions, please use the following method to define the icon. > @@ -97,10 +97,10 @@ More layouts with navigation: [Layout](/components/layout). ### Menu.ItemGroup -| Param | Description | Type | Default value | Version | -| --- | --- | --- | --- | --- | -| children | Sub-menu items | MenuItem\[] | - | | -| title | The title of the group | ReactNode | - | | +| Param | Description | Type | Default value | Version | +| -------- | ---------------------- | ----------- | ------------- | ------- | +| children | Sub-menu items | MenuItem\[] | - | | +| title | The title of the group | ReactNode | - | | ### Menu.Divider diff --git a/components/menu/index.zh-CN.md b/components/menu/index.zh-CN.md index be11d15102..33c79b8a9e 100644 --- a/components/menu/index.zh-CN.md +++ b/components/menu/index.zh-CN.md @@ -56,13 +56,13 @@ cover: https://gw.alipayobjects.com/zos/alicdn/3XZcjGpvK/Menu.svg ### Menu.Item -| 参数 | 说明 | 类型 | 默认值 | 版本 | -| --- | --- | --- | --- | --- | -| danger | 展示错误状态样式 | boolean | false | 4.3.0 | -| disabled | 是否禁用 | boolean | false | | -| icon | 菜单图标 | ReactNode | - | 4.2.0 | -| key | item 的唯一标志 | string | - | | -| title | 设置收缩时展示的悬浮标题 | string | - | | +| 参数 | 说明 | 类型 | 默认值 | 版本 | +| -------- | ------------------------ | --------- | ------ | ----- | +| danger | 展示错误状态样式 | boolean | false | 4.3.0 | +| disabled | 是否禁用 | boolean | false | | +| icon | 菜单图标 | ReactNode | - | 4.2.0 | +| key | item 的唯一标志 | string | - | | +| title | 设置收缩时展示的悬浮标题 | string | - | | > 注意：`icon` 是 `4.2.0` 新增的属性，之前的版本请使用下面的方式定义图标。 > @@ -98,10 +98,10 @@ cover: https://gw.alipayobjects.com/zos/alicdn/3XZcjGpvK/Menu.svg ### Menu.ItemGroup -| 参数 | 说明 | 类型 | 默认值 | 版本 | -| --- | --- | --- | --- | --- | -| children | 分组的菜单项 | MenuItem\[] | - | | -| title | 分组标题 | ReactNode | - | | +| 参数 | 说明 | 类型 | 默认值 | 版本 | +| -------- | ------------ | ----------- | ------ | ---- | +| children | 分组的菜单项 | MenuItem\[] | - | | +| title | 分组标题 | ReactNode | - | | ### Menu.Divider diff --git a/components/message/index.zh-CN.md b/components/message/index.zh-CN.md index d2cdfba40e..60d1b4b5d3 100644 --- a/components/message/index.zh-CN.md +++ b/components/message/index.zh-CN.md @@ -25,11 +25,11 @@ cover: https://gw.alipayobjects.com/zos/alicdn/hAkKTIW0K/Message.svg - `message.warn(content, [duration], onClose)` // alias of warning - `message.loading(content, [duration], onClose)` -| 参数 | 说明 | 类型 | 默认值 | -| --- | --- | --- | --- | -| content | 提示内容 | ReactNode \| config | - | -| duration | 自动关闭的延时，单位秒。设为 0 时不自动关闭 | number | 3 | -| onClose | 关闭时触发的回调函数 | function | - | +| 参数 | 说明 | 类型 | 默认值 | +| -------- | ------------------------------------------- | ------------------- | ------ | +| content | 提示内容 | ReactNode \| config | - | +| duration | 自动关闭的延时，单位秒。设为 0 时不自动关闭 | number | 3 | +| onClose | 关闭时触发的回调函数 | function | - | 组件同时提供 promise 接口。 diff --git a/components/popover/index.en-US.md b/components/popover/index.en-US.md index 9ae178420e..30e0f0719b 100644 --- a/components/popover/index.en-US.md +++ b/components/popover/index.en-US.md @@ -15,10 +15,10 @@ Comparing with `Tooltip`, besides information `Popover` card can also provide ac ## API -| Param | Description | Type | Default value | Version | -| --- | --- | --- | --- | --- | -| content | Content of the card | ReactNode \| () => ReactNode | - | | -| title | Title of the card | ReactNode \| () => ReactNode | - | | +| Param | Description | Type | Default value | Version | +| ------- | ------------------- | ---------------------------- | ------------- | ------- | +| content | Content of the card | ReactNode \| () => ReactNode | - | | +| title | Title of the card | ReactNode \| () => ReactNode | - | | Consult [Tooltip's documentation](/components/tooltip/#API) to find more APIs. diff --git a/components/popover/index.zh-CN.md b/components/popover/index.zh-CN.md index 970bbfc6b2..78709f7286 100644 --- a/components/popover/index.zh-CN.md +++ b/components/popover/index.zh-CN.md @@ -16,10 +16,10 @@ cover: https://gw.alipayobjects.com/zos/alicdn/1PNL1p_cO/Popover.svg ## API -| 参数 | 说明 | 类型 | 默认值 | 版本 | -| --- | --- | --- | --- | --- | -| content | 卡片内容 | ReactNode \| () => ReactNode | - | | -| title | 卡片标题 | ReactNode \| () => ReactNode | - | | +| 参数 | 说明 | 类型 | 默认值 | 版本 | +| ------- | -------- | ---------------------------- | ------ | ---- | +| content | 卡片内容 | ReactNode \| () => ReactNode | - | | +| title | 卡片标题 | ReactNode \| () => ReactNode | - | | 更多属性请参考 [Tooltip](/components/tooltip/#API)。 diff --git a/components/progress/index.zh-CN.md b/components/progress/index.zh-CN.md index d55417296b..adb5c71d0d 100644 --- a/components/progress/index.zh-CN.md +++ b/components/progress/index.zh-CN.md @@ -41,11 +41,11 @@ cover: https://gw.alipayobjects.com/zos/alicdn/xqsDu4ZyR/Progress.svg ### `type="circle"` -| 属性 | 说明 | 类型 | 默认值 | -| --- | --- | --- | --- | -| strokeColor | 圆形进度条线的色彩，传入 object 时为渐变 | string \| object | - | -| strokeWidth | 圆形进度条线的宽度，单位是进度条画布宽度的百分比 | number | 6 | -| width | 圆形进度条画布宽度，单位 px | number | 132 | +| 属性 | 说明 | 类型 | 默认值 | +| ----------- | ------------------------------------------------ | ---------------- | ------ | +| strokeColor | 圆形进度条线的色彩，传入 object 时为渐变 | string \| object | - | +| strokeWidth | 圆形进度条线的宽度，单位是进度条画布宽度的百分比 | number | 6 | +| width | 圆形进度条画布宽度，单位 px | number | 132 | ### `type="dashboard"` diff --git a/components/radio/index.en-US.md b/components/radio/index.en-US.md index 81cc80ee7e..18d4e20c1f 100644 --- a/components/radio/index.en-US.md +++ b/components/radio/index.en-US.md @@ -44,7 +44,7 @@ Radio group can wrap a group of `Radio`。 ### Radio -| Name | Description | -| --- | --- | -| blur() | Remove focus | -| focus() | Get focus | +| Name | Description | +| ------- | ------------ | +| blur() | Remove focus | +| focus() | Get focus | diff --git a/components/radio/index.zh-CN.md b/components/radio/index.zh-CN.md index 82e31db6ac..1ae30ee0f8 100644 --- a/components/radio/index.zh-CN.md +++ b/components/radio/index.zh-CN.md @@ -17,13 +17,13 @@ cover: https://gw.alipayobjects.com/zos/alicdn/8cYb5seNB/Radio.svg ### Radio/Radio.Button -| 参数 | 说明 | 类型 | 默认值 | -| --- | --- | --- | --- | -| autoFocus | 自动获取焦点 | boolean | false | -| checked | 指定当前是否选中 | boolean | false | -| defaultChecked | 初始是否选中 | boolean | false | -| disabled | 禁用 Radio | boolean | false | -| value | 根据 value 进行比较，判断是否选中 | any | - | +| 参数 | 说明 | 类型 | 默认值 | +| -------------- | --------------------------------- | ------- | ------ | +| autoFocus | 自动获取焦点 | boolean | false | +| checked | 指定当前是否选中 | boolean | false | +| defaultChecked | 初始是否选中 | boolean | false | +| disabled | 禁用 Radio | boolean | false | +| value | 根据 value 进行比较，判断是否选中 | any | - | ### RadioGroup @@ -45,7 +45,7 @@ cover: https://gw.alipayobjects.com/zos/alicdn/8cYb5seNB/Radio.svg ### Radio -| 名称 | 描述 | -| --- | --- | -| blur() | 移除焦点 | +| 名称 | 描述 | +| ------- | -------- | +| blur() | 移除焦点 | | focus() | 获取焦点 | diff --git a/components/rate/index.en-US.md b/components/rate/index.en-US.md index 45a9c42100..817d8e9abe 100644 --- a/components/rate/index.en-US.md +++ b/components/rate/index.en-US.md @@ -35,7 +35,7 @@ Rate component. ## Methods -| Name | Description | -| --- | --- | -| blur() | Remove focus | -| focus() | Get focus | +| Name | Description | +| ------- | ------------ | +| blur() | Remove focus | +| focus() | Get focus | diff --git a/components/rate/index.zh-CN.md b/components/rate/index.zh-CN.md index c5be4b345e..e203629d34 100644 --- a/components/rate/index.zh-CN.md +++ b/components/rate/index.zh-CN.md @@ -36,7 +36,7 @@ cover: https://gw.alipayobjects.com/zos/alicdn/R5uiIWmxe/Rate.svg ## 方法 -| 名称 | 描述 | -| --- | --- | -| blur() | 移除焦点 | +| 名称 | 描述 | +| ------- | -------- | +| blur() | 移除焦点 | | focus() | 获取焦点 | diff --git a/components/select/index.en-US.md b/components/select/index.en-US.md index 8c58352ea7..7aa10ccac2 100644 --- a/components/select/index.en-US.md +++ b/components/select/index.en-US.md @@ -81,26 +81,26 @@ Select component to select value from options. ### Select Methods -| Name | Description | Version | -| --- | --- | --- | -| blur() | Remove focus | | -| focus() | Get focus | | +| Name | Description | Version | +| ------- | ------------ | ------- | +| blur() | Remove focus | | +| focus() | Get focus | | ### Option props -| Property | Description | Type | Default | Version | -| --- | --- | --- | --- | --- | -| className | The additional class to option | string | - | | -| disabled | Disable this option | boolean | false | | -| title | `title` of Select after select this Option | string | - | | -| value | Default to filter with this property | string \| number | - | | +| Property | Description | Type | Default | Version | +| --------- | ------------------------------------------ | ---------------- | ------- | ------- | +| className | The additional class to option | string | - | | +| disabled | Disable this option | boolean | false | | +| title | `title` of Select after select this Option | string | - | | +| value | Default to filter with this property | string \| number | - | | ### OptGroup props -| Property | Description | Type | Default | Version | -| --- | --- | --- | --- | --- | -| key | Group key | string | - | | -| label | Group label | string \| React.Element | - | | +| Property | Description | Type | Default | Version | +| -------- | ----------- | ----------------------- | ------- | ------- | +| key | Group key | string | - | | +| label | Group label | string \| React.Element | - | | ## FAQ diff --git a/components/select/index.zh-CN.md b/components/select/index.zh-CN.md index 2402abf131..fabea0922f 100644 --- a/components/select/index.zh-CN.md +++ b/components/select/index.zh-CN.md @@ -39,7 +39,7 @@ cover: https://gw.alipayobjects.com/zos/alicdn/_0XzgOis7/Select.svg | dropdownRender | 自定义下拉框内容 | (originNode: ReactNode) => ReactNode | - | | | dropdownStyle | 下拉菜单的 style 属性 | CSSProperties | - | | | filterOption | 是否根据输入项进行筛选。当其为一个函数时，会接收 `inputValue` `option` 两个参数，当 `option` 符合筛选条件时，应返回 true，反之则返回 false | boolean \| function(inputValue, option) | true | | -| filterSort | 搜索时对筛选结果项的排序函数, 类似[Array.sort](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort)里的compareFunction | (optionA: Option, optionB: Option) => number | - | 4.9.0 | +| filterSort | 搜索时对筛选结果项的排序函数, 类似[Array.sort](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort)里的 compareFunction | (optionA: Option, optionB: Option) => number | - | 4.9.0 | | getPopupContainer | 菜单渲染父节点。默认渲染到 body 上，如果你遇到菜单滚动定位问题，试试修改为滚动的区域，并相对其定位。[示例](https://codesandbox.io/s/4j168r7jw0) | function(triggerNode) | () => document.body | | | labelInValue | 是否把每个选项的 label 包装到 value 中，会把 Select 的 value 类型从 `string` 变为 { value: string, label: ReactNode } 的格式 | boolean | false | | | listHeight | 设置弹窗滚动高度 | number | 256 | | @@ -82,26 +82,26 @@ cover: https://gw.alipayobjects.com/zos/alicdn/_0XzgOis7/Select.svg ### Select Methods -| 名称 | 说明 | 版本 | -| --- | --- | --- | -| blur() | 取消焦点 | | -| focus() | 获取焦点 | | +| 名称 | 说明 | 版本 | +| ------- | -------- | ---- | +| blur() | 取消焦点 | | +| focus() | 获取焦点 | | ### Option props -| 参数 | 说明 | 类型 | 默认值 | 版本 | -| --- | --- | --- | --- | --- | -| className | Option 器类名 | string | - | | -| disabled | 是否禁用 | boolean | false | | -| title | 选中该 Option 后，Select 的 title | string | - | | -| value | 默认根据此属性值进行筛选 | string \| number | - | | +| 参数 | 说明 | 类型 | 默认值 | 版本 | +| --------- | --------------------------------- | ---------------- | ------ | ---- | +| className | Option 器类名 | string | - | | +| disabled | 是否禁用 | boolean | false | | +| title | 选中该 Option 后，Select 的 title | string | - | | +| value | 默认根据此属性值进行筛选 | string \| number | - | | ### OptGroup props -| 参数 | 说明 | 类型 | 默认值 | 版本 | -| --- | --- | --- | --- | --- | -| key | Key | string | - | | -| label | 组名 | string \| React.Element | - | | +| 参数 | 说明 | 类型 | 默认值 | 版本 | +| ----- | ---- | ----------------------- | ------ | ---- | +| key | Key | string | - | | +| label | 组名 | string \| React.Element | - | | ## FAQ diff --git a/components/skeleton/index.en-US.md b/components/skeleton/index.en-US.md index 4507aa96fb..609022f294 100644 --- a/components/skeleton/index.en-US.md +++ b/components/skeleton/index.en-US.md @@ -38,9 +38,9 @@ Provide a placeholder while you wait for content to load, or to visualise conten ### SkeletonTitleProps -| Property | Description | Type | Default | -| --- | --- | --- | --- | -| width | Set the width of title | number \| string | - | +| Property | Description | Type | Default | +| -------- | ---------------------- | ---------------- | ------- | +| width | Set the width of title | number \| string | - | ### SkeletonParagraphProps @@ -51,15 +51,15 @@ Provide a placeholder while you wait for content to load, or to visualise conten ### SkeletonButtonProps -| Property | Description | Type | Default | -| --- | --- | --- | --- | -| active | Show animation effect | boolean | false | -| shape | Set the shape of button | `circle` \| `round` \| `default` | - | -| size | Set the size of button | `large` \| `small` \| `default` | - | +| Property | Description | Type | Default | +| -------- | ----------------------- | -------------------------------- | ------- | +| active | Show animation effect | boolean | false | +| shape | Set the shape of button | `circle` \| `round` \| `default` | - | +| size | Set the size of button | `large` \| `small` \| `default` | - | ### SkeletonInputProps -| Property | Description | Type | Default | -| --- | --- | --- | --- | -| active | Show animation effect | boolean | false | -| size | Set the size of input | `large` \| `small` \| `default` | - | +| Property | Description | Type | Default | +| -------- | --------------------- | ------------------------------- | ------- | +| active | Show animation effect | boolean | false | +| size | Set the size of input | `large` \| `small` \| `default` | - | diff --git a/components/skeleton/index.zh-CN.md b/components/skeleton/index.zh-CN.md index 1e580da146..465de32ab3 100644 --- a/components/skeleton/index.zh-CN.md +++ b/components/skeleton/index.zh-CN.md @@ -39,9 +39,9 @@ cover: https://gw.alipayobjects.com/zos/alicdn/KpcciCJgv/Skeleton.svg ### SkeletonTitleProps -| 属性 | 说明 | 类型 | 默认值 | -| --- | --- | --- | --- | -| width | 设置标题占位图的宽度 | number \| string | - | +| 属性 | 说明 | 类型 | 默认值 | +| ----- | -------------------- | ---------------- | ------ | +| width | 设置标题占位图的宽度 | number \| string | - | ### SkeletonParagraphProps @@ -52,15 +52,15 @@ cover: https://gw.alipayobjects.com/zos/alicdn/KpcciCJgv/Skeleton.svg ### SkeletonButtonProps -| 属性 | 说明 | 类型 | 默认值 | -| --- | --- | --- | --- | -| active | 是否展示动画效果 | boolean | false | -| shape | 指定按钮的形状 | `circle` \| `round` \| `default` | - | -| size | 设置按钮的大小 | `large` \| `small` \| `default` | - | +| 属性 | 说明 | 类型 | 默认值 | +| ------ | ---------------- | -------------------------------- | ------ | +| active | 是否展示动画效果 | boolean | false | +| shape | 指定按钮的形状 | `circle` \| `round` \| `default` | - | +| size | 设置按钮的大小 | `large` \| `small` \| `default` | - | ### SkeletonInputProps -| 属性 | 说明 | 类型 | 默认值 | -| --- | --- | --- | --- | -| active | 是否展示动画效果 | boolean | false | -| size | 设置输入框的大小 | `large` \| `small` \| `default` | - | +| 属性 | 说明 | 类型 | 默认值 | +| ------ | ---------------- | ------------------------------- | ------ | +| active | 是否展示动画效果 | boolean | false | +| size | 设置输入框的大小 | `large` \| `small` \| `default` | - | diff --git a/components/slider/index.en-US.md b/components/slider/index.en-US.md index 8c3423ac26..e8c8fe77db 100644 --- a/components/slider/index.en-US.md +++ b/components/slider/index.en-US.md @@ -37,7 +37,7 @@ To input a value in a range. ## Methods -| Name | Description | Version | -| --- | --- | --- | -| blur() | Remove focus | | -| focus() | Get focus | | +| Name | Description | Version | +| ------- | ------------ | ------- | +| blur() | Remove focus | | +| focus() | Get focus | | diff --git a/components/slider/index.zh-CN.md b/components/slider/index.zh-CN.md index 377396b7e1..5cfe349980 100644 --- a/components/slider/index.zh-CN.md +++ b/components/slider/index.zh-CN.md @@ -38,7 +38,7 @@ cover: https://gw.alipayobjects.com/zos/alicdn/HZ3meFc6W/Silder.svg ## 方法 -| 名称 | 描述 | 版本 | -| --- | --- | --- | -| blur() | 移除焦点 | | -| focus() | 获取焦点 | | +| 名称 | 描述 | 版本 | +| ------- | -------- | ---- | +| blur() | 移除焦点 | | +| focus() | 获取焦点 | | diff --git a/components/spin/index.zh-CN.md b/components/spin/index.zh-CN.md index eed77c70e3..99b46c8536 100644 --- a/components/spin/index.zh-CN.md +++ b/components/spin/index.zh-CN.md @@ -14,14 +14,14 @@ cover: https://gw.alipayobjects.com/zos/alicdn/LBcJqCPRv/Spin.svg ## API -| 参数 | 说明 | 类型 | 默认值 | -| --- | --- | --- | --- | -| delay | 延迟显示加载效果的时间（防止闪烁） | number (毫秒) | - | -| indicator | 加载指示符 | ReactNode | - | -| size | 组件大小，可选值为 `small` `default` `large` | string | `default` | -| spinning | 是否为加载中状态 | boolean | true | -| tip | 当作为包裹元素时，可以自定义描述文案 | string | - | -| wrapperClassName | 包装器的类属性 | string | - | +| 参数 | 说明 | 类型 | 默认值 | +| ---------------- | -------------------------------------------- | ------------- | --------- | +| delay | 延迟显示加载效果的时间（防止闪烁） | number (毫秒) | - | +| indicator | 加载指示符 | ReactNode | - | +| size | 组件大小，可选值为 `small` `default` `large` | string | `default` | +| spinning | 是否为加载中状态 | boolean | true | +| tip | 当作为包裹元素时，可以自定义描述文案 | string | - | +| wrapperClassName | 包装器的类属性 | string | - | ### 静态方法 diff --git a/components/statistic/index.en-US.md b/components/statistic/index.en-US.md index 7b546c070f..2d2822c86d 100644 --- a/components/statistic/index.en-US.md +++ b/components/statistic/index.en-US.md @@ -16,27 +16,27 @@ Display statistic number. #### Statistic -| Property | Description | Type | Default | Version | -| --- | --- | --- | --- | --- | -| decimalSeparator | The decimal separator | string | `.` | | -| formatter | Customize value display logic | (value) => ReactNode | - | | -| groupSeparator | Group separator | string | `,` | | -| loading | Loading status of Statistic | boolean | false | 4.8.0 | -| precision | The precision of input value | number | - | | -| prefix | The prefix node of value | ReactNode | - | | -| suffix | The suffix node of value | ReactNode | - | | -| title | Display title | ReactNode | - | | -| value | Display value | string \| number | - | | -| valueStyle | Set value css style | CSSProperties | - | | +| Property | Description | Type | Default | Version | +| ---------------- | ----------------------------- | -------------------- | ------- | ------- | +| decimalSeparator | The decimal separator | string | `.` | | +| formatter | Customize value display logic | (value) => ReactNode | - | | +| groupSeparator | Group separator | string | `,` | | +| loading | Loading status of Statistic | boolean | false | 4.8.0 | +| precision | The precision of input value | number | - | | +| prefix | The prefix node of value | ReactNode | - | | +| suffix | The suffix node of value | ReactNode | - | | +| title | Display title | ReactNode | - | | +| value | Display value | string \| number | - | | +| valueStyle | Set value css style | CSSProperties | - | | #### Statistic.Countdown -| Property | Description | Type | Default | Version | -| --- | --- | --- | --- | --- | -| format | Format as [moment](http://momentjs.com/) | string | `HH:mm:ss` | | -| prefix | The prefix node of value | ReactNode | - | | -| suffix | The suffix node of value | ReactNode | - | | -| title | Display title | ReactNode | - | | -| value | Set target countdown time | number \| moment | - | | -| valueStyle | Set value css style | CSSProperties | - | | -| onFinish | Trigger when time's up | () => void | - | | +| Property | Description | Type | Default | Version | +| ---------- | ---------------------------------------- | ---------------- | ---------- | ------- | +| format | Format as [moment](http://momentjs.com/) | string | `HH:mm:ss` | | +| prefix | The prefix node of value | ReactNode | - | | +| suffix | The suffix node of value | ReactNode | - | | +| title | Display title | ReactNode | - | | +| value | Set target countdown time | number \| moment | - | | +| valueStyle | Set value css style | CSSProperties | - | | +| onFinish | Trigger when time's up | () => void | - | | diff --git a/components/statistic/index.zh-CN.md b/components/statistic/index.zh-CN.md index d691de797b..93fc76da85 100644 --- a/components/statistic/index.zh-CN.md +++ b/components/statistic/index.zh-CN.md @@ -17,18 +17,18 @@ cover: https://gw.alipayobjects.com/zos/antfincdn/rcBNhLBrKbE/Statistic.svg #### Statistic -| 参数 | 说明 | 类型 | 默认值 | 版本 | -| --- | --- | --- | --- | --- | -| decimalSeparator | 设置小数点 | string | `.` | | -| formatter | 自定义数值展示 | (value) => ReactNode | - | | -| groupSeparator | 设置千分位标识符 | string | `,` | | -| loading | 数值是否加载中 | boolean | false | 4.8.0 | -| precision | 数值精度 | number | - | | -| prefix | 设置数值的前缀 | ReactNode | - | | -| suffix | 设置数值的后缀 | ReactNode | - | | -| title | 数值的标题 | ReactNode | - | | -| value | 数值内容 | string \| number | - | | -| valueStyle | 设置数值的样式 | CSSProperties | - | | +| 参数 | 说明 | 类型 | 默认值 | 版本 | +| ---------------- | ---------------- | -------------------- | ------ | ----- | +| decimalSeparator | 设置小数点 | string | `.` | | +| formatter | 自定义数值展示 | (value) => ReactNode | - | | +| groupSeparator | 设置千分位标识符 | string | `,` | | +| loading | 数值是否加载中 | boolean | false | 4.8.0 | +| precision | 数值精度 | number | - | | +| prefix | 设置数值的前缀 | ReactNode | - | | +| suffix | 设置数值的后缀 | ReactNode | - | | +| title | 数值的标题 | ReactNode | - | | +| value | 数值内容 | string \| number | - | | +| valueStyle | 设置数值的样式 | CSSProperties | - | | #### Statistic.Countdown diff --git a/components/switch/index.en-US.md b/components/switch/index.en-US.md index 1014eb7fb0..15c82021e2 100644 --- a/components/switch/index.en-US.md +++ b/components/switch/index.en-US.md @@ -30,7 +30,7 @@ Switching Selector. ## Methods -| Name | Description | -| --- | --- | -| blur() | Remove focus | -| focus() | Get focus | +| Name | Description | +| ------- | ------------ | +| blur() | Remove focus | +| focus() | Get focus | diff --git a/components/switch/index.zh-CN.md b/components/switch/index.zh-CN.md index 00ee4b4301..df5a27448a 100644 --- a/components/switch/index.zh-CN.md +++ b/components/switch/index.zh-CN.md @@ -31,7 +31,7 @@ cover: https://gw.alipayobjects.com/zos/alicdn/zNdJQMhfm/Switch.svg ## 方法 -| 名称 | 描述 | -| --- | --- | -| blur() | 移除焦点 | +| 名称 | 描述 | +| ------- | -------- | +| blur() | 移除焦点 | | focus() | 获取焦点 | diff --git a/components/tabs/index.zh-CN.md b/components/tabs/index.zh-CN.md index c9478fad3d..b24c09629a 100644 --- a/components/tabs/index.zh-CN.md +++ b/components/tabs/index.zh-CN.md @@ -46,9 +46,9 @@ Ant Design 依次提供了三级选项卡，分别用于不同的场景。 ### Tabs.TabPane -| 参数 | 说明 | 类型 | 默认值 | -| --- | --- | --- | --- | -| closeIcon | 自定义关闭图标，`在 type="editable-card"`时有效 | ReactNode | - | -| forceRender | 被隐藏时是否渲染 DOM 结构 | boolean | false | -| key | 对应 activeKey | string | - | -| tab | 选项卡头显示文字 | ReactNode | - | +| 参数 | 说明 | 类型 | 默认值 | +| ----------- | ----------------------------------------------- | --------- | ------ | +| closeIcon | 自定义关闭图标，`在 type="editable-card"`时有效 | ReactNode | - | +| forceRender | 被隐藏时是否渲染 DOM 结构 | boolean | false | +| key | 对应 activeKey | string | - | +| tab | 选项卡头显示文字 | ReactNode | - | diff --git a/components/tag/index.en-US.md b/components/tag/index.en-US.md index 17c5ee8c2b..9f5a59188e 100644 --- a/components/tag/index.en-US.md +++ b/components/tag/index.en-US.md @@ -17,18 +17,18 @@ Tag for categorizing or markup. ### Tag -| Property | Description | Type | Default | Version | -| --- | --- | --- | --- | --- | -| closable | Whether the Tag can be closed | boolean | false | | -| closeIcon | Custom close icon | ReactNode | - | 4.4.0 | -| color | Color of the Tag | string | - | | -| icon | Set the icon of tag | ReactNode | - | | -| visible | Whether the Tag is closed or not | boolean | true | | -| onClose | Callback executed when tag is closed | (e) => void | - | | +| Property | Description | Type | Default | Version | +| --------- | ------------------------------------ | ----------- | ------- | ------- | +| closable | Whether the Tag can be closed | boolean | false | | +| closeIcon | Custom close icon | ReactNode | - | 4.4.0 | +| color | Color of the Tag | string | - | | +| icon | Set the icon of tag | ReactNode | - | | +| visible | Whether the Tag is closed or not | boolean | true | | +| onClose | Callback executed when tag is closed | (e) => void | - | | ### Tag.CheckableTag -| Property | Description | Type | Default | -| --- | --- | --- | --- | -| checked | Checked status of Tag | boolean | false | -| onChange | Callback executed when Tag is checked/unchecked | (checked) => void | - | +| Property | Description | Type | Default | +| -------- | ----------------------------------------------- | ----------------- | ------- | +| checked | Checked status of Tag | boolean | false | +| onChange | Callback executed when Tag is checked/unchecked | (checked) => void | - | diff --git a/components/tag/index.zh-CN.md b/components/tag/index.zh-CN.md index 690364c690..476873b92a 100644 --- a/components/tag/index.zh-CN.md +++ b/components/tag/index.zh-CN.md @@ -17,18 +17,18 @@ cover: https://gw.alipayobjects.com/zos/alicdn/cH1BOLfxC/Tag.svg ### Tag -| 参数 | 说明 | 类型 | 默认值 | 版本 | -| --- | --- | --- | --- | --- | -| closable | 标签是否可以关闭 | boolean | false | | -| closeIcon | 自定义关闭按钮 | ReactNode | - | 4.4.0 | -| color | 标签色 | string | - | | -| icon | 设置图标 | ReactNode | - | | -| visible | 是否显示标签 | boolean | true | | -| onClose | 关闭时的回调 | (e) => void | - | | +| 参数 | 说明 | 类型 | 默认值 | 版本 | +| --------- | ---------------- | ----------- | ------ | ----- | +| closable | 标签是否可以关闭 | boolean | false | | +| closeIcon | 自定义关闭按钮 | ReactNode | - | 4.4.0 | +| color | 标签色 | string | - | | +| icon | 设置图标 | ReactNode | - | | +| visible | 是否显示标签 | boolean | true | | +| onClose | 关闭时的回调 | (e) => void | - | | ### Tag.CheckableTag -| 参数 | 说明 | 类型 | 默认值 | -| --- | --- | --- | --- | -| checked | 设置标签的选中状态 | boolean | false | -| onChange | 点击标签时触发的回调 | (checked) => void | - | +| 参数 | 说明 | 类型 | 默认值 | +| -------- | -------------------- | ----------------- | ------ | +| checked | 设置标签的选中状态 | boolean | false | +| onChange | 点击标签时触发的回调 | (checked) => void | - | diff --git a/components/time-picker/index.en-US.md b/components/time-picker/index.en-US.md index c5190a6f71..8c87b5c22f 100644 --- a/components/time-picker/index.en-US.md +++ b/components/time-picker/index.en-US.md @@ -58,18 +58,18 @@ import moment from 'moment'; ## Methods -| Name | Description | Version | -| --- | --- | --- | -| blur() | Remove focus | | -| focus() | Get focus | | +| Name | Description | Version | +| ------- | ------------ | ------- | +| blur() | Remove focus | | +| focus() | Get focus | | ### RangePicker Same props from [RangePicker](/components/date-picker/#RangePicker) of DatePicker. And includes additional props: -| Property | Description | Type | Default | Version | -| --- | --- | --- | --- | --- | -| order | Order start and end time | boolean | true | 4.1.0 | +| Property | Description | Type | Default | Version | +| -------- | ------------------------ | ------- | ------- | ------- | +| order | Order start and end time | boolean | true | 4.1.0 |