AutoComplete
Represents the Kendo UI for Vue AutoComplete component. Use the AutoComplete to show a list of suggestions while the user types in an input field.
Definition
Package:@progress/kendo-vue-dropdowns
Properties Interface:AutoCompleteProps
Syntax:
<AutoComplete :data-items="countries" :placeholder="'e.g. Denmark'" />
Properties
accessKey?
string
Sets the accessKey attribute of the AutoComplete.
ariaDescribedBy?
string
Sets the id values of the elements that describe the AutoComplete, like the HTML aria-describedby attribute.
For example, these elements can contain an error or a hint message.
ariaLabel?
string
Sets the aria-label attribute of the AutoComplete.
ariaLabelledBy?
string
Sets the id values of the elements that label the AutoComplete.
dataItems?
any[]
Sets the data of the AutoComplete (more information and example).
defaultValue?
string
Sets the default value of the AutoComplete. It works like the defaultValue of the native input HTML element.
dir?
string
Sets the dir HTML attribute of the AutoComplete.
disabled?
boolean
Sets the disabled state of the AutoComplete.
fillMode?
"solid" | "outline" | "flat"
Configures the fillMode of the AutoComplete.
The available options are:
- solid
- outline
- flat
undefined
Sets a function that returns the index of the focused item.
By default, the AutoComplete focuses the first item that starts with the input text.
number
footer?
any
Sets the footer component of the AutoComplete popup (see example).
groupField?
string
Sets the data item field that marks the start of a group. Applies to object data.
Sets a custom template for the group header items of the AutoComplete. Use it to change the default look of the group headers.
Sets a custom template for the sticky group header of the AutoComplete. Use it to change the default look of the sticky group header.
header?
any
Sets the header component of the AutoComplete popup (see example).
id?
string
Sets the id of the input element of the AutoComplete. The floating label uses it as its target.
inputAttributes?
Object
Sets the built-in HTML attributes of the inner focusable input element.
You cannot change the attributes that some component features need.
itemRender?
any
Sets a custom template for the list items of the AutoComplete (see example). Use it to change the default look of the list items.
label?
string
Renders a floating label for the AutoComplete.
Sets a custom template for the element that the popup shows when there is no data (see example). Use it to change the default look of this element.
loading?
boolean
Sets the loading state of the AutoComplete (see example).
modelValue?
string
Sets the value of the AutoComplete when you use v-model (more information and example).
name?
string
Sets the name property of the input DOM element.
onBlur?
(event: AutoCompleteBlurEvent) => void
Fires each time the AutoComplete loses focus.
onChange?
(event: AutoCompleteChangeEvent) => void
Fires each time the value of the AutoComplete is about to change (more information and example).
onClose?
(event: AutoCompleteCloseEvent) => void
Fires each time the popup of the AutoComplete is about to close.
onFocus?
(event: AutoCompleteFocusEvent) => void
Fires each time the AutoComplete receives focus.
onOpen?
(event: AutoCompleteOpenEvent) => void
Fires each time the popup of the AutoComplete is about to open.
opened?
boolean
Sets whether the popup of the AutoComplete is open or closed.
placeholder?
string
Sets the hint that the AutoComplete shows when it is empty.
Configures the popup of the AutoComplete.
{ animate: true, height: '200px', anchor: '' }
readonly?
boolean
Sets the read-only state of the AutoComplete.
required?
boolean
Sets whether null is a valid value for the component.
rounded?
"none" | "small" | "medium" | "large" | "full"
Configures the roundness of the AutoComplete.
The available options are:
- none
- small
- medium
- large
- full
undefined
size?
"small" | "medium" | "large"
Configures the size of the AutoComplete.
The available options are:
- small
- medium
- large
undefined
suggest?
string | boolean
Turns on the auto-completion of the text based on the first data item (see example).
false
tabIndex?
number
Sets the tabIndex attribute of the AutoComplete.
textField?
string
Sets the data item field that holds the item text (see example). If the data contains only primitive values, do not set it.
valid?
boolean
Overrides the validity state of the component.
When you set valid, the component ignores the required property.
validationMessage?
string
Sets the form error message of the component. If you set it to an empty string, the component shows no error.
validityStyles?
boolean
Shows or hides the invalid state styles of the component. When you set it to false, the component shows no invalid state styles.
value?
string
Sets the value of the AutoComplete (more information and example).