2016-07-25 17:46:45 +08:00
---
category: Components
2016-11-09 14:43:32 +08:00
type: Data Entry
2016-07-25 17:46:45 +08:00
cols: 1
2016-09-08 16:53:50 +08:00
title: AutoComplete
2016-07-25 17:46:45 +08:00
---
Autocomplete function of input field.
2016-09-10 13:43:30 +08:00
## When To Use
2016-07-25 17:46:45 +08:00
2016-11-29 17:13:24 +08:00
When there is a need for autocomplete functionality.
2016-07-25 17:46:45 +08:00
## API
```jsx
const dataSource = ['12345', '23456', '34567'];
< AutoComplete dataSource = {dataSource} / >
```
| Property | Description | Type | Default |
|----------------|----------------------------------|------------|--------|
2017-01-20 20:10:50 +08:00
| dataSource | Data source for autocomplete | [DataSourceItemType ](https://git.io/vMMKF )[] | |
| 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 }> | - |
2016-07-25 17:46:45 +08:00
| allowClear | Show clear button, effective in multiple mode only. | boolean | false |
2016-10-07 20:22:46 +08:00
| onChange | Called when select an option or input value change, or value of input is changed | function(value, label) | - |
2016-10-08 11:20:53 +08:00
| onSelect | Called when a option is selected. param is option's value and option instance. | function(value, option) | - |
2016-07-25 17:46:45 +08:00
| disabled | Whether disabled select | boolean | false |
2016-12-03 15:28:47 +08:00
| placeholder | placeholder of input | string | - |
2017-01-13 21:19:23 +08:00
| children (for dataSource) | Data source for autocomplet | React.ReactElement< OptionProps > / Array< React.ReactElement < OptionProps > > | - |
2017-01-20 18:28:09 +08:00
| children (for customize input element) | customize input element | HTMLInputElement / HTMLTextAreaElement / React.ReactElement< InputProps > | `<Input />` |
2017-02-13 15:45:49 +08:00
| 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 |