# 选择器 - 页面: https://jiguang132.com/zh/resources/ant-design/docs/select - 资源: Ant Design (https://jiguang132.com/zh/resources/ant-design.md) - 全部指南: https://jiguang132.com/zh/resources/ant-design/docs.md 下拉选择器。 ## 何时使用 {#when-to-use} - 弹出一个下拉菜单给用户选择操作，用于代替原生的选择器，或者需要一个更优雅的多选器时。 - 当选项少时（少于 5 项），建议直接将选项平铺，使用 [Radio](/components/radio/) 是更好的选择。 - 如果你在寻找一个可输可选的输入框，那你可能需要 [AutoComplete](/components/auto-complete/)。 ## 代码演示 {#examples} - 基本使用 · `basic` - 带搜索框 · `search` - 自定义搜索 · `search-filter-option` - 多字段搜索 · `search-multi-field` - 多选 · `multiple` - 三种大小 · `size` - 自定义下拉选项 · `option-render` - 带排序的搜索 · `search-sort` - 标签 · `tags` - 分组 · `optgroup` - 联动 · `coordinate` - 获得选项的文本 · `label-in-value` - 自动分词 · `automatic-tokenization` - 自定义分词 · `custom-tokenization` - 搜索用户 · `select-users` - 前后缀 · `suffix` - 扩展菜单 · `custom-dropdown-menu` - 隐藏已选择选项 · `hide-selected` - 形态变体 · `variant` - 自定义选择标签 · `custom-tag-render` - 自定义选中 label · `custom-label-render` - 响应式 maxTagCount · `responsive` - 大数据 · `big-data` - 自定义状态 · `status` - 弹出位置 · `placement` - 最大选中数量 · `maxCount` - 自定义语义结构的样式和类 · `style-class` ## API 通用属性参考：[通用属性](#jguang-common-props) ### Select props | 参数 | 说明 | 类型 | 默认值 | 版本 | [全局配置](/components/config-provider#component-config) | | --- | --- | --- | --- | --- | --- | | allowClear | 自定义清除按钮 | boolean \| { clearIcon?: ReactNode } | false | 5.8.0: 支持对象类型 | 6.4.0 | | ~~autoClearSearchValue~~ | 是否在选中项后清空搜索框，只在 `mode` 为 `multiple` 或 `tags` 时有效 | boolean | true | | × | | ~~bordered~~ | 是否带边框，请使用 `variant` 替代 | boolean | true | - | × | | classNames | 用于自定义 Select 组件内部各语义化结构的 class，支持对象或函数 | Record<[SemanticDOM](#semantic-dom), string> \| (info: { props }) => Record<[SemanticDOM](#semantic-dom), string> | - | | 5.25.0 | | defaultActiveFirstOption | 是否默认高亮第一个选项 | boolean | true | | × | | defaultOpen | 是否默认展开下拉菜单 | boolean | - | | × | | defaultValue | 指定默认选中的条目 | string \| string\[] \|
number \| number\[] \|
LabeledValue \| LabeledValue\[] | - | | × | | disabled | 是否禁用 | boolean | false | | × | | ~~dropdownClassName~~ | 下拉菜单的 className 属性，请使用 `classNames.popup.root` 替代 | string | - | - | × | | ~~dropdownMatchSelectWidth~~ | 下拉菜单和选择器是否同宽，请使用 `popupMatchSelectWidth` 替代 | boolean \| number | true | - | × | | ~~popupClassName~~ | 下拉菜单的 className 属性，使用 `classNames.popup.root` 替换 | string | - | 4.23.0 | × | | popupMatchSelectWidth | 下拉菜单和选择器同宽。默认将设置 `min-width`，当值小于选择框宽度时会被忽略。false 时会关闭虚拟滚动 | boolean \| number | true | 5.5.0 | × | | ~~dropdownRender~~ | 自定义下拉框内容，使用 `popupRender` 替换 | (originNode: ReactElement) => ReactNode | - | | × | | popupRender | 自定义下拉框内容 | (originNode: ReactElement) => ReactNode | - | 5.25.0 | × | | ~~dropdownStyle~~ | 下拉菜单的 style 属性，使用 `styles.popup.root` 替换 | CSSProperties | - | | × | | fieldNames | 自定义节点 label、value、options、groupLabel 的字段 | object | { label: `label`, value: `value`, options: `options`, groupLabel: `label` } | 4.17.0（`groupLabel` 在 5.6.0 新增） | × | | ~~filterOption~~ | 是否根据输入项进行筛选。当其为一个函数时，会接收 `inputValue` `option` 两个参数，当 `option` 符合筛选条件时，应返回 true，反之则返回 false。[示例](#select-demo-search) | boolean \| function(inputValue, option) | true | | × | | ~~filterSort~~ | 搜索时对筛选结果项的排序函数, 类似[Array.sort](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort)里的 compareFunction | (optionA: Option, optionB: Option, info: { searchValue: string }) => number | - | `searchValue`: 5.19.0 | × | | getPopupContainer | 菜单渲染父节点。默认渲染到 body 上，如果你遇到菜单滚动定位问题，试试修改为滚动的区域，并相对其定位。[示例](https://codesandbox.io/s/4j168r7jw0) | function(triggerNode) | () => document.body | | × | | labelInValue | 是否把每个选项的 label 包装到 value 中，会把 Select 的 value 类型从 `string` 变为 { value: string, label: ReactNode } 的格式 | boolean | false | | × | | listHeight | 设置弹窗滚动高度 | number | 256 | | × | | loading | 加载中状态 | boolean | false | | × | | loadingIcon | 自定义的加载图标 | ReactNode | `` | 6.4.0 | 6.4.0 | | maxCount | 指定可选中的最多 items 数量，仅在 `mode` 为 `multiple` 或 `tags` 时生效 | number | - | 5.13.0 | × | | maxTagCount | 最多显示多少个 tag，响应式模式会对性能产生损耗 | number \| `responsive` | - | responsive: 4.10 | × | | maxTagPlaceholder | 隐藏 tag 时显示的内容 | ReactNode \| function(omittedValues) | - | | × | | maxTagTextLength | 最大显示的 tag 文本长度 | number | - | | × | | menuItemSelectedIcon | 自定义多选时当前选中的条目图标 | ReactNode | `` | | 6.4.0 | | mode | 设置 Select 的模式为多选或标签 | `multiple` \| `tags` | - | | × | | notFoundContent | 当下拉列表为空时显示的内容 | ReactNode | `暂无数据` | | × | | open | 是否展开下拉菜单 | boolean | - | | × | | ~~optionFilterProp~~ | 已废弃，见 `showSearch.optionFilterProp` | | | | × | | optionLabelProp | 回填到选择框的 Option 的属性值，默认是 Option 的子元素。比如在子元素需要高亮效果时，此值可以设为 `value`。[示例](https://codesandbox.io/s/antd-reproduction-template-tk678) | string | `children` | | × | | options | 数据化配置选项内容，相比 jsx 定义会获得更好的渲染性能 | { label, value }\[] | - | | × | | optionRender | 自定义渲染下拉选项 | (option: FlattenOptionData\ , info: { index: number }) => React.ReactNode | - | 5.11.0 | × | | placeholder | 选择框默认文本 | ReactNode | - | | × | | placement | 选择框弹出的位置 | `bottomLeft` `bottomRight` `topLeft` `topRight` | bottomLeft | | × | | prefix | 自定义前缀 | ReactNode | - | 5.22.0 | × | | removeIcon | 自定义的多选框清除图标 | ReactNode | `` | | 6.4.0 | | ~~searchValue~~ | 控制搜索文本 | string | - | | × | | ~~showArrow~~ | 是否显示箭头图标，请使用 `suffixIcon={null}` 替代 | boolean | true | - | × | | showSearch | 配置是否可搜索 | boolean \| [Object](#showsearch) | 单选为 false，多选为 true | Object: 6.0.0 | 6.4.0 | | size | 选择框大小 | `large` \| `medium` \| `small` | `medium` | | × | | status | 设置校验状态 | 'error' \| 'warning' | - | 4.19.0 | × | | styles | 用于自定义 Select 组件内部各语义化结构的行内 style，支持对象或函数 | Record<[SemanticDOM](#semantic-dom), CSSProperties> \| (info: { props }) => Record<[SemanticDOM](#semantic-dom), CSSProperties> | - | | 5.25.0 | | suffixIcon | 自定义的选择框后缀图标。以防止图标被用于其他交互，替换的图标默认不会响应展开、收缩事件，可以通过添加 `pointer-events: none` 样式透传。 | ReactNode | `` | | 6.4.0 | | tagRender | 自定义 tag 内容 render，仅在 `mode` 为 `multiple` 或 `tags` 时生效 | (props) => ReactNode | - | | × | | labelRender | 自定义当前选中的 label 内容 render （LabelInValueType的定义见 [LabelInValueType](https://github.com/react-component/select/blob/b39c28aa2a94e7754ebc570f200ab5fd33bd31e7/src/Select.tsx#L70)） | (props: LabelInValueType) => ReactNode | - | 5.15.0 | × | | tokenSeparators | 自动分词的分隔符或自定义分词函数，仅在 `mode="tags"` 或 `mode="multiple"` 时生效 | string[] \| ((input: string) => string[]) | - | function: 6.5.0 | × | | value | 指定当前选中的条目，多选时为一个数组。（value 数组引用未变化时，Select 不会更新） | string \| string\[] \|
number \| number\[] \|
LabeledValue \| LabeledValue\[] | - | | × | | variant | 形态变体 | `outlined` \| `borderless` \| `filled` \| `underlined` | `outlined` | 5.13.0 \| `underlined`: 5.24.0 | 5.19.0 | | virtual | 设置 false 时关闭虚拟滚动 | boolean | true | 4.1.0 | × | | onActive | 键盘和鼠标交互时触发 | function(value: string \| number \| LabeledValue) | - | | × | | onBlur | 失去焦点时回调 | function | - | | × | | onChange | 选中 option，或 input 的 value 变化时，调用此函数 | function(value, option:Option \| Array<Option>) | - | | × | | onClear | 清除内容时回调 | function | - | 4.6.0 | × | | onDeselect | 取消选中时调用，参数为选中项的 value (或 key) 值，仅在 `multiple` 或 `tags` 模式下生效 | function(value: string \| number \| LabeledValue) | - | | × | | ~~onDropdownVisibleChange~~ | 展开下拉菜单的回调，使用 `onOpenChange` 替换 | (open: boolean) => void | - | | × | | onOpenChange | 展开下拉菜单的回调 | (open: boolean) => void | - | | × | | onFocus | 获得焦点时回调 | (event: FocusEvent) => void | - | | × | | onInputKeyDown | 按键按下时回调 | (event: KeyboardEvent) => void | - | | × | | onPopupScroll | 下拉列表滚动时的回调 | (event: UIEvent) => void | - | | × | | ~~onSearch~~ | 文本框值变化时回调 | function(value: string) | - | | × | | onSelect | 被选中时调用，参数为选中项的 value (或 key) 值 | function(value: string \| number \| LabeledValue, option: Option) | - | | × | > 注意，如果发现下拉菜单跟随页面滚动，或者需要在其他弹层中触发 Select，请尝试使用 `getPopupContainer={triggerNode => triggerNode.parentElement}` 将下拉弹层渲染节点固定在触发器的父元素中。 ### showSearch | 参数 | 说明 | 类型 | 默认值 | 版本 | | --- | --- | --- | --- | --- | | autoClearSearchValue | 是否在选中项后清空搜索框，只在 `mode` 为 `multiple` 或 `tags` 时有效 | boolean | true | | | filterOption | 是否根据输入项进行筛选。当其为一个函数时，会接收 `inputValue` `option` 两个参数，当 `option` 符合筛选条件时，应返回 true，反之则返回 false。[示例](#select-demo-search) | boolean \| function(inputValue, option) | true | | | filterSort | 搜索时对筛选结果项的排序函数, 类似[Array.sort](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort)里的 compareFunction | (optionA: Option, optionB: Option, info: { searchValue: string }) => number | - | `searchValue`: 5.19.0 | | optionFilterProp | 搜索时过滤对应的 `option` 属性，如设置为 `children` 表示对内嵌内容进行搜索。
若通过 `options` 属性配置选项内容，建议设置 `optionFilterProp="label"` 来对内容进行搜索。
当传入 `string[]` 时多个字段进行 OR 匹配搜索 | string \| string[] | `value` | `string[]`: 6.1.0 | | searchValue | 控制搜索文本 | string | - | | | onSearch | 文本框值变化时回调 | function(value: string) | - | | | searchIcon | 自定义的搜索图标 | ReactNode | `` | 6.4.0 | ### Select Methods | 名称 | 说明 | 版本 | | ------- | -------- | ---- | | blur() | 取消焦点 | | | focus() | 获取焦点 | | ### Option props | 参数 | 说明 | 类型 | 默认值 | 版本 | | --------- | ------------------------ | ---------------- | ------ | ---- | | className | Option 器类名 | string | - | | | disabled | 是否禁用 | boolean | false | | | title | 选项上的原生 title 提示 | string | - | | | value | 默认根据此属性值进行筛选 | string \| number | - | | ### OptGroup props | 参数 | 说明 | 类型 | 默认值 | 版本 | | --------- | ----------------------- | --------------- | ------ | ---- | | key | Key | string | - | | | label | 组名 | React.ReactNode | - | | | className | Option 器类名 | string | - | | | title | 选项上的原生 title 提示 | string | - | | ## 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）{#design-token} 类型、继承关系和原生令牌声明保持固定源码原文；默认值由原生主题计算，并可能受 ConfigProvider 覆盖。本表不伪造静态默认值。 | 令牌 | 类型 | 原生说明 | | --- | --- | --- | | `zIndexPopup` | `number` | 下拉菜单 z-index | | `optionSelectedColor` | `string` | 选项选中时文本颜色 | | `optionSelectedFontWeight` | `CSSProperties['fontWeight']` | 选项选中时文本字重 | | `optionSelectedBg` | `string` | 选项选中时背景色 | | `optionActiveBg` | `string` | 选项激活态时背景色 | | `optionPadding` | `CSSProperties['padding']` | 选项内间距 | | `optionFontSize` | `number` | 选项字体大小 | | `optionLineHeight` | `CSSProperties['lineHeight']` | 选项行高 | | `optionHeight` | `number` | 选项高度 | | `selectorBg` | `string` | 选框背景色 | | `clearBg` | `string` | 清空按钮背景色 | | `singleItemHeightLG` | `number` | 单选大号回填项高度 | | `showArrowPaddingInlineEnd` | `number` | 箭头的行末内边距 | | `hoverBorderColor` | `string` | 悬浮态边框色 | | `activeBorderColor` | `string` | 激活态边框色 | | `activeOutlineColor` | `string` | 激活态 outline 颜色 | 声明来源: `vendor/components/select/style/token.ts` ```ts import type { CSSProperties } from 'react'; import type { FullToken, GetDefaultToken } from '../../theme/internal'; export interface MultipleSelectorToken { /** * @desc 多选标签背景色 * @descEN Background color of multiple tag */ multipleItemBg: string; /** * @desc 多选标签边框色 * @descEN Border color of multiple tag */ multipleItemBorderColor: string; /** * @desc 多选标签高度 * @descEN Height of multiple tag */ multipleItemHeight: number; /** * @desc 小号多选标签高度 * @descEN Height of multiple tag with small size */ multipleItemHeightSM: number; /** * @desc 大号多选标签高度 * @descEN Height of multiple tag with large size */ multipleItemHeightLG: number; /** * @desc 多选框禁用背景 * @descEN Background color of multiple selector when disabled */ multipleSelectorBgDisabled: string; /** * @desc 多选标签禁用文本颜色 * @descEN Text color of multiple tag when disabled */ multipleItemColorDisabled: string; /** * @desc 多选标签禁用边框色 * @descEN Border color of multiple tag when disabled */ multipleItemBorderColorDisabled: string; /** * @internal */ } export interface ComponentToken extends MultipleSelectorToken { /** * @desc 下拉菜单 z-index * @descEN z-index of dropdown */ zIndexPopup: number; /** * @desc 选项选中时文本颜色 * @descEN Text color when option is selected */ optionSelectedColor: string; /** * @desc 选项选中时文本字重 * @descEN Font weight when option is selected */ optionSelectedFontWeight: CSSProperties['fontWeight']; /** * @desc 选项选中时背景色 * @descEN Background color when option is selected */ optionSelectedBg: string; /** * @desc 选项激活态时背景色 * @descEN Background color when option is active */ optionActiveBg: string; /** * @desc 选项内间距 * @descEN Padding of option */ optionPadding: CSSProperties['padding']; /** * @desc 选项字体大小 * @descEN Font size of option */ optionFontSize: number; /** * @desc 选项行高 * @descEN Line height of option */ optionLineHeight: CSSProperties['lineHeight']; /** * @desc 选项高度 * @descEN Height of option */ optionHeight: number; /** * @desc 选框背景色 * @descEN Background color of selector */ selectorBg: string; /** * @desc 清空按钮背景色 * @descEN Background color of clear button */ clearBg: string; /** * @desc 单选大号回填项高度 * @descEN Height of single selected item with large size */ singleItemHeightLG: number; /** * @desc 箭头的行末内边距 * @descEN Inline end padding of arrow */ showArrowPaddingInlineEnd: number; /** * @desc 悬浮态边框色 * @descEN Hover border color */ hoverBorderColor: string; /** * @desc 激活态边框色 * @descEN Active border color */ activeBorderColor: string; /** * @desc 激活态 outline 颜色 * @descEN Active outline color */ activeOutlineColor: string; } export interface SelectorToken { selectAffixPadding: number | string; inputPaddingHorizontalBase: number | string; multipleSelectItemHeight: number; selectHeight: number; } export interface SelectToken extends FullToken<'Select'>, SelectorToken { rootPrefixCls: string; /** @private Used for internal calculation */ INTERNAL_FIXED_ITEM_MARGIN: number; } ``` ## FAQ ### `mode="tags"` 模式下为何搜索有时会出现两个相同选项？ {#faq-tags-mode-duplicate} 这一般是 `options` 中的 `label` 和 `value` 不同导致的，你可以通过 `optionFilterProp="label"` 将过滤设置为展示值以避免这种情况。 ### 点击 `popupRender` 里的元素，下拉菜单不会自动消失？ {#faq-popup-not-close} 你可以使用受控模式，手动设置 `open` 属性：[codesandbox](https://codesandbox.io/s/ji-ben-shi-yong-antd-4-21-7-forked-gnp4cy?file=/demo.js)。 ### 反过来希望点击 `popupRender` 里元素不消失该怎么办？ {#faq-popup-keep-open} Select 当失去焦点时会关闭下拉框，你可以通过阻止默认行为来避免丢失焦点导致的关闭： ```tsx ``` 注意：`listItemHeight` 和 `listHeight` 为内部属性，如无必要，请勿修改该值。 ### 为何无障碍测试会报缺失 `aria-` 属性？ {#faq-aria-attribute} Select 无障碍辅助元素仅在弹窗展开时创建，因而当你在进行无障碍检测时请先打开下拉后再进行测试。对于 `aria-label` 与 `aria-labelledby` 属性缺失警告，请自行为 Select 组件添加相应无障碍属性。 Select 虚拟滚动会模拟无障碍绑定元素。如果需要读屏器完整获取全部列表，你可以设置 `virtual={false}` 关闭虚拟滚动，无障碍选项将会绑定到真实元素上。 ### 使用 `tagRender` 生成的自定义标签，点击关闭时会呼出下拉框 {#faq-tagrender-dropdown} 如果你不希望点击某个元素后下拉框自动出现（例如关闭按钮），可以在其上阻止 `MouseDown` 事件的传播。 ```tsx