2016-03-31 14:17:09 +08:00
|
|
|
|
---
|
|
|
|
|
category: Components
|
2016-09-21 11:28:38 +08:00
|
|
|
|
subtitle: 选择器
|
2018-11-04 16:20:35 +08:00
|
|
|
|
type: 数据录入
|
2016-09-21 11:28:38 +08:00
|
|
|
|
title: Select
|
2020-06-05 13:50:09 +08:00
|
|
|
|
cover: https://gw.alipayobjects.com/zos/alicdn/_0XzgOis7/Select.svg
|
2016-07-10 09:14:14 +08:00
|
|
|
|
---
|
2015-05-27 15:43:29 +08:00
|
|
|
|
|
2017-08-23 11:45:21 +08:00
|
|
|
|
下拉选择器。
|
2015-06-14 17:54:08 +08:00
|
|
|
|
|
|
|
|
|
## 何时使用
|
|
|
|
|
|
2016-10-14 11:29:45 +08:00
|
|
|
|
- 弹出一个下拉菜单给用户选择操作,用于代替原生的选择器,或者需要一个更优雅的多选器时。
|
2016-10-14 11:31:24 +08:00
|
|
|
|
- 当选项少时(少于 5 项),建议直接将选项平铺,使用 [Radio](/components/radio/) 是更好的选择。
|
2016-10-14 11:29:45 +08:00
|
|
|
|
|
|
|
|
|
## API
|
2015-06-09 21:16:59 +08:00
|
|
|
|
|
2019-06-19 19:09:08 +08:00
|
|
|
|
```jsx
|
2019-05-27 21:32:45 +08:00
|
|
|
|
<Select>
|
2020-07-01 20:49:24 +08:00
|
|
|
|
<Option value="lucy">lucy</Option>
|
2019-05-27 21:32:45 +08:00
|
|
|
|
</Select>
|
2015-06-09 21:16:59 +08:00
|
|
|
|
```
|
|
|
|
|
|
2015-08-01 17:51:55 +08:00
|
|
|
|
### Select props
|
|
|
|
|
|
2019-07-11 14:14:33 +08:00
|
|
|
|
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|
|
|
|
|
| --- | --- | --- | --- | --- |
|
|
|
|
|
| allowClear | 支持清除 | boolean | false | |
|
2020-07-01 17:28:59 +08:00
|
|
|
|
| autoClearSearchValue | 是否在选中项后清空搜索框,只在 `mode` 为 `multiple` 或 `tags` 时有效 | boolean | true | |
|
2019-07-11 14:14:33 +08:00
|
|
|
|
| autoFocus | 默认获取焦点 | boolean | false | |
|
2020-08-26 17:50:14 +08:00
|
|
|
|
| bordered | 是否有边框 | boolean | true | |
|
|
|
|
|
| clearIcon | 自定义的多选框清空图标 | ReactNode | - | |
|
2020-07-01 17:28:59 +08:00
|
|
|
|
| defaultActiveFirstOption | 是否默认高亮第一个选项 | boolean | true | |
|
2020-08-26 17:50:14 +08:00
|
|
|
|
| defaultOpen | 是否默认展开下拉菜单 | boolean | - | |
|
2020-10-21 10:33:43 +08:00
|
|
|
|
| defaultValue | 指定默认选中的条目 | string \| string\[]<br />number \| number\[]<br />LabeledValue \| LabeledValue\[] | - | |
|
2019-07-11 14:14:33 +08:00
|
|
|
|
| disabled | 是否禁用 | boolean | false | |
|
2022-08-05 11:21:07 +08:00
|
|
|
|
| popupClassName | 下拉菜单的 className 属性 | string | - | 4.23.0 |
|
2020-07-01 17:28:59 +08:00
|
|
|
|
| dropdownMatchSelectWidth | 下拉菜单和选择器同宽。默认将设置 `min-width`,当值小于选择框宽度时会被忽略。false 时会关闭虚拟滚动 | boolean \| number | true | |
|
2020-06-08 13:54:53 +08:00
|
|
|
|
| dropdownRender | 自定义下拉框内容 | (originNode: ReactNode) => ReactNode | - | |
|
2020-04-28 14:09:54 +08:00
|
|
|
|
| dropdownStyle | 下拉菜单的 style 属性 | CSSProperties | - | |
|
2022-03-10 12:11:26 +08:00
|
|
|
|
| fieldNames | 自定义节点 label、value、options 的字段 | object | { label: `label`, value: `value`, options: `options` } | 4.17.0 |
|
2020-07-01 17:28:59 +08:00
|
|
|
|
| filterOption | 是否根据输入项进行筛选。当其为一个函数时,会接收 `inputValue` `option` 两个参数,当 `option` 符合筛选条件时,应返回 true,反之则返回 false | boolean \| function(inputValue, option) | true | |
|
2020-12-25 13:13:07 +08:00
|
|
|
|
| filterSort | 搜索时对筛选结果项的排序函数, 类似[Array.sort](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort)里的 compareFunction | (optionA: Option, optionB: Option) => number | - | 4.9.0 |
|
2020-07-01 17:28:59 +08:00
|
|
|
|
| getPopupContainer | 菜单渲染父节点。默认渲染到 body 上,如果你遇到菜单滚动定位问题,试试修改为滚动的区域,并相对其定位。[示例](https://codesandbox.io/s/4j168r7jw0) | function(triggerNode) | () => document.body | |
|
2020-08-26 17:50:14 +08:00
|
|
|
|
| labelInValue | 是否把每个选项的 label 包装到 value 中,会把 Select 的 value 类型从 `string` 变为 { value: string, label: ReactNode } 的格式 | boolean | false | |
|
2020-04-15 10:04:01 +08:00
|
|
|
|
| listHeight | 设置弹窗滚动高度 | number | 256 | |
|
2020-08-26 17:50:14 +08:00
|
|
|
|
| loading | 加载中状态 | boolean | false | |
|
2020-12-25 13:13:07 +08:00
|
|
|
|
| maxTagCount | 最多显示多少个 tag,响应式模式会对性能产生损耗 | number \| `responsive` | - | responsive: 4.10 |
|
2020-07-01 17:28:59 +08:00
|
|
|
|
| maxTagPlaceholder | 隐藏 tag 时显示的内容 | ReactNode \| function(omittedValues) | - | |
|
2020-08-26 17:50:14 +08:00
|
|
|
|
| maxTagTextLength | 最大显示的 tag 文本长度 | number | - | |
|
|
|
|
|
| menuItemSelectedIcon | 自定义多选时当前选中的条目图标 | ReactNode | - | |
|
2020-01-15 10:37:50 +08:00
|
|
|
|
| mode | 设置 Select 的模式为多选或标签 | `multiple` \| `tags` | - | |
|
2020-07-01 17:28:59 +08:00
|
|
|
|
| notFoundContent | 当下拉列表为空时显示的内容 | ReactNode | `Not Found` | |
|
2019-11-20 14:55:34 +08:00
|
|
|
|
| open | 是否展开下拉菜单 | boolean | - | |
|
2020-10-30 17:50:39 +08:00
|
|
|
|
| optionFilterProp | 搜索时过滤对应的 `option` 属性,如设置为 `children` 表示对内嵌内容进行搜索。若通过 `options` 属性配置选项内容,建议设置 `optionFilterProp="label"` 来对内容进行搜索。 | string | `value` | |
|
|
|
|
|
| optionLabelProp | 回填到选择框的 Option 的属性值,默认是 Option 的子元素。比如在子元素需要高亮效果时,此值可以设为 `value`。[示例](https://codesandbox.io/s/antd-reproduction-template-tk678) | string | `children` | |
|
2020-10-21 10:33:43 +08:00
|
|
|
|
| options | 数据化配置选项内容,相比 jsx 定义会获得更好的渲染性能 | { label, value }\[] | - | |
|
2020-11-27 11:34:04 +08:00
|
|
|
|
| placeholder | 选择框默认文本 | string | - | |
|
2022-01-20 16:54:47 +08:00
|
|
|
|
| placement | 选择框弹出的位置 | `bottomLeft` `bottomRight` `topLeft` `topRight` | bottomLeft | |
|
2020-08-26 17:50:14 +08:00
|
|
|
|
| removeIcon | 自定义的多选框清除图标 | ReactNode | - | |
|
2020-11-27 11:34:04 +08:00
|
|
|
|
| searchValue | 控制搜索文本 | string | - | |
|
2020-08-26 17:50:14 +08:00
|
|
|
|
| showArrow | 是否显示下拉小箭头 | boolean | 单选为 true,多选为 false | |
|
2022-07-14 19:27:19 +08:00
|
|
|
|
| showSearch | 配置是否可搜索 | boolean | 单选为 false,多选为 true | |
|
2020-10-24 14:32:43 +08:00
|
|
|
|
| size | 选择框大小 | `large` \| `middle` \| `small` | `middle` | |
|
2022-02-16 21:39:48 +08:00
|
|
|
|
| status | 设置校验状态 | 'error' \| 'warning' | - | 4.19.0 |
|
2020-08-26 17:50:14 +08:00
|
|
|
|
| suffixIcon | 自定义的选择框后缀图标 | ReactNode | - | |
|
2021-09-15 12:21:04 +08:00
|
|
|
|
| tagRender | 自定义 tag 内容 render,仅在 `mode` 为 `multiple` 或 `tags` 时生效 | (props) => ReactNode | - | |
|
2022-04-29 21:23:39 +08:00
|
|
|
|
| tokenSeparators | 自动分词的分隔符,仅在 `mode="tags"` 时生效 | string\[] | - | |
|
2021-08-02 10:58:10 +08:00
|
|
|
|
| value | 指定当前选中的条目,多选时为一个数组。(value 数组引用未变化时,Select 不会更新) | string \| string\[]<br />number \| number\[]<br />LabeledValue \| LabeledValue\[] | - | |
|
2020-08-26 17:50:14 +08:00
|
|
|
|
| virtual | 设置 false 时关闭虚拟滚动 | boolean | true | 4.1.0 |
|
2020-10-21 10:33:43 +08:00
|
|
|
|
| onBlur | 失去焦点时回调 | function | - | |
|
|
|
|
|
| onChange | 选中 option,或 input 的 value 变化时,调用此函数 | function(value, option:Option \| Array<Option>) | - | |
|
|
|
|
|
| onClear | 清除内容时回调 | function | - | 4.6.0 |
|
|
|
|
|
| onDeselect | 取消选中时调用,参数为选中项的 value (或 key) 值,仅在 `multiple` 或 `tags` 模式下生效 | function(string \| number \| LabeledValue) | - | |
|
|
|
|
|
| onDropdownVisibleChange | 展开下拉菜单的回调 | function(open) | - | |
|
|
|
|
|
| onFocus | 获得焦点时回调 | function | - | |
|
|
|
|
|
| onInputKeyDown | 按键按下时回调 | function | - | |
|
|
|
|
|
| onMouseEnter | 鼠标移入时回调 | function | - | |
|
|
|
|
|
| onMouseLeave | 鼠标移出时回调 | function | - | |
|
|
|
|
|
| onPopupScroll | 下拉列表滚动时的回调 | function | - | |
|
|
|
|
|
| onSearch | 文本框值变化时回调 | function(value: string) | - | |
|
|
|
|
|
| onSelect | 被选中时调用,参数为选中项的 value (或 key) 值 | function(string \| number \| LabeledValue, option: Option) | - | |
|
2015-08-01 17:51:55 +08:00
|
|
|
|
|
2019-05-26 10:35:59 +08:00
|
|
|
|
> 注意,如果发现下拉菜单跟随页面滚动,或者需要在其他弹层中触发 Select,请尝试使用 `getPopupContainer={triggerNode => triggerNode.parentElement}` 将下拉弹层渲染节点固定在触发器的父元素中。
|
2017-08-14 22:57:31 +08:00
|
|
|
|
|
2017-11-11 00:07:03 +08:00
|
|
|
|
### Select Methods
|
|
|
|
|
|
2021-08-02 10:58:10 +08:00
|
|
|
|
| 名称 | 说明 | 版本 |
|
|
|
|
|
| ------- | -------- | ---- |
|
|
|
|
|
| blur() | 取消焦点 | |
|
|
|
|
|
| focus() | 获取焦点 | |
|
2017-11-11 00:07:03 +08:00
|
|
|
|
|
2015-08-01 17:51:55 +08:00
|
|
|
|
### Option props
|
|
|
|
|
|
2021-12-01 14:54:12 +08:00
|
|
|
|
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|
|
|
|
|
| --------- | ------------------------ | ---------------- | ------ | ---- |
|
|
|
|
|
| className | Option 器类名 | string | - | |
|
|
|
|
|
| disabled | 是否禁用 | boolean | false | |
|
|
|
|
|
| title | 选项上的原生 title 提示 | string | - | |
|
|
|
|
|
| value | 默认根据此属性值进行筛选 | string \| number | - | |
|
2015-08-01 17:51:55 +08:00
|
|
|
|
|
|
|
|
|
### OptGroup props
|
|
|
|
|
|
2021-08-02 10:58:10 +08:00
|
|
|
|
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|
|
|
|
|
| ----- | ---- | ----------------------- | ------ | ---- |
|
|
|
|
|
| key | Key | string | - | |
|
|
|
|
|
| label | 组名 | string \| React.Element | - | |
|
2019-09-24 22:37:34 +08:00
|
|
|
|
|
|
|
|
|
## FAQ
|
|
|
|
|
|
2022-07-14 19:27:19 +08:00
|
|
|
|
### `mode="tags"` 模式下为何搜索有时会出现两个相同选项?
|
2021-01-29 18:01:16 +08:00
|
|
|
|
|
|
|
|
|
这一般是 `options` 中的 `label` 和 `value` 不同导致的,你可以通过 `optionFilterProp="label"` 将过滤设置为展示值以避免这种情况。
|
|
|
|
|
|
2022-07-23 17:00:19 +08:00
|
|
|
|
### 点击 `dropdownRender` 里的元素,下拉菜单不会自动消失?
|
2019-09-24 22:37:34 +08:00
|
|
|
|
|
2022-07-23 17:00:19 +08:00
|
|
|
|
你可以使用受控模式,手动设置 `open` 属性:[codesandbox](https://codesandbox.io/s/ji-ben-shi-yong-antd-4-21-7-forked-gnp4cy?file=/demo.js)。
|
2020-02-18 17:29:35 +08:00
|
|
|
|
|
2022-10-09 17:47:43 +08:00
|
|
|
|
### 反过来希望点击 `dropdownRender` 里元素不消失该怎么办?
|
|
|
|
|
|
|
|
|
|
Select 当失去焦点时会关闭下拉框,如果你可以通过阻止默认行为避免丢失焦点导致的关闭:
|
|
|
|
|
|
|
|
|
|
```jsx
|
|
|
|
|
<Select
|
|
|
|
|
dropdownRender={() => (
|
|
|
|
|
<div
|
|
|
|
|
onMouseDown={e => {
|
|
|
|
|
e.preventDefault();
|
|
|
|
|
e.stopPropagation();
|
|
|
|
|
}}
|
|
|
|
|
>
|
|
|
|
|
Some Content
|
|
|
|
|
</div>
|
|
|
|
|
)}
|
|
|
|
|
/>
|
|
|
|
|
```
|
|
|
|
|
|
2020-02-18 17:29:35 +08:00
|
|
|
|
### 自定义 Option 样式导致滚动异常怎么办?
|
|
|
|
|
|
|
|
|
|
这是由于虚拟滚动默认选项高度为 `32px`,如果你的选项高度小于该值则需要通过 `listItemHeight` 属性调整,而 `listHeight` 用于设置滚动容器高度:
|
|
|
|
|
|
|
|
|
|
```tsx
|
|
|
|
|
<Select listItemHeight={10} listHeight={250} />
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
注意:`listItemHeight` 和 `listHeight` 为内部属性,如无必要,请勿修改该值。
|
2020-05-23 14:51:54 +08:00
|
|
|
|
|
|
|
|
|
### 为何无障碍测试会报缺失 `aria-` 属性?
|
|
|
|
|
|
|
|
|
|
Select 无障碍辅助元素仅在弹窗展开时创建,因而当你在进行无障碍检测时请先打开下拉后再进行测试。对于 `aria-label` 与 `aria-labelledby` 属性缺失警告,请自行为 Select 组件添加相应无障碍属性。
|