doc: sort api

Author: tangjinzhou

.gitignore

@@ -78,3 +78,4 @@ report.html
 site/src/router/demoRoutes.js
 
 components/version/version.tsx
+~component-api.json

components/affix/index.zh-CN.md

@@ -24,7 +24,7 @@ cover: https://gw.alipayobjects.com/zos/alicdn/tX6-md4H6/Affix.svg
 
 ### 事件
 
-| 事件名称 | 说明                         | 回调参数                    | 版本 |
+| 事件名称 | 说明                         | 回调参数                    | 版本 |     |
 | -------- | ---------------------------- | --------------------------- | ---- | --- |
 | change   | 固定状态改变时触发的回调函数 | (affixed?: boolean) => void | -    |     |
 

components/alert/index.en-US.md

@@ -19,8 +19,8 @@ Alert component for feedback.
 | afterClose | Called when close animation is finished | () => void | - |  |
 | banner | Whether to show as banner | boolean | false |  |
 | closable | Whether Alert can be closed | boolean |  |  |
-| closeText | Close text to show | string\|slot | - |  |
 | closeIcon | Custom close icon | slot | <CloseOutlined /> | 3.0 |
+| closeText | Close text to show | string\|slot | - |  |
 | description | Additional content of Alert | string\|slot | - |  |
 | icon | Custom icon, effective when `showIcon` is `true` | vnode \| slot | - |  |
 | message | Content of Alert | string\|slot | - |  |

components/alert/index.zh-CN.md

@@ -20,8 +20,8 @@ cover: https://gw.alipayobjects.com/zos/alicdn/8emPa3fjl/Alert.svg
 | afterClose | 关闭动画结束后触发的回调函数 | () => void | - |  |
 | banner | 是否用作顶部公告 | boolean | false |  |
 | closable | 默认不显示关闭按钮 | boolean | 无 |  |
-| closeText | 自定义关闭按钮 | string\|slot | 无 |  |
 | closeIcon | 自定义关闭 Icon | slot | <CloseOutlined /> | 3.0 |
+| closeText | 自定义关闭按钮 | string\|slot | 无 |  |
 | description | 警告提示的辅助性文字介绍 | string\|slot | 无 |  |
 | icon | 自定义图标，`showIcon` 为 `true` 时有效 | vnode\|slot | - |  |
 | message | 警告提示内容 | string\|slot | 无 |  |

components/anchor/index.en-US.md

@@ -21,25 +21,25 @@ For displaying anchor hyperlinks on page and jumping between them.
 | affix | Fixed mode of Anchor | boolean | true |  |
 | bounds | Bounding distance of anchor area | number | 5(px) |  |
 | getContainer | Scrolling container | () => HTMLElement | () => window |  |
+| getCurrentAnchor | Customize the anchor highlight | () => string | - | 1.5.0 |
 | offsetBottom | Pixels to offset from bottom when calculating position of scroll | number | - |  |
 | offsetTop | Pixels to offset from top when calculating position of scroll | number | 0 |  |
 | showInkInFixed | Whether show ink-balls when `：affix="false"` | boolean | false |  |
+| targetOffset | Anchor scroll offset, default as `offsetTop`, [example](#components-anchor-demo-targetOffset) | number | `offsetTop` | 1.5.0 |
 | wrapperClass | The class name of the container | string | - |  |
 | wrapperStyle | The style of the container | object | - |  |
-| getCurrentAnchor | Customize the anchor highlight | () => string | - | 1.5.0 |
-| targetOffset | Anchor scroll offset, default as `offsetTop`, [example](#components-anchor-demo-targetOffset) | number | `offsetTop` | 1.5.0 |
 
 ### Events
 
-| Events Name | Description | Arguments | Version |
+| Events Name | Description | Arguments | Version |  |
 | --- | --- | --- | --- | --- |
-| click | set the handler to handle `click` event | Function(e: Event, link: Object) |  |
 | change | Listening for anchor link change | (currentActiveLink: string) => void |  | 1.5.0 |
+| click | set the handler to handle `click` event | Function(e: Event, link: Object) |  |  |
 
 ### Link Props
 
 | Property | Description                               | Type         | Default | Version |
 | -------- | ----------------------------------------- | ------------ | ------- | ------- |
 | href     | target of hyperlink                       | string       |         |         |
-| title    | content of hyperlink                      | string\|slot |         |         |
 | target   | Specifies where to display the linked URL | string       |         | 1.5.0   |
+| title    | content of hyperlink                      | string\|slot |         |         |

components/anchor/index.zh-CN.md

@@ -22,25 +22,25 @@ cover: https://gw.alipayobjects.com/zos/alicdn/_1-C1JwsC/Anchor.svg
 | affix | 固定模式 | boolean | true |  |
 | bounds | 锚点区域边界 | number | 5(px) |  |
 | getContainer | 指定滚动的容器 | () => HTMLElement | () => window |  |
+| getCurrentAnchor | 自定义高亮的锚点 | () => string | - | 1.5.0 |
 | offsetBottom | 距离窗口底部达到指定偏移量后触发 | number |  |  |
 | offsetTop | 距离窗口顶部达到指定偏移量后触发 | number |  |  |
 | showInkInFixed | `:affix="false"` 时是否显示小圆点 | boolean | false |  |
+| targetOffset | 锚点滚动偏移量，默认与 offsetTop 相同，[例子](#components-anchor-demo-targetOffset) | number | `offsetTop` | 1.5.0 |
 | wrapperClass | 容器的类名 | string | - |  |
 | wrapperStyle | 容器样式 | object | - |  |
-| getCurrentAnchor | 自定义高亮的锚点 | () => string | - | 1.5.0 |
-| targetOffset | 锚点滚动偏移量，默认与 offsetTop 相同，[例子](#components-anchor-demo-targetOffset) | number | `offsetTop` | 1.5.0 |
 
 ### 事件
 
-| 事件名称 | 说明                   | 回调参数                            | 版本 |
+| 事件名称 | 说明                   | 回调参数                            | 版本 |       |
 | -------- | ---------------------- | ----------------------------------- | ---- | ----- |
-| click    | `click` 事件的 handler | Function(e: Event, link: Object)    |      |
 | change   | 监听锚点链接改变       | (currentActiveLink: string) => void |      | 1.5.0 |
+| click    | `click` 事件的 handler | Function(e: Event, link: Object)    |      |       |
 
 ### Link Props
 
 | 成员   | 说明                             | 类型         | 默认值 | 版本  |
 | ------ | -------------------------------- | ------------ | ------ | ----- |
 | href   | 锚点链接                         | string       |        |       |
-| title  | 文字内容                         | string\|slot |        |       |
 | target | 该属性指定在何处显示链接的资源。 | string       |        | 1.5.0 |
+| title  | 文字内容                         | string\|slot |        |       |

components/auto-complete/index.en-US.md

@@ -26,32 +26,32 @@ The differences with Select are:
 
 | Property | Description | Type | Default | Version |
 | --- | --- | --- | --- | --- |
+| #default (for customize input element) | customize input element | HTMLInputElement / HTMLTextAreaElement | `<Input />` |  |
 | allowClear | Show clear button, effective in multiple mode only. | boolean | false |  |
 | autofocus | get focus when component mounted | boolean | false |  |
 | backfill | backfill selected item the input when using keyboard | boolean | false |  |
-| #default (for customize input element) | customize input element | HTMLInputElement / HTMLTextAreaElement | `<Input />` |  |
-| options | Data source for autocomplete | [DataSourceItemType](https://github.com/vueComponent/ant-design-vue/blob/724d53b907e577cf5880c1e6742d4c3f924f8f49/components/auto-complete/index.vue#L9)\[] |  |  |
-| option | custom render option by slot | v-slot:option="{value, label, [disabled, key, title]}" | - | 3.0 |
-| dropdownMenuStyle | additional style applied to dropdown menu | object |  | 1.5.0 |
 | defaultActiveFirstOption | Whether active first option by default | boolean | true |  |
+| defaultOpen | Initial open state of dropdown | boolean | - |  |
 | disabled | Whether disabled select | boolean | false |  |
 | dropdownMatchSelectWidth | Determine whether the dropdown menu and the select input are the same width. Default set `min-width` same as input. Will ignore when value less than select width. `false` will disable virtual scroll | boolean \| number | true |  |
+| dropdownMenuStyle | additional style applied to dropdown menu | object |  | 1.5.0 |
 | filterOption | If true, filter options by input, if function, filter options against it. The function will receive two arguments, `inputValue` and `option`, if the function returns `true`, the option will be included in the filtered set; Otherwise, it will be excluded. | boolean or function(inputValue, option) | true |  |
+| open | Controlled open state of dropdown | boolean | - |  |
+| option | custom render option by slot | v-slot:option="{value, label, [disabled, key, title]}" | - | 3.0 |
+| options | Data source for autocomplete | [DataSourceItemType](https://github.com/vueComponent/ant-design-vue/blob/724d53b907e577cf5880c1e6742d4c3f924f8f49/components/auto-complete/index.vue#L9)\[] |  |  |
 | placeholder | placeholder of input | string | - |  |
 | v-model:value | selected option | string\|string\[]\|{ key: string, label: string\|vNodes }\|Array&lt;{ key: string, label: string\|vNodes }> | - |  |
-| defaultOpen | Initial open state of dropdown | boolean | - |  |
-| open | Controlled open state of dropdown | boolean | - |  |
 
 ### events
 
-| Events Name | Description | Arguments | Version |
+| Events Name | Description | Arguments | Version |  |
 | --- | --- | --- | --- | --- |
-| change | Called when select an option or input value change, or value of input is changed | function(value) |  |
-| blur | Called when leaving the component. | function() |  |
-| focus | Called when entering the component | function() |  |
+| blur | Called when leaving the component. | function() |  |  |
+| change | Called when select an option or input value change, or value of input is changed | function(value) |  |  |
+| dropdownVisibleChange | Call when dropdown open | function(open) |  |  |
+| focus | Called when entering the component | function() |  |  |
 | search | Called when searching items. | function(value) | - |  |
-| select | Called when a option is selected. param is option's value and option instance. | function(value, option) |  |
-| dropdownVisibleChange | Call when dropdown open | function(open) |  |
+| select | Called when a option is selected. param is option's value and option instance. | function(value, option) |  |  |
 
 ## Methods
 

components/auto-complete/index.zh-CN.md

@@ -27,39 +27,39 @@ cover: https://gw.alipayobjects.com/zos/alicdn/qtJm4yt45/AutoComplete.svg
 
 | 参数 | 说明 | 类型 | 默认值 | 版本 |
 | --- | --- | --- | --- | --- |
+| #default (自定义输入框) | 自定义输入框 | HTMLInputElement / HTMLTextAreaElement | `<Input />` |  |
 | allowClear | 支持清除, 单选模式有效 | boolean | false |  |
 | autofocus | 自动获取焦点 | boolean | false |  |
 | backfill | 使用键盘选择选项的时候把选中项回填到输入框中 | boolean | false |  |
-| #default (自定义输入框) | 自定义输入框 | HTMLInputElement / HTMLTextAreaElement | `<Input />` |  |
-| options | 自动完成的数据源 | [DataSourceItemType](https://github.com/vueComponent/ant-design-vue/blob/724d53b907e577cf5880c1e6742d4c3f924f8f49/components/auto-complete/index.vue#L9)\[] |  |  |
-| option | 通过 option 插槽，自定义节点 | v-slot:option="{value, label, [disabled, key, title]}" | - | 3.0 |
-| dropdownMenuStyle | dropdown 菜单自定义样式 | object |  | 1.5.0 |
 | defaultActiveFirstOption | 是否默认高亮第一个选项。 | boolean | true |  |
+| defaultOpen | 是否默认展开下拉菜单 | boolean | - |  |
 | disabled | 是否禁用 | boolean | false |  |
 | dropdownMatchSelectWidth | 下拉菜单和选择器同宽。默认将设置 `min-width`，当值小于选择框宽度时会被忽略。false 时会关闭虚拟滚动 | boolean \| number | true |  |
+| dropdownMenuStyle | dropdown 菜单自定义样式 | object |  | 1.5.0 |
 | filterOption | 是否根据输入项进行筛选。当其为一个函数时，会接收 `inputValue` `option` 两个参数，当 `option` 符合筛选条件时，应返回 `true`，反之则返回 `false`。 | boolean or function(inputValue, option) | true |  |
+| open | 是否展开下拉菜单 | boolean | - |  |
+| option | 通过 option 插槽，自定义节点 | v-slot:option="{value, label, [disabled, key, title]}" | - | 3.0 |
+| options | 自动完成的数据源 | [DataSourceItemType](https://github.com/vueComponent/ant-design-vue/blob/724d53b907e577cf5880c1e6742d4c3f924f8f49/components/auto-complete/index.vue#L9)\[] |  |  |
 | placeholder | 输入框提示 | string \| slot | - |  |
 | v-model:value | 指定当前选中的条目 | string\|string\[]\|{ key: string, label: string\|vNodes }\|Array&lt;{ key: string, label: string\|vNodes }> | 无 |  |
-| defaultOpen | 是否默认展开下拉菜单 | boolean | - |  |
-| open | 是否展开下拉菜单 | boolean | - |  |
 
 ### 事件
 
 | 事件名称 | 说明 | 回调参数 | 版本 |
 | --- | --- | --- | --- |
-| change | 选中 option，或 input 的 value 变化时，调用此函数 | function(value) |
-| blur | 失去焦点时的回调 | function() |
-| focus | 获得焦点时的回调 | function() |
-| search | 搜索补全项的时候调用 | function(value) |
-| select | 被选中时调用，参数为选中项的 value 值 | function(value, option) |
-| dropdownVisibleChange | 展开下拉菜单的回调 | function(open) |
+| blur | 失去焦点时的回调 | function() |  |
+| change | 选中 option，或 input 的 value 变化时，调用此函数 | function(value) |  |
+| dropdownVisibleChange | 展开下拉菜单的回调 | function(open) |  |
+| focus | 获得焦点时的回调 | function() |  |
+| search | 搜索补全项的时候调用 | function(value) |  |
+| select | 被选中时调用，参数为选中项的 value 值 | function(value, option) |  |
 
 ## 方法
 
 | 名称    | 描述     | 版本 |
 | ------- | -------- | ---- |
-| blur()  | 移除焦点 |
-| focus() | 获取焦点 |
+| blur()  | 移除焦点 |      |
+| focus() | 获取焦点 |      |
 
 ## FAQ
 

components/avatar/index.en-US.md

@@ -13,16 +13,16 @@ Avatars can be used to represent people or objects. It supports images, `Icon`s,
 
 | Property | Description | Type | Default | Version |
 | --- | --- | --- | --- | --- |
-| icon | the `Icon` type for an icon avatar, see `Icon` Component | VNode \| slot | - |
-| shape | the shape of avatar | `circle` \| `square` | `circle` |
-| size | The size of the avatar | number \| `large` \| `small` \| `default` \| { xs: number, sm: number, ...} | `default` | 2.2.0 |
-| src | the address of the image for an image avatar | string | - |
-| srcset | a list of sources to use for different screen resolutions | string | - |
-| alt | This attribute defines the alternative text describing the image | string | - |
-| gap | Letter type unit distance between left and right sides | number | 4 | 2.2.0 |
-| draggable | Whether the picture is allowed to be dragged | boolean \| `'true'` \| `'false'` | - | 2.2.0 |
+| alt | This attribute defines the alternative text describing the image | string | - |  |
 | crossOrigin | CORS settings attributes | `'anonymous'` \| `'use-credentials'` \| `''` | - | 3.0 |
-| loadError | handler when img load error, return false to prevent default fallback behavior | () => boolean | - |
+| draggable | Whether the picture is allowed to be dragged | boolean \| `'true'` \| `'false'` | - | 2.2.0 |
+| gap | Letter type unit distance between left and right sides | number | 4 | 2.2.0 |
+| icon | the `Icon` type for an icon avatar, see `Icon` Component | VNode \| slot | - |  |
+| loadError | handler when img load error, return false to prevent default fallback behavior | () => boolean | - |  |
+| shape | the shape of avatar | `circle` \| `square` | `circle` |  |
+| size | The size of the avatar | number \| `large` \| `small` \| `default` \| { xs: number, sm: number, ...} | `default` | 2.2.0 |
+| src | the address of the image for an image avatar | string | - |  |
+| srcset | a list of sources to use for different screen resolutions | string | - |  |
 
 ### Avatar.Group (2.2.0)
 

components/avatar/index.zh-CN.md

@@ -18,16 +18,16 @@ cover: https://gw.alipayobjects.com/zos/antfincdn/aBcnbw68hP/Avatar.svg
 
 | 参数 | 说明 | 类型 | 默认值 | 版本 |
 | --- | --- | --- | --- | --- |
-| icon | 设置头像的图标类型，可设为 Icon 的 `type` 或 VNode | VNode \| slot | - |
+| alt | 图像无法显示时的替代文本 | string | - |  |
+| crossOrigin | CORS 属性设置 | `'anonymous'` \| `'use-credentials'` \| `''` | - | 3.0 |
+| draggable | 图片是否允许拖动 | boolean \| `'true'` \| `'false'` | - | 2.2.0 |
+| gap | 字符类型距离左右两侧边界单位像素 | number | 4 | 2.2.0 |
+| icon | 设置头像的图标类型，可设为 Icon 的 `type` 或 VNode | VNode \| slot | - |  |
+| loadError | 图片加载失败的事件，返回 false 会关闭组件默认的 fallback 行为 | () => boolean | - |  |
 | shape | 指定头像的形状 | `circle` \| `square` | `circle` |  |
 | size | 设置头像的大小 | number \| `large` \| `small` \| `default` \| { xs: number, sm: number, ...} | `default` | 2.2.0 |
-| src | 图片类头像的资源地址 | string | - |
-| srcset | 设置图片类头像响应式资源地址 | string | - |
-| alt | 图像无法显示时的替代文本 | string | - |
-| gap | 字符类型距离左右两侧边界单位像素 | number | 4 | 2.2.0 |
-| draggable | 图片是否允许拖动 | boolean \| `'true'` \| `'false'` | - | 2.2.0 |
-| loadError | 图片加载失败的事件，返回 false 会关闭组件默认的 fallback 行为 | () => boolean | - |
-| crossOrigin | CORS 属性设置 | `'anonymous'` \| `'use-credentials'` \| `''` | - | 3.0 |
+| src | 图片类头像的资源地址 | string | - |  |
+| srcset | 设置图片类头像响应式资源地址 | string | - |  |
 
 ### Avatar.Group (2.2.0)
 

components/badge/index.zh-CN.md

@@ -31,12 +31,12 @@ cover: https://gw.alipayobjects.com/zos/antfincdn/6%26GF9WHwvY/Badge.svg
 | color | 自定义小圆点的颜色 | string | - | 1.5.0 |
 | count | 展示的数字，大于 overflowCount 时显示为 `${overflowCount}+`，为 0 时隐藏 | number \| string \| slot |  |  |
 | dot | 不展示数字，只有一个小红点 | boolean | false |  |
+| numberStyle | 设置状态点的样式 | object | '' |  |
 | offset | 设置状态点的位置偏移，格式为 [x, y] | [number\|string, number\|string] | - |  |
 | overflowCount | 展示封顶的数字值 | number | 99 |  |
 | showZero | 当数值为 0 时，是否展示 Badge | boolean | false |  |
 | status | 设置 Badge 为状态点 | Enum{ 'success', 'processing, 'default', 'error', 'warning' } | '' |  |
 | text | 在设置了 `status` 的前提下有效，设置状态点的文本 | string | '' |  |
-| numberStyle | 设置状态点的样式 | object | '' |  |
 | title | 设置鼠标放在状态点上时显示的文字 | string | `count` |  |
 
 ### Badge.Ribbon (2.0.1+)

components/breadcrumb/index.en-US.md

@@ -31,7 +31,7 @@ A breadcrumb displays the current location within a hierarchy. It allows going b
 
 #### Events
 
-| Events Name | Description                   | Arguments            | Version |
+| Events Name | Description                   | Arguments            | Version |       |
 | ----------- | ----------------------------- | -------------------- | ------- | ----- |
 | click       | handler to handle click event | (e:MouseEvent)=>void | -       | 1.5.0 |
 

components/breadcrumb/index.zh-CN.md

@@ -32,7 +32,7 @@ cover: https://gw.alipayobjects.com/zos/alicdn/9Ltop8JwH/Breadcrumb.svg
 
 #### 事件
 
-| 事件名称 | 说明     | 回调参数             | 版本 |
+| 事件名称 | 说明     | 回调参数             | 版本 |       |
 | -------- | -------- | -------------------- | ---- | ----- |
 | click    | 单击事件 | (e:MouseEvent)=>void | -    | 1.5.0 |