From 6b71c3b7fa0065d6d288a9d3e189ec7cabc58bcc Mon Sep 17 00:00:00 2001 From: EmilyyyLiu <100924403+EmilyyyLiu@users.noreply.github.com> Date: Thu, 3 Apr 2025 11:45:17 +0800 Subject: [PATCH] docs: document the open and defaultOpen props for TreeSelect/Cascader/DatePicker (#53356) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * doc: treeSelect,cascader,datePicker添加open/defaultOpen属性的支持描述 * feat: 调整描述在表格内的位置 --------- Co-authored-by: 刘欢 --- components/cascader/index.en-US.md | 1 + components/cascader/index.zh-CN.md | 1 + components/date-picker/index.en-US.md | 1 + components/date-picker/index.zh-CN.md | 1 + components/tree-select/index.en-US.md | 2 ++ components/tree-select/index.zh-CN.md | 2 ++ 6 files changed, 8 insertions(+) diff --git a/components/cascader/index.en-US.md b/components/cascader/index.en-US.md index 76b5429877..ccff69cc19 100644 --- a/components/cascader/index.en-US.md +++ b/components/cascader/index.en-US.md @@ -55,6 +55,7 @@ Common props ref：[Common props](/docs/react/common-props) | autoFocus | If 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 | The additional css class | string | - | | +| defaultOpen | Initial visible of cascader popup | boolean | - | | | defaultValue | Initial selected value | string\[] \| number\[] | \[] | | | disabled | Whether disabled select | boolean | false | | | displayRender | The render function of displaying selected options | (label, selectedOptions) => ReactNode | label => label.join(`/`) | `multiple`: 4.18.0 | diff --git a/components/cascader/index.zh-CN.md b/components/cascader/index.zh-CN.md index 64cabf98e3..9df657c093 100644 --- a/components/cascader/index.zh-CN.md +++ b/components/cascader/index.zh-CN.md @@ -56,6 +56,7 @@ demo: | autoFocus | 自动获取焦点 | boolean | false | | | changeOnSelect | 单选时生效（multiple 下始终都可以选择），点选每级菜单选项值都会发生变化。 | boolean | false | | | className | 自定义类名 | string | - | | +| defaultOpen | 是否默认展示浮层 | boolean | - | | | defaultValue | 默认的选中项 | string\[] \| number\[] | \[] | | | disabled | 禁用 | boolean | false | | | displayRender | 选择后展示的渲染函数 | (label, selectedOptions) => ReactNode | label => label.join(`/`) | `multiple`: 4.18.0 | diff --git a/components/date-picker/index.en-US.md b/components/date-picker/index.en-US.md index c535ca9426..98ae3a9b23 100644 --- a/components/date-picker/index.en-US.md +++ b/components/date-picker/index.en-US.md @@ -97,6 +97,7 @@ The following APIs are shared by DatePicker, RangePicker. | dateRender | Custom rendering function for date cells, >= 5.4.0 use `cellRender` instead. | function(currentDate: dayjs, today: dayjs) => React.ReactNode | - | < 5.4.0 | | cellRender | Custom rendering function for picker cells | (current: dayjs, info: { originNode: React.ReactElement,today: DateType, range?: 'start' \| 'end', type: PanelMode, locale?: Locale, subType?: 'hour' \| 'minute' \| 'second' \| 'meridiem' }) => React.ReactNode | - | 5.4.0 | | components | Custom panels | Record | - | 5.14.0 | +| defaultOpen | Initial open state of picker | boolean | - | | | disabled | Determine whether the DatePicker is disabled | boolean | false | | | disabledDate | Specify the date that cannot be selected | (currentDate: dayjs, info: { from?: dayjs, type: Picker }) => boolean | - | `info`: 5.14.0 | | format | To set the date format, support multi-format matching when it is an array, display the first one shall prevail. refer to [dayjs#format](https://day.js.org/docs/en/display/format). for example: [Custom Format](#date-picker-demo-format) | [formatType](#formattype) | [rc-picker](https://github.com/react-component/picker/blob/f512f18ed59d6791280d1c3d7d37abbb9867eb0b/src/utils/uiUtil.ts#L155-L177) | | diff --git a/components/date-picker/index.zh-CN.md b/components/date-picker/index.zh-CN.md index 17f1f32583..87affb963e 100644 --- a/components/date-picker/index.zh-CN.md +++ b/components/date-picker/index.zh-CN.md @@ -98,6 +98,7 @@ dayjs.locale('zh-cn'); | dateRender | 自定义日期单元格的内容，5.4.0 起用 `cellRender` 代替 | function(currentDate: dayjs, today: dayjs) => React.ReactNode | - | < 5.4.0 | | cellRender | 自定义单元格的内容 | (current: dayjs, info: { originNode: React.ReactElement,today: DateType, range?: 'start' \| 'end', type: PanelMode, locale?: Locale, subType?: 'hour' \| 'minute' \| 'second' \| 'meridiem' }) => React.ReactNode | - | 5.4.0 | | components | 自定义面板 | Record | - | 5.14.0 | +| defaultOpen | 是否默认展开控制弹层 | boolean | - | | | disabled | 禁用 | boolean | false | | | disabledDate | 不可选择的日期 | (currentDate: dayjs, info: { from?: dayjs, type: Picker }) => boolean | - | `info`: 5.14.0 | | format | 设置日期格式，为数组时支持多格式匹配，展示以第一个为准。配置参考 [dayjs#format](https://day.js.org/docs/zh-CN/display/format#%E6%94%AF%E6%8C%81%E7%9A%84%E6%A0%BC%E5%BC%8F%E5%8C%96%E5%8D%A0%E4%BD%8D%E7%AC%A6%E5%88%97%E8%A1%A8)。示例：[自定义格式](#date-picker-demo-format) | [formatType](#formattype) | [rc-picker](https://github.com/react-component/picker/blob/f512f18ed59d6791280d1c3d7d37abbb9867eb0b/src/utils/uiUtil.ts#L155-L177) | | diff --git a/components/tree-select/index.en-US.md b/components/tree-select/index.en-US.md index 0b9abc8281..6931f43e6a 100644 --- a/components/tree-select/index.en-US.md +++ b/components/tree-select/index.en-US.md @@ -40,6 +40,7 @@ Common props ref：[Common props](/docs/react/common-props) | --- | --- | --- | --- | --- | | allowClear | Customize clear icon | boolean \| { clearIcon?: ReactNode } | false | 5.8.0: Support object type | | autoClearSearchValue | If auto clear search input value when multiple select is selected/deselected | boolean | true | | +| defaultOpen | Initial open state of dropdown | boolean | - | | | defaultValue | To set the initial selected treeNode(s) | string \| string\[] | - | | | disabled | Disabled or not | boolean | false | | | popupClassName | The className of dropdown menu | string | - | 4.23.0 | @@ -58,6 +59,7 @@ Common props ref：[Common props](/docs/react/common-props) | maxTagTextLength | Max tag text length to show | number | - | | | multiple | Support multiple or not, will be `true` when enable `treeCheckable` | boolean | false | | | notFoundContent | Specify content to show when no result matches | ReactNode | `Not Found` | | +| open | Controlled open state of dropdown | boolean | - | | | placeholder | Placeholder of the select input | string | - | | | placement | The position where the selection box pops up | `bottomLeft` `bottomRight` `topLeft` `topRight` | bottomLeft | | | prefix | The custom prefix | ReactNode | - | 5.22.0 | diff --git a/components/tree-select/index.zh-CN.md b/components/tree-select/index.zh-CN.md index 1c3eea7182..0822c75317 100644 --- a/components/tree-select/index.zh-CN.md +++ b/components/tree-select/index.zh-CN.md @@ -41,6 +41,7 @@ demo: | --- | --- | --- | --- | --- | | allowClear | 自定义清除按钮 | boolean \| { clearIcon?: ReactNode } | false | 5.8.0: 支持对象形式 | | autoClearSearchValue | 当多选模式下值被选择，自动清空搜索框 | boolean | true | | +| defaultOpen | 是否默认展开下拉菜单 | boolean | - | | | defaultValue | 指定默认选中的条目 | string \| string\[] | - | | | disabled | 是否禁用 | boolean | false | | | popupClassName | 下拉菜单的 className 属性 | string | - | 4.23.0 | @@ -59,6 +60,7 @@ demo: | maxTagTextLength | 最大显示的 tag 文本长度 | number | - | | | multiple | 支持多选（当设置 treeCheckable 时自动变为 true） | boolean | false | | | notFoundContent | 当下拉列表为空时显示的内容 | ReactNode | `Not Found` | | +| open | 是否展开下拉菜单 | boolean | - | | | placeholder | 选择框默认文字 | string | - | | | placement | 选择框弹出的位置 | `bottomLeft` `bottomRight` `topLeft` `topRight` | bottomLeft | | | prefix | 自定义前缀 | ReactNode | - | 5.22.0 |