ant-design-vue/components/auto-complete/index.en-US.md

category	type	cols	title	cover	coverDark
Components	Data Entry	2	AutoComplete	https://mdn.alipayobjects.com/huamei_7uahnr/afts/img/A*g8THS4NpV6sAAAAAAAAAAAAADrJ8AQ/original	https://mdn.alipayobjects.com/huamei_7uahnr/afts/img/A*WERTQ6qvgEYAAAAAAAAAAAAADrJ8AQ/original

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.

API

<a-auto-complete v-model:value="value" :options="options" />

Property	Description	Type	Default	Version
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
bordered	Whether has border style	boolean	true	4.0
clearIcon	Use slot custom clear icon	slot	<CloseCircleFilled />	4.0
default (for customize input element)	customize input element	slot	<Input />
defaultActiveFirstOption	Whether active first option by default	boolean	true
defaultOpen	Initial open state of dropdown	boolean	-
disabled	Whether disabled select	boolean	false
popupClassName	The className of dropdown menu	string	-	4.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
dropdownMenuStyle	additional style applied to dropdown menu	object		1.5.0
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
open	Controlled open state of dropdown	boolean	-
option	custom render option by slot	v-slot:option="{value, label, [disabled, key, title]}"	-	3.0
options	Data source for autocomplete	DataSourceItemType[]
placeholder	placeholder of input	string	-
status	Set validation status	'error' | 'warning'	-	3.3.0
v-model:value	selected option	string|string[]|{ key: string, label: string|vNodes }|Array<{ key: string, label: string|vNodes }>	-

events

Events Name	Description	Arguments	Version
blur	Called when leaving the component.	function()
change	Called when select an option or input value change, or value of input is changed	function(value)
dropdownVisibleChange	Call when dropdown open	function(open)
focus	Called when entering the component	function()
search	Called when searching items.	function(value)	-
select	Called when a option is selected. param is option's value and option instance.	function(value, option)
clear	Called when clear	function	-	3.3.0

Methods

Name	Description	Version
blur()	remove focus
focus()	get focus

FAQ

Part of the api in v2 are not available in v3?

AutoComplete is an Input component that supports auto complete tips. As such, it should not support props like labelInValue that affect value display. In v3, the AutoComplete implementation can not handle the case where the value and label are identical. v4 not longer support label as the value input.

Besides, to unify the API, dataSource is replaced with options. You can migrate with the following change:

v2

dataSource = ['light', 'bamboo'];
// or
dataSource = [
  { value: 'light', text: 'Light' },
  { value: 'bamboo', text: 'Bamboo' },
];

v3

options = [
  { value: 'light', label: 'Light' },
  { value: 'bamboo', label: 'Bamboo' },
];