mirror of
https://github.com/ant-design/ant-design.git
synced 2024-11-30 14:29:33 +08:00
122 lines
7.4 KiB
Markdown
122 lines
7.4 KiB
Markdown
---
|
||
category: Components
|
||
subtitle: 选择器
|
||
type: 数据录入
|
||
title: Select
|
||
cover: https://gw.alipayobjects.com/zos/alicdn/_0XzgOis7/Select.svg
|
||
---
|
||
|
||
下拉选择器。
|
||
|
||
## 何时使用
|
||
|
||
- 弹出一个下拉菜单给用户选择操作，用于代替原生的选择器，或者需要一个更优雅的多选器时。
|
||
- 当选项少时（少于 5 项），建议直接将选项平铺，使用 [Radio](/components/radio/) 是更好的选择。
|
||
|
||
## API
|
||
|
||
```jsx
|
||
<Select>
|
||
<Option value="lucy">lucy</Option>
|
||
</Select>
|
||
```
|
||
|
||
### Select props
|
||
|
||
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|
||
| --- | --- | --- | --- | --- |
|
||
| allowClear | 支持清除 | boolean | false | |
|
||
| autoClearSearchValue | 是否在选中项后清空搜索框，只在 `mode` 为 `multiple` 或 `tags` 时有效 | boolean | true | |
|
||
| autoFocus | 默认获取焦点 | boolean | false | |
|
||
| defaultActiveFirstOption | 是否默认高亮第一个选项 | boolean | true | |
|
||
| defaultValue | 指定默认选中的条目 | string \| string\[]<br />number \| number\[]<br />LabeledValue \| LabeledValue[] | - | |
|
||
| disabled | 是否禁用 | boolean | false | |
|
||
| dropdownClassName | 下拉菜单的 className 属性 | string | - | |
|
||
| dropdownMatchSelectWidth | 下拉菜单和选择器同宽。默认将设置 `min-width`，当值小于选择框宽度时会被忽略。false 时会关闭虚拟滚动 | boolean \| number | true | |
|
||
| dropdownRender | 自定义下拉框内容 | (originNode: ReactNode) => ReactNode | - | |
|
||
| dropdownStyle | 下拉菜单的 style 属性 | CSSProperties | - | |
|
||
| filterOption | 是否根据输入项进行筛选。当其为一个函数时，会接收 `inputValue` `option` 两个参数，当 `option` 符合筛选条件时，应返回 true，反之则返回 false | boolean \| function(inputValue, option) | true | |
|
||
| 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 | |
|
||
| maxTagCount | 最多显示多少个 tag | number | - | |
|
||
| maxTagTextLength | 最大显示的 tag 文本长度 | number | - | |
|
||
| maxTagPlaceholder | 隐藏 tag 时显示的内容 | ReactNode \| function(omittedValues) | - | |
|
||
| tagRender | 自定义 tag 内容 render | (props) => ReactNode | - | |
|
||
| mode | 设置 Select 的模式为多选或标签 | `multiple` \| `tags` | - | |
|
||
| notFoundContent | 当下拉列表为空时显示的内容 | ReactNode | `Not Found` | |
|
||
| options | 数据化配置选项内容，相比 jsx 定义会获得更好的渲染性能 | { label, value }[] | - | |
|
||
| optionFilterProp | 搜索时过滤对应的 option 属性，如设置为 children 表示对内嵌内容进行搜索。[示例](https://codesandbox.io/s/antd-reproduction-template-tk678) | string | `value` | |
|
||
| optionLabelProp | 回填到选择框的 Option 的属性值，默认是 Option 的子元素。比如在子元素需要高亮效果时，此值可以设为 `value` | string | `children` | |
|
||
| placeholder | 选择框默认文字 | string | - | |
|
||
| showArrow | 是否显示下拉小箭头 | boolean | 单选为 true，多选为 false | |
|
||
| showSearch | 使单选模式可搜索 | boolean | false | |
|
||
| size | 选择框大小 | `large` \| `middle` \| `small` | - | |
|
||
| suffixIcon | 自定义的选择框后缀图标 | ReactNode | - | |
|
||
| removeIcon | 自定义的多选框清除图标 | ReactNode | - | |
|
||
| clearIcon | 自定义的多选框清空图标 | ReactNode | - | |
|
||
| menuItemSelectedIcon | 自定义多选时当前选中的条目图标 | ReactNode | - | |
|
||
| tokenSeparators | 在 tags 和 multiple 模式下自动分词的分隔符 | string\[] | - | |
|
||
| value | 指定当前选中的条目 | string \| string\[]<br />number \| number\[]<br />LabeledValue \| LabeledValue[] | - | |
|
||
| virtual | 设置 false 时关闭虚拟滚动 | boolean | true | 4.1.0 |
|
||
| onBlur | 失去焦点时回调 | function | - | |
|
||
| onChange | 选中 option，或 input 的 value 变化时，调用此函数 | function(value, option:Option \| Array<Option>) | - | |
|
||
| onDeselect | 取消选中时调用，参数为选中项的 value (或 key) 值，仅在 multiple 或 tags 模式下生效 | function(string \| number \| LabeledValue) | - | |
|
||
| onFocus | 获得焦点时回调 | function | - | |
|
||
| onInputKeyDown | 按键按下时回调 | function | - | |
|
||
| onMouseEnter | 鼠标移入时回调 | function | - | |
|
||
| onMouseLeave | 鼠标移出时回调 | function | - | |
|
||
| onPopupScroll | 下拉列表滚动时的回调 | function | - | |
|
||
| onSearch | 文本框值变化时回调 | function(value: string) | - | |
|
||
| onSelect | 被选中时调用，参数为选中项的 value (或 key) 值 | function(string \| number \| LabeledValue, option: Option) | - | |
|
||
| defaultOpen | 是否默认展开下拉菜单 | boolean | - | |
|
||
| open | 是否展开下拉菜单 | boolean | - | |
|
||
| onDropdownVisibleChange | 展开下拉菜单的回调 | function(open) | - | |
|
||
| loading | 加载中状态 | boolean | false | |
|
||
| bordered | 是否有边框 | boolean | true | |
|
||
|
||
> 注意，如果发现下拉菜单跟随页面滚动，或者需要在其他弹层中触发 Select，请尝试使用 `getPopupContainer={triggerNode => triggerNode.parentElement}` 将下拉弹层渲染节点固定在触发器的父元素中。
|
||
|
||
### Select Methods
|
||
|
||
| 名称 | 说明 | 版本 |
|
||
| ------- | -------- | ---- |
|
||
| blur() | 取消焦点 | |
|
||
| focus() | 获取焦点 | |
|
||
|
||
### Option props
|
||
|
||
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|
||
| --------- | --------------------------------- | ---------------- | ------ | ---- |
|
||
| disabled | 是否禁用 | boolean | false | |
|
||
| title | 选中该 Option 后，Select 的 title | string | - | |
|
||
| value | 默认根据此属性值进行筛选 | string \| number | - | |
|
||
| className | Option 器类名 | string | - | |
|
||
|
||
### OptGroup props
|
||
|
||
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|
||
| ----- | ---- | ----------------------- | ------ | ---- |
|
||
| key | Key | string | - | |
|
||
| label | 组名 | string \| React.Element | - | |
|
||
|
||
## FAQ
|
||
|
||
### 点击 `dropdownRender` 里的内容浮层关闭怎么办？
|
||
|
||
看下 [dropdownRender 例子](#components-select-demo-custom-dropdown-menu) 里的说明。
|
||
|
||
### 自定义 Option 样式导致滚动异常怎么办？
|
||
|
||
这是由于虚拟滚动默认选项高度为 `32px`，如果你的选项高度小于该值则需要通过 `listItemHeight` 属性调整，而 `listHeight` 用于设置滚动容器高度：
|
||
|
||
```tsx
|
||
<Select listItemHeight={10} listHeight={250} />
|
||
```
|
||
|
||
注意：`listItemHeight` 和 `listHeight` 为内部属性，如无必要，请勿修改该值。
|
||
|
||
### 为何无障碍测试会报缺失 `aria-` 属性？
|
||
|
||
Select 无障碍辅助元素仅在弹窗展开时创建，因而当你在进行无障碍检测时请先打开下拉后再进行测试。对于 `aria-label` 与 `aria-labelledby` 属性缺失警告，请自行为 Select 组件添加相应无障碍属性。
|