index.zh-CN.md 4.7 KB
Newer Older
B
Benjy Cui 已提交
1 2
---
category: Components
B
Benjy Cui 已提交
3
subtitle: 选择器
D
ddcat1115 已提交
4
type: Data Entry
B
Benjy Cui 已提交
5
title: Select
B
Benjy Cui 已提交
6
---
A
挖坑  
afc163 已提交
7

A
afc163 已提交
8
下拉选择器。
A
afc163 已提交
9 10 11

## 何时使用

A
afc163 已提交
12
- 弹出一个下拉菜单给用户选择操作,用于代替原生的选择器,或者需要一个更优雅的多选器时。
A
afc163 已提交
13
- 当选项少时(少于 5 项),建议直接将选项平铺,使用 [Radio](/components/radio/) 是更好的选择。
A
afc163 已提交
14 15

## API
然则 已提交
16 17 18 19 20 21 22

```html
<Select>
  <Option value="lucy">lucy</Option>
</Select>
```

fix #99  
然则 已提交
23 24
### Select props

W
Wei Zhu 已提交
25 26 27
| 参数 | 说明 | 类型 | 默认值 |
| --- | --- | --- | --- |
| allowClear | 支持清除 | boolean | false |
W
Wei Zhu 已提交
28
| autoFocus | 默认获取焦点 | boolean | false |
A
afc163 已提交
29
| combobox | 输入框自动提示模式(2.9 之后废弃,请使用 `mode`) | boolean | false |
W
Wei Zhu 已提交
30 31
| defaultActiveFirstOption | 是否默认高亮第一个选项。 | boolean | true |
| defaultValue | 指定默认选中的条目 | string\|string\[] | - |
B
Benjy Cui 已提交
32
| disabled | 是否禁用 | boolean | false |
A
afc163 已提交
33
| dropdownClassName | 下拉菜单的 className 属性 | string | - |
W
Wei Zhu 已提交
34 35 36 37
| dropdownMatchSelectWidth | 下拉菜单和选择器同宽 | boolean | true |
| dropdownStyle | 下拉菜单的 style 属性 | object | - |
| filterOption | 是否根据输入项进行筛选。当其为一个函数时,会接收 `inputValue` `option` 两个参数,当 `option` 符合筛选条件时,应返回 `true`,反之则返回 `false`。 | boolean or function(inputValue, option) | true |
| firstActiveValue | 默认高亮的选项 | string\|string\[] | - |
A
afc163 已提交
38
| getPopupContainer | 菜单渲染父节点。默认渲染到 body 上,如果你遇到菜单滚动定位问题,试试修改为滚动的区域,并相对其定位。[示例](https://codepen.io/afc163/pen/zEjNOy?editors=0010) | Function(triggerNode) | () => document.body |
W
Wei Zhu 已提交
39
| labelInValue | 是否把每个选项的 label 包装到 value 中,会把 Select 的 value 类型从 `string` 变为 `{key: string, label: ReactNode}` 的格式 | boolean | false |
W
Wei Zhu 已提交
40 41
| maxTagCount | 最多显示多少个 tag | number | - |
| maxTagPlaceholder | 隐藏 tag 时显示的内容 | ReactNode | - |
W
Wei Zhu 已提交
42 43 44 45 46 47 48 49 50 51 52 53 54 55 56
| mode | 设置 Select 的模式(2.9 之后支持) | 'multiple' \| 'tags' \| 'combobox' | - |
| multiple | 支持多选(2.9 之后废弃,请使用 `mode`) | boolean | false |
| notFoundContent | 当下拉列表为空时显示的内容 | string | 'Not Found' |
| optionFilterProp | 搜索时过滤对应的 option 属性,如设置为 children 表示对内嵌内容进行搜索 | string | value |
| optionLabelProp | 回填到选择框的 Option 的属性值,默认是 Option 的子元素。比如在子元素需要高亮效果时,此值可以设为 `value`。 | string | `children` (combobox 模式下为 `value`) |
| placeholder | 选择框默认文字 | string | - |
| showSearch | 使单选模式可搜索 | boolean | false |
| size | 选择框大小,可选 `large` `small` | string | default |
| tags | 可以把随意输入的条目作为 tag,输入项不需要与下拉选项匹配(2.9 之后废弃,请使用 `mode`) | boolean | false |
| tokenSeparators | 在 tags 和 multiple 模式下自动分词的分隔符 | string\[] |  |
| value | 指定当前选中的条目 | string\|string\[] | - |
| onBlur | 失去焦点的时回调 | function | - |
| onChange | 选中 option,或 input 的 value 变化(combobox 模式下)时,调用此函数 | function(value) | - |
| onDeselect | 取消选中时调用,参数为选中项的 value (或 key) 值,仅在 multiple 或 tags 模式下生效 | function(value) | - |
| onFocus | 获得焦点时回调 | function | - |
W
Wei Zhu 已提交
57 58
| onMouseEnter | 鼠标移入时回调 | function | - |
| onMouseLeave | 鼠标移出时回调 | function | - |
W
Wei Zhu 已提交
59 60
| onSearch | 文本框值变化时回调 | function(value: string) |  |
| onSelect | 被选中时调用,参数为选中项的 value (或 key) 值 | function(value, option) | - |
fix #99  
然则 已提交
61

62 63
> 注意,如果发现下拉菜单跟随页面滚动,或者需要在其他弹层中触发 Select,请尝试使用 `getPopupContainer={triggerNode => triggerNode.parentNode}` 将下拉弹层渲染节点固定在触发器的父元素中。

W
Wei Zhu 已提交
64 65 66 67 68 69 70
### Select Methods

| 名称 | 说明 |
| --- | --- |
| blur() | 取消焦点 |
| focus() | 获取焦点 |

fix #99  
然则 已提交
71 72
### Option props

W
Wei Zhu 已提交
73 74 75 76
| 参数 | 说明 | 类型 | 默认值 |
| --- | --- | --- | --- |
| disabled | 是否禁用 | boolean | false |
| key | 和 value 含义一致。如果 React 需要你设置此项,此项值与 value 的值相同,然后可以省略 value 设置 | string |  |
W
Wei Zhu 已提交
77
| title | 选中该 Option 后,Select 的 title | string | - |
W
Wei Zhu 已提交
78
| value | 默认根据此属性值进行筛选 | string | - |
fix #99  
然则 已提交
79 80 81

### OptGroup props

W
Wei Zhu 已提交
82 83 84 85
| 参数 | 说明 | 类型 | 默认值 |
| --- | --- | --- | --- |
| key |  | string | - |
| label | 组名 | string\|React.Element | 无 |