From fb0b4f0fc93564c317c25eda4eec916b2c926288 Mon Sep 17 00:00:00 2001 From: MuYu Date: Thu, 11 Jul 2019 14:14:33 +0800 Subject: [PATCH] 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 --- components/affix/index.en-US.md | 12 +- components/affix/index.zh-CN.md | 12 +- components/alert/index.en-US.md | 24 ++-- components/alert/index.zh-CN.md | 24 ++-- components/anchor/index.en-US.md | 26 ++-- components/anchor/index.zh-CN.md | 26 ++-- components/auto-complete/index.en-US.md | 54 ++++---- components/auto-complete/index.zh-CN.md | 56 ++++---- components/avatar/index.en-US.md | 18 +-- components/avatar/index.zh-CN.md | 18 +-- components/back-top/index.en-US.md | 10 +- components/back-top/index.zh-CN.md | 10 +- components/badge/index.en-US.md | 2 +- components/badge/index.zh-CN.md | 2 +- components/breadcrumb/index.en-US.md | 12 +- components/breadcrumb/index.zh-CN.md | 24 ++-- components/button/index.en-US.md | 28 ++-- components/button/index.zh-CN.md | 28 ++-- components/calendar/index.en-US.md | 6 +- components/calendar/index.zh-CN.md | 10 +- components/card/index.en-US.md | 56 ++++---- components/card/index.zh-CN.md | 56 ++++---- components/carousel/index.en-US.md | 10 +- components/carousel/index.zh-CN.md | 20 +-- components/cascader/index.en-US.md | 74 +++++----- components/cascader/index.zh-CN.md | 74 +++++----- components/checkbox/index.en-US.md | 40 +++--- components/checkbox/index.zh-CN.md | 40 +++--- components/collapse/index.en-US.md | 24 ++-- components/collapse/index.zh-CN.md | 24 ++-- components/comment/index.en-US.md | 16 +-- components/comment/index.zh-CN.md | 16 +-- components/config-provider/index.en-US.md | 14 +- components/config-provider/index.zh-CN.md | 14 +- components/date-picker/index.en-US.md | 114 +++++++-------- components/date-picker/index.zh-CN.md | 112 +++++++-------- components/descriptions/index.en-US.md | 22 +-- components/descriptions/index.zh-CN.md | 22 +-- components/divider/index.en-US.md | 14 +- components/divider/index.zh-CN.md | 14 +- components/drawer/index.en-US.md | 40 +++--- components/drawer/index.zh-CN.md | 38 ++--- components/dropdown/index.en-US.md | 22 +-- components/dropdown/index.zh-CN.md | 24 ++-- components/empty/index.en-US.md | 10 +- components/empty/index.zh-CN.md | 10 +- components/form/index.en-US.md | 126 ++++++++--------- components/form/index.zh-CN.md | 124 ++++++++--------- components/grid/index.en-US.md | 38 ++--- components/grid/index.zh-CN.md | 38 ++--- components/icon/index.en-US.md | 40 +++--- components/icon/index.zh-CN.md | 40 +++--- components/input-number/index.en-US.md | 38 ++--- components/input-number/index.zh-CN.md | 38 ++--- components/input/index.en-US.md | 64 ++++----- components/input/index.zh-CN.md | 64 ++++----- components/layout/index.en-US.md | 40 +++--- components/layout/index.zh-CN.md | 40 +++--- components/list/index.en-US.md | 72 +++++----- components/list/index.zh-CN.md | 70 +++++----- components/locale-provider/index.en-US.md | 6 +- components/locale-provider/index.zh-CN.md | 6 +- components/mention/index.en-US.md | 70 +++++----- components/mention/index.zh-CN.md | 70 +++++----- components/mentions/index.en-US.md | 48 +++---- components/mentions/index.zh-CN.md | 48 +++---- components/menu/index.en-US.md | 74 +++++----- components/menu/index.zh-CN.md | 74 +++++----- components/message/index.en-US.md | 34 ++--- components/message/index.zh-CN.md | 34 ++--- components/modal/index.en-US.md | 96 ++++++------- components/modal/index.zh-CN.md | 96 ++++++------- components/notification/index.en-US.md | 46 +++--- components/notification/index.zh-CN.md | 46 +++--- components/page-header/index.en-US.md | 20 +-- components/page-header/index.zh-CN.md | 20 +-- components/pagination/index.en-US.md | 6 +- components/pagination/index.zh-CN.md | 6 +- components/popconfirm/index.en-US.md | 20 +-- components/popconfirm/index.zh-CN.md | 20 +-- components/popover/index.en-US.md | 8 +- components/popover/index.zh-CN.md | 8 +- components/progress/index.en-US.md | 50 +++---- components/progress/index.zh-CN.md | 50 +++---- components/radio/index.en-US.md | 42 +++--- components/radio/index.zh-CN.md | 40 +++--- components/rate/index.en-US.md | 44 +++--- components/rate/index.zh-CN.md | 44 +++--- components/select/index.en-US.md | 124 ++++++++--------- components/select/index.zh-CN.md | 122 ++++++++-------- components/skeleton/index.en-US.md | 36 ++--- components/skeleton/index.zh-CN.md | 36 ++--- components/slider/index.en-US.md | 10 +- components/slider/index.zh-CN.md | 12 +- components/spin/index.en-US.md | 16 +-- components/spin/index.zh-CN.md | 16 +-- components/statistic/index.en-US.md | 40 +++--- components/statistic/index.zh-CN.md | 40 +++--- components/steps/index.en-US.md | 18 +-- components/steps/index.zh-CN.md | 18 +-- components/switch/index.en-US.md | 34 ++--- components/switch/index.zh-CN.md | 34 ++--- components/table/index.en-US.md | 162 +++++++++++----------- components/table/index.zh-CN.md | 162 +++++++++++----------- components/tabs/index.en-US.md | 46 +++--- components/tabs/index.zh-CN.md | 46 +++--- components/tag/index.en-US.md | 22 +-- components/tag/index.zh-CN.md | 22 +-- components/time-picker/index.en-US.md | 68 ++++----- components/time-picker/index.zh-CN.md | 68 ++++----- components/timeline/index.en-US.md | 12 +- components/timeline/index.zh-CN.md | 12 +- components/tooltip/index.en-US.md | 36 ++--- components/tooltip/index.zh-CN.md | 36 ++--- components/transfer/index.en-US.md | 10 +- components/transfer/index.zh-CN.md | 7 +- components/tree-select/index.en-US.md | 102 +++++++------- components/tree-select/index.zh-CN.md | 102 +++++++------- components/tree/index.en-US.md | 92 ++++++------ components/tree/index.zh-CN.md | 78 +++++------ components/typography/index.en-US.md | 78 +++++------ components/typography/index.zh-CN.md | 70 +++++----- components/upload/index.en-US.md | 4 +- components/upload/index.zh-CN.md | 4 +- 124 files changed, 2538 insertions(+), 2537 deletions(-) diff --git a/components/affix/index.en-US.md b/components/affix/index.en-US.md index df912dfd49..e9fbc05305 100644 --- 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 index 51a2990865..c2b9aba8a9 100644 --- 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 index 7e63f0d0aa..50ec8f7b71 100644 --- 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 index 404d8aaf67..970ed0673d 100644 --- 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 index 1cf5eb5f86..b90c1f4fc2 100644 --- 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 index 6cc7e3e175..e6554673cb 100644 --- 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 index 166823ae64..cbfe936962 100644 --- 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']; ; ``` -| 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 | `` | -| children (for dataSource) | Data source for autocomplete | React.ReactElement / Array<React.ReactElement> | - | -| 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<{ 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 | `` | | +| children (for dataSource) | Data source for autocomplete | React.ReactElement / Array<React.ReactElement> | - | | +| 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<{ 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 index 6d2edb45b0..0fa281fc51 100644 --- 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']; ; ``` -| 参数 | 说明 | 类型 | 默认值 | -| --- | --- | --- | --- | -| allowClear | 支持清除, 单选模式有效 | boolean | false | -| autoFocus | 自动获取焦点 | boolean | false | -| backfill | 使用键盘选择选项的时候把选中项回填到输入框中 | boolean | false | -| children (自动完成的数据源) | 自动完成的数据源 | React.ReactElement / Array<React.ReactElement> | - | -| children (自定义输入框) | 自定义输入框 | HTMLInputElement / HTMLTextAreaElement / React.ReactElement | `` | -| 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<{ 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 / Array<React.ReactElement> | - | | | +| children (自定义输入框) | 自定义输入框 | HTMLInputElement / HTMLTextAreaElement / React.ReactElement | `` | @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<{ 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() | 获取焦点 | | diff --git a/components/avatar/index.en-US.md b/components/avatar/index.en-US.md index 47cfe2b33f..73b65698ff 100644 --- a/components/avatar/index.en-US.md +++ b/components/avatar/index.en-US.md @@ -8,12 +8,12 @@ Avatars can be used to represent people or objects. It supports images, `Icon`s, ## API -| Property | Description | Type | Default | -| --- | --- | --- | --- | -| icon | the `Icon` type for an icon avatar, see `Icon` Component | string | - | -| shape | the shape of avatar | `circle` \| `square` | `circle` | -| size | the size of the avatar | number \| string: `large` `small` `default` | `default` | -| 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 | - | -| onError | handler when img load error, return false to prevent default fallback behavior | () => boolean | - | +| Property | Description | Type | Default | Version | +| --- | --- | --- | --- | --- | +| icon | the `Icon` type for an icon avatar, see `Icon` Component | string | - | | +| shape | the shape of avatar | `circle` \| `square` | `circle` | | +| size | the size of the avatar | number \| string: `large` `small` `default` | `default` | | +| 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 | +| alt | This attribute defines the alternative text describing the image | string | - | 3.7.0 | +| onError | handler when img load error, return false to prevent default fallback behavior | () => boolean | - | 3.8.0 | diff --git a/components/avatar/index.zh-CN.md b/components/avatar/index.zh-CN.md index 2d449a0f7b..2118e96c49 100644 --- a/components/avatar/index.zh-CN.md +++ b/components/avatar/index.zh-CN.md @@ -13,12 +13,12 @@ title: Avatar ## API -| 参数 | 说明 | 类型 | 默认值 | -| --- | --- | --- | --- | -| icon | 设置头像的图标类型，参考 `Icon` 组件 | string | - | -| shape | 指定头像的形状 | Enum{ 'circle', 'square' } | `circle` | -| size | 设置头像的大小 | number \| Enum{ 'large', 'small', 'default' } | `default` | -| src | 图片类头像的资源地址 | string | - | -| srcSet | 设置图片类头像响应式资源地址 | string | - | -| alt | 图像无法显示时的替代文本 | string | - | -| onError | 图片加载失败的事件，返回 false 会关闭组件默认的 fallback 行为 | () => boolean | - | +| 参数 | 说明 | 类型 | 默认值 | 版本 | +| --- | --- | --- | --- | --- | +| icon | 设置头像的图标类型，参考 `Icon` 组件 | string | - | | +| shape | 指定头像的形状 | Enum{ 'circle', 'square' } | `circle` | | +| size | 设置头像的大小 | number \| Enum{ 'large', 'small', 'default' } | `default` | | +| src | 图片类头像的资源地址 | string | - | | +| srcSet | 设置图片类头像响应式资源地址 | string | - | 3.11.0 | +| alt | 图像无法显示时的替代文本 | string | - | 3.7.0 | +| onError | 图片加载失败的事件，返回 false 会关闭组件默认的 fallback 行为 | () => boolean | - | 3.8.0 | diff --git a/components/back-top/index.en-US.md b/components/back-top/index.en-US.md index 92f1be37fc..a5d7da816f 100644 --- a/components/back-top/index.en-US.md +++ b/components/back-top/index.en-US.md @@ -17,8 +17,8 @@ title: BackTop > > If you decide to use custom styles, please note the size limit: no more than `40px * 40px`. -| Property | Description | Type | Default | -| --- | --- | --- | --- | -| target | specifies the scrollable area dom node | () => HTMLElement | () => window | -| visibilityHeight | the `BackTop` button will not show until the scroll height reaches this value | number | 400 | -| onClick | a callback function, which can be executed when you click the button | Function | - | +| Property | Description | Type | Default | Version | +| --- | --- | --- | --- | --- | +| target | specifies the scrollable area dom node | () => HTMLElement | () => window | | +| visibilityHeight | the `BackTop` button will not show until the scroll height reaches this value | number | 400 | | +| onClick | a callback function, which can be executed when you click the button | Function | - | | diff --git a/components/back-top/index.zh-CN.md b/components/back-top/index.zh-CN.md index fa45e819bc..c95bb50495 100644 --- a/components/back-top/index.zh-CN.md +++ b/components/back-top/index.zh-CN.md @@ -18,8 +18,8 @@ title: BackTop > > 自定义样式宽高不大于 40px \* 40px。 -| 参数 | 说明 | 类型 | 默认值 | -| --- | --- | --- | --- | -| target | 设置需要监听其滚动事件的元素，值为一个返回对应 DOM 元素的函数 | Function | () => window | -| visibilityHeight | 滚动高度达到此参数值才出现 `BackTop` | number | 400 | -| onClick | 点击按钮的回调函数 | Function | - | +| 参数 | 说明 | 类型 | 默认值 | 版本 | +| --- | --- | --- | --- | --- | +| target | 设置需要监听其滚动事件的元素，值为一个返回对应 DOM 元素的函数 | Function | () => window | | +| visibilityHeight | 滚动高度达到此参数值才出现 `BackTop` | number | 400 | | +| onClick | 点击按钮的回调函数 | Function | - | | diff --git a/components/badge/index.en-US.md b/components/badge/index.en-US.md index 5917ec8a0f..b2dba9b4c5 100644 --- a/components/badge/index.en-US.md +++ b/components/badge/index.en-US.md @@ -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` | | | 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 | `''` | | -| title | Text to show when hovering over the badge | string | `count` | | +| title | Text to show when hovering over the badge | string | `count` | 3.5.0 | diff --git a/components/badge/index.zh-CN.md b/components/badge/index.zh-CN.md index 08dfc0d1c8..8408a1cf93 100644 --- a/components/badge/index.zh-CN.md +++ b/components/badge/index.zh-CN.md @@ -33,4 +33,4 @@ title: Badge | showZero | 当数值为 0 时，是否展示 Badge | boolean | false | | | status | 设置 Badge 为状态点 | Enum{ 'success', 'processing, 'default', 'error', 'warning' } | '' | | | text | 在设置了 `status` 的前提下有效，设置状态点的文本 | string | '' | | -| title | 设置鼠标放在状态点上时显示的文字 | string | `count` | | +| title | 设置鼠标放在状态点上时显示的文字 | string | `count` | 3.5.0 | diff --git a/components/breadcrumb/index.en-US.md b/components/breadcrumb/index.en-US.md index fe204edbf9..323aff50b0 100644 --- a/components/breadcrumb/index.en-US.md +++ b/components/breadcrumb/index.en-US.md @@ -15,12 +15,12 @@ A breadcrumb displays the current location within a hierarchy. It allows going b ## API -| Property | Description | Type | Optional | Default | -| --- | --- | --- | --- | --- | -| itemRender | Custom item renderer | (route, params, routes, paths) => ReactNode | | - | -| params | Routing parameters | object | | - | -| routes | The routing stack information of router | [routes\[\]](#routes) | | - | -| separator | Custom separator | string\|ReactNode | | `/` | +| Property | Description | Type | Optional | Default | Version | +| --- | --- | --- | --- | --- | --- | +| itemRender | Custom item renderer | (route, params, routes, paths) => ReactNode | | - | | +| params | Routing parameters | object | | - | | +| routes | The routing stack information of router | [routes\[\]](#routes) | | - | | +| separator | Custom separator | string\|ReactNode | | `/` | | ### Use with browserHistory diff --git a/components/breadcrumb/index.zh-CN.md b/components/breadcrumb/index.zh-CN.md index 5726fc8200..9354a466b4 100644 --- a/components/breadcrumb/index.zh-CN.md +++ b/components/breadcrumb/index.zh-CN.md @@ -17,21 +17,21 @@ title: Breadcrumb ### Breadcrumb -| 参数 | 说明 | 类型 | 默认值 | -| --- | --- | --- | --- | -| itemRender | 自定义链接函数，和 react-router 配置使用 | (route, params, routes, paths) => ReactNode | - | -| params | 路由的参数 | object | - | -| routes | router 的路由栈信息 | [routes\[\]](#routes) | - | -| separator | 分隔符自定义 | string\|ReactNode | '/' | +| 参数 | 说明 | 类型 | 默认值 | 版本 | +| --- | --- | --- | --- | --- | +| itemRender | 自定义链接函数，和 react-router 配置使用 | (route, params, routes, paths) => ReactNode | - | 3.17.0 | +| params | 路由的参数 | object | - | 3.17.0 | +| routes | router 的路由栈信息 | [routes\[\]](#routes) | - | 3.17.0 | +| separator | 分隔符自定义 | string\|ReactNode | '/' | 3.17.0 | ### Breadcrumb.Item -| 参数 | 参数 | 类型 | 默认值 | -| --------- | -------------- | -------------------------------------- | ------ | -| href | 链接的目的地 | string | - | -| separator | 自定义的分隔符 | string\|ReactNode | '/' | -| overlay | 下来菜单的内容 | [Menu](/components/menu) \| () => Menu | - | -| onClick | 单击事件 | (e:MouseEvent)=>void | - | +| 参数 | 参数 | 类型 | 默认值 | 版本 | +| --------- | -------------- | -------------------------------------- | ------ | ------ | +| href | 链接的目的地 | string | - | 3.17.0 | +| separator | 自定义的分隔符 | string\|ReactNode | '/' | 3.17.0 | +| overlay | 下来菜单的内容 | [Menu](/components/menu) \| () => Menu | - | 3.17.0 | +| onClick | 单击事件 | (e:MouseEvent)=>void | - | 3.17.0 | ### routes diff --git a/components/button/index.en-US.md b/components/button/index.en-US.md index 3191e595a9..625cf18466 100644 --- a/components/button/index.en-US.md +++ b/components/button/index.en-US.md @@ -14,20 +14,20 @@ A button means an operation (or a series of operations). Clicking a button will To get a customized button, just set `type`/`shape`/`size`/`loading`/`disabled`. -| Property | Description | Type | Default | -| --- | --- | --- | --- | -| disabled | disabled state of button | boolean | `false` | -| ghost | make background transparent and invert text and border colors, added in 2.7 | boolean | `false` | -| href | redirect url of link button | string | - | -| htmlType | set the original html `type` of `button`, see: [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#attr-type) | string | `button` | -| icon | set the icon of button, see: Icon component | string | - | -| loading | set the loading status of button | boolean \| { delay: number } | `false` | -| shape | can be set to `circle`, `round` or omitted | string | - | -| size | can be set to `small` `large` or omitted | string | `default` | -| target | same as target attribute of a, works when href is specified | string | - | -| type | can be set to `primary` `ghost` `dashed` `danger` `link`(added in 3.17) or omitted (meaning `default`) | string | `default` | -| onClick | set the handler to handle `click` event | (event) => void | - | -| block | option to fit button width to its parent width | boolean | `false` | +| Property | Description | Type | Default | Version | +| --- | --- | --- | --- | --- | +| disabled | disabled state of button | boolean | `false` | 3.5.1 | +| ghost | make background transparent and invert text and border colors, added in 2.7 | boolean | `false` | | +| href | redirect url of link button | string | - | | +| htmlType | set the original html `type` of `button`, see: [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#attr-type) | string | `button` | | +| icon | set the icon of button, see: Icon component | string | - | | +| loading | set the loading status of button | boolean \| { delay: number } | `false` | | +| shape | can be set to `circle`, `round` or omitted | string | - | | +| size | can be set to `small` `large` or omitted | string | `default` | | +| target | same as target attribute of a, works when href is specified | string | - | | +| type | can be set to `primary` `ghost` `dashed` `danger` `link`(added in 3.17) or omitted (meaning `default`) | string | `default` | | +| onClick | set the handler to handle `click` event | (event) => void | - | | +| block | option to fit button width to its parent width | boolean | `false` | 3.8.0 | It accepts all props which native button support. diff --git a/components/button/index.zh-CN.md b/components/button/index.zh-CN.md index fc100d36a3..7ccb81c3db 100644 --- a/components/button/index.zh-CN.md +++ b/components/button/index.zh-CN.md @@ -17,20 +17,20 @@ subtitle: 按钮 按钮的属性说明如下： -| 属性 | 说明 | 类型 | 默认值 | -| --- | --- | --- | --- | -| disabled | 按钮失效状态 | boolean | `false` | -| ghost | 幽灵属性，使按钮背景透明，版本 2.7 中增加 | boolean | false | -| href | 点击跳转的地址，指定此属性 button 的行为和 a 链接一致 | string | - | -| htmlType | 设置 `button` 原生的 `type` 值，可选值请参考 [HTML 标准](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#attr-type) | string | `button` | -| icon | 设置按钮的图标类型 | string | - | -| loading | 设置按钮载入状态 | boolean \| { delay: number } | `false` | -| shape | 设置按钮形状，可选值为 `circle`、 `round` 或者不设 | string | - | -| size | 设置按钮大小，可选值为 `small` `large` 或者不设 | string | `default` | -| target | 相当于 a 链接的 target 属性，href 存在时生效 | string | - | -| type | 设置按钮类型，可选值为 `primary` `dashed` `danger` `link`(3.17 中增加) 或者不设 | string | - | -| onClick | 点击按钮时的回调 | (event) => void | - | -| block | 将按钮宽度调整为其父宽度的选项 | boolean | `false` | +| 属性 | 说明 | 类型 | 默认值 | 版本 | +| --- | --- | --- | --- | --- | +| disabled | 按钮失效状态 | boolean | `false` | 3.5.1 | +| ghost | 幽灵属性，使按钮背景透明，版本 2.7 中增加 | boolean | false | | +| href | 点击跳转的地址，指定此属性 button 的行为和 a 链接一致 | string | - | | +| htmlType | 设置 `button` 原生的 `type` 值，可选值请参考 [HTML 标准](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#attr-type) | string | `button` | | +| icon | 设置按钮的图标类型 | string | - | | +| loading | 设置按钮载入状态 | boolean \| { delay: number } | `false` | | +| shape | 设置按钮形状，可选值为 `circle`、 `round` 或者不设 | string | - | | +| size | 设置按钮大小，可选值为 `small` `large` 或者不设 | string | `default` | | +| target | 相当于 a 链接的 target 属性，href 存在时生效 | string | - | | +| type | 设置按钮类型，可选值为 `primary` `dashed` `danger` `link`(3.17 中增加) 或者不设 | string | - | | +| onClick | 点击按钮时的回调 | (event) => void | - | | +| block | 将按钮宽度调整为其父宽度的选项 | boolean | `false` | 3.8.0 | 支持原生 button 的其他所有属性。 diff --git a/components/calendar/index.en-US.md b/components/calendar/index.en-US.md index 1cd91c9cb8..c8d7db0806 100644 --- a/components/calendar/index.en-US.md +++ b/components/calendar/index.en-US.md @@ -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` | | | 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 | - | | -| validRange | to set valid range | \[[moment](http://momentjs.com/), [moment](http://momentjs.com/)] | - | | -| value | The current selected date | [moment](http://momentjs.com/) | current date | +| validRange | to set valid range | \[[moment](http://momentjs.com/), [moment](http://momentjs.com/)] | - | 3.3.0 | +| value | The current selected date | [moment](http://momentjs.com/) | current date | | | onPanelChange | Callback for when panel changes | function(date: moment, mode: string) | - | | | onSelect | Callback for when a date is selected | function(date: moment） | - | | -| onChange | Callback for when date changes | function(date: moment） | - | | +| onChange | Callback for when date changes | function(date: moment） | - | 3.8.0 | | headerRender | render custom header in panel | function(object:{value: moment, type: string, onChange: f(), onTypeChange: f()}) | - | 3.19.0 | diff --git a/components/calendar/index.zh-CN.md b/components/calendar/index.zh-CN.md index a406232006..417188053f 100644 --- a/components/calendar/index.zh-CN.md +++ b/components/calendar/index.zh-CN.md @@ -34,16 +34,16 @@ title: Calendar | --- | --- | --- | --- | --- | | dateCellRender | 自定义渲染日期单元格，返回内容会被追加到单元格 | function(date: moment): ReactNode | 无 | | | dateFullCellRender | 自定义渲染日期单元格，返回内容覆盖单元格 | function(date: moment): ReactNode | 无 | | -| defaultValue | 默认展示的日期 | [moment](http://momentjs.com/) | 默认日期 | +| defaultValue | 默认展示的日期 | [moment](http://momentjs.com/) | 默认日期 | | | disabledDate | 不可选择的日期 | (currentDate: moment) => boolean | 无 | | | fullscreen | 是否全屏显示 | boolean | true | | | locale | 国际化配置 | object | [默认配置](https://github.com/ant-design/ant-design/blob/master/components/date-picker/locale/example.json) | | -| mode | 初始模式，`month/year` | string | month | +| mode | 初始模式，`month/year` | string | month | | | monthCellRender | 自定义渲染月单元格，返回内容会被追加到单元格 | function(date: moment): ReactNode | 无 | | | monthFullCellRender | 自定义渲染月单元格，返回内容覆盖单元格 | function(date: moment): ReactNode | 无 | | -| validRange | 设置可以显示的日期 | \[[moment](http://momentjs.com/), [moment](http://momentjs.com/)] | 无 | | -| value | 展示日期 | [moment](http://momentjs.com/) | 当前日期 | +| validRange | 设置可以显示的日期 | \[[moment](http://momentjs.com/), [moment](http://momentjs.com/)] | 无 | 3.3.0 | +| value | 展示日期 | [moment](http://momentjs.com/) | 当前日期 | | | onPanelChange | 日期面板变化回调 | function(date: moment, mode: string) | 无 | | | onSelect | 点击选择日期回调 | function(date: moment） | 无 | | -| onChange | 日期变化回调 | function(date: moment） | 无 | | +| onChange | 日期变化回调 | function(date: moment） | 无 | 3.8.0 | | headerRender | 自定义头部内容 | function(object:{value: moment, type: string, onChange: f(), onTypeChange: f()}) | 无 | 3.19.0 | diff --git a/components/card/index.en-US.md b/components/card/index.en-US.md index ab7f15ce95..85f69a50d1 100644 --- a/components/card/index.en-US.md +++ b/components/card/index.en-US.md @@ -19,37 +19,37 @@ A card can be used to display content related to a single subject. The content c ### Card -| Property | Description | Type | Default | -| --- | --- | --- | --- | -| actions | The action list, shows at the bottom of the Card. | Array<ReactNode> | - | -| activeTabKey | Current TabPane's key | string | - | -| headStyle | Inline style to apply to the card head | object | - | -| bodyStyle | Inline style to apply to the card content | object | - | -| bordered | Toggles rendering of the border around the card | boolean | `true` | -| cover | Card cover | ReactNode | - | -| 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 | - | -| hoverable | Lift up when hovering card | 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}> | - | -| size | Size of card | `default` \| `small` | `default` | -| title | Card title | string\|ReactNode | - | -| type | Card style type, can be set to `inner` or not set | string | - | -| onTabChange | Callback when tab is switched | (key) => void | - | +| Property | Description | Type | Default | Version | +| --- | --- | --- | --- | --- | +| actions | The action list, shows at the bottom of the Card. | Array<ReactNode> | - | | +| activeTabKey | Current TabPane's key | string | - | 3.3.0 | +| headStyle | Inline style to apply to the card head | object | - | 3.8.0 | +| bodyStyle | Inline style to apply to the card content | object | - | | +| bordered | Toggles rendering of the border around the card | boolean | `true` | | +| cover | Card cover | ReactNode | - | | +| defaultActiveTabKey | Initial active TabPane's key, if `activeTabKey` is not set. | string | - | 3.3.0 | +| extra | Content to render in the top-right corner of the card | string\|ReactNode | - | | +| hoverable | Lift up when hovering card | 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}> | - | | +| size | Size of card | `default` \| `small` | `default` | 3.12.0 | +| title | Card title | string\|ReactNode | - | | +| type | Card style type, can be set to `inner` or not set | string | - | | +| onTabChange | Callback when tab is switched | (key) => void | - | | ### Card.Grid -| Property | Description | Type | Default | -| --------- | ------------------------- | ------ | ------- | -| className | className of container | string | - | -| style | style object of container | object | - | +| Property | Description | Type | Default | Version | +| --------- | ------------------------- | ------ | ------- | ------- | +| className | className of container | string | - | | +| style | style object of container | object | - | | ### Card.Meta -| Property | Description | Type | Default | -| ----------- | ------------------------- | --------- | ------- | -| avatar | avatar or icon | ReactNode | - | -| className | className of container | string | - | -| description | description content | ReactNode | - | -| style | style object of container | object | - | -| title | title content | ReactNode | - | +| Property | Description | Type | Default | Version | +| ----------- | ------------------------- | --------- | ------- | ------- | +| avatar | avatar or icon | ReactNode | - | | +| className | className of container | string | - | | +| description | description content | ReactNode | - | | +| style | style object of container | object | - | | +| title | title content | ReactNode | - | | diff --git a/components/card/index.zh-CN.md b/components/card/index.zh-CN.md index 1d4473080d..26507a34a3 100644 --- a/components/card/index.zh-CN.md +++ b/components/card/index.zh-CN.md @@ -20,37 +20,37 @@ cols: 1 ### Card -| 参数 | 说明 | 类型 | 默认值 | -| --- | --- | --- | --- | -| actions | 卡片操作组，位置在卡片底部 | Array<ReactNode> | - | -| activeTabKey | 当前激活页签的 key | string | - | -| headStyle | 自定义标题区域样式 | object | - | -| bodyStyle | 内容区域自定义样式 | object | - | -| bordered | 是否有边框 | boolean | true | -| cover | 卡片封面 | ReactNode | - | -| defaultActiveTabKey | 初始化选中页签的 key，如果没有设置 activeTabKey | string | 第一个页签 | -| extra | 卡片右上角的操作区域 | string\|ReactNode | - | -| hoverable | 鼠标移过时可浮起 | boolean | false | -| loading | 当卡片内容还在加载中时，可以用 loading 展示一个占位 | boolean | false | -| tabList | 页签标题列表 | Array<{key: string, tab: ReactNode}> | - | -| size | card 的尺寸 | `default` \| `small` | `default` | -| title | 卡片标题 | string\|ReactNode | - | -| type | 卡片类型，可设置为 `inner` 或 不设置 | string | - | -| onTabChange | 页签切换的回调 | (key) => void | - | +| 参数 | 说明 | 类型 | 默认值 | 版本 | +| --- | --- | --- | --- | --- | +| actions | 卡片操作组，位置在卡片底部 | Array<ReactNode> | - | | +| activeTabKey | 当前激活页签的 key | string | - | 3.3.0 | +| headStyle | 自定义标题区域样式 | object | - | 3.8.0 | +| bodyStyle | 内容区域自定义样式 | object | - | | +| bordered | 是否有边框 | boolean | true | | +| cover | 卡片封面 | ReactNode | - | | +| defaultActiveTabKey | 初始化选中页签的 key，如果没有设置 activeTabKey | string | 第一个页签 | 3.3.0 | +| extra | 卡片右上角的操作区域 | string\|ReactNode | - | | +| hoverable | 鼠标移过时可浮起 | boolean | false | | +| loading | 当卡片内容还在加载中时，可以用 loading 展示一个占位 | boolean | false | | +| tabList | 页签标题列表 | Array<{key: string, tab: ReactNode}> | - | | +| size | card 的尺寸 | `default` \| `small` | `default` | 3.12.0 | +| title | 卡片标题 | string\|ReactNode | - | | +| type | 卡片类型，可设置为 `inner` 或 不设置 | string | - | | +| onTabChange | 页签切换的回调 | (key) => void | - | | ### Card.Grid -| Property | Description | Type | Default | -| --------- | ---------------------- | ------ | ------- | -| className | 网格容器类名 | string | - | -| style | 定义网格容器类名的样式 | object | - | +| Property | Description | Type | Default | 版本 | +| --------- | ---------------------- | ------ | ------- | ---- | +| className | 网格容器类名 | string | - | | +| style | 定义网格容器类名的样式 | object | - | | ### Card.Meta -| Property | Description | Type | Default | -| ----------- | ------------------ | --------- | ------- | -| avatar | 头像/图标 | ReactNode | - | -| className | 容器类名 | string | - | -| description | 描述内容 | ReactNode | - | -| style | 定义容器类名的样式 | object | - | -| title | 标题内容 | ReactNode | - | +| Property | Description | Type | Default | 版本 | +| ----------- | ------------------ | --------- | ------- | ---- | +| avatar | 头像/图标 | ReactNode | - | | +| className | 容器类名 | string | - | | +| description | 描述内容 | ReactNode | - | | +| style | 定义容器类名的样式 | object | - | | +| title | 标题内容 | ReactNode | - | | diff --git a/components/carousel/index.en-US.md b/components/carousel/index.en-US.md index ff4851d421..6861e197eb 100644 --- a/components/carousel/index.en-US.md +++ b/components/carousel/index.en-US.md @@ -26,10 +26,10 @@ A carousel component. Scales with its container. ## Methods -| Name | Description | -| --- | --- | -| goTo(slideNumber, dontAnimate) | Go to slide index, if dontAnimate=true, it happens without animation | -| next() | Change current slide to next slide | -| prev() | Change current slide to previous slide | +| Name | Description | Version | +| --- | --- | --- | +| goTo(slideNumber, dontAnimate) | Go to slide index, if dontAnimate=true, it happens without animation | 3.9.3 | +| next() | Change current slide to next slide | | +| prev() | Change current slide to previous slide | | For more info on the parameters, refer to the diff --git a/components/carousel/index.zh-CN.md b/components/carousel/index.zh-CN.md index 7d7ae166f2..a2c237db0e 100644 --- a/components/carousel/index.zh-CN.md +++ b/components/carousel/index.zh-CN.md @@ -17,20 +17,20 @@ subtitle: 走马灯 | 参数 | 说明 | 类型 | 默认值 | 版本 | | --- | --- | --- | --- | --- | -| afterChange | 切换面板的回调 | function(current) | 无 | | -| autoplay | 是否自动切换 | boolean | false | | -| beforeChange | 切换面板的回调 | function(from, to) | 无 | | -| dotPosition | 面板指示点位置，可选 `top` `bottom` `left` `right` | string | bottom | 3.17.0 | -| dots | 是否显示面板指示点 | boolean | true | | -| easing | 动画效果 | string | linear | | -| effect | 动画效果函数，可取 scrollx, fade | string | scrollx | | +| afterChange | 切换面板的回调 | function(current) | 无 | | | +| autoplay | 是否自动切换 | boolean | false | | | +| beforeChange | 切换面板的回调 | function(from, to) | 无 | | | +| dotPosition | 面板指示点位置，可选 `top` `bottom` `left` `right` | string | bottom | 3.17.0 | 3.17.0 | +| dots | 是否显示面板指示点 | boolean | true | | | +| easing | 动画效果 | string | linear | | | +| effect | 动画效果函数，可取 scrollx, fade | string | scrollx | | | ## 方法 | 名称 | 描述 | | ------------------------------ | ------------------------------------------------- | -| goTo(slideNumber, dontAnimate) | 切换到指定面板, dontAnimate = true 时，不使用动画 | -| next() | 切换到下一面板 | -| prev() | 切换到上一面板 | +| goTo(slideNumber, dontAnimate) | 切换到指定面板, dontAnimate = true 时，不使用动画 | 3.9.3 | +| next() | 切换到下一面板 | | +| prev() | 切换到上一面板 | | 更多参数可参考： diff --git a/components/cascader/index.en-US.md b/components/cascader/index.en-US.md index 7650c356cc..073f2a3bda 100644 --- a/components/cascader/index.en-US.md +++ b/components/cascader/index.en-US.md @@ -18,42 +18,42 @@ Cascade selection box. ``` -| Property | Description | Type | Default | -| --- | --- | --- | --- | -| allowClear | whether allow clear | boolean | true | -| autoFocus | get focus when component mounted | boolean | false | -| changeOnSelect | change value on each selection if set to true, see above demo for details | boolean | false | -| className | additional css class | string | - | -| defaultValue | initial selected value | string\[] | \[] | -| disabled | whether disabled select | boolean | false | -| displayRender | render function of displaying selected options | `(label, selectedOptions) => ReactNode` | `label => label.join(' / ')` | -| expandTrigger | expand current item when click or hover, one of 'click' 'hover' | string | 'click' | -| fieldNames | custom field name for label and value and children (before 3.7.0 it calls `filedNames` which is typo）) | object | `{ label: 'label', value: 'value', children: 'children' }` | -| getPopupContainer | Parent Node which the selector should be rendered to. Default to `body`. When position issues happen, try to modify it into scrollable content and position it relative.[example](https://codepen.io/afc163/pen/zEjNOy?editors=0010) | Function(triggerNode) | () => document.body | -| loadData | To load option lazily, and it cannot work with `showSearch` | `(selectedOptions) => void` | - | -| notFoundContent | Specify content to show when no result matches. | string | 'Not Found' | -| options | data options of cascade | [Option](#Option)[] | - | -| placeholder | input placeholder | string | 'Please select' | -| popupClassName | additional className of popup overlay | string | - | -| popupPlacement | use preset popup align config from builtinPlacements：`bottomLeft` `bottomRight` `topLeft` `topRight` | string | `bottomLeft` | -| popupVisible | set visible of cascader popup | boolean | - | -| showSearch | Whether show search input in single mode. | boolean\|object | false | -| size | input size, one of `large` `default` `small` | string | `default` | -| style | additional style | string | - | -| suffixIcon | The custom suffix icon | ReactNode | - | -| value | selected value | string\[] | - | -| onChange | callback when finishing cascader select | `(value, selectedOptions) => void` | - | -| onPopupVisibleChange | callback when popup shown or hidden | `(value) => void` | - | +| Property | Description | Type | Default | Version | +| --- | --- | --- | --- | --- | +| allowClear | whether allow clear | boolean | true | | +| autoFocus | get focus when component mounted | boolean | false | | +| changeOnSelect | change value on each selection if set to true, see above demo for details | boolean | false | | +| className | additional css class | string | - | | +| defaultValue | initial selected value | string\[] | \[] | | +| disabled | whether disabled select | boolean | false | | +| displayRender | render function of displaying selected options | `(label, selectedOptions) => ReactNode` | `label => label.join(' / ')` | | +| expandTrigger | expand current item when click or hover, one of 'click' 'hover' | string | 'click' | | +| fieldNames | custom field name for label and value and children (before 3.7.0 it calls `filedNames` which is typo）) | object | `{ label: 'label', value: 'value', children: 'children' }` | 3.7.0 | +| getPopupContainer | Parent Node which the selector should be rendered to. Default to `body`. When position issues happen, try to modify it into scrollable content and position it relative.[example](https://codepen.io/afc163/pen/zEjNOy?editors=0010) | Function(triggerNode) | () => document.body | | +| loadData | To load option lazily, and it cannot work with `showSearch` | `(selectedOptions) => void` | - | | +| notFoundContent | Specify content to show when no result matches. | string | 'Not Found' | | +| options | data options of cascade | [Option](#Option)[] | - | | +| placeholder | input placeholder | string | 'Please select' | | +| popupClassName | additional className of popup overlay | string | - | | +| popupPlacement | use preset popup align config from builtinPlacements：`bottomLeft` `bottomRight` `topLeft` `topRight` | string | `bottomLeft` | | +| popupVisible | set visible of cascader popup | boolean | - | | +| showSearch | Whether show search input in single mode. | boolean\|object | false | | +| size | input size, one of `large` `default` `small` | string | `default` | | +| style | additional style | string | - | | +| suffixIcon | The custom suffix icon | ReactNode | - | 3.10.0 | +| value | selected value | string\[] | - | | +| onChange | callback when finishing cascader select | `(value, selectedOptions) => void` | - | | +| onPopupVisibleChange | callback when popup shown or hidden | `(value) => void` | - | | Fields in `showSearch`: -| Property | Description | Type | Default | -| --- | --- | --- | --- | -| filter | 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. | `function(inputValue, path): boolean` | | -| limit | Set the count of filtered items | number \| false | 50 | -| matchInputWidth | Whether the width of result list equals to input's | boolean | | -| render | Used to render filtered options. | `function(inputValue, path): ReactNode` | | -| sort | Used to sort filtered options. | `function(a, b, inputValue)` | | +| Property | Description | Type | Default | Version | +| --- | --- | --- | --- | --- | +| filter | 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. | `function(inputValue, path): boolean` | | | +| limit | Set the count of filtered items | number \| false | 50 | 3.11.0 | +| matchInputWidth | Whether the width of result list equals to input's | boolean | | | +| render | Used to render filtered options. | `function(inputValue, path): ReactNode` | | | +| sort | Used to sort filtered options. | `function(a, b, inputValue)` | | | ### Option @@ -68,10 +68,10 @@ interface Option { ## Methods -| Name | Description | -| ------- | ------------ | -| blur() | remove focus | -| focus() | get focus | +| Name | Description | Version | +| ------- | ------------ | ------- | +| blur() | remove focus | | +| focus() | get focus | | diff --git a/components/time-picker/index.zh-CN.md b/components/time-picker/index.zh-CN.md index 16391f51d8..ee92d5d280 100644 --- a/components/time-picker/index.zh-CN.md +++ b/components/time-picker/index.zh-CN.md @@ -22,42 +22,42 @@ import moment from 'moment'; ; ``` -| 参数 | 说明 | 类型 | 默认值 | -| --- | --- | --- | --- | -| addon | 选择框底部显示自定义的内容 | function | 无 | -| allowClear | 是否展示清除按钮 | boolean | true | -| autoFocus | 自动获取焦点 | boolean | false | -| className | 选择器类名 | string | '' | -| clearText | 清除按钮的提示文案 | string | clear | -| defaultOpenValue | 当 defaultValue/value 不存在时，可以设置面板打开时默认选中的值 | [moment](http://momentjs.com/) | moment() | -| defaultValue | 默认时间 | [moment](http://momentjs.com/) | 无 | -| disabled | 禁用全部操作 | boolean | false | -| disabledHours | 禁止选择部分小时选项 | function() | 无 | -| disabledMinutes | 禁止选择部分分钟选项 | function(selectedHour) | 无 | -| disabledSeconds | 禁止选择部分秒选项 | function(selectedHour, selectedMinute) | 无 | -| format | 展示的时间格式 | string | "HH:mm:ss" | -| getPopupContainer | 定义浮层的容器，默认为 body 上新建 div | function(trigger) | 无 | -| hideDisabledOptions | 隐藏禁止选择的选项 | boolean | false | -| hourStep | 小时选项间隔 | number | 1 | -| inputReadOnly | 设置输入框为只读（避免在移动设备上打开虚拟键盘） | boolean | false | -| minuteStep | 分钟选项间隔 | number | 1 | -| open | 面板是否打开 | boolean | false | -| placeholder | 没有值的时候显示的内容 | string | "请选择时间" | -| popupClassName | 弹出层类名 | string | '' | -| popupStyle | 弹出层样式对象 | object | - | -| secondStep | 秒选项间隔 | number | 1 | -| suffixIcon | 自定义的选择框后缀图标 | ReactNode | - | -| clearIcon | 自定义的清除图标 | ReactNode | - | -| use12Hours | 使用 12 小时制，为 true 时 `format` 默认为 `h:mm:ss a` | boolean | false | -| value | 当前时间 | [moment](http://momentjs.com/) | 无 | -| onChange | 时间发生变化的回调 | function(time: moment, timeString: string): void | 无 | -| onOpenChange | 面板打开/关闭时的回调 | (open: boolean): void | 无 | +| 参数 | 说明 | 类型 | 默认值 | 版本 | +| --- | --- | --- | --- | --- | +| addon | 选择框底部显示自定义的内容 | function | 无 | | +| allowClear | 是否展示清除按钮 | boolean | true | 3.13.0 | +| autoFocus | 自动获取焦点 | boolean | false | | +| className | 选择器类名 | string | '' | | +| clearText | 清除按钮的提示文案 | string | clear | | +| defaultOpenValue | 当 defaultValue/value 不存在时，可以设置面板打开时默认选中的值 | [moment](http://momentjs.com/) | moment() | | +| defaultValue | 默认时间 | [moment](http://momentjs.com/) | 无 | | +| disabled | 禁用全部操作 | boolean | false | | +| disabledHours | 禁止选择部分小时选项 | function() | 无 | | +| disabledMinutes | 禁止选择部分分钟选项 | function(selectedHour) | 无 | | +| disabledSeconds | 禁止选择部分秒选项 | function(selectedHour, selectedMinute) | 无 | | +| format | 展示的时间格式 | string | "HH:mm:ss" | | +| getPopupContainer | 定义浮层的容器，默认为 body 上新建 div | function(trigger) | 无 | | +| hideDisabledOptions | 隐藏禁止选择的选项 | boolean | false | | +| hourStep | 小时选项间隔 | number | 1 | | +| inputReadOnly | 设置输入框为只读（避免在移动设备上打开虚拟键盘） | boolean | false | 3.3.0 | +| minuteStep | 分钟选项间隔 | number | 1 | | +| open | 面板是否打开 | boolean | false | | +| placeholder | 没有值的时候显示的内容 | string | "请选择时间" | | +| popupClassName | 弹出层类名 | string | '' | | +| popupStyle | 弹出层样式对象 | object | - | 3.12.0 | +| secondStep | 秒选项间隔 | number | 1 | | +| suffixIcon | 自定义的选择框后缀图标 | ReactNode | - | 3.10.0 | +| clearIcon | 自定义的清除图标 | ReactNode | - | 3.14.0 | +| use12Hours | 使用 12 小时制，为 true 时 `format` 默认为 `h:mm:ss a` | boolean | false | | +| value | 当前时间 | [moment](http://momentjs.com/) | 无 | | +| onChange | 时间发生变化的回调 | function(time: moment, timeString: string): void | 无 | | +| onOpenChange | 面板打开/关闭时的回调 | (open: boolean): void | 无 | | ## 方法 -| 名称 | 描述 | -| ------- | -------- | -| blur() | 移除焦点 | -| focus() | 获取焦点 | +| 名称 | 描述 | 版本 | +| ------- | -------- | ---- | +| blur() | 移除焦点 | | +| focus() | 获取焦点 | | diff --git a/components/timeline/index.en-US.md b/components/timeline/index.en-US.md index 7a4817d76c..4b49cc99c5 100644 --- a/components/timeline/index.en-US.md +++ b/components/timeline/index.en-US.md @@ -26,12 +26,12 @@ Vertical display timeline. Timeline -| Property | Description | Type | Default | -| --- | --- | --- | --- | -| pending | Set the last ghost node's existence or its content | boolean\|string\|ReactNode | `false` | -| pendingDot | Set the dot of the last ghost node when pending is true | string\|ReactNode | `` | -| reverse | reverse nodes or not | boolean | false | -| mode | By sending `alternate` the timeline will distribute the nodes to the left and right. | `left` \| `alternate` \| `right` | - | +| Property | Description | Type | Default | Version | +| --- | --- | --- | --- | --- | +| pending | Set the last ghost node's existence or its content | boolean\|string\|ReactNode | `false` | | +| pendingDot | Set the dot of the last ghost node when pending is true | string\|ReactNode | `` | 3.3.0 | +| reverse | reverse nodes or not | boolean | false | 3.5.0 | +| mode | By sending `alternate` the timeline will distribute the nodes to the left and right. | `left` \| `alternate` \| `right` | - | 3.8.0 | ### Timeline.Item diff --git a/components/timeline/index.zh-CN.md b/components/timeline/index.zh-CN.md index 8d6c07f1e3..cfaa5cb2b8 100644 --- a/components/timeline/index.zh-CN.md +++ b/components/timeline/index.zh-CN.md @@ -27,12 +27,12 @@ title: Timeline 时间轴。 -| 参数 | 说明 | 类型 | 默认值 | -| --- | --- | --- | --- | -| pending | 指定最后一个幽灵节点是否存在或内容 | boolean\|string\|ReactNode | false | -| pendingDot | 当最后一个幽灵节点存在時，指定其时间图点 | string\|ReactNode | `` | -| reverse | 节点排序 | boolean | false | -| mode | 通过设置 `mode` 可以改变时间轴和内容的相对位置 | `left` \| `alternate` \| `right` | - | +| 参数 | 说明 | 类型 | 默认值 | 版本 | +| --- | --- | --- | --- | --- | +| pending | 指定最后一个幽灵节点是否存在或内容 | boolean\|string\|ReactNode | false | | +| pendingDot | 当最后一个幽灵节点存在時，指定其时间图点 | string\|ReactNode | `` | 3.3.0 | +| reverse | 节点排序 | boolean | false | 3.5.0 | +| mode | 通过设置 `mode` 可以改变时间轴和内容的相对位置 | `left` \| `alternate` \| `right` | - | 3.8.0 | ### Timeline.Item diff --git a/components/tooltip/index.en-US.md b/components/tooltip/index.en-US.md index 64b96a31a1..588afd70d7 100644 --- a/components/tooltip/index.en-US.md +++ b/components/tooltip/index.en-US.md @@ -13,29 +13,29 @@ A simple text popup tip. ## API -| Property | Description | Type | Default | -| -------- | ----------------------------- | ---------------------------------- | ------- | -| title | The text shown in the tooltip | string\|ReactNode\|() => ReactNode | - | +| Property | Description | Type | Default | Version | +| --- | --- | --- | --- | --- | +| title | The text shown in the tooltip | string\|ReactNode\|() => ReactNode | - | | ### Common API The following APIs are shared by Tooltip, Popconfirm, Popover. -| Property | Description | Type | Default | -| --- | --- | --- | --- | -| arrowPointAtCenter | Whether the arrow is pointed at the center of target, supported after `antd@1.11+` | boolean | `false` | -| autoAdjustOverflow | Whether to adjust popup placement automatically when popup is off screen | boolean | `true` | -| defaultVisible | Whether the floating tooltip card is visible by default | boolean | `false` | -| getPopupContainer | The DOM container of the tip, the default behavior is to create a `div` element in `body` | Function(triggerNode) | () => document.body | -| mouseEnterDelay | Delay in seconds, before tooltip is shown on mouse enter | number | 0.1 | -| mouseLeaveDelay | Delay in seconds, before tooltip is hidden on mouse leave | number | 0.1 | -| overlayClassName | Class name of the tooltip card | string | - | -| overlayStyle | Style of the tooltip card | object | - | -| placement | The position of the tooltip relative to the target, which can be one of `top` `left` `right` `bottom` `topLeft` `topRight` `bottomLeft` `bottomRight` `leftTop` `leftBottom` `rightTop` `rightBottom` | string | `top` | -| trigger | Tooltip trigger mode | `hover` \| `focus` \| `click` \| `contextMenu` | `hover` | -| visible | Whether the floating tooltip card is visible or not | boolean | `false` | -| onVisibleChange | Callback executed when visibility of the tooltip card is changed | (visible) => void | - | -| align | this value will be merged into placement's config, please refer to the settings [rc-tooltip](https://github.com/react-component/tooltip) | Object | - | +| Property | Description | Type | Default | Version | +| --- | --- | --- | --- | --- | +| arrowPointAtCenter | Whether the arrow is pointed at the center of target, supported after `antd@1.11+` | boolean | `false` | | +| autoAdjustOverflow | Whether to adjust popup placement automatically when popup is off screen | boolean | `true` | | +| defaultVisible | Whether the floating tooltip card is visible by default | boolean | `false` | | +| getPopupContainer | The DOM container of the tip, the default behavior is to create a `div` element in `body` | Function(triggerNode) | () => document.body | | +| mouseEnterDelay | Delay in seconds, before tooltip is shown on mouse enter | number | 0.1 | | +| mouseLeaveDelay | Delay in seconds, before tooltip is hidden on mouse leave | number | 0.1 | | +| overlayClassName | Class name of the tooltip card | string | - | | +| overlayStyle | Style of the tooltip card | object | - | | +| placement | The position of the tooltip relative to the target, which can be one of `top` `left` `right` `bottom` `topLeft` `topRight` `bottomLeft` `bottomRight` `leftTop` `leftBottom` `rightTop` `rightBottom` | string | `top` | | +| trigger | Tooltip trigger mode | `hover` \| `focus` \| `click` \| `contextMenu` | `hover` | | +| visible | Whether the floating tooltip card is visible or not | boolean | `false` | | +| onVisibleChange | Callback executed when visibility of the tooltip card is changed | (visible) => void | - | | +| align | this value will be merged into placement's config, please refer to the settings [rc-tooltip](https://github.com/react-component/tooltip) | Object | - | 3.10.0 | ## Note diff --git a/components/tooltip/index.zh-CN.md b/components/tooltip/index.zh-CN.md index 9bf0fc739b..f5c4d6605d 100644 --- a/components/tooltip/index.zh-CN.md +++ b/components/tooltip/index.zh-CN.md @@ -15,29 +15,29 @@ title: Tooltip ## API -| 参数 | 说明 | 类型 | 默认值 | -| ----- | -------- | ---------------------------------- | ------ | -| title | 提示文字 | string\|ReactNode\|() => ReactNode | 无 | +| 参数 | 说明 | 类型 | 默认值 | 版本 | +| ----- | -------- | ---------------------------------- | ------ | ---- | +| title | 提示文字 | string\|ReactNode\|() => ReactNode | 无 | | ### 共同的 API 以下 API 为 Tooltip、Popconfirm、Popover 共享的 API。 -| 参数 | 说明 | 类型 | 默认值 | -| --- | --- | --- | --- | -| arrowPointAtCenter | 箭头是否指向目标元素中心，`antd@1.11+` 支持 | boolean | `false` | -| autoAdjustOverflow | 气泡被遮挡时自动调整位置 | boolean | `true` | -| defaultVisible | 默认是否显隐 | boolean | false | -| getPopupContainer | 浮层渲染父节点，默认渲染到 body 上 | Function(triggerNode) | () => document.body | -| mouseEnterDelay | 鼠标移入后延时多少才显示 Tooltip，单位：秒 | number | 0.1 | -| mouseLeaveDelay | 鼠标移出后延时多少才隐藏 Tooltip，单位：秒 | number | 0.1 | -| overlayClassName | 卡片类名 | string | 无 | -| overlayStyle | 卡片样式 | object | 无 | -| placement | 气泡框位置，可选 `top` `left` `right` `bottom` `topLeft` `topRight` `bottomLeft` `bottomRight` `leftTop` `leftBottom` `rightTop` `rightBottom` | string | top | -| trigger | 触发行为，可选 `hover/focus/click/contextMenu` | string | hover | -| visible | 用于手动控制浮层显隐 | boolean | false | -| onVisibleChange | 显示隐藏的回调 | (visible) => void | 无 | -| align | 该值将合并到 placement 的配置中，设置参考 [rc-tooltip](https://github.com/react-component/tooltip) | Object | 无 | +| 参数 | 说明 | 类型 | 默认值 | 版本 | +| --- | --- | --- | --- | --- | +| arrowPointAtCenter | 箭头是否指向目标元素中心，`antd@1.11+` 支持 | boolean | `false` | | +| autoAdjustOverflow | 气泡被遮挡时自动调整位置 | boolean | `true` | | +| defaultVisible | 默认是否显隐 | boolean | false | | +| getPopupContainer | 浮层渲染父节点，默认渲染到 body 上 | Function(triggerNode) | () => document.body | | +| mouseEnterDelay | 鼠标移入后延时多少才显示 Tooltip，单位：秒 | number | 0.1 | | +| mouseLeaveDelay | 鼠标移出后延时多少才隐藏 Tooltip，单位：秒 | number | 0.1 | | +| overlayClassName | 卡片类名 | string | 无 | | +| overlayStyle | 卡片样式 | object | 无 | | +| placement | 气泡框位置，可选 `top` `left` `right` `bottom` `topLeft` `topRight` `bottomLeft` `bottomRight` `leftTop` `leftBottom` `rightTop` `rightBottom` | string | top | | +| trigger | 触发行为，可选 `hover/focus/click/contextMenu` | string | hover | | +| visible | 用于手动控制浮层显隐 | boolean | false | | +| onVisibleChange | 显示隐藏的回调 | (visible) => void | 无 | | +| align | 该值将合并到 placement 的配置中，设置参考 [rc-tooltip](https://github.com/react-component/tooltip) | Object | 无 | 3.10.0 | ## 注意 diff --git a/components/transfer/index.en-US.md b/components/transfer/index.en-US.md index 90c4edd35c..8c8662ec73 100644 --- a/components/transfer/index.en-US.md +++ b/components/transfer/index.en-US.md @@ -22,24 +22,24 @@ One or more elements can be selected from either column, one click on the proper | --- | --- | --- | --- | --- | | className | A custom CSS class. | string | \['', ''] | | | dataSource | Used for setting the source data. The elements that are part of this array will be present the left column. Except the elements whose keys are included in `targetKeys` prop. | [TransferItem](https://git.io/vMM64)\[] | \[] | | -| disabled | Whether disabled transfer | boolean | false | | +| disabled | Whether disabled transfer | boolean | false | 3.10.0 | | filterOption | A function to determine whether an item should show in search result list | (inputValue, option): boolean | | | | footer | A function used for rendering the footer. | (props): ReactNode | | | | lazy | property of [react-lazy-load](https://github.com/loktar00/react-lazy-load) for lazy rendering items. Turn off it by set to `false`. | object\|boolean | `{ height: 32, offset: 32 }` | | | listStyle | A custom CSS style used for rendering the transfer columns. | object | | | -| locale | i18n text including filter, empty text, item unit, etc | { itemUnit: string; itemsUnit: string; searchPlaceholder: string; notFoundContent: ReactNode; } | `{ itemUnit: 'item', itemsUnit: 'items', notFoundContent: 'The list is empty', searchPlaceholder: 'Search here' }` | | +| locale | i18n text including filter, empty text, item unit, etc | { itemUnit: string; itemsUnit: string; searchPlaceholder: string; notFoundContent: ReactNode; } | `{ itemUnit: 'item', itemsUnit: 'items', notFoundContent: 'The list is empty', searchPlaceholder: 'Search here' }` | 3.9.0 | | operations | A set of operations that are sorted from top to bottom. | string\[] | \['>', '<'] | | -| operationStyle | A custom CSS style used for rendering the operations column. | object | | | +| operationStyle | A custom CSS style used for rendering the operations column. | object | | 3.6.0 | | render | The function to generate the item shown on a column. Based on an record (element of the dataSource array), this function should return a React element which is generated from that record. Also, it can return a plain object with `value` and `label`, `label` is a React element and `value` is for title | Function(record) | | | | selectedKeys | A set of keys of selected items. | string\[] | \[] | | | showSearch | If included, a search box is shown on each column. | boolean | false | | | showSelectAll | Show select all checkbox on the header | boolean | true | 3.18.0 | -| style | A custom CSS style used for rendering wrapper element. | object | | | +| style | A custom CSS style used for rendering wrapper element. | object | | 3.6.0 | | targetKeys | A set of keys of elements that are listed on the right column. | string\[] | \[] | | | titles | A set of titles that are sorted from left to right. | string\[] | - | | | onChange | A callback function that is executed when the transfer between columns is complete. | (targetKeys, direction, moveKeys): void | | | | onScroll | A callback function which is executed when scroll options list | (direction, event): void | | | -| onSearch | A callback function which is executed when search field are changed | (direction: 'left'\|'right', value: string): void | - | | +| onSearch | A callback function which is executed when search field are changed | (direction: 'left'\|'right', value: string): void | - | 3.11.0 | | onSelectChange | A callback function which is executed when selected items are changed. | (sourceSelectedKeys, targetSelectedKeys): void | | | ### Render Props diff --git a/components/transfer/index.zh-CN.md b/components/transfer/index.zh-CN.md index eb6ca3f170..79d8d53855 100644 --- a/components/transfer/index.zh-CN.md +++ b/components/transfer/index.zh-CN.md @@ -25,22 +25,23 @@ title: Transfer | --- | --- | --- | --- | --- | | className | 自定义类 | string | | | | dataSource | 数据源，其中的数据将会被渲染到左边一栏中，`targetKeys` 中指定的除外。 | [TransferItem](https://git.io/vMM64)\[] | \[] | | -| disabled | 是否禁用 | boolean | false | | +| disabled | 是否禁用 | boolean | false | 3.10.0 | | filterOption | 接收 `inputValue` `option` 两个参数，当 `option` 符合筛选条件时，应返回 `true`，反之则返回 `false`。 | | (inputValue, option): boolean | | | | footer | 底部渲染函数 | (props): ReactNode | | | | lazy | Transfer 使用了 [react-lazy-load](https://github.com/loktar00/react-lazy-load) 优化性能，这里可以设置相关参数。设为 `false` 可以关闭懒加载。 | object\|boolean | `{ height: 32, offset: 32 }` | | | listStyle | 两个穿梭框的自定义样式 | object | | | -| locale | 各种语言 | { itemUnit: string; itemsUnit: string; searchPlaceholder: string; notFoundContent: ReactNode; } | `{ itemUnit: '项', itemsUnit: '项', searchPlaceholder: '请输入搜索内容' }` | | +| locale | 各种语言 | { itemUnit: string; itemsUnit: string; searchPlaceholder: string; notFoundContent: ReactNode; } | `{ itemUnit: '项', itemsUnit: '项', searchPlaceholder: '请输入搜索内容' }` | 3.9.0 | | operations | 操作文案集合，顺序从上至下 | string\[] | \['>', '<'] | | | render | 每行数据渲染函数，该函数的入参为 `dataSource` 中的项，返回值为 ReactElement。或者返回一个普通对象，其中 `label` 字段为 ReactElement，`value` 字段为 title | Function(record) | | | | selectedKeys | 设置哪些项应该被选中 | string\[] | \[] | | | showSearch | 是否显示搜索框 | boolean | false | | | showSelectAll | 是否展示全选勾选框 | boolean | true | 3.18.0 | +| style | 容器的自定义样式 | object | | 3.6.0 | | targetKeys | 显示在右侧框数据的 key 集合 | string\[] | \[] | | | titles | 标题集合，顺序从左至右 | string\[] | \['', ''] | | | onChange | 选项在两栏之间转移时的回调函数 | (targetKeys, direction, moveKeys): void | | | | onScroll | 选项列表滚动时的回调函数 | (direction, event): void | | | -| onSearch | 搜索框内容时改变时的回调函数 | (direction: 'left'\|'right', value: string): void | - | | +| onSearch | 搜索框内容时改变时的回调函数 | (direction: 'left'\|'right', value: string): void | - | 3.11.0 | | onSelectChange | 选中项发生改变时的回调函数 | (sourceSelectedKeys, targetSelectedKeys): void | | | ### Render Props diff --git a/components/tree-select/index.en-US.md b/components/tree-select/index.en-US.md index 55e2cb9f8e..e1a7f1f717 100644 --- a/components/tree-select/index.en-US.md +++ b/components/tree-select/index.en-US.md @@ -14,65 +14,65 @@ Tree selection control. ### Tree props -| Property | Description | Type | Default | -| --- | --- | --- | --- | -| allowClear | Whether allow clear | boolean | false | -| autoClearSearchValue | auto clear search input value when multiple select is selected/deselected | boolean | true | -| defaultValue | To set the initial selected treeNode(s). | string\|string\[] | - | -| disabled | Disabled or not | boolean | false | -| dropdownClassName | className of dropdown menu | string | - | -| dropdownMatchSelectWidth | Determine whether the dropdown menu and the select input are the same width. Default set `min-width` same as input. | boolean | true | -| dropdownStyle | To set the style of the dropdown menu | object | - | -| filterTreeNode | Whether to filter treeNodes by input value. The value of `treeNodeFilterProp` is used for filtering by default. | boolean\|Function(inputValue: string, treeNode: TreeNode) (should return boolean) | Function | -| getPopupContainer | To set the container of the dropdown menu. The default is to create a `div` element in `body`, you can reset it to the scrolling area and make a relative reposition. [example](https://codepen.io/afc163/pen/zEjNOy?editors=0010) | Function(triggerNode) | () => document.body | -| labelInValue | whether to embed label in value, turn the format of value from `string` to `{value: string, label: ReactNode, halfChecked: string[]}` | boolean | false | -| loadData | Load data asynchronously. | function(node) | - | -| maxTagCount | Max tag count to show | number | - | -| maxTagPlaceholder | Placeholder for not showing tags | ReactNode/function(omittedValues) | - | -| multiple | Support multiple or not, will be `true` when enable `treeCheckable`. | boolean | false | -| placeholder | Placeholder of the select input | string | - | -| searchPlaceholder | Placeholder of the search input | string | - | -| searchValue | work with `onSearch` to make search value controlled. | string | - | -| treeIcon | Shows the icon before a TreeNode's title. There is no default style; you must set a custom style for it if set to `true` | boolean | false | -| showCheckedStrategy | The way show selected item in box. **Default:** just show child nodes. **`TreeSelect.SHOW_ALL`:** show all checked treeNodes (include parent treeNode). **`TreeSelect.SHOW_PARENT`:** show checked treeNodes (just show parent treeNode). | enum { TreeSelect.SHOW_ALL, TreeSelect.SHOW_PARENT, TreeSelect.SHOW_CHILD } | TreeSelect.SHOW_CHILD | -| showSearch | Support search or not | boolean | single: `false` \| multiple: `true` | -| size | To set the size of the select input, options: `large` `small` | string | 'default' | -| suffixIcon | The custom suffix icon | ReactNode | - | -| treeCheckable | Whether to show checkbox on the treeNodes | boolean | false | -| treeCheckStrictly | Whether to check nodes precisely (in the `checkable` mode), means parent and child nodes are not associated, and it will make `labelInValue` be true | boolean | false | -| treeData | Data of the treeNodes, manual construction work is no longer needed if this property has been set(ensure the Uniqueness of each value) | array\<{ value, title, children, \[disabled, disableCheckbox, selectable] }> | \[] | -| treeDataSimpleMode | Enable simple mode of treeData. Changes the `treeData` schema to: \[{id:1, pId:0, value:'1', title:"test1",...},...] where pId is parent node's id). It is possible to replace the default `id` and `pId` keys by providing object to `treeDataSimpleMode` | false\|object\<{ id: string, pId: string, rootPId: string }> | false | -| treeDefaultExpandAll | Whether to expand all treeNodes by default | boolean | false | -| treeDefaultExpandedKeys | Default expanded treeNodes | string\[] | - | -| treeExpandedKeys | Set expanded keys | string\[] | - | -| treeNodeFilterProp | Will be used for filtering if `filterTreeNode` returns true | string | 'value' | -| treeNodeLabelProp | Will render as content of select | string | 'title' | -| value | To set the current selected treeNode(s). | string\|string\[] | - | -| onChange | A callback function, can be executed when selected treeNodes or input value change | function(value, label, extra) | - | -| onSearch | A callback function, can be executed when the search input changes. | function(value: string) | - | -| onSelect | A callback function, can be executed when you select a treeNode. | function(value, node, extra) | - | -| onTreeExpand | A callback function, can be executed when treeNode expanded | function(expandedKeys) | - | +| Property | Description | Type | Default | Version | +| --- | --- | --- | --- | --- | +| allowClear | Whether allow clear | boolean | false | | +| autoClearSearchValue | auto clear search input value when multiple select is selected/deselected | boolean | true | 3.7.0 | +| defaultValue | To set the initial selected treeNode(s). | string\|string\[] | - | | +| disabled | Disabled or not | boolean | false | | +| dropdownClassName | className of dropdown menu | string | - | 3.3.0 | +| dropdownMatchSelectWidth | Determine whether the dropdown menu and the select input are the same width. Default set `min-width` same as input. | boolean | true | | +| dropdownStyle | To set the style of the dropdown menu | object | - | | +| filterTreeNode | Whether to filter treeNodes by input value. The value of `treeNodeFilterProp` is used for filtering by default. | boolean\|Function(inputValue: string, treeNode: TreeNode) (should return boolean) | Function | | +| getPopupContainer | To set the container of the dropdown menu. The default is to create a `div` element in `body`, you can reset it to the scrolling area and make a relative reposition. [example](https://codepen.io/afc163/pen/zEjNOy?editors=0010) | Function(triggerNode) | () => document.body | | +| labelInValue | whether to embed label in value, turn the format of value from `string` to `{value: string, label: ReactNode, halfChecked: string[]}` | boolean | false | | +| loadData | Load data asynchronously. | function(node) | - | | +| maxTagCount | Max tag count to show | number | - | 3.7.0 | +| maxTagPlaceholder | Placeholder for not showing tags | ReactNode/function(omittedValues) | - | 3.7.0 | +| multiple | Support multiple or not, will be `true` when enable `treeCheckable`. | boolean | false | | +| placeholder | Placeholder of the select input | string | - | | +| searchPlaceholder | Placeholder of the search input | string | - | | +| searchValue | work with `onSearch` to make search value controlled. | string | - | 3.7.0 | +| treeIcon | Shows the icon before a TreeNode's title. There is no default style; you must set a custom style for it if set to `true` | boolean | false | 3.13.1 | +| showCheckedStrategy | The way show selected item in box. **Default:** just show child nodes. **`TreeSelect.SHOW_ALL`:** show all checked treeNodes (include parent treeNode). **`TreeSelect.SHOW_PARENT`:** show checked treeNodes (just show parent treeNode). | enum { TreeSelect.SHOW_ALL, TreeSelect.SHOW_PARENT, TreeSelect.SHOW_CHILD } | TreeSelect.SHOW_CHILD | | +| showSearch | Support search or not | boolean | single: `false` \| multiple: `true` | | +| size | To set the size of the select input, options: `large` `small` | string | 'default' | | +| suffixIcon | The custom suffix icon | ReactNode | - | 3.10.0 | +| treeCheckable | Whether to show checkbox on the treeNodes | boolean | false | | +| treeCheckStrictly | Whether to check nodes precisely (in the `checkable` mode), means parent and child nodes are not associated, and it will make `labelInValue` be true | boolean | false | | +| treeData | Data of the treeNodes, manual construction work is no longer needed if this property has been set(ensure the Uniqueness of each value) | array\<{ value, title, children, \[disabled, disableCheckbox, selectable] }> | \[] | | +| treeDataSimpleMode | Enable simple mode of treeData. Changes the `treeData` schema to: \[{id:1, pId:0, value:'1', title:"test1",...},...] where pId is parent node's id). It is possible to replace the default `id` and `pId` keys by providing object to `treeDataSimpleMode` | false\|object\<{ id: string, pId: string, rootPId: string }> | false | | +| treeDefaultExpandAll | Whether to expand all treeNodes by default | boolean | false | | +| treeDefaultExpandedKeys | Default expanded treeNodes | string\[] | - | | +| treeExpandedKeys | Set expanded keys | string\[] | - | 3.10.0 | +| treeNodeFilterProp | Will be used for filtering if `filterTreeNode` returns true | string | 'value' | | +| treeNodeLabelProp | Will render as content of select | string | 'title' | | +| value | To set the current selected treeNode(s). | string\|string\[] | - | | +| onChange | A callback function, can be executed when selected treeNodes or input value change | function(value, label, extra) | - | | +| onSearch | A callback function, can be executed when the search input changes. | function(value: string) | - | | +| onSelect | A callback function, can be executed when you select a treeNode. | function(value, node, extra) | - | | +| onTreeExpand | A callback function, can be executed when treeNode expanded | function(expandedKeys) | - | 3.10.0 | ### Tree Methods -| Name | Description | -| ------- | ------------ | -| blur() | remove focus | -| focus() | get focus | +| Name | Description | Version | +| ------- | ------------ | ------- | +| blur() | remove focus | | +| focus() | get focus | | ### TreeNode props > We recommend you to use `treeData` rather than `TreeNode`, to avoid the trouble of manual construction. -| Property | Description | Type | Default | -| --- | --- | --- | --- | -| selectable | can be selected | boolean | true | -| disableCheckbox | Disables the checkbox of the treeNode | boolean | false | -| disabled | Disabled or not | boolean | false | -| isLeaf | Leaf node or not | boolean | false | -| key | Required property (unless using `treeDataSimpleMode`), should be unique in the tree | string | - | -| title | Content showed on the treeNodes | string\|ReactNode | '---' | -| value | Will be treated as `treeNodeFilterProp` by default, should be unique in the tree | string | - | +| Property | Description | Type | Default | Version | +| --- | --- | --- | --- | --- | +| selectable | can be selected | boolean | true | 3.9.3 | +| disableCheckbox | Disables the checkbox of the treeNode | boolean | false | | +| disabled | Disabled or not | boolean | false | | +| isLeaf | Leaf node or not | boolean | false | | +| key | Required property (unless using `treeDataSimpleMode`), should be unique in the tree | string | - | | +| title | Content showed on the treeNodes | string\|ReactNode | '---' | | +| value | Will be treated as `treeNodeFilterProp` by default, should be unique in the tree | string | - | | ## FAQ diff --git a/components/tree-select/index.zh-CN.md b/components/tree-select/index.zh-CN.md index 9f0aaa945e..82ad2904ff 100644 --- a/components/tree-select/index.zh-CN.md +++ b/components/tree-select/index.zh-CN.md @@ -15,65 +15,65 @@ title: TreeSelect ### Tree props -| 参数 | 说明 | 类型 | 默认值 | -| --- | --- | --- | --- | -| allowClear | 显示清除按钮 | boolean | false | -| autoClearSearchValue | 当多选模式下值被选择，自动清空搜索框 | boolean | true | -| defaultValue | 指定默认选中的条目 | string/string\[] | - | -| disabled | 是否禁用 | boolean | false | -| dropdownClassName | 下拉菜单的 className 属性 | string | - | -| dropdownMatchSelectWidth | 下拉菜单和选择器同宽。默认将设置 `min-width`。 | boolean | true | -| dropdownStyle | 下拉菜单的样式 | object | - | -| filterTreeNode | 是否根据输入项进行筛选，默认用 treeNodeFilterProp 的值作为要筛选的 TreeNode 的属性值 | boolean\|Function(inputValue: string, treeNode: TreeNode) (函数需要返回 bool 值) | Function | -| getPopupContainer | 菜单渲染父节点。默认渲染到 body 上，如果你遇到菜单滚动定位问题，试试修改为滚动的区域，并相对其定位。[示例](https://codepen.io/afc163/pen/zEjNOy?editors=0010) | Function(triggerNode) | () => document.body | -| labelInValue | 是否把每个选项的 label 包装到 value 中，会把 value 类型从 `string` 变为 `{value: string, label: ReactNode, halfChecked(treeCheckStrictly 时有效): string[] }` 的格式 | boolean | false | -| loadData | 异步加载数据 | function(node) | - | -| maxTagCount | 最多显示多少个 tag | number | - | -| maxTagPlaceholder | 隐藏 tag 时显示的内容 | ReactNode/function(omittedValues) | - | -| multiple | 支持多选（当设置 treeCheckable 时自动变为 true） | boolean | false | -| placeholder | 选择框默认文字 | string | - | -| searchPlaceholder | 搜索框默认文字 | string | - | -| searchValue | 搜索框的值，可以通过 `onSearch` 获取用户输入 | string | - | -| treeIcon | 是否展示 TreeNode title 前的图标，没有默认样式，如设置为 true，需要自行定义图标相关样式 | boolean | false | -| showCheckedStrategy | 定义选中项回填的方式。`TreeSelect.SHOW_ALL`: 显示所有选中节点(包括父节点). `TreeSelect.SHOW_PARENT`: 只显示父节点(当父节点下所有子节点都选中时). 默认只显示子节点. | enum{TreeSelect.SHOW_ALL, TreeSelect.SHOW_PARENT, TreeSelect.SHOW_CHILD } | TreeSelect.SHOW_CHILD | -| showSearch | 是否支持搜索框 | boolean | 单选：`false` \| 多选：`true` | -| size | 选择框大小，可选 `large` `small` | string | 'default' | -| suffixIcon | 自定义的选择框后缀图标 | ReactNode | - | -| treeCheckable | 显示 checkbox | boolean | false | -| treeCheckStrictly | checkable 状态下节点选择完全受控（父子节点选中状态不再关联），会使得 `labelInValue` 强制为 true | boolean | false | -| treeData | treeNodes 数据，如果设置则不需要手动构造 TreeNode 节点（value 在整个树范围内唯一） | array\<{value, title, children, \[disabled, disableCheckbox, selectable]}> | \[] | -| treeDataSimpleMode | 使用简单格式的 treeData，具体设置参考可设置的类型 (此时 treeData 应变为这样的数据结构: \[{id:1, pId:0, value:'1', title:"test1",...},...], `pId` 是父节点的 id) | false\|object\<{ id: string, pId: string, rootPId: string }> | false | -| treeDefaultExpandAll | 默认展开所有树节点 | boolean | false | -| treeDefaultExpandedKeys | 默认展开的树节点 | string\[] | - | -| treeExpandedKeys | 设置展开的树节点 | string\[] | - | -| treeNodeFilterProp | 输入项过滤对应的 treeNode 属性 | string | 'value' | -| treeNodeLabelProp | 作为显示的 prop 设置 | string | 'title' | -| value | 指定当前选中的条目 | string/string\[] | - | -| onChange | 选中树节点时调用此函数 | function(value, label, extra) | - | -| onSearch | 文本框值变化时回调 | function(value: string) | - | -| onSelect | 被选中时调用 | function(value, node, extra) | - | -| onTreeExpand | 展示节点时调用 | function(expandedKeys) | - | +| 参数 | 说明 | 类型 | 默认值 | 版本 | +| --- | --- | --- | --- | --- | +| allowClear | 显示清除按钮 | boolean | false | | +| autoClearSearchValue | 当多选模式下值被选择，自动清空搜索框 | boolean | true | 3.7.0 | +| defaultValue | 指定默认选中的条目 | string/string\[] | - | | +| disabled | 是否禁用 | boolean | false | | +| dropdownClassName | 下拉菜单的 className 属性 | string | - | 3.3.0 | +| dropdownMatchSelectWidth | 下拉菜单和选择器同宽。默认将设置 `min-width`。 | boolean | true | | +| dropdownStyle | 下拉菜单的样式 | object | - | | +| filterTreeNode | 是否根据输入项进行筛选，默认用 treeNodeFilterProp 的值作为要筛选的 TreeNode 的属性值 | boolean\|Function(inputValue: string, treeNode: TreeNode) (函数需要返回 bool 值) | Function | | +| getPopupContainer | 菜单渲染父节点。默认渲染到 body 上，如果你遇到菜单滚动定位问题，试试修改为滚动的区域，并相对其定位。[示例](https://codepen.io/afc163/pen/zEjNOy?editors=0010) | Function(triggerNode) | () => document.body | | +| labelInValue | 是否把每个选项的 label 包装到 value 中，会把 value 类型从 `string` 变为 `{value: string, label: ReactNode, halfChecked(treeCheckStrictly 时有效): string[] }` 的格式 | boolean | false | | +| loadData | 异步加载数据 | function(node) | - | | +| maxTagCount | 最多显示多少个 tag | number | - | 3.7.0 | +| maxTagPlaceholder | 隐藏 tag 时显示的内容 | ReactNode/function(omittedValues) | - | 3.7.0 | +| multiple | 支持多选（当设置 treeCheckable 时自动变为 true） | boolean | false | | +| placeholder | 选择框默认文字 | string | - | | +| searchPlaceholder | 搜索框默认文字 | string | - | | +| searchValue | 搜索框的值，可以通过 `onSearch` 获取用户输入 | string | - | 3.7.0 | +| treeIcon | 是否展示 TreeNode title 前的图标，没有默认样式，如设置为 true，需要自行定义图标相关样式 | boolean | false | 3.13.1 | +| showCheckedStrategy | 定义选中项回填的方式。`TreeSelect.SHOW_ALL`: 显示所有选中节点(包括父节点). `TreeSelect.SHOW_PARENT`: 只显示父节点(当父节点下所有子节点都选中时). 默认只显示子节点. | enum{TreeSelect.SHOW_ALL, TreeSelect.SHOW_PARENT, TreeSelect.SHOW_CHILD } | TreeSelect.SHOW_CHILD | | +| showSearch | 是否支持搜索框 | boolean | 单选：`false` \| 多选：`true` | | +| size | 选择框大小，可选 `large` `small` | string | 'default' | | +| suffixIcon | 自定义的选择框后缀图标 | ReactNode | - | 3.10.0 | +| treeCheckable | 显示 checkbox | boolean | false | | +| treeCheckStrictly | checkable 状态下节点选择完全受控（父子节点选中状态不再关联），会使得 `labelInValue` 强制为 true | boolean | false | | +| treeData | treeNodes 数据，如果设置则不需要手动构造 TreeNode 节点（value 在整个树范围内唯一） | array\<{value, title, children, \[disabled, disableCheckbox, selectable]}> | \[] | | +| treeDataSimpleMode | 使用简单格式的 treeData，具体设置参考可设置的类型 (此时 treeData 应变为这样的数据结构: \[{id:1, pId:0, value:'1', title:"test1",...},...], `pId` 是父节点的 id) | false\|object\<{ id: string, pId: string, rootPId: string }> | false | | +| treeDefaultExpandAll | 默认展开所有树节点 | boolean | false | | +| treeDefaultExpandedKeys | 默认展开的树节点 | string\[] | - | | +| treeExpandedKeys | 设置展开的树节点 | string\[] | - | 3.10.0 | +| treeNodeFilterProp | 输入项过滤对应的 treeNode 属性 | string | 'value' | | +| treeNodeLabelProp | 作为显示的 prop 设置 | string | 'title' | | +| value | 指定当前选中的条目 | string/string\[] | - | | +| onChange | 选中树节点时调用此函数 | function(value, label, extra) | - | | +| onSearch | 文本框值变化时回调 | function(value: string) | - | | +| onSelect | 被选中时调用 | function(value, node, extra) | - | | +| onTreeExpand | 展示节点时调用 | function(expandedKeys) | - | 3.10.0 | ### Tree 方法 -| 名称 | 描述 | -| ------- | -------- | -| blur() | 移除焦点 | -| focus() | 获取焦点 | +| 名称 | 描述 | 版本 | +| ------- | -------- | ---- | +| blur() | 移除焦点 | | +| focus() | 获取焦点 | | ### TreeNode props > 建议使用 treeData 来代替 TreeNode，免去手工构造麻烦 -| 参数 | 说明 | 类型 | 默认值 | -| --- | --- | --- | --- | -| selectable | 是否可选 | boolean | true | -| disableCheckbox | 禁掉 checkbox | boolean | false | -| disabled | 是否禁用 | boolean | false | -| isLeaf | 是否是叶子节点 | boolean | false | -| key | 此项必须设置（其值在整个树范围内唯一） | string | - | -| title | 树节点显示的内容 | string\|ReactNode | '---' | -| value | 默认根据此属性值进行筛选（其值在整个树范围内唯一） | string | - | +| 参数 | 说明 | 类型 | 默认值 | 版本 | +| --- | --- | --- | --- | --- | +| selectable | 是否可选 | boolean | true | 3.9.3 | +| disableCheckbox | 禁掉 checkbox | boolean | false | | +| disabled | 是否禁用 | boolean | false | | +| isLeaf | 是否是叶子节点 | boolean | false | | +| key | 此项必须设置（其值在整个树范围内唯一） | string | - | | +| title | 树节点显示的内容 | string\|ReactNode | '---' | | +| value | 默认根据此属性值进行筛选（其值在整个树范围内唯一） | string | - | | ## FAQ diff --git a/components/tree/index.en-US.md b/components/tree/index.en-US.md index ca81f133f6..a2cd41df91 100644 --- a/components/tree/index.en-US.md +++ b/components/tree/index.en-US.md @@ -12,60 +12,60 @@ Almost anything can be represented in a tree structure. Examples include directo ### Tree props -| Property | Description | Type | Default | -| --- | --- | --- | --- | -| autoExpandParent | Whether to automatically expand a parent treeNode | boolean | true | -| blockNode | Whether treeNode fill remaining horizontal space | boolean | false | -| checkable | Adds a `Checkbox` before the treeNodes | boolean | false | -| checkedKeys | (Controlled) Specifies the keys of the checked treeNodes (PS: When this specifies the key of a treeNode which is also a parent treeNode, all the children treeNodes of will be checked; and vice versa, when it specifies the key of a treeNode which is a child treeNode, its parent treeNode will also be checked. When `checkable` and `checkStrictly` is true, its object has `checked` and `halfChecked` property. Regardless of whether the child or parent treeNode is checked, they won't impact each other. | string\[] \| {checked: string\[], halfChecked: string\[]} | \[] | -| checkStrictly | Check treeNode precisely; parent treeNode and children treeNodes are not associated | boolean | false | -| defaultCheckedKeys | Specifies the keys of the default checked treeNodes | string\[] | \[] | -| defaultExpandAll | Whether to expand all treeNodes by default | boolean | false | -| defaultExpandedKeys | Specify the keys of the default expanded treeNodes | string\[] | \[] | -| defaultExpandParent | auto expand parent treeNodes when init | bool | true | -| defaultSelectedKeys | Specifies the keys of the default selected treeNodes | string\[] | \[] | -| disabled | whether disabled the tree | bool | false | -| draggable | Specifies whether this Tree is draggable (IE > 8) | boolean | false | -| expandedKeys | (Controlled) Specifies the keys of the expanded treeNodes | string\[] | \[] | -| filterTreeNode | Defines a function to filter (highlight) treeNodes. When the function returns `true`, the corresponding treeNode will be highlighted | function(node) | - | -| loadData | Load data asynchronously | function(node) | - | -| loadedKeys | (Controlled) Set loaded tree nodes. Need work with `loadData` | string\[] | \[] | -| multiple | Allows selecting multiple treeNodes | boolean | false | -| selectedKeys | (Controlled) Specifies the keys of the selected treeNodes | string\[] | - | -| showIcon | Shows the icon before a TreeNode's title. There is no default style; you must set a custom style for it if set to `true` | boolean | false | -| switcherIcon | customize collapse/expand icon of tree node | React.ReactElement | - | -| showLine | Shows a connecting line | boolean | false | -| onCheck | Callback function for when the onCheck event occurs | function(checkedKeys, e:{checked: bool, checkedNodes, node, event}) | - | -| onDragEnd | Callback function for when the onDragEnd event occurs | function({event, node}) | - | -| onDragEnter | Callback function for when the onDragEnter event occurs | function({event, node, expandedKeys}) | - | -| onDragLeave | Callback function for when the onDragLeave event occurs | function({event, node}) | - | -| onDragOver | Callback function for when the onDragOver event occurs | function({event, node}) | - | -| onDragStart | Callback function for when the onDragStart event occurs | function({event, node}) | - | -| onDrop | Callback function for when the onDrop event occurs | function({event, node, dragNode, dragNodesKeys}) | - | -| onExpand | Callback function for when a treeNode is expanded or collapsed | function(expandedKeys, {expanded: bool, node}) | - | -| onLoad | Callback function for when a treeNode is loaded | function(loadedKeys, {event, node}) | - | -| onRightClick | Callback function for when the user right clicks a treeNode | function({event, node}) | - | -| onSelect | Callback function for when the user clicks a treeNode | function(selectedKeys, e:{selected: bool, selectedNodes, node, event}) | - | -| treeData | treeNodes data Array, if set it then you need not to construct children TreeNode. (key should be unique across the whole array) | array\<{ key, title, children, \[disabled, selectable] }> | - | +| Property | Description | Type | Default | Version | +| --- | --- | --- | --- | --- | +| autoExpandParent | Whether to automatically expand a parent treeNode | boolean | true | | +| blockNode | Whether treeNode fill remaining horizontal space | boolean | false | 3.15.0 | +| checkable | Adds a `Checkbox` before the treeNodes | boolean | false | | +| checkedKeys | (Controlled) Specifies the keys of the checked treeNodes (PS: When this specifies the key of a treeNode which is also a parent treeNode, all the children treeNodes of will be checked; and vice versa, when it specifies the key of a treeNode which is a child treeNode, its parent treeNode will also be checked. When `checkable` and `checkStrictly` is true, its object has `checked` and `halfChecked` property. Regardless of whether the child or parent treeNode is checked, they won't impact each other. | string\[] \| {checked: string\[], halfChecked: string\[]} | \[] | | +| checkStrictly | Check treeNode precisely; parent treeNode and children treeNodes are not associated | boolean | false | | +| defaultCheckedKeys | Specifies the keys of the default checked treeNodes | string\[] | \[] | | +| defaultExpandAll | Whether to expand all treeNodes by default | boolean | false | | +| defaultExpandedKeys | Specify the keys of the default expanded treeNodes | string\[] | \[] | | +| defaultExpandParent | auto expand parent treeNodes when init | bool | true | 3.4.0 | +| defaultSelectedKeys | Specifies the keys of the default selected treeNodes | string\[] | \[] | | +| disabled | whether disabled the tree | bool | false | 3.4.0 | +| draggable | Specifies whether this Tree is draggable (IE > 8) | boolean | false | | +| expandedKeys | (Controlled) Specifies the keys of the expanded treeNodes | string\[] | \[] | | +| filterTreeNode | Defines a function to filter (highlight) treeNodes. When the function returns `true`, the corresponding treeNode will be highlighted | function(node) | - | | +| loadData | Load data asynchronously | function(node) | - | | +| loadedKeys | (Controlled) Set loaded tree nodes. Need work with `loadData` | string\[] | \[] | 3.7.0 | +| multiple | Allows selecting multiple treeNodes | boolean | false | | +| selectedKeys | (Controlled) Specifies the keys of the selected treeNodes | string\[] | - | | +| showIcon | Shows the icon before a TreeNode's title. There is no default style; you must set a custom style for it if set to `true` | boolean | false | | +| switcherIcon | customize collapse/expand icon of tree node | React.ReactElement | - | 3.12.0 | +| showLine | Shows a connecting line | boolean | false | | +| onCheck | Callback function for when the onCheck event occurs | function(checkedKeys, e:{checked: bool, checkedNodes, node, event}) | - | | +| onDragEnd | Callback function for when the onDragEnd event occurs | function({event, node}) | - | | +| onDragEnter | Callback function for when the onDragEnter event occurs | function({event, node, expandedKeys}) | - | | +| onDragLeave | Callback function for when the onDragLeave event occurs | function({event, node}) | - | | +| onDragOver | Callback function for when the onDragOver event occurs | function({event, node}) | - | | +| onDragStart | Callback function for when the onDragStart event occurs | function({event, node}) | - | | +| onDrop | Callback function for when the onDrop event occurs | function({event, node, dragNode, dragNodesKeys}) | - | | +| onExpand | Callback function for when a treeNode is expanded or collapsed | function(expandedKeys, {expanded: bool, node}) | - | | +| onLoad | Callback function for when a treeNode is loaded | function(loadedKeys, {event, node}) | - | 3.7.0 | +| onRightClick | Callback function for when the user right clicks a treeNode | function({event, node}) | - | | +| onSelect | Callback function for when the user clicks a treeNode | function(selectedKeys, e:{selected: bool, selectedNodes, node, event}) | - | | +| treeData | treeNodes data Array, if set it then you need not to construct children TreeNode. (key should be unique across the whole array) | array\<{ key, title, children, \[disabled, selectable] }> | - | 3.19.8 | ### TreeNode props | Property | Description | Type | Default | Version | | --- | --- | --- | --- | --- | -| checkable | When Tree is checkable, set TreeNode display Checkbox or not | boolean | - | 3.17.0 | -| disableCheckbox | Disables the checkbox of the treeNode | boolean | false | | -| disabled | Disables the treeNode | boolean | false | | -| icon | customize icon. When you pass component, whose render will receive full TreeNode props as component props | ReactNode/Function(props):ReactNode | - | | -| isLeaf | Determines if this is a leaf node(effective when `loadData` is specified) | boolean | false | | -| key | Used with (default)ExpandedKeys / (default)CheckedKeys / (default)SelectedKeys. P.S.: It must be unique in all of treeNodes of the tree! | string | internal calculated position of treeNode | | -| selectable | Set whether the treeNode can be selected | boolean | true | | -| title | Title | string\|ReactNode | '---' | | +| checkable | When Tree is checkable, set TreeNode display Checkbox or not | boolean | - | 3.17.0 | 3.17.0 | +| disableCheckbox | Disables the checkbox of the treeNode | boolean | false | | | +| disabled | Disables the treeNode | boolean | false | | | +| icon | customize icon. When you pass component, whose render will receive full TreeNode props as component props | ReactNode/Function(props):ReactNode | - | | 3.4.0 | +| isLeaf | Determines if this is a leaf node(effective when `loadData` is specified) | boolean | false | | | +| key | Used with (default)ExpandedKeys / (default)CheckedKeys / (default)SelectedKeys. P.S.: It must be unique in all of treeNodes of the tree! | string | internal calculated position of treeNode | | | +| selectable | Set whether the treeNode can be selected | boolean | true | | | +| title | Title | string\|ReactNode | '---' | | | ### DirectoryTree props -| Property | Description | Type | Default | -| --- | --- | --- | --- | -| expandAction | Directory open logic, optional `false` `'click'` `'doubleClick'` | string | click | +| Property | Description | Type | Default | Version | +| --- | --- | --- | --- | --- | +| expandAction | Directory open logic, optional `false` `'click'` `'doubleClick'` | string | click | 3.7.0 | ## Note diff --git a/components/tree/index.zh-CN.md b/components/tree/index.zh-CN.md index 2b6fbe94dd..0eda7a391a 100644 --- a/components/tree/index.zh-CN.md +++ b/components/tree/index.zh-CN.md @@ -13,41 +13,41 @@ subtitle: 树形控件 ### Tree props -| 参数 | 说明 | 类型 | 默认值 | -| --- | --- | --- | --- | -| autoExpandParent | 是否自动展开父节点 | boolean | true | -| blockNode | 是否节点占据一行 | boolean | false | -| checkable | 节点前添加 Checkbox 复选框 | boolean | false | -| checkedKeys | （受控）选中复选框的树节点（注意：父子节点有关联，如果传入父节点 key，则子节点自动选中；相应当子节点 key 都传入，父节点也自动选中。当设置`checkable`和`checkStrictly`，它是一个有`checked`和`halfChecked`属性的对象，并且父子节点的选中与否不再关联 | string\[] \| {checked: string\[], halfChecked: string\[]} | \[] | -| checkStrictly | checkable 状态下节点选择完全受控（父子节点选中状态不再关联） | boolean | false | -| defaultCheckedKeys | 默认选中复选框的树节点 | string\[] | \[] | -| defaultExpandAll | 默认展开所有树节点 | boolean | false | -| defaultExpandedKeys | 默认展开指定的树节点 | string\[] | \[] | -| defaultExpandParent | 默认展开父节点 | bool | true | -| defaultSelectedKeys | 默认选中的树节点 | string\[] | \[] | -| disabled | 将树禁用 | bool | false | -| draggable | 设置节点可拖拽（IE>8） | boolean | false | -| expandedKeys | （受控）展开指定的树节点 | string\[] | \[] | -| filterTreeNode | 按需筛选树节点（高亮），返回 true | function(node) | - | -| loadData | 异步加载数据 | function(node) | - | -| loadedKeys | （受控）已经加载的节点，需要配合 `loadData` 使用 | string\[] | \[] | -| multiple | 支持点选多个节点（节点本身） | boolean | false | -| selectedKeys | （受控）设置选中的树节点 | string\[] | - | -| showIcon | 是否展示 TreeNode title 前的图标，没有默认样式，如设置为 true，需要自行定义图标相关样式 | boolean | false | -| switcherIcon | 自定义树节点的展开/折叠图标 | React.ReactElement | - | -| showLine | 是否展示连接线 | boolean | false | -| onCheck | 点击复选框触发 | function(checkedKeys, e:{checked: bool, checkedNodes, node, event}) | - | -| onDragEnd | dragend 触发时调用 | function({event, node}) | - | -| onDragEnter | dragenter 触发时调用 | function({event, node, expandedKeys}) | - | -| onDragLeave | dragleave 触发时调用 | function({event, node}) | - | -| onDragOver | dragover 触发时调用 | function({event, node}) | - | -| onDragStart | 开始拖拽时调用 | function({event, node}) | - | -| onDrop | drop 触发时调用 | function({event, node, dragNode, dragNodesKeys}) | - | -| onExpand | 展开/收起节点时触发 | function(expandedKeys, {expanded: bool, node}) | - | -| onLoad | 节点加载完毕时触发 | function(loadedKeys, {event, node}) | - | -| onRightClick | 响应右键点击 | function({event, node}) | - | -| onSelect | 点击树节点触发 | function(selectedKeys, e:{selected: bool, selectedNodes, node, event}) | - | -| treeData | treeNodes 数据，如果设置则不需要手动构造 TreeNode 节点（key 在整个树范围内唯一） | array\<{key, title, children, \[disabled, selectable]}> | - | +| 参数 | 说明 | 类型 | 默认值 | 版本 | +| --- | --- | --- | --- | --- | +| autoExpandParent | 是否自动展开父节点 | boolean | true | | +| blockNode | 是否节点占据一行 | boolean | false | 3.15.0 | +| checkable | 节点前添加 Checkbox 复选框 | boolean | false | | +| checkedKeys | （受控）选中复选框的树节点（注意：父子节点有关联，如果传入父节点 key，则子节点自动选中；相应当子节点 key 都传入，父节点也自动选中。当设置`checkable`和`checkStrictly`，它是一个有`checked`和`halfChecked`属性的对象，并且父子节点的选中与否不再关联 | string\[] \| {checked: string\[], halfChecked: string\[]} | \[] | | +| checkStrictly | checkable 状态下节点选择完全受控（父子节点选中状态不再关联） | boolean | false | | +| defaultCheckedKeys | 默认选中复选框的树节点 | string\[] | \[] | | +| defaultExpandAll | 默认展开所有树节点 | boolean | false | | +| defaultExpandedKeys | 默认展开指定的树节点 | string\[] | \[] | | +| defaultExpandParent | 默认展开父节点 | bool | true | 3.4.0 | +| defaultSelectedKeys | 默认选中的树节点 | string\[] | \[] | | +| disabled | 将树禁用 | bool | false | 3.4.0 | +| draggable | 设置节点可拖拽（IE>8） | boolean | false | | +| expandedKeys | （受控）展开指定的树节点 | string\[] | \[] | | +| filterTreeNode | 按需筛选树节点（高亮），返回 true | function(node) | - | | +| loadData | 异步加载数据 | function(node) | - | | +| loadedKeys | （受控）已经加载的节点，需要配合 `loadData` 使用 | string\[] | \[] | 3.7.0 | +| multiple | 支持点选多个节点（节点本身） | boolean | false | | +| selectedKeys | （受控）设置选中的树节点 | string\[] | - | | +| showIcon | 是否展示 TreeNode title 前的图标，没有默认样式，如设置为 true，需要自行定义图标相关样式 | boolean | false | | +| switcherIcon | 自定义树节点的展开/折叠图标 | React.ReactElement | - | 3.12.0 | +| showLine | 是否展示连接线 | boolean | false | | +| onCheck | 点击复选框触发 | function(checkedKeys, e:{checked: bool, checkedNodes, node, event}) | - | | +| onDragEnd | dragend 触发时调用 | function({event, node}) | - | | +| onDragEnter | dragenter 触发时调用 | function({event, node, expandedKeys}) | - | | +| onDragLeave | dragleave 触发时调用 | function({event, node}) | - | | +| onDragOver | dragover 触发时调用 | function({event, node}) | - | | +| onDragStart | 开始拖拽时调用 | function({event, node}) | - | | +| onDrop | drop 触发时调用 | function({event, node, dragNode, dragNodesKeys}) | - | | +| onExpand | 展开/收起节点时触发 | function(expandedKeys, {expanded: bool, node}) | - | | +| onLoad | 节点加载完毕时触发 | function(loadedKeys, {event, node}) | - | 3.7.0 | +| onRightClick | 响应右键点击 | function({event, node}) | - | | +| onSelect | 点击树节点触发 | function(selectedKeys, e:{selected: bool, selectedNodes, node, event}) | - | | +| treeData | treeNodes 数据，如果设置则不需要手动构造 TreeNode 节点（key 在整个树范围内唯一） | array\<{key, title, children, \[disabled, selectable]}> | - | 3.19.8 | ### TreeNode props @@ -56,7 +56,7 @@ subtitle: 树形控件 | checkable | 当树为 checkable 时，设置独立节点是否展示 Checkbox | boolean | - | 3.17.0 | | disableCheckbox | 禁掉 checkbox | boolean | false | | | disabled | 禁掉响应 | boolean | false | | -| icon | 自定义图标。可接收组件，props 为当前节点 props | ReactNode/Function(props):ReactNode | - | | +| icon | 自定义图标。可接收组件，props 为当前节点 props | ReactNode/Function(props):ReactNode | - | 3.4.0 | | isLeaf | 设置为叶子节点(设置了`loadData`时有效) | boolean | false | | | key | 被树的 (default)ExpandedKeys / (default)CheckedKeys / (default)SelectedKeys 属性所用。注意：整个树范围内的所有节点的 key 值不能重复！ | string | 内部计算出的节点位置 | | | selectable | 设置节点是否可被选中 | boolean | true | | @@ -64,9 +64,9 @@ subtitle: 树形控件 ### DirectoryTree props -| 参数 | 说明 | 类型 | 默认值 | -| ------------ | ---------------------------------------------------- | ------ | ------ | -| expandAction | 目录展开逻辑，可选 `false` `'click'` `'doubleClick'` | string | click | +| 参数 | 说明 | 类型 | 默认值 | 版本 | +| ------------ | ---------------------------------------------------- | ------ | ------ | ----- | +| expandAction | 目录展开逻辑，可选 `false` `'click'` `'doubleClick'` | string | click | 3.7.0 | ## 注意 diff --git a/components/typography/index.en-US.md b/components/typography/index.en-US.md index 7959ea74aa..f4468d6649 100644 --- a/components/typography/index.en-US.md +++ b/components/typography/index.en-US.md @@ -16,48 +16,48 @@ Basic text writing, including headings, body text, lists, and more. ### Typography.Text -| Property | Description | Type | Default | -| --- | --- | --- | --- | -| code | code style | boolean | false | -| copyable | Config copy. Can set copy text and callback when is an object | boolean \| { text: string, onCopy: Function } | false | -| delete | delete line style | boolean | false | -| disabled | Disable content | boolean | false | -| editable | Editable. Can control edit state when is object | boolean \| { editing: boolean, onStart: Function, onChange: Function(string) } | false | -| ellipsis | Display ellipsis when overflow | boolean | false | -| mark | mark style | boolean | false | -| underline | underline style | boolean | false | -| onChange | Trigger when user edit the content | Function(string) | - | -| strong | bold style | boolean | false | -| type | Content type | `secondary`, `warning`, `danger` | - | +| Property | Description | Type | Default | Version | +| --- | --- | --- | --- | --- | +| code | code style | boolean | false | 3.15.1 | +| copyable | Config copy. Can set copy text and callback when is an object | boolean \| { text: string, onCopy: Function } | false | 3.14.0 | +| delete | delete line style | boolean | false | 3.14.0 | +| disabled | Disable content | boolean | false | 3.14.0 | +| editable | Editable. Can control edit state when is object | boolean \| { editing: boolean, onStart: Function, onChange: Function(string) } | false | 3.14.0 | +| ellipsis | Display ellipsis when overflow | boolean | false | 3.14.0 | +| mark | mark style | boolean | false | 3.14.0 | +| underline | underline style | boolean | false | 3.14.0 | +| onChange | Trigger when user edit the content | Function(string) | - | 3.14.0 | +| strong | bold style | boolean | false | 3.14.0 | +| type | Content type | `secondary`, `warning`, `danger` | - | 3.14.0 | ### Typography.Title -| Property | Description | Type | Default | -| --- | --- | --- | --- | -| code | code style | boolean | false | -| copyable | Config copy. Can set copy text and callback when is an object | boolean \| { text: string, onCopy: Function } | false | -| delete | delete line style | boolean | false | -| disabled | Disable content | boolean | false | -| editable | Editable. Can control edit state when is object | boolean \| { editing: boolean, onStart: Function, onChange: Function(string) } | false | -| ellipsis | Display ellipsis when overflow. Can config rows and expandable by using object | boolean \| { rows: number, expandable: boolean, onExpand: Function } | false | -| level | Set content importance. Match with `h1`, `h2`, `h3`, `h4` | number: `1`, `2`, `3`, `4` | 1 | -| mark | mark style | boolean | false | -| underline | underline style | boolean | false | -| onChange | Trigger when user edit the content | Function(string) | - | -| type | Content type | `secondary`, `warning`, `danger` | - | +| Property | Description | Type | Default | Version | +| --- | --- | --- | --- | --- | +| code | code style | boolean | false | 3.15.1 | +| copyable | Config copy. Can set copy text and callback when is an object | boolean \| { text: string, onCopy: Function } | false | 3.14.0 | +| delete | delete line style | boolean | false | 3.14.0 | +| disabled | Disable content | boolean | false | 3.14.0 | +| editable | Editable. Can control edit state when is object | boolean \| { editing: boolean, onStart: Function, onChange: Function(string) } | false | 3.14.0 | +| ellipsis | Display ellipsis when overflow. Can config rows and expandable by using object | boolean \| { rows: number, expandable: boolean, onExpand: Function } | false | 3.14.0 | +| level | Set content importance. Match with `h1`, `h2`, `h3`, `h4` | number: `1`, `2`, `3`, `4` | 1 | 3.14.0 | +| mark | mark style | boolean | false | 3.14.0 | +| underline | underline style | boolean | false | 3.14.0 | +| onChange | Trigger when user edit the content | Function(string) | - | 3.14.0 | +| type | Content type | `secondary`, `warning`, `danger` | - | 3.14.0 | ### Typography.Paragraph -| Property | Description | Type | Default | -| --- | --- | --- | --- | -| code | code style | boolean | false | -| copyable | Config copy. Can set copy text and callback when is an object | boolean \| { text: string, onCopy: Function } | false | -| delete | delete line style | boolean | false | -| disabled | Disable content | boolean | false | -| editable | Editable. Can control edit state when is object | boolean \| { editing: boolean, onStart: Function, onChange: Function(string) } | false | -| ellipsis | Display ellipsis when overflow. Can config rows and expandable by using object | boolean \| { rows: number, expandable: boolean, onExpand: Function } | false | -| mark | mark style | boolean | false | -| underline | underline style | boolean | false | -| onChange | Trigger when user edit the content | Function(string) | - | -| strong | bold style | boolean | false | -| type | Content type | `secondary`, `warning`, `danger` | - | +| Property | Description | Type | Default | Version | +| --- | --- | --- | --- | --- | +| code | code style | boolean | false | 3.15.1 | +| copyable | Config copy. Can set copy text and callback when is an object | boolean \| { text: string, onCopy: Function } | false | 3.14.0 | +| delete | delete line style | boolean | false | 3.14.0 | +| disabled | Disable content | boolean | false | 3.14.0 | +| editable | Editable. Can control edit state when is object | boolean \| { editing: boolean, onStart: Function, onChange: Function(string) } | false | 3.14.0 | +| ellipsis | Display ellipsis when overflow. Can config rows and expandable by using object | boolean \| { rows: number, expandable: boolean, onExpand: Function } | false | 3.14.0 | +| mark | mark style | boolean | false | 3.14.0 | +| underline | underline style | boolean | false | 3.14.0 | +| onChange | Trigger when user edit the content | Function(string) | - | 3.14.0 | +| strong | bold style | boolean | false | 3.14.0 | +| type | Content type | `secondary`, `warning`, `danger` | - | 3.14.0 | diff --git a/components/typography/index.zh-CN.md b/components/typography/index.zh-CN.md index 17a4942e21..a3fdbbabdc 100644 --- a/components/typography/index.zh-CN.md +++ b/components/typography/index.zh-CN.md @@ -17,44 +17,44 @@ cols: 1 ### Typography.Text -| 参数 | 说明 | 类型 | 默认值 | -| --- | --- | --- | --- | -| copyable | 是否可拷贝，为对象时可设置复制文本以回调函数 | boolean \| { text: string, onCopy: Function } | false | -| delete | 添加删除线样式 | boolean | false | -| disabled | 禁用文本 | boolean | false | -| editable | 是否可编辑，为对象时可对编辑进行控制 | boolean \| { editing: boolean, onStart: Function, onChange: Function(string) } | false | -| ellipsis | 设置自动溢出省略 | boolean | false | -| mark | 添加标记样式 | boolean | false | -| underline | 添加下划线样式 | boolean | false | -| strong | 是否加粗 | boolean | false | -| type | 文本类型 | `secondary`, `warning`, `danger` | - | +| 参数 | 说明 | 类型 | 默认值 | 版本 | +| --- | --- | --- | --- | --- | +| copyable | 是否可拷贝，为对象时可设置复制文本以回调函数 | boolean \| { text: string, onCopy: Function } | false | 3.14.0 | +| delete | 添加删除线样式 | boolean | false | 3.14.0 | +| disabled | 禁用文本 | boolean | false | 3.14.0 | +| editable | 是否可编辑，为对象时可对编辑进行控制 | boolean \| { editing: boolean, onStart: Function, onChange: Function(string) } | false | 3.14.0 | +| ellipsis | 设置自动溢出省略 | boolean | false | 3.14.0 | +| mark | 添加标记样式 | boolean | false | 3.14.0 | +| underline | 添加下划线样式 | boolean | false | 3.14.0 | +| strong | 是否加粗 | boolean | false | 3.14.0 | +| type | 文本类型 | `secondary`, `warning`, `danger` | - | 3.14.0 | ### Typography.Title -| 参数 | 说明 | 类型 | 默认值 | -| --- | --- | --- | --- | -| copyable | 是否可拷贝，为对象时可设置复制文本以回调函数 | boolean \| { text: string, onCopy: Function } | false | -| delete | 添加删除线样式 | boolean | false | -| disabled | 禁用文本 | boolean | false | -| editable | 是否可编辑，为对象时可对编辑进行控制 | boolean \| { editing: boolean, onStart: Function, onChange: Function(string) } | false | -| ellipsis | 自动溢出省略，为对象时可设置省略行数与是否可展开等 | boolean \| { rows: number, expandable: boolean, onExpand: Function } | false | -| level | 重要程度，相当于 `h1`、`h2`、`h3`、`h4` | number: `1`, `2`, `3`, `4` | 1 | -| mark | 添加标记样式 | boolean | false | -| underline | 添加下划线样式 | boolean | false | -| onChange | 当用户提交编辑内容时触发 | Function(string) | - | -| type | 文本类型 | `secondary`, `warning`, `danger` | - | +| 参数 | 说明 | 类型 | 默认值 | 版本 | +| --- | --- | --- | --- | --- | +| copyable | 是否可拷贝，为对象时可设置复制文本以回调函数 | boolean \| { text: string, onCopy: Function } | false | 3.14.0 | +| delete | 添加删除线样式 | boolean | false | 3.14.0 | +| disabled | 禁用文本 | boolean | false | 3.14.0 | +| editable | 是否可编辑，为对象时可对编辑进行控制 | boolean \| { editing: boolean, onStart: Function, onChange: Function(string) } | false | 3.14.0 | +| ellipsis | 自动溢出省略，为对象时可设置省略行数与是否可展开等 | boolean \| { rows: number, expandable: boolean, onExpand: Function } | false | 3.14.0 | +| level | 重要程度，相当于 `h1`、`h2`、`h3`、`h4` | number: `1`, `2`, `3`, `4` | 1 | 3.14.0 | +| mark | 添加标记样式 | boolean | false | 3.14.0 | +| underline | 添加下划线样式 | boolean | false | 3.14.0 | +| onChange | 当用户提交编辑内容时触发 | Function(string) | - | 3.14.0 | +| type | 文本类型 | `secondary`, `warning`, `danger` | - | 3.14.0 | ### Typography.Paragraph -| 参数 | 说明 | 类型 | 默认值 | -| --- | --- | --- | --- | -| copyable | 是否可拷贝，为对象时可设置复制文本以回调函数 | boolean \| { text: string, onCopy: Function } | false | -| delete | 添加删除线样式 | boolean | false | -| disabled | 禁用文本 | boolean | false | -| editable | 是否可编辑，为对象时可对编辑进行控制 | boolean \| { editing: boolean, onStart: Function, onChange: Function(string) } | false | -| ellipsis | 自动溢出省略，为对象时可设置省略行数与是否可展开等 | boolean \| { rows: number, expandable: boolean, onExpand: Function } | false | -| mark | 添加标记样式 | boolean | false | -| underline | 添加下划线样式 | boolean | false | -| onChange | 当用户提交编辑内容时触发 | Function(string) | - | -| strong | 是否加粗 | boolean | false | -| type | 文本类型 | `secondary`, `warning`, `danger` | - | +| 参数 | 说明 | 类型 | 默认值 | 版本 | +| --- | --- | --- | --- | --- | +| copyable | 是否可拷贝，为对象时可设置复制文本以回调函数 | boolean \| { text: string, onCopy: Function } | false | 3.14.1 | +| delete | 添加删除线样式 | boolean | false | 3.14.0 | +| disabled | 禁用文本 | boolean | false | 3.14.0 | +| editable | 是否可编辑，为对象时可对编辑进行控制 | boolean \| { editing: boolean, onStart: Function, onChange: Function(string) } | false | 3.14.0 | +| ellipsis | 自动溢出省略，为对象时可设置省略行数与是否可展开等 | boolean \| { rows: number, expandable: boolean, onExpand: Function } | false | 3.14.0 | +| mark | 添加标记样式 | boolean | false | 3.14.0 | +| underline | 添加下划线样式 | boolean | false | 3.14.0 | +| onChange | 当用户提交编辑内容时触发 | Function(string) | - | 3.14.0 | +| strong | 是否加粗 | boolean | false | 3.14.0 | +| type | 文本类型 | `secondary`, `warning`, `danger` | - | 3.14.0 | diff --git a/components/upload/index.en-US.md b/components/upload/index.en-US.md index 7db0f558f9..6e6c611d17 100644 --- a/components/upload/index.en-US.md +++ b/components/upload/index.en-US.md @@ -20,7 +20,7 @@ Uploading is the process of publishing information (web pages, text, pictures, v | --- | --- | --- | --- | --- | | accept | File types that can be accepted. See [input accept Attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/file#accept) | string | - | | | action | Uploading URL | string\|(file) => `Promise` | - | | -| directory | support upload whole directory ([caniuse](https://caniuse.com/#feat=input-file-directory)) | boolean | false | | +| directory | support upload whole directory ([caniuse](https://caniuse.com/#feat=input-file-directory)) | boolean | false | 3.7.0 | | beforeUpload | Hook function which will be executed before uploading. Uploading will be stopped with `false` or a rejected Promise returned. **Warning：this function is not supported in IE9**。 | (file, fileList) => `boolean | Promise` | - | | | customRequest | override for the default xhr behavior allowing for additional customization and ability to implement your own XMLHttpRequest | Function | - | | | data | Uploading params or function which can return uploading params. | object\|function(file) | - | | @@ -35,7 +35,7 @@ Uploading is the process of publishing information (web pages, text, pictures, v | showUploadList | Whether to show default upload list, could be an object to specify `showPreviewIcon` and `showRemoveIcon` individually | Boolean or { showPreviewIcon?: boolean, showRemoveIcon?: boolean } | true | | | supportServerRender | Need to be turned on while the server side is rendering | boolean | false | | | withCredentials | ajax upload with cookie sent | boolean | false | | -| openFileDialogOnClick | click open file dialog | boolean | true | | +| openFileDialogOnClick | click open file dialog | boolean | true | 3.10.0 | | onChange | A callback function, can be executed when uploading state is changing, see [onChange](#onChange) | Function | - | | | onPreview | A callback function, will be executed when file link or preview icon is clicked | Function(file) | - | | | onRemove | A callback function, will be executed when removing file button is clicked, remove event will be prevented when return value is `false` or a Promise which resolve(false) or reject | Function(file): `boolean | Promise` | - | | diff --git a/components/upload/index.zh-CN.md b/components/upload/index.zh-CN.md index eb56239eba..29daed3c02 100644 --- a/components/upload/index.zh-CN.md +++ b/components/upload/index.zh-CN.md @@ -21,7 +21,7 @@ title: Upload | --- | --- | --- | --- | --- | | accept | 接受上传的文件类型, 详见 [input accept Attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/file#accept) | string | 无 | | | action | 上传的地址 | string\|(file) => `Promise` | 无 | | -| directory | 支持上传文件夹（[caniuse](https://caniuse.com/#feat=input-file-directory)） | boolean | false | | +| directory | 支持上传文件夹（[caniuse](https://caniuse.com/#feat=input-file-directory)） | boolean | false | 3.7.0 | | beforeUpload | 上传文件之前的钩子，参数为上传的文件，若返回 `false` 则停止上传。支持返回一个 Promise 对象，Promise 对象 reject 时则停止上传，resolve 时开始上传（ resolve 传入 `File` 或 `Blob` 对象则上传 resolve 传入对象）。**注意：IE9 不支持该方法**。 | (file, fileList) => `boolean | Promise` | 无 | | | customRequest | 通过覆盖默认的上传行为，可以自定义自己的上传实现 | Function | 无 | | | data | 上传所需参数或返回上传参数的方法 | object\|(file) => object | 无 | | @@ -36,7 +36,7 @@ title: Upload | showUploadList | 是否展示文件列表, 可设为一个对象，用于单独设定 `showPreviewIcon` 和 `showRemoveIcon` | Boolean or { showPreviewIcon?: boolean, showRemoveIcon?: boolean } | true | | | supportServerRender | 服务端渲染时需要打开这个 | boolean | false | | | withCredentials | 上传请求时是否携带 cookie | boolean | false | | -| openFileDialogOnClick | 点击打开文件对话框 | boolean | true | | +| openFileDialogOnClick | 点击打开文件对话框 | boolean | true | 3.10.0 | | onChange | 上传文件改变时的状态，详见 [onChange](#onChange) | Function | 无 | | | onPreview | 点击文件链接或预览图标时的回调 | Function(file) | 无 | | | onRemove   | 点击移除文件时的回调，返回值为 false 时不移除。支持返回一个 Promise 对象，Promise 对象 resolve(false) 或 reject 时不移除。               | Function(file): `boolean | Promise` | 无   | |