Browse Source
docs(components:Cascader): supplement the API documentation (#34466)
* docs(components:Cascader): supplement the API documentation
* docs(Cascader:en-US): supplement the API documentation
pull/34482/head
EvanOne（文一）
3 years ago
committed by
GitHub
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with
4 additions and
0 deletions
-
components/cascader/index.en-US.md
-
components/cascader/index.zh-CN.md
|
|
|
@ -24,6 +24,7 @@ Cascade selection box. |
|
|
|
| allowClear | Whether allow clear | boolean | true | | |
|
|
|
| autoFocus | If get focus when component mounted | boolean | false | | |
|
|
|
| bordered | Whether has border style | boolean | true | | |
|
|
|
| clearIcon | The custom clear icon | ReactNode | - | | |
|
|
|
| changeOnSelect | (Work on single select) Change value on each selection if set to true, see above demo for details | boolean | false | | |
|
|
|
| className | The additional css class | string | - | | |
|
|
|
| defaultValue | Initial selected value | string\[] \| number\[] | \[] | | |
|
|
|
@ -53,6 +54,7 @@ Cascade selection box. |
|
|
|
| onChange | Callback when finishing cascader select | (value, selectedOptions) => void | - | | |
|
|
|
| onDropdownVisibleChange | Callback when popup shown or hidden | (value) => void | - | 4.17.0 | |
|
|
|
| multiple | Support multiple or not | boolean | - | 4.17.0 | |
|
|
|
| removeIcon | The custom remove icon | ReactNode | - | | |
|
|
|
| searchValue | Set search value，Need work with `showSearch` | string | - | 4.17.0 | |
|
|
|
| onSearch | The callback function triggered when input changed | (search: string) => void | - | 4.17.0 | |
|
|
|
| dropdownMenuColumnStyle | The style of the drop-down menu column | CSSProperties | - | | |
|
|
|
|
|
|
|
@ -25,6 +25,7 @@ cover: https://gw.alipayobjects.com/zos/alicdn/UdS8y8xyZ/Cascader.svg |
|
|
|
| allowClear | 是否支持清除 | boolean | true | | |
|
|
|
| autoFocus | 自动获取焦点 | boolean | false | | |
|
|
|
| bordered | 是否有边框 | boolean | true | | |
|
|
|
| clearIcon | 自定义的选择框清空图标 | ReactNode | - | | |
|
|
|
| changeOnSelect | （单选时生效）当此项为 true 时，点选每级菜单选项值都会发生变化，具体见上面的演示 | boolean | false | | |
|
|
|
| className | 自定义类名 | string | - | | |
|
|
|
| defaultValue | 默认的选中项 | string\[] \| number\[] | \[] | | |
|
|
|
@ -54,6 +55,7 @@ cover: https://gw.alipayobjects.com/zos/alicdn/UdS8y8xyZ/Cascader.svg |
|
|
|
| onChange | 选择完成后的回调 | (value, selectedOptions) => void | - | | |
|
|
|
| onDropdownVisibleChange | 显示/隐藏浮层的回调 | (value) => void | - | 4.17.0 | |
|
|
|
| multiple | 支持多选节点 | boolean | - | 4.17.0 | |
|
|
|
| removeIcon | 自定义的多选框清除图标 | ReactNode | - | | |
|
|
|
| searchValue | 设置搜索的值，需要与 `showSearch` 配合使用 | string | - | 4.17.0 | |
|
|
|
| onSearch | 监听搜索，返回输入的值 | (search: string) => void | - | 4.17.0 | |
|
|
|
| dropdownMenuColumnStyle | 下拉菜单列的样式 | CSSProperties | - | | |
|
|
|
|
