mirror of
https://github.com/ant-design/ant-design.git
synced 2024-11-29 13:47:02 +08:00
70 lines
4.2 KiB
Markdown
70 lines
4.2 KiB
Markdown
---
|
|
category: Components
|
|
type: Data Entry
|
|
title: Select
|
|
---
|
|
|
|
A Selector similar to Select2.
|
|
|
|
## When To Use
|
|
|
|
- A dropdown menu for choosing, an elegant alternative to the native select component.
|
|
- [Radio](/components/radio/) is a better solution when options amount is too little (less than 5).
|
|
|
|
## API
|
|
|
|
```html
|
|
<Select>
|
|
<Option value="lucy">lucy</Option>
|
|
</Select>
|
|
```
|
|
|
|
### Select props
|
|
|
|
| Property | Description | Type | Default |
|
|
|----------|----------------|----------|--------------|
|
|
| value | Current selected option. | string/Array<String> | - |
|
|
| defaultValue | Initial selected option. | string/Array<String> | - |
|
|
| multiple | Allow multiple select. | boolean | false |
|
|
| allowClear | Show clear button, working in single mode only. | boolean | false |
|
|
| filterOption | If true, filter options by input, if function, filter options against it. The function will receive two arguments, `inputValue` and `option`, if the function returns `true`, the option will be included in the filtered set; Otherwise, it will be excluded. | boolean or function(inputValue, option) | true |
|
|
| tags | When tagging is enabled the user can select from pre-existing options or create a new tag by picking the first choice, which is what the user has typed into the search box so far. | boolean |false |
|
|
| onSelect | Called when a option is selected, the params are option's value (or key) and option instance. | function(value, option) | - |
|
|
| onDeselect | Called when a option is deselected, the params are option's value (or key) . only called for multiple or tags, effective in multiple or tags mode only. | function(value) | - |
|
|
| onChange | Called when select an option or input value change, or value of input is changed in combobox mode | function(value, label) | - |
|
|
| onSearch | Callback function that is fired when input changed. | function(value: String) | |
|
|
| onBlur | Called when blur | function | - |
|
|
| onFocus | Called when focus | function | - |
|
|
| placeholder | Placeholder of select | string | - |
|
|
| notFoundContent | Specify content to show when no result matches..| string | 'Not Found' |
|
|
| dropdownMatchSelectWidth | Whether dropdown's with is same with select. | boolean | true |
|
|
| optionFilterProp | Which prop value of option will be used for filter if filterOption is true | string | value |
|
|
| optionLabelProp | Which prop value of option will render as content of select. | string | `children` |
|
|
| combobox | Enable combobox mode(can not set multiple at the same time). | boolean | false |
|
|
| size | Size of Select input. `large` `small` | String | default |
|
|
| showSearch | Whether show search input in single mode.| boolean | false |
|
|
| disabled | Whether disabled select | boolean | false |
|
|
| defaultActiveFirstOption | Whether active first option by default | boolean | true |
|
|
| dropdownStyle | style of dropdown menu | object | - |
|
|
| dropdownClassName | className of dropdown menu | string | - |
|
|
| getPopupContainer | Parent Node which the selector should be rendered to. Default to `body`. When position issues happen, try to modify it into scrollable content and position it relative.[example](http://codepen.io/anon/pen/xVBOVQ?editors=001) | function(triggerNode) | () => document.body |
|
|
| labelInValue | whether to embed label in value, turn the format of value from `string` to `{key: String, label: React.Node}` | boolean | false |
|
|
| tokenSeparators | Separator used to tokenize on tag/multiple mode | string[]? | |
|
|
|
|
|
|
### Option props
|
|
|
|
| Property | Description | Type | Default |
|
|
|----------|----------------|----------|--------------|
|
|
| disabled | Disable this option | Boolean | false |
|
|
| value | default to filter with this property | String | - |
|
|
| key | Same usage as `value`. If React request you to set this property, you can set it to value of option, and then omit value property. | String | |
|
|
| title | `title` of Select after select this Option | String | - |
|
|
|
|
### OptGroup props
|
|
|
|
| Property | Description | Type | Default |
|
|
|----------|----------------|----------|-----------------|
|
|
| label | Group label | String/React.Element | - |
|
|
| key | | String | - |
|