AutoComplete

Autocomplete function of input field.

When To Use

When you need an input box instead of a selector.
When you need input suggestions or helping text.

The differences with Select are:

AutoComplete is an input box with text hints, and users can type freely. The keyword is aiding input.
Select is selecting among given choices. The keyword is select.

Examples

API

Common props ref：Common props

Property	Description	Type	Default	Version
allowClear	Show clear button	boolean \| { clearIcon?: ReactNode }	false	5.8.0: Support Object type
autoFocus	If get focus when component mounted	boolean	false
backfill	If backfill selected item the input when using keyboard	boolean	false
bordered	Whether has border style	boolean	true
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
defaultOpen	Initial open state of dropdown	boolean	-
defaultValue	Initial selected option	string	-
disabled	Whether disabled select	boolean	false
popupClassName	The className of dropdown menu	string	-	4.23.0
dropdownMatchSelectWidth	Determine whether the dropdown menu and the select input are the same width. Default set `min-width` same as input. Will ignore when value less than select width. `false` will disable virtual scroll	boolean \| number	true
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 \| function(inputValue, option)	true
notFoundContent	Specify content to show when no result matches	string	`Not Found`
open	Controlled open state of dropdown	boolean	-
options	Select options. Will get better perf than jsx definition	{ label, value }[]	-
placeholder	The placeholder of input	string	-
status	Set validation status	'error' \| 'warning'	-	4.19.0
value	Selected option	string	-
onBlur	Called when leaving the component	function()	-
onChange	Called when selecting an option or changing an input value	function(value)	-
onDropdownVisibleChange	Call when dropdown open	function(open)	-
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)	-
onClear	Called when clear	function	-	4.6.0

Methods

Name	Description	Version
blur()	Remove focus
focus()	Get focus

Design Token

Component TokenHow to use?

Token Name	Description	Type	Default Value
clearBg	Background color of clear button	string	#ffffff
multipleItemBg	Background color of multiple tag	string	rgba(0, 0, 0, 0.06)
multipleItemBorderColor	Border color of multiple tag	string	transparent
multipleItemBorderColorDisabled	Border color of multiple tag when disabled	string	transparent
multipleItemColorDisabled	Text color of multiple tag when disabled	string	rgba(0, 0, 0, 0.25)
multipleItemHeight	Height of multiple tag	number	24
multipleItemHeightLG	Height of multiple tag with large size	number	32
multipleSelectorBgDisabled	Background color of multiple selector when disabled	string	rgba(0, 0, 0, 0.04)
optionActiveBg	Background color when option is active	string	rgba(0, 0, 0, 0.04)
optionFontSize	Font size of option	number	14
optionHeight	Height of option	number	32
optionLineHeight	Line height of option	undefined \| LineHeight<string \| number>	1.5714285714285714
optionPadding	Padding of option	undefined \| Padding<string \| number>	5px 12px
optionSelectedBg	Background color when option is selected	string	#e6f4ff
optionSelectedColor	Text color when option is selected	string	rgba(0, 0, 0, 0.88)
optionSelectedFontWeight	Font weight when option is selected	undefined \| FontWeight	600
selectorBg	Background color of selector	string	#ffffff
singleItemHeightLG	Height of single selected item with large size	number	40
zIndexPopup	z-index of dropdown	number	1050

Global TokenHow to use?

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 the same as onChange. Besides, clicking on the option will not trigger the onSearch event.

Related issue: #18230 #17916

The AutoComplete component is essentially an extension of the Input form element. When the options property is empty, displaying empty text could mislead the user into believing the component is not operational, when in fact they are still able to input text. To avoid confusion, the open property will not display the drop-down menu when set to true and in combination with an empty options property. The open property must be used in conjunction with the options property.

Ant Design

AutoComplete

Ant Design

AutoComplete

When To Use

Examples

API

Methods

Design Token

Component TokenHow to use?

Global TokenHow to use?

FAQ

Why doesn't the text composition system work well with onSearch in controlled mode?

Why won't a controlled open AutoComplete display a drop-down menu when options are empty?

When To Use

Examples

API

Methods

Design Token

Component TokenHow to use?

Global TokenHow to use?

FAQ

Why doesn't the text composition system work well with onSearch in controlled mode?

Why won't a controlled open AutoComplete display a drop-down menu when options are empty?

AutoCompleteChangelog

AutoCompleteChangelog

When To Use

Examples

API

Methods

Design Token

Component TokenHow to use?

Global TokenHow to use?

FAQ

Why doesn't the text composition system work well with onSearch in controlled mode?

Why won't a controlled open AutoComplete display a drop-down menu when options are empty?

When To Use

Examples

API

Methods

Design Token

Component TokenHow to use?

Global TokenHow to use?

FAQ

Why doesn't the text composition system work well with onSearch in controlled mode?

Why won't a controlled open AutoComplete display a drop-down menu when options are empty?

AutoComplete

AutoComplete