| allowClear |
Show clear button. |
boolean |
false |
| autoClearSearchValue |
Whether the current search will be cleared on selecting an item. Only applies when mode is set to multiple or tags. |
boolean |
true |
| autoFocus |
Get focus by default |
boolean |
false |
| defaultActiveFirstOption |
Whether active first option by default |
boolean |
true |
| defaultValue |
Initial selected option. |
string|string[]
number|number[] |
- |
| disabled |
Whether disabled select |
boolean |
false |
| dropdownClassName |
className of dropdown menu |
string |
- |
| dropdownMatchSelectWidth |
Whether dropdown's width is same with select. |
boolean |
true |
| dropdownRender |
Customize dropdown content |
(menuNode: ReactNode, props) => ReactNode |
- |
| dropdownStyle |
style of dropdown menu |
object |
- |
| 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 |
| firstActiveValue |
Value of action option by default |
string|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 |
function(triggerNode) |
() => document.body |
| labelInValue |
whether to embed label in value, turn the format of value from string to {key: string, label: ReactNode} |
boolean |
false |
| maxTagCount |
Max tag count to show |
number |
- |
| maxTagPlaceholder |
Placeholder for not showing tags |
ReactNode/function(omittedValues) |
- |
| mode |
Set mode of Select |
'default' | 'multiple' | 'tags' |
'default' |
| notFoundContent |
Specify content to show when no result matches.. |
string |
'Not Found' |
| 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 |
value for combobox, children for other modes |
| placeholder |
Placeholder of select |
string|ReactNode |
- |
| showArrow |
Whether to show the drop-down arrow |
boolean |
true |
| showSearch |
Whether show search input in single mode. |
boolean |
false |
| size |
Size of Select input. default large small |
string |
default |
| suffixIcon |
The custom suffix icon |
ReactNode |
- |
| removeIcon |
The custom remove icon |
ReactNode |
- |
| clearIcon |
The custom clear icon |
ReactNode |
- |
| menuItemSelectedIcon |
The custom menuItemSelected icon |
ReactNode |
- |
| tokenSeparators |
Separator used to tokenize on tag/multiple mode |
string[] |
|
| value |
Current selected option. |
string|number|string[]|number[] |
- |
| onBlur |
Called when blur |
function |
- |
| onChange |
Called when select an option or input value change, or value of input is changed in combobox mode |
function(value, option:Option/Array<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, option:Option) |
- |
| onFocus |
Called when focus |
function |
- |
| onInputKeyDown |
Called when key pressed |
function |
- |
| onMouseEnter |
Called when mouse enter |
function |
- |
| onMouseLeave |
Called when mouse leave |
function |
- |
| onPopupScroll |
Called when dropdown scrolls |
function |
- |
| onSearch |
Callback function that is fired when input changed. |
function(value: string) |
|
| onSelect |
Called when a option is selected, the params are option's value (or key) and option instance. |
function(value, option:Option) |
- |
| defaultOpen |
Initial open state of dropdown |
boolean |
- |
| open |
Controlled open state of dropdown |
boolean |
- |
| onDropdownVisibleChange |
Call when dropdown open (Supported after version 3.9.0) |
function(open) |
- |
| loading |
indicate loading state |
Boolean |
false |
