ant-design/components/select/index.md

63 lines
3.6 KiB
Markdown
Raw Normal View History

2016-03-31 14:17:09 +08:00
---
category: Components
chinese: 选择器
2016-05-11 14:21:01 +08:00
type: Form Control
2016-03-31 14:17:09 +08:00
english: Select
---
2015-05-27 15:43:29 +08:00
2015-06-14 17:54:08 +08:00
类似 Select2 的选择器。
## 何时使用
弹出一个下拉菜单给用户选择操作,用于代替原生的选择器,或者需要一个更优雅的多选器时。
2015-06-09 21:16:59 +08:00
```html
<Select>
<Option value="lucy">lucy</Option>
</Select>
```
## API
2015-08-01 17:51:55 +08:00
### Select props
2015-06-09 21:16:59 +08:00
| 参数 | 说明 | 类型 | 默认值 |
|----------|----------------|----------|--------------|
2016-05-19 13:44:08 +08:00
| value | 指定当前选中的条目 | String/Array<String>/{key: String, label: React.Node}/Array<{key, label}> | 无 |
| defaultValue | 指定默认选中的条目 | String/Array<String>/{key: String, label: React.Node}/Array<{key, label}> | 无 |
2015-12-02 15:31:25 +08:00
| multiple | 支持多选 | boolean | false |
2016-02-19 16:16:49 +08:00
| allowClear | 支持清除, 单选模式有效 | boolean | false |
2016-03-28 15:13:18 +08:00
| filterOption | 是否根据输入项进行筛选。当其为一个函数时,会接收 `inputValue` `option` 两个参数,当 `option` 符合筛选条件时,应返回 `true`,反之则返回 `false`。 | boolean or function(inputValue, option) | true |
2015-12-05 01:03:08 +08:00
| tags | 可以把随意输入的条目作为 tag输入项不需要与下拉选项匹配 | boolean |false |
| onSelect | 被选中时调用,参数为选中项的 value 值 | function(value, option) | 无 |
2016-04-21 12:17:37 +08:00
| onDeselect | 取消选中时调用,参数为选中项的 option value 值,仅在 multiple 或 tags 模式下生效 | function(value) | 无 |
2016-05-19 13:44:08 +08:00
| onChange | 选中 option或 input 的 value 变化combobox 模式下)时,调用此函数 | function(value) | 无 |
2015-11-12 14:16:17 +08:00
| onSearch | 文本框值变化时回调 | function(value: String) | |
2015-07-21 11:05:11 +08:00
| placeholder | 选择框默认文字 | string | 无 |
2016-01-05 17:49:59 +08:00
| notFoundContent | 当下拉列表为空时显示的内容 | string | 'Not Found' |
2015-12-16 11:56:30 +08:00
| dropdownMatchSelectWidth | 下拉菜单和选择器同宽 | boolean | true |
| optionFilterProp | 搜索时过滤对应的 option 属性,如设置为 children 表示对内嵌内容进行搜索 | string | value |
| optionLabelProp | 回填到选择框的 Option 的属性值,默认是 Option 的子元素。比如在子元素需要高亮效果时,此值可以设为 `value`。 | string | `children` combobox 模式下为 `value` |
2015-12-02 15:31:25 +08:00
| combobox | 输入框自动提示模式 | boolean | false |
| size | 选择框大小,可选 `large` `small` | String | default |
2016-04-27 17:57:35 +08:00
| showSearch | 在选择框中显示搜索框 | boolean | false |
2015-12-02 15:31:25 +08:00
| disabled | 是否禁用 | boolean | false |
| defaultActiveFirstOption | 是否默认高亮第一个选项。 | boolean | true
2016-05-11 02:02:23 +08:00
| getPopupContainer | 菜单渲染父节点。默认渲染到 body 上,如果你遇到菜单滚动定位问题,试试修改为滚动的区域,并相对其定位。[示例](http://codepen.io/anon/pen/xVBOVQ?editors=001) | Function(triggerNode) | () => document.body |
2016-05-19 13:44:08 +08:00
| labelInValue | 是否把每个选项的 label 包装到 value 中,决定 Select 的 value 类型。 | boolean | false |
2015-08-01 17:51:55 +08:00
### Option props
| 参数 | 说明 | 类型 | 默认值 |
|----------|----------------|----------|--------------|
| disabled | 是否禁用 | Boolean | false |
2015-12-05 01:03:08 +08:00
| key | 如果 react 需要你设置此项,此项值与 value 的值相同,然后可以省略 value 设置 | String | |
2015-08-01 17:51:55 +08:00
| value | 默认根据此属性值进行筛选 | String | - |
### OptGroup props
2015-12-05 01:03:08 +08:00
| 参数 | 说明 | 类型 | 默认值 |
|----------|----------------|----------|-----------------|
| label | 组名 | String/React.Element | 无 |
| key | | String | - |