级联选择
级联选择框。
何时使用
- 需要从一组相关联的数据集合进行选择,例如省市区,公司层级,事物分类等。
- 从一个较大的数据集合中进行选择时,用多级分类进行分隔,方便选择。
- 比起 Select 组件,可以在同一个浮层中完成选择,有较好的体验。
代码演示
- 基本 ·
basic - 默认值 ·
default-value - 可以自定义显示 ·
custom-trigger - 移入展开 ·
hover - 禁用选项 ·
disabled-option - 选择即改变 ·
change-on-select - 多选 ·
multiple - 自定义回填方式 ·
showCheckedStrategy - 大小 ·
size - 自定义已选项 ·
custom-render - 搜索 ·
search - 动态加载选项 ·
lazy - 自定义字段名 ·
fields-name - 前后缀 ·
suffix - 扩展菜单 ·
custom-dropdown - 弹出位置 ·
placement - 形态变体 ·
variant - 自定义状态 ·
status - 自定义语义结构的样式和类 ·
style-class - 面板使用 ·
panel
API
通用属性参考:通用属性
<Cascader options={options} onChange={onChange} />
| 参数 | 说明 | 类型 | 默认值 | 版本 | 全局配置 |
|---|---|---|---|---|---|
| allowClear | 支持清除 | boolean | { clearIcon?: ReactNode } | true | 5.8.0: 支持对象形式 | clearIcon: 6.4.0 |
是否在选中项后清空搜索框,只在 multiple 为 true 时有效 | boolean | true | 5.9.0 | × | |
是否带边框,请使用 variant 替代 | boolean | true | - | × | |
| changeOnSelect | 单选时生效(multiple 下始终都可以选择),点选每级菜单选项值都会发生变化。 | boolean | false | × | |
| classNames | 用于自定义组件内部各语义化结构的 class,支持对象或函数 | Record<SemanticDOM, string> | (info: { props })=> Record<SemanticDOM, string> | - | 5.25.0 | |
| defaultOpen | 是否默认展示浮层 | boolean | - | × | |
| defaultValue | 默认的选中项 | string[] | number[] | [] | × | |
| disabled | 禁用 | boolean | false | × | |
| displayRender | 选择后展示的渲染函数 | (label, selectedOptions) => ReactNode | label => label.join(/) | multiple: 4.18.0 | × |
| tagRender | 自定义 tag 内容 render,仅在多选时生效 | ({ label: string, onClose: function, value: string }) => ReactNode | - | × | |
自定义浮层类名,使用 classNames.popup.root 替换 | string | - | 4.23.0 | × | |
自定义浮层类名,请使用 classNames.popup.root 替代 | string | - | - | × | |
自定义下拉框内容,请使用 popupRender 替换 | (menus: ReactElement) => ReactNode | - | 4.4.0 | × | |
| popupRender | 自定义下拉框内容 | (menus: ReactElement) => ReactNode | - | × | |
下拉菜单的 style 属性,使用 styles.popup.root 替换 | CSSProperties | - | × | ||
| expandIcon | 自定义次级菜单展开图标 | ReactNode | - | 4.4.0 | 6.3.0 |
| expandTrigger | 次级菜单的展开方式,可选 'click' 和 'hover' | string | click | × | |
| fieldNames | 自定义 options 中 label value children 的字段 | object | { label: label, value: value, children: children } | × | |
| getPopupContainer | 菜单渲染父节点。默认渲染到 body 上,如果你遇到菜单滚动定位问题,试试修改为滚动的区域,并相对其定位。示例 | function(triggerNode) | () => document.body | × | |
| loadData | 用于动态加载选项,无法与 showSearch 一起使用 | (selectedOptions) => void | - | × | |
| loadingIcon | 自定义的加载图标 | ReactNode | - | 6.3.0 | |
| maxTagCount | 最多显示多少个 tag,响应式模式会对性能产生损耗 | number | responsive | - | 4.17.0 | × |
| maxTagPlaceholder | 隐藏 tag 时显示的内容 | ReactNode | function(omittedValues) | - | 4.17.0 | × |
| maxTagTextLength | 最大显示的 tag 文本长度 | number | - | 4.17.0 | × |
| notFoundContent | 当下拉列表为空时显示的内容 | ReactNode | 暂无数据 | × | |
| open | 控制浮层显隐 | boolean | - | 4.17.0 | × |
| options | 可选项数据源 | Option[] | - | × | |
| placeholder | 输入框占位文本 | string | - | × | |
| placement | 浮层预设位置 | bottomLeft bottomRight topLeft topRight | bottomLeft | 4.17.0 | × |
| prefix | 自定义前缀 | ReactNode | - | 5.22.0 | × |
是否显示箭头图标,请使用 suffixIcon={null} 替代 | boolean | true | - | × | |
| showSearch | 在选择框中显示搜索框 | boolean | Object | false | searchIcon: 6.4.0 | |
| size | 输入框大小 | large | medium | small | medium | × | |
| status | 设置校验状态 | 'error' | 'warning' | - | 4.19.0 | × |
| styles | 用于自定义组件内部各语义化结构的行内 style,支持对象或函数 | Record<SemanticDOM, CSSProperties> | (info: { props })=> Record<SemanticDOM, CSSProperties> | - | 5.25.0 | |
| suffixIcon | 自定义的选择框后缀图标 | ReactNode | - | 6.4.0 | |
| value | 指定选中项 | string[] | number[] | - | × | |
| variant | 形态变体 | outlined | borderless | filled | underlined | outlined | 5.13.0 | underlined: 5.24.0 | 5.19.0 |
| onChange | 选择完成后的回调 | (value, selectedOptions) => void | - | × | |
| onClear | 清除内容时回调 | () => void | - | - | × |
显示/隐藏浮层的回调,请使用 onOpenChange 替换 | (value) => void | - | 4.17.0 | × | |
| onOpenChange | 显示/隐藏浮层的回调 | (open: boolean) => void | - | × | |
显示或隐藏浮层的回调,请使用 onOpenChange 替代 | (value) => void | - | - | × | |
| multiple | 支持多选节点 | boolean | - | 4.17.0 | × |
| removeIcon | 自定义的多选框清除图标 | ReactNode | - | 6.4.0 | |
| showCheckedStrategy | 定义选中项回填的方式(仅在 multiple 为 true 时生效)。Cascader.SHOW_CHILD: 只显示选中的子节点。Cascader.SHOW_PARENT: 只显示父节点(当父节点下所有子节点都选中时)。 | Cascader.SHOW_PARENT | Cascader.SHOW_CHILD | Cascader.SHOW_PARENT | 4.20.0 | × |
设置搜索的值,需要与 showSearch 配合使用 | string | - | 4.17.0 | × | |
| 监听搜索,返回输入的值 | (search: string) => void | - | 4.17.0 | × | |
下拉菜单列的样式,请使用 styles.popup.listItem 替换 | CSSProperties | - | × | ||
下拉菜单列的样式,请使用 styles.popup.listItem 替换 | CSSProperties | - | × | ||
| optionRender | 自定义渲染下拉选项 | (option: Option) => React.ReactNode | - | 5.16.0 | × |
showSearch
showSearch 为对象时,其中的字段:
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|---|---|---|---|---|
| autoClearSearchValue | 是否在选中项后清空搜索框,只在 multiple 为 true 时有效 | boolean | true | 5.9.0 |
| filter | 接收 inputValue path 两个参数,当 path 符合筛选条件时,应返回 true,反之则返回 false | function(inputValue, path): boolean | - | |
| limit | 搜索结果展示数量 | number | false | 50 | |
| matchInputWidth | 搜索结果列表是否与输入框同宽(效果) | boolean | true | |
| render | 用于渲染 filter 后的选项 | function(inputValue, path): ReactNode | - | |
| sort | 用于排序 filter 后的选项 | function(a, b, inputValue) | - | |
| searchValue | 设置搜索的值,需要与 showSearch 配合使用 | string | - | 4.17.0 |
| onSearch | 监听搜索,返回输入的值 | (search: string) => void | - | 4.17.0 |
| searchIcon | 自定义的搜索图标 | ReactNode | - | 6.3.0 |
Option
interface Option {
value: string | number;
label?: React.ReactNode;
disabled?: boolean;
children?: Option[];
// 标记是否为叶子节点,设置了 `loadData` 时有效
// 设为 `false` 时会强制标记为父节点,即使当前节点没有 children,也会显示展开图标
isLeaf?: boolean;
}
方法
| 名称 | 描述 | 版本 |
|---|---|---|
| blur() | 移除焦点 | |
| focus() | 获取焦点 |
注意,如果需要获得中国省市区数据,可以参考 china-division。
Semantic DOM
| 语义节点 | 原生说明 | 版本 |
|---|---|---|
root | 根元素,包含相对定位、行内 flex 布局、光标样式、过渡动画、边框等选择器容器的基础样式 | — |
prefix | 前缀元素,包含前缀内容的布局和样式 | — |
content | 多选容器,包含已选项的布局、间距、换行相关样式 | — |
placeholder | 占位符元素,包含占位符文本的字体样式和颜色 | — |
clear | 清除按钮元素,包含清除按钮的布局、样式和交互效果 | — |
input | 输入框元素,包含搜索输入框的样式、光标控制、字体继承等搜索相关样式,去除了边框样式 | — |
suffix | 后缀元素,包含后缀内容的布局和样式,如清除按钮、箭头图标等 | — |
popup.root | 弹出菜单元素,包含弹出层的定位、层级、背景、边框、阴影等弹出容器样式 | — |
popup.list | 弹出菜单列表元素,包含选项列表的布局、滚动、最大高度等列表容器样式 | — |
popup.listItem | 弹出菜单条目元素,包含选项项的内边距、悬浮效果、选中状态、禁用状态等选项交互样式 | — |
item | 多选项元素,包含边框、背景、内边距、外边距样式 (多选模式) | — |
itemContent | 多选项内容区域,包含文字的省略样式 (多选模式) | — |
itemRemove | 多选项移除按钮,包含字体相关样式 (多选模式) | — |
语义说明来源: vendor/.dumi/theme/common/SelectSemanticTemplate.tsx
主题变量(Design Token)
类型、继承关系和原生令牌声明保持固定源码原文;默认值由原生主题计算,并可能受 ConfigProvider 覆盖。本表不伪造静态默认值。
| 令牌 | 类型 | 原生说明 |
|---|---|---|
controlWidth | number | string | 选择器宽度 |
controlItemWidth | number | string | 选项宽度 |
dropdownHeight | number | string | 下拉菜单高度 |
optionSelectedBg | string | 选项选中时背景色 |
optionSelectedColor | string | 选项选中时文本颜色 |
optionSelectedFontWeight | CSSProperties['fontWeight'] | 选项选中时字重 |
optionPadding | CSSProperties['padding'] | 选项内间距 |
menuPadding | CSSProperties['padding'] | 选项菜单(单列)内间距 |
声明来源: vendor/components/cascader/style/index.ts
import type { CSSProperties } from 'react';
import { genCompactItemStyle } from '../../style/compact-item';
import type { FullToken, GenerateStyle, GlobalToken } from '../../theme/internal';
import { genStyleHooks } from '../../theme/internal';
import getColumnsStyle from './columns';
export interface ComponentToken {
/**
* @desc 选择器宽度
* @descEN Width of Cascader
*/
controlWidth: number | string;
/**
* @desc 选项宽度
* @descEN Width of item
*/
controlItemWidth: number | string;
/**
* @desc 下拉菜单高度
* @descEN Height of dropdown
*/
dropdownHeight: number | string;
/**
* @desc 选项选中时背景色
* @descEN Background color of selected item
*/
optionSelectedBg: string;
/**
* @desc 选项选中时文本颜色
* @descEN Text color when option is selected
*/
optionSelectedColor: string;
/**
* @desc 选项选中时字重
* @descEN Font weight of selected item
*/
optionSelectedFontWeight: CSSProperties['fontWeight'];
/**
* @desc 选项内间距
* @descEN Padding of menu item
*/
optionPadding: CSSProperties['padding'];
/**
* @desc 选项菜单(单列)内间距
* @descEN Padding of menu item (single column)
*/
menuPadding: CSSProperties['padding'];
}
export type CascaderToken = FullToken<'Cascader'>;
原生通用属性
Tips: 以下通用属性适用于 antd 大部分组件,不支持的组件会单独说明。
| 参数 | 说明 | 类型 | 默认值 |
|---|---|---|---|
| style | 自定义样式 | CSSProperties | - |
| className | 自定义类名 | string | - |
| rootClassName | 添加在组件最外层的 className | string | - |
| autoFocus | 自动获取焦点,仅对表单类、链接、交互容器等可聚焦元素生效 | boolean | false |
安装并复现示例
npm install antd@6.6.5 @ant-design/icons@6.3.4 dayjs@1.11.23
使用 ConfigProvider 和原生 App,并单独配置 dayjs 语言。每个示例在查看代码中列出完整源码文件和额外固定依赖。示例名称用于选择演示,不是组件通用属性。主题、语言与 SSR 初始化见资源安装指南。
原生类型参考
源码查看器包含未修改的原生实现和以下声明文件,继承类型仍位于原生包中。代码中的英文注释保留为源码参考。
vendor/components/cascader/Panel.tsxvendor/components/cascader/hooks/useIcons.tsxvendor/components/cascader/index.tsxvendor/components/cascader/style/index.ts
来源与许可
https://github.com/ant-design/ant-design/tree/4a39f54842eade4e565ab336ef6097cd7e723cdd
保留原生中英文正文与可执行示例;官网专用的嵌入章节和令牌表格在本地展开。Ant Design 使用 MIT 许可,另列依赖的许可证也需保留。上传预览禁止向外发起请求,不提供后端服务。