docs: show version Number features were added (#17373)

* docs: add api first appearance * docs: fix auto-complete doc * docs: replace Version Added with Version * docs: date picker common method * docs: date picker common method * docs: tree * docs: remove meaningless 3.0.0
ant-design · Jul 11, 2019 · fb0b4f0 · fb0b4f0
1 parent 79bff3f
commit fb0b4f0
Show file tree

Hide file tree

Showing 124 changed files with 2,538 additions and 2,537 deletions.
diff --git a/components/affix/index.en-US.md b/components/affix/index.en-US.md
@@ -14,12 +14,12 @@ Please note that Affix should not cover other content on the page, especially wh
 
 ## API
 
-| Property | Description | Type | Default |
-| --- | --- | --- | --- |
-| 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 |
-| target | specifies the scrollable area dom node | () => HTMLElement | () => window |
-| onChange | Callback for when affix state is changed | Function(affixed) | - |
+| Property | Description | Type | Default | Version |
+| --- | --- | --- | --- | --- |
+| 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 |  |
+| target | specifies the scrollable area dom node | () => HTMLElement | () => window |  |
+| onChange | Callback for when affix state is changed | Function(affixed) | - |  |
 
 **Note:** Children of `Affix` can not be `position: absolute`, but you can set `Affix` as `position: absolute`:
 

diff --git a/components/affix/index.zh-CN.md b/components/affix/index.zh-CN.md
@@ -15,12 +15,12 @@ title: Affix
 
 ## API
 
-| 成员 | 说明 | 类型 | 默认值 |
-| --- | --- | --- | --- |
-| offsetBottom | 距离窗口底部达到指定偏移量后触发 | number |  |
-| offsetTop | 距离窗口顶部达到指定偏移量后触发 | number |  |
-| target | 设置 `Affix` 需要监听其滚动事件的元素，值为一个返回对应 DOM 元素的函数 | () => HTMLElement | () => window |
-| onChange | 固定状态改变时触发的回调函数 | Function(affixed) | 无 |
+| 成员 | 说明 | 类型 | 默认值 | 版本 |
+| --- | --- | --- | --- | --- |
+| offsetBottom | 距离窗口底部达到指定偏移量后触发 | number |  |  |
+| offsetTop | 距离窗口顶部达到指定偏移量后触发 | number |  |  |
+| target | 设置 `Affix` 需要监听其滚动事件的元素，值为一个返回对应 DOM 元素的函数 | () => HTMLElement | () => window |  |
+| onChange | 固定状态改变时触发的回调函数 | Function(affixed) | 无 |  |
 
 **注意：**`Affix` 内的元素不要使用绝对定位，如需要绝对定位的效果，可以直接设置 `Affix` 为绝对定位：
 

diff --git a/components/alert/index.en-US.md b/components/alert/index.en-US.md
@@ -13,15 +13,15 @@ Alert component for feedback.
 
 ## API
 
-| Property | Description | Type | Default |
-| --- | --- | --- | --- |
-| 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\|ReactNode | - |
-| description | Additional content of Alert | string\|ReactNode | - |
-| icon | Custom icon, effective when `showIcon` is `true` | ReactNode | - |
-| message | Content of Alert | string\|ReactNode | - |
-| showIcon | Whether to show icon | boolean | false, in `banner` mode default is true |
-| type | Type of Alert styles, options: `success`, `info`, `warning`, `error` | string | `info`, in `banner` mode default is `warning` |
-| onClose | Callback when Alert is closed | (e: MouseEvent) => void | - |
+| Property | Description | Type | Default | Version |
+| --- | --- | --- | --- | --- |
+| afterClose | Called when close animation is finished | () => void | - | 3.3.1 |
+| banner | Whether to show as banner | boolean | false |  |
+| closable | Whether Alert can be closed | boolean | - |  |
+| closeText | Close text to show | string\|ReactNode | - |  |
+| description | Additional content of Alert | string\|ReactNode | - |  |
+| icon | Custom icon, effective when `showIcon` is `true` | ReactNode | - | 3.10.0 |
+| message | Content of Alert | string\|ReactNode | - |  |
+| showIcon | Whether to show icon | boolean | false, in `banner` mode default is true |  |
+| type | Type of Alert styles, options: `success`, `info`, `warning`, `error` | string | `info`, in `banner` mode default is `warning` |  |
+| onClose | Callback when Alert is closed | (e: MouseEvent) => void | - |  |
diff --git a/components/alert/index.zh-CN.md b/components/alert/index.zh-CN.md
@@ -14,15 +14,15 @@ title: Alert
 
 ## API
 
-| 参数 | 说明 | 类型 | 默认值 |
-| --- | --- | --- | --- |
-| afterClose | 关闭动画结束后触发的回调函数 | () => void | - |
-| banner | 是否用作顶部公告 | boolean | false |
-| closable | 默认不显示关闭按钮 | boolean | 无 |
-| closeText | 自定义关闭按钮 | string\|ReactNode | 无 |
-| description | 警告提示的辅助性文字介绍 | string\|ReactNode | 无 |
-| icon | 自定义图标，`showIcon` 为 `true` 时有效 | ReactNode | - |
-| message | 警告提示内容 | string\|ReactNode | 无 |
-| showIcon | 是否显示辅助图标 | boolean | false，`banner` 模式下默认值为 true |
-| type | 指定警告提示的样式，有四种选择 `success`、`info`、`warning`、`error` | string | `info`，`banner` 模式下默认值为 `warning` |
-| onClose | 关闭时触发的回调函数 | (e: MouseEvent) => void | 无 |
+| 参数 | 说明 | 类型 | 默认值 | 版本 |
+| --- | --- | --- | --- | --- |
+| afterClose | 关闭动画结束后触发的回调函数 | () => void | - | 3.3.1 |
+| banner | 是否用作顶部公告 | boolean | false |  |
+| closable | 默认不显示关闭按钮 | boolean | 无 |  |
+| closeText | 自定义关闭按钮 | string\|ReactNode | 无 |  |
+| description | 警告提示的辅助性文字介绍 | string\|ReactNode | 无 |  |
+| icon | 自定义图标，`showIcon` 为 `true` 时有效 | ReactNode | - | 3.10.0 |
+| message | 警告提示内容 | string\|ReactNode | 无 |  |
+| showIcon | 是否显示辅助图标 | boolean | false，`banner` 模式下默认值为 true |  |
+| type | 指定警告提示的样式，有四种选择 `success`、`info`、`warning`、`error` | string | `info`，`banner` 模式下默认值为 `warning` |  |
+| onClose | 关闭时触发的回调函数 | (e: MouseEvent) => void | 无 |  |
diff --git a/components/anchor/index.en-US.md b/components/anchor/index.en-US.md
@@ -15,19 +15,19 @@ For displaying anchor hyperlinks on page and jumping between them.
 
 ### Anchor Props
 
-| Property | Description | Type | Default |
-| --- | --- | --- | --- |
-| affix | Fixed mode of Anchor | boolean | true |
-| bounds | Bounding distance of anchor area | number | 5(px) |
-| getContainer | Scrolling container | () => HTMLElement | () => window |
-| 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 in Fixed mode | boolean | false |
-| onClick | set the handler to handle `click` event | Function(e: Event, link: Object) | - |
+| Property | Description | Type | Default | Version |
+| --- | --- | --- | --- | --- |
+| affix | Fixed mode of Anchor | boolean | true |  |
+| bounds | Bounding distance of anchor area | number | 5(px) |  |
+| getContainer | Scrolling container | () => HTMLElement | () => window | 3.4.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 in Fixed mode | boolean | false |  |
+| onClick | set the handler to handle `click` event | Function(e: Event, link: Object) | - | 3.9.0 |
 
 ### Link Props
 
-| Property | Description          | Type              | Default |
-| -------- | -------------------- | ----------------- | ------- |
-| href     | target of hyperlink  | string            |         |
-| title    | content of hyperlink | string\|ReactNode |         |
+| Property | Description          | Type              | Default | Version |
+| -------- | -------------------- | ----------------- | ------- | ------- |
+| href     | target of hyperlink  | string            |         |         |
+| title    | content of hyperlink | string\|ReactNode |         |         |
diff --git a/components/anchor/index.zh-CN.md b/components/anchor/index.zh-CN.md
@@ -16,19 +16,19 @@ title: Anchor
 
 ### Anchor Props
 
-| 成员 | 说明 | 类型 | 默认值 |
-| --- | --- | --- | --- |
-| affix | 固定模式 | boolean | true |
-| bounds | 锚点区域边界 | number | 5(px) |
-| getContainer | 指定滚动的容器 | () => HTMLElement | () => window |
-| offsetBottom | 距离窗口底部达到指定偏移量后触发 | number |  |
-| offsetTop | 距离窗口顶部达到指定偏移量后触发 | number |  |
-| showInkInFixed | 固定模式是否显示小圆点 | boolean | false |
-| onClick | `click` 事件的 handler | Function(e: Event, link: Object) | - |
+| 成员 | 说明 | 类型 | 默认值 | 版本 |
+| --- | --- | --- | --- | --- |
+| affix | 固定模式 | boolean | true |  |
+| bounds | 锚点区域边界 | number | 5(px) |  |
+| getContainer | 指定滚动的容器 | () => HTMLElement | () => window | 3.4.0 |
+| offsetBottom | 距离窗口底部达到指定偏移量后触发 | number |  |  |
+| offsetTop | 距离窗口顶部达到指定偏移量后触发 | number |  |  |
+| showInkInFixed | 固定模式是否显示小圆点 | boolean | false |  |
+| onClick | `click` 事件的 handler | Function(e: Event, link: Object) | - | 3.9.0 |
 
 ### Link Props
 
-| 成员  | 说明     | 类型              | 默认值 |
-| ----- | -------- | ----------------- | ------ |
-| href  | 锚点链接 | string            |        |
-| title | 文字内容 | string\|ReactNode |        |
+| 成员  | 说明     | 类型              | 默认值 | 版本 |
+| ----- | -------- | ----------------- | ------ | ---- |
+| href  | 锚点链接 | string            |        |      |
+| title | 文字内容 | string\|ReactNode |        |      |
diff --git a/components/auto-complete/index.en-US.md b/components/auto-complete/index.en-US.md
@@ -18,33 +18,33 @@ const dataSource = ['12345', '23456', '34567'];
 <AutoComplete dataSource={dataSource} />;
 ```
 
-| Property | Description | Type | Default |
-| --- | --- | --- | --- |
-| 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 |
-| children (for customize input element) | customize input element | HTMLInputElement / HTMLTextAreaElement / React.ReactElement<InputProps> | `<Input />` |
-| children (for dataSource) | Data source for autocomplete | React.ReactElement<OptionProps> / Array&lt;React.ReactElement<OptionProps>> | - |
-| dataSource | Data source for autocomplete | [DataSourceItemType](https://git.io/vMMKF)\[] |  |
-| defaultActiveFirstOption | Whether active first option by default | boolean | true |
-| defaultValue | Initial selected option. | string\|string\[]\| - |
-| disabled | Whether disabled select | boolean | false |
-| 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 |
-| optionLabelProp | Which prop value of option will render as content of select. | string | `children` |
-| placeholder | placeholder of input | string | - |
-| value | selected option | string\|string\[]\|{ key: string, label: string\|ReactNode }\|Array&lt;{ key: string, label: string\|ReactNode }> | - |
-| onBlur | Called when leaving the component. | function() | - |
-| onChange | Called when select an option or input value change, or value of input is changed | function(value) | - |
-| onFocus | Called when entering the component | function() | - |
-| onSearch | Called when searching items. | function(value) | - |
-| onSelect | Called when a option is selected. param is option's value and option instance. | function(value, option) | - |
-| defaultOpen | Initial open state of dropdown | boolean | - |
-| open | Controlled open state of dropdown | boolean | - |
-| onDropdownVisibleChange | Call when dropdown open | function(open) | - |
+| Property | Description | Type | Default | Version |
+| --- | --- | --- | --- | --- |
+| 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 |  |
+| children (for customize input element) | customize input element | HTMLInputElement / HTMLTextAreaElement / React.ReactElement<InputProps> | `<Input />` |  |
+| children (for dataSource) | Data source for autocomplete | React.ReactElement<OptionProps> / Array&lt;React.ReactElement<OptionProps>> | - |  |
+| dataSource | Data source for autocomplete | [DataSourceItemType](https://git.io/vMMKF)\[] | - |  |
+| defaultActiveFirstOption | Whether active first option by default | boolean | true |  |
+| defaultValue | Initial selected option. | string\|string\[] | - |  |
+| disabled | Whether disabled select | boolean | false |  |
+| 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 |  |
+| optionLabelProp | Which prop value of option will render as content of select. | string | `children` |  |
+| placeholder | placeholder of input | string | - |  |
+| value | selected option | string\|string\[]\|{ key: string, label: string\|ReactNode }\|Array&lt;{ key: string, label: string\|ReactNode }> | - |  |
+| onBlur | Called when leaving the component. | function() | - | 3.6.5 |
+| onChange | Called when select an option or input value change, or value of input is changed | function(value) | - |  |
+| onFocus | Called when entering the component | function() | - | 3.6.5 |
+| onSearch | Called when searching items. | function(value) | - |  |
+| onSelect | Called when a option is selected. param is option's value and option instance. | function(value, option) | - |  |
+| defaultOpen | Initial open state of dropdown | boolean | - | 3.9.3 |
+| open | Controlled open state of dropdown | boolean | - | 3.9.3 |
+| onDropdownVisibleChange | Call when dropdown open | function(open) | - | 3.9.3 |
 
 ## Methods
 
-| Name    | Description  |
-| ------- | ------------ |
-| blur()  | remove focus |
-| focus() | get focus    |
+| Name    | Description  | Version |
+| ------- | ------------ | ------- |
+| blur()  | remove focus |         |
+| focus() | get focus    |         |
diff --git a/components/auto-complete/index.zh-CN.md b/components/auto-complete/index.zh-CN.md
@@ -19,34 +19,34 @@ const dataSource = ['12345', '23456', '34567'];
 <AutoComplete dataSource={dataSource} />;
 ```
 
-| 参数 | 说明 | 类型 | 默认值 |
-| --- | --- | --- | --- |
-| allowClear | 支持清除, 单选模式有效 | boolean | false |
-| autoFocus | 自动获取焦点 | boolean | false |
-| backfill | 使用键盘选择选项的时候把选中项回填到输入框中 | boolean | false |
-| children (自动完成的数据源) | 自动完成的数据源 | React.ReactElement<OptionProps> / Array&lt;React.ReactElement<OptionProps>> | - |
-| children (自定义输入框) | 自定义输入框 | HTMLInputElement / HTMLTextAreaElement / React.ReactElement<InputProps> | `<Input />` |
-| dataSource | 自动完成的数据源 | [DataSourceItemType](https://git.io/vMMKF)\[] |  |
-| defaultActiveFirstOption | 是否默认高亮第一个选项。 | boolean | true |
-| defaultValue | 指定默认选中的条目 | string\|string\[]\| 无 |
-| disabled | 是否禁用 | boolean | false |
-| filterOption | 是否根据输入项进行筛选。当其为一个函数时，会接收 `inputValue` `option` 两个参数，当 `option` 符合筛选条件时，应返回 `true`，反之则返回 `false`。 | boolean or function(inputValue, option) | true |
-| getPopupContainer | 菜单渲染父节点。默认渲染到 body 上，如果你遇到菜单滚动定位问题，试试修改为滚动的区域，并相对其定位。[示例](https://codesandbox.io/s/4j168r7jw0) | Function(triggerNode) | () => document.body |
-| optionLabelProp | 回填到选择框的 Option 的属性值，默认是 Option 的子元素。比如在子元素需要高亮效果时，此值可以设为 `value`。 | string | `children` |
-| placeholder | 输入框提示 | string | - |
-| value | 指定当前选中的条目 | string\|string\[]\|{ key: string, label: string\|ReactNode }\|Array&lt;{ key: string, label: string\|ReactNode }> | 无 |
-| onBlur | 失去焦点时的回调 | function() | - |
-| onChange | 选中 option，或 input 的 value 变化时，调用此函数 | function(value) | 无 |
-| onFocus | 获得焦点时的回调 | function() | - |
-| onSearch | 搜索补全项的时候调用 | function(value) | 无 |
-| onSelect | 被选中时调用，参数为选中项的 value 值 | function(value, option) | 无 |
-| defaultOpen | 是否默认展开下拉菜单 | boolean | - |
-| open | 是否展开下拉菜单 | boolean | - |
-| onDropdownVisibleChange | 展开下拉菜单的回调 | function(open) | - |
+| 参数 | 说明 | 类型 | 默认值 | 版本 |
+| --- | --- | --- | --- | --- |
+| allowClear | 支持清除, 单选模式有效 | boolean | false |  |
+| autoFocus | 自动获取焦点 | boolean | false |  |
+| backfill | 使用键盘选择选项的时候把选中项回填到输入框中 | boolean | false |  |
+| children (自动完成的数据源) | 自动完成的数据源 | React.ReactElement<OptionProps> / Array&lt;React.ReactElement<OptionProps>> | - |  |  |
+| children (自定义输入框) | 自定义输入框 | HTMLInputElement / HTMLTextAreaElement / React.ReactElement<InputProps> | `<Input />` | @todo.muyu |
+| dataSource | 自动完成的数据源 | [DataSourceItemType](https://git.io/vMMKF)\[] |  |  |
+| defaultActiveFirstOption | 是否默认高亮第一个选项。 | boolean | true |  |
+| defaultValue | 指定默认选中的条目 | string\|string\[]\| 无 |  |
+| disabled | 是否禁用 | boolean | false |  |
+| filterOption | 是否根据输入项进行筛选。当其为一个函数时，会接收 `inputValue` `option` 两个参数，当 `option` 符合筛选条件时，应返回 `true`，反之则返回 `false`。 | boolean or function(inputValue, option) | true |  |
+| getPopupContainer | 菜单渲染父节点。默认渲染到 body 上，如果你遇到菜单滚动定位问题，试试修改为滚动的区域，并相对其定位。[示例](https://codesandbox.io/s/4j168r7jw0) | Function(triggerNode) | () => document.body | 3.19.4 |
+| optionLabelProp | 回填到选择框的 Option 的属性值，默认是 Option 的子元素。比如在子元素需要高亮效果时，此值可以设为 `value`。 | string | `children` |  |
+| placeholder | 输入框提示 | string | - |  |
+| value | 指定当前选中的条目 | string\|string\[]\|{ key: string, label: string\|ReactNode }\|Array&lt;{ key: string, label: string\|ReactNode }> | 无 |  |
+| onBlur | 失去焦点时的回调 | function() | - | 3.6.5 |
+| onChange | 选中 option，或 input 的 value 变化时，调用此函数 | function(value) | 无 |  |
+| onFocus | 获得焦点时的回调 | function() | - | 3.6.5 |
+| onSearch | 搜索补全项的时候调用 | function(value) | 无 |  |
+| onSelect | 被选中时调用，参数为选中项的 value 值 | function(value, option) | 无 |  |
+| defaultOpen | 是否默认展开下拉菜单 | boolean | - | 3.9.3 |
+| open | 是否展开下拉菜单 | boolean | - | 3.9.3 |
+| onDropdownVisibleChange | 展开下拉菜单的回调 | function(open) | - | 3.9.3 |
 
 ## 方法
 
-| 名称    | 描述     |
-| ------- | -------- |
-| blur()  | 移除焦点 |
-| focus() | 获取焦点 |
+| 名称    | 描述     | 版本 |
+| ------- | -------- | ---- |
+| blur()  | 移除焦点 |      |
+| focus() | 获取焦点 |      |