mirror of
https://github.com/ant-design/ant-design.git
synced 2024-11-30 06:09:34 +08:00
1.7 KiB
1.7 KiB
| category | type | cols | title |
|---|---|---|---|
| Components | Data Entry | 1 | AutoComplete |
Autocomplete function of input field.
When To Use
When there is a need for autocomplete functionality.
API
const dataSource = ['12345', '23456', '34567'];
<AutoComplete dataSource={dataSource} />
Since AutoComplete is based on Select, so besides the following API, AutoComplete has the same API as Select.
| Property | Description | Type | Default |
|---|---|---|---|
| dataSource | Data source for autocomplete | DataSourceItemType[] | |
| value | selected option | string|string[]|{ key: string, label: string|ReactNode }|Array<{ key: string, label: string|ReactNode }> | - |
| defaultValue | Initial selected option. | string|string[]|{ key: string, label: string|ReactNode }|Array<{ key: string, label: string|ReactNode }> | - |
| allowClear | Show clear button, effective in multiple mode only. | boolean | false |
| onChange | Called when select an option or input value change, or value of input is changed | function(value, label) | - |
| onSelect | Called when a option is selected. param is option's value and option instance. | function(value, option) | - |
| disabled | Whether disabled select | boolean | false |
| placeholder | placeholder of input | string | - |
| children (for dataSource) | Data source for autocomplet | React.ReactElement / Array<React.ReactElement> | - |
| children (for customize input element) | customize input element | HTMLInputElement / HTMLTextAreaElement / React.ReactElement | <Input /> |