allowClear |
Show clear button. |
boolean |
false |
autoClearSearchValue |
Whether the current search will be cleared on selecting an item |
boolean |
true |
autoFocus |
Get focus by default |
boolean |
false |
clearIcon |
The custom clear icon |
React.ReactNode |
- |
defaultActiveFirstOption |
Whether active first option by default |
boolean |
true |
defaultOpen |
Initial open state of dropdown |
boolean |
- |
defaultValue |
Initial selected option. |
string / string[] / number / number[] / LabeledValue / LabeledValue[]
|
- |
description |
input description |
string |
- |
disabled |
Whether disabled select |
boolean |
false |
dropdownClassName |
className of dropdown menu |
string |
- |
dropdownMatchSelectWidth |
Whether dropdown's width is same with select. |
boolean |
true |
dropdownMenuStyle |
additional style applied to dropdown menu |
React.CSSProperties |
- |
dropdownRender |
Customize dropdown content |
(menuNode: React.ReactNode, props) => React.ReactNode |
- |
dropdownStyle |
style of dropdown menu |
React.CSSProperties |
- |
errorText |
error message, if provided input will be set in error state |
string |
- |
error |
if provided input will be set in error state, without error message |
boolean |
- |
filterOption |
If true, filter options by input, if function, filter options against it. |
boolean / (inputValue: string / number / LabeledValue, option: Option) => void |
true |
firstActiveValue |
Value of action option by default |
string or string[] |
- |
grey |
Turn on grey background of the component |
boolean |
false |
getPopupContainer |
Parent Node which the selector should be rendered to. Default to body |
(triggerNode: React.ReactNode) => void |
() => document.body |
label |
input label |
string |
- |
labelInValue |
whether to embed label in value |
boolean |
false |
loading |
indicate loading state |
Boolean |
false |
maxTagCount |
Max tag count to show |
number |
- |
maxTagPlaceholder |
Placeholder for not showing tags |
React.ReactNode/function(omittedValues) |
- |
maxTagTextLength |
Max tag count to show |
number |
- |
menuItemSelectedIcon |
The custom menuItemSelected icon with multiple options |
React.ReactNode |
- |
mode |
Set mode of Select |
default / multiple / tags
|
default |
notFoundContent |
Specify content to show when no result matches. |
string |
Not Found |
onBlur |
Called when blur |
(e: Event) => void |
- |
onChange |
Called when select an option or input value change, or value of input is changed in combobox mode |
(value: string / number / LabeledValue, option: Option / Option[]) => void |
- |
onDeselect |
Called when a option is deselected, param is the selected option's value. |
(value: string / number / LabeledValue) => void |
- |
onDropdownVisibleChange |
Call when dropdown open |
(open: boolean) => void |
- |
onFocus |
Called when focus |
(e: Event) => void |
- |
onInputKeyDown |
Called when key pressed |
(e: Event) => void |
- |
onMouseEnter |
Called when mouse enter |
(e: Event) => void |
- |
onMouseLeave |
Called when mouse leave |
(e: Event) => void |
- |
onPopupScroll |
Called when dropdown scrolls |
(e: Event) => void |
- |
onSearch |
Callback function that is fired when input changed. |
(value: string) => void |
|
onSelect |
Called when a option is selected, the params are option's value (or key) and option instance. |
(value: string / number / LabeledValue, option:Option) => void |
- |
open |
Controlled open state of dropdown |
boolean |
- |
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 / React.ReactNode |
- |
removeIcon |
The custom remove icon |
React.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 or large . small is deprecated |
string |
default |
suffixIcon |
The custom suffix icon |
React.ReactNode |
- |
tokenSeparators |
Separator used to tokenize on tag/multiple mode |
string[] |
|
tooltip |
Tooltip content |
React.ReactNode |
- |
tooltipConfig |
Config of tooltip |
TooltipProps |
- |
value |
Current selected option. |
string / string[] / number / number[] / LabeledValue / LabeledValue[]
|
- |