New to Kendo UI for Angular? Start a free 30-day trial

AutoCompleteComponent

Component

Represents the Kendo UI AutoComplete component for Angular.

Definition

Package:@progress/kendo-angular-dropdowns

Selector:kendo-autocomplete

Export Name:Accessible in templates as #kendoAutoCompleteInstance="kendoAutoComplete"

Syntax:

html

<kendo-autocomplete
    [data]="['Item1', 'Item2', 'Item3']"
    placeholder="placeholder">
</kendo-autocomplete>

Inputs

adaptiveMode

AdaptiveMode

Enables or disables the adaptive mode. By default, the adaptive rendering is disabled.

Default:

'none'

adaptiveSubtitle

string

Sets the subtitle of the ActionSheet that renders instead of the Popup when using small screen devices. By default, the ActionSheet does not render a subtitle.

adaptiveTitle

string

Sets the title of the ActionSheet that renders instead of the Popup when using small screen devices. By default, the ActionSheet title uses the text provided for the label of the AutoComplete.

Default:

data

any

Sets the data of the AutoComplete.

The data has to be provided in an array-like list.

disabled

boolean

Sets the disabled state of the component. To learn how to disable the component in reactive forms, refer to the article on Forms Support.

Default:

false

fillMode

DropDownFillMode

Sets the fillMode of the component. The default value is set by the Kendo theme.

filterable

boolean

Enables the filtering functionality. If set to true, the component emits the filterChange event.

Default:

false

highlightFirst

boolean

Defines whether the first match from the suggestions list will be automatically focused. By default, highlightFirst is set to true.

Default:

true

inputAttributes

{ [key: string]: string }

Sets the HTML attributes of the inner focusable input element. Attributes which are essential for certain component functionalities cannot be changed.

itemDisabled

ItemDisabledFn

Defines a Boolean function that is executed for each data item in the component (see examples). Determines whether the item will be disabled.

listHeight

number

Sets the height of the options list in the popup. By default, listHeight is 200px.

The listHeight property affects only the list of options and not the whole popup container. To set the height of the popup container, use popupSettings.height.

When using adaptiveMode and the screen size is small or medium, the listHeight property is set to null.

Default:

200

loading

boolean

Sets and gets the loading state of the AutoComplete.

Default:

false

placeholder

string

Sets the placeholder of the AutoComplete.

Default:

popupSettings

PopupSettings

Configures the popup of the AutoComplete.

The available options are:

animate: Boolean—Controls the popup animation. By default, the open and close animations are enabled.
width: Number | String—Sets the width of the popup container. By default, the width of the host element is used. If set to auto, the component automatically adjusts the width of the popup and no item labels are wrapped. The auto mode is not supported when virtual scrolling is enabled.
height: Number—Sets the height of the popup container.
popupClass: String—Specifies a list of CSS classes that are used to style the popup.
appendTo: "root" | "component" | ViewContainerRef—Specifies the component to which the popup will be appended.

readonly

boolean

Sets the read-only state of the component.

Default:

false

rounded

DropDownRounded

Sets the border radius of the component. The default value is set by the Kendo theme.

showStickyHeader

boolean

Shows or hides the current group sticky header when using grouped data. By default, the sticky header is displayed (see example).

Default:

true

size

DropDownSize

Sets the size of the component. The default value is set by the Kendo theme.

suggest

boolean

Enables the auto-completion of the text based on the first data item.

Default:

false

tabindex

number

Specifies the tabindex of the component.

Default:

value

string

Sets the value of the AutoComplete.

valueField

string

Specifies the string property of the data item that represents the item value. If the data contains only primitive values, do not define it.

The valueField property can be set to point to a nested property value - e.g. category.name.

virtual

boolean | VirtualizationSettings

Enables the virtualization functionality.

Default:

false

Fields

isOpen

boolean

Returns the current open state. Returns true if the popup or actionSheet is open.

Events

blur

EventEmitter<any>

Fires each time the AutoComplete gets blurred.

close

EventEmitter<PreventableEvent>

Fires each time the popup is about to close. This event is preventable. If you cancel it, the popup remains open.

closed

EventEmitter<any>

Fires after the popup closes.

filterChange

EventEmitter<string>

Fires each time the user types in the input field. You can filter the source based on the passed filtration value (see example).

focus

EventEmitter<any>

Fires each time the user focuses the AutoComplete.

inputBlur

EventEmitter<any>

Fires each time the input element gets blurred.

inputFocus

EventEmitter<any>

Fires each time the user focuses the input element.

open

EventEmitter<PreventableEvent>

Fires each time the popup is about to open. This event is preventable. If you cancel it, the popup remains closed.

opened

EventEmitter<any>

Fires after the popup opens.

Fires each time the value changes— when the component is blurred or the value is cleared through the Clear button (see example. When the value of the component is programmatically changed to ngModel or formControl through its API or form binding, the valueChange event is not triggered because it might cause a mix-up with the built-in valueChange mechanisms of the ngModel or formControl bindings.

The state of the popup.