mirror of
https://gitee.com/ant-design/ant-design.git
synced 2024-12-04 04:58:55 +08:00
1.5 KiB
1.5 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 | Array | |
value | selected option | String/Array/{key: String, label: React.Node}/Array<{key, label}> | - |
defaultValue | Initial selected option. | string/Array | - |
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 /> |