AutoComplete

Autocomplete function of input field.

AutoComplete

When to use

When there is a need for autocomplete functionality.


Basic Usage

Basic Usage, set data source of autocomplete with options property.


Customized

You could pass AutoComplete.Option as children of AutoComplete, instead of using options

Customize Input Component

Customize Input Component

Non-case-sensitive AutoComplete

A non-case-sensitive AutoComplete.

Lookup-Patterns - Certain Category

Demonstration of Lookup Patterns: Certain Category. Basic Usage, set options of autocomplete with options property.

Lookup-Patterns - Uncertain Category

Demonstration of Lookup Patterns: Uncertain Category.

API

PropertyDescriptionTypeDefault
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
<Input />
children (for dataSource)
Data source to auto complete
React.ReactElement Array>
-
defaultActiveFirstOption
Whether active first option by default
boolean
true
defaultValue
Initial selected option.
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
placeholder
placeholder of input
string
-
value
selected option
string
-
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)
-
notFoundContent
Specify content to show when no result matches..
string
'Not Found'

Methods

NameDescriptionVersion
blur()
remove focus
focus()
get focus