mirror of
https://github.com/ant-design/ant-design.git
synced 2024-11-29 21:59:41 +08:00
2.9 KiB
2.9 KiB
| category | type | cols | title |
|---|---|---|---|
| Components | Data Entry | 2 | AutoComplete |
Autocomplete function of input field.
When To Use
When there is a need for autocomplete functionality.
API
| Property | Description | Type | Default | Version |
|---|---|---|---|---|
| allowClear | Show clear button, effective in multiple mode only. | boolean | false | |
| autoFocus | get focus when component mounted | boolean | false | |
| backfill | backfill selected item the input when using keyboard | boolean | false | |
| children (for customize input element) | customize input element | HTMLInputElement HTMLTextAreaElement React.ReactElement<InputProps> |
<Input /> |
|
| children (for dataSource) | Data source to auto complete | React.ReactElement<OptionProps> Array<React.ReactElement<OptionProps>> |
- | |
| defaultActiveFirstOption | Whether active first option by default | boolean | true | |
| defaultValue | Initial selected option. | string|string[] | - | |
| disabled | Whether disabled select | 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 | |
| optionLabelProp | Which prop value of option will render as content of select. | string | children |
|
| placeholder | placeholder of input | string | - | |
| value | selected option | string|string[]|{ key: string, label: string|ReactNode }|Array<{ key: string, label: string|ReactNode }> | - | |
| onBlur | Called when leaving the component. | function() | - | |
| onChange | Called when select an option or input value change, or value of input is changed | function(value) | - | |
| onFocus | Called when entering the component | function() | - | |
| onSearch | Called when searching items. | function(value) | - | |
| onSelect | Called when a option is selected. param is option's value and option instance. | function(value, option) | - | |
| defaultOpen | Initial open state of dropdown | boolean | - | |
| open | Controlled open state of dropdown | boolean | - | |
| onDropdownVisibleChange | Call when dropdown open | function(open) | - |
Methods
| Name | Description | Version |
|---|---|---|
| blur() | remove focus | |
| focus() | get focus |
FAQ
Why doesn't the text composition system work well with onSearch in controlled mode?
Please use onChange to manage control state. onSearch is used for searching input which is not same as onChange. Besides, clicking on the option will not trigger the onSearch event.