2016-03-31 14:17:09 +08:00
|
|
|
|
---
|
|
|
|
|
category: Components
|
2018-11-04 16:20:35 +08:00
|
|
|
|
type: 数据录入
|
2016-09-01 11:08:41 +08:00
|
|
|
|
title: Cascader
|
|
|
|
|
subtitle: 级联选择
|
2020-06-05 13:50:09 +08:00
|
|
|
|
cover: https://gw.alipayobjects.com/zos/alicdn/UdS8y8xyZ/Cascader.svg
|
2016-03-31 14:17:09 +08:00
|
|
|
|
---
|
2015-12-29 11:46:13 +08:00
|
|
|
|
|
|
|
|
|
级联选择框。
|
|
|
|
|
|
|
|
|
|
## 何时使用
|
|
|
|
|
|
2015-12-29 18:24:21 +08:00
|
|
|
|
- 需要从一组相关联的数据集合进行选择,例如省市区,公司层级,事物分类等。
|
|
|
|
|
- 从一个较大的数据集合中进行选择时,用多级分类进行分隔,方便选择。
|
|
|
|
|
- 比起 Select 组件,可以在同一个浮层中完成选择,有较好的体验。
|
2015-12-29 11:46:13 +08:00
|
|
|
|
|
|
|
|
|
## API
|
|
|
|
|
|
2019-07-09 19:10:36 +08:00
|
|
|
|
```jsx
|
|
|
|
|
<Cascader options={options} onChange={onChange} />
|
2015-12-29 18:24:21 +08:00
|
|
|
|
```
|
|
|
|
|
|
2019-07-11 14:14:33 +08:00
|
|
|
|
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|
|
|
|
|
| --- | --- | --- | --- | --- |
|
|
|
|
|
| allowClear | 是否支持清除 | boolean | true | |
|
|
|
|
|
| autoFocus | 自动获取焦点 | boolean | false | |
|
2020-02-06 10:02:02 +08:00
|
|
|
|
| bordered | 是否有边框 | boolean | true | |
|
2021-11-17 11:06:30 +08:00
|
|
|
|
| changeOnSelect | (单选时生效)当此项为 true 时,点选每级菜单选项值都会发生变化,具体见上面的演示 | boolean | false | |
|
2019-07-11 14:14:33 +08:00
|
|
|
|
| className | 自定义类名 | string | - | |
|
2020-05-18 19:58:46 +08:00
|
|
|
|
| defaultValue | 默认的选中项 | string\[] \| number\[] | \[] | |
|
2019-07-11 14:14:33 +08:00
|
|
|
|
| disabled | 禁用 | boolean | false | |
|
2022-02-18 15:02:26 +08:00
|
|
|
|
| displayRender | 选择后展示的渲染函数 | (label, selectedOptions) => ReactNode | label => label.join(`/`) | `multiple`: 4.18.0 |
|
2021-09-13 15:59:57 +08:00
|
|
|
|
| dropdownClassName | 自定义浮层类名 | string | - | 4.17.0 |
|
2020-10-21 10:33:43 +08:00
|
|
|
|
| dropdownRender | 自定义下拉框内容 | (menus: ReactNode) => ReactNode | - | 4.4.0 |
|
2020-06-28 22:41:59 +08:00
|
|
|
|
| expandIcon | 自定义次级菜单展开图标 | ReactNode | - | 4.4.0 |
|
2020-10-21 10:33:43 +08:00
|
|
|
|
| expandTrigger | 次级菜单的展开方式,可选 'click' 和 'hover' | string | `click` | |
|
2021-12-22 17:22:15 +08:00
|
|
|
|
| fieldNames | 自定义 options 中 label value children 的字段 | object | { label: `label`, value: `value`, children: `children` } | |
|
2020-06-30 16:36:58 +08:00
|
|
|
|
| getPopupContainer | 菜单渲染父节点。默认渲染到 body 上,如果你遇到菜单滚动定位问题,试试修改为滚动的区域,并相对其定位。[示例](https://codepen.io/afc163/pen/zEjNOy?editors=0010) | function(triggerNode) | () => document.body | |
|
|
|
|
|
| loadData | 用于动态加载选项,无法与 `showSearch` 一起使用 | (selectedOptions) => void | - | |
|
2021-09-27 18:16:50 +08:00
|
|
|
|
| maxTagCount | 最多显示多少个 tag,响应式模式会对性能产生损耗 | number \| `responsive` | - | 4.17.0 |
|
|
|
|
|
| maxTagPlaceholder | 隐藏 tag 时显示的内容 | ReactNode \| function(omittedValues) | - | 4.17.0 |
|
2020-06-17 23:18:14 +08:00
|
|
|
|
| notFoundContent | 当下拉列表为空时显示的内容 | string | `Not Found` | |
|
2021-08-31 15:51:02 +08:00
|
|
|
|
| open | 控制浮层显隐 | boolean | - | 4.17.0 |
|
2020-10-21 10:33:43 +08:00
|
|
|
|
| options | 可选项数据源 | [Option](#Option)\[] | - | |
|
2020-06-30 16:36:58 +08:00
|
|
|
|
| placeholder | 输入框占位文本 | string | `请选择` | |
|
2022-01-30 15:21:41 +08:00
|
|
|
|
| placement | 浮层预设位置:`bottomLeft` `bottomRight` `topLeft` `topRight` | string | `bottomLeft` | 4.17.0 |
|
2020-11-11 17:05:04 +08:00
|
|
|
|
| showSearch | 在选择框中显示搜索框 | boolean \| [Object](#showSearch) | false | |
|
2020-06-17 23:18:14 +08:00
|
|
|
|
| size | 输入框大小 | `large` \| `middle` \| `small` | - | |
|
2020-04-28 14:09:54 +08:00
|
|
|
|
| style | 自定义样式 | CSSProperties | - | |
|
2019-11-20 14:53:43 +08:00
|
|
|
|
| suffixIcon | 自定义的选择框后缀图标 | ReactNode | - | |
|
2021-09-27 18:16:50 +08:00
|
|
|
|
| tagRender | 自定义 tag 内容,多选时生效 | (props) => ReactNode | - | 4.17.0 |
|
2020-05-18 19:58:46 +08:00
|
|
|
|
| value | 指定选中项 | string\[] \| number\[] | - | |
|
2020-06-30 16:36:58 +08:00
|
|
|
|
| onChange | 选择完成后的回调 | (value, selectedOptions) => void | - | |
|
2021-08-31 15:51:02 +08:00
|
|
|
|
| onDropdownVisibleChange | 显示/隐藏浮层的回调 | (value) => void | - | 4.17.0 |
|
2021-09-30 11:02:12 +08:00
|
|
|
|
| multiple | 支持多选节点 | boolean | - | 4.17.0 |
|
2021-12-30 11:38:48 +08:00
|
|
|
|
| searchValue | 设置搜索的值,需要与 `showSearch` 配合使用 | string | - | 4.17.0 |
|
|
|
|
|
| onSearch | 监听搜索,返回输入的值 | (search: string) => void | - | 4.17.0 |
|
2021-09-25 16:59:51 +08:00
|
|
|
|
| dropdownMenuColumnStyle | 下拉菜单列的样式 | CSSProperties | - | |
|
2016-09-01 11:08:41 +08:00
|
|
|
|
|
2020-11-11 17:05:04 +08:00
|
|
|
|
### showSearch
|
|
|
|
|
|
2016-09-01 11:08:41 +08:00
|
|
|
|
`showSearch` 为对象时,其中的字段:
|
|
|
|
|
|
2019-07-11 14:14:33 +08:00
|
|
|
|
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|
|
|
|
|
| --- | --- | --- | --- | --- |
|
2020-06-30 16:36:58 +08:00
|
|
|
|
| filter | 接收 `inputValue` `path` 两个参数,当 `path` 符合筛选条件时,应返回 true,反之则返回 false | function(inputValue, path): boolean | - | |
|
2019-11-20 14:53:43 +08:00
|
|
|
|
| limit | 搜索结果展示数量 | number \| false | 50 | |
|
2020-07-23 17:51:00 +08:00
|
|
|
|
| matchInputWidth | 搜索结果列表是否与输入框同宽([效果](https://github.com/ant-design/ant-design/issues/25779)) | boolean | true | |
|
2020-06-30 16:36:58 +08:00
|
|
|
|
| render | 用于渲染 filter 后的选项 | function(inputValue, path): ReactNode | - | |
|
|
|
|
|
| sort | 用于排序 filter 后的选项 | function(a, b, inputValue) | - | |
|
2016-09-30 13:37:36 +08:00
|
|
|
|
|
2019-07-09 19:10:36 +08:00
|
|
|
|
### Option
|
|
|
|
|
|
|
|
|
|
```typescript
|
|
|
|
|
interface Option {
|
2020-05-18 19:38:36 +08:00
|
|
|
|
value: string | number;
|
2019-07-09 19:10:36 +08:00
|
|
|
|
label?: React.ReactNode;
|
|
|
|
|
disabled?: boolean;
|
|
|
|
|
children?: Option[];
|
2022-02-24 10:53:51 +08:00
|
|
|
|
// 标记是否为叶子节点,设置了 `loadData` 时有效
|
|
|
|
|
// 设为 `false` 时会强制标记为父节点,即使当前节点没有 children,也会显示展开图标
|
|
|
|
|
isLeaf?: boolean;
|
2019-07-09 19:10:36 +08:00
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
2017-12-01 19:28:41 +08:00
|
|
|
|
## 方法
|
|
|
|
|
|
2021-09-13 15:59:57 +08:00
|
|
|
|
| 名称 | 描述 | 版本 |
|
|
|
|
|
| ------- | -------- | ---- |
|
|
|
|
|
| blur() | 移除焦点 | |
|
|
|
|
|
| focus() | 获取焦点 | |
|
2017-12-01 19:28:41 +08:00
|
|
|
|
|
2017-03-09 20:19:18 +08:00
|
|
|
|
> 注意,如果需要获得中国省市区数据,可以参考 [china-division](https://gist.github.com/afc163/7582f35654fd03d5be7009444345ea17)。
|