Configuration

An object defining configuration options for the Autocomplete widget.

accessKey

Specifies the shortcut key that sets focus on the widget.

Type:

String

Default Value: null

The value of this option will be passed to the accesskey attribute of the HTML element that underlies the widget.

activeStateEnabled

Specifies whether or not the widget changes its state when interacting with a user.

Type:

Boolean

Default Value: true

This option is used when the widget is displayed on a platform whose guidelines include the active state change for widgets.

dataSource

A data source used to fetch data the widget should display.

Default Value: null

This option accepts one of the following:

  • Array
    A JavaScript array that contains string, numeric, Boolean values, or plain objects.

  • URL
    The URL of a JSON file or service that returns JSON data.

  • DataSource or its configuration object
    The DataSource is an object that provides an API for data processing. The DataSource's underlying data access logic is isolated in a store. Refer to the Data Layer and DataSource Examples guides for more information about the DataSource.

If the data source contains objects, specify the key in the store and/or a data field providing values in the widget.

NOTE
Data field names should not contain the following characters: ., ,, :, [, and ]. Their presence may cause issues in the widget's operation.

If the data source is specified using the dataSource option, use the items option only for reading. Updating data items using the items option may cause unexpected results.

See Also

deferRendering

Specifies whether to render the drop-down field's content when it is displayed. If false, the content is rendered immediately.

Type:

Boolean

Default Value: true

disabled

Specifies whether the widget responds to user interaction.

Type:

Boolean

Default Value: false

displayValue

Returns the value currently displayed by the widget.

Type:

String

Read-only
Default Value: undefined

The value you pass to this option does not affect widget behavior. Pass an observable variable to this option to get the value currently displayed by the widget.

dropDownButtonTemplate

Specifies a custom template for the drop-down button.

Type:

template

Function parameters:
buttonData:

Object

Information about the button.

Object structure:
text:

String

The button's text.

icon:

String

The button's icon.

contentElement:

Element (jQuery or HTML)

The button's container. It is an HTML Element or a jQuery Element when you use jQuery.

Return Value:

String

|

DOM Node

|

jQuery

A template name or container.

Default Value: 'dropDownButton'

elementAttr

Specifies the attributes to be attached to the widget's root element.

Type:

Object

Default Value: {}
jQuery
$(function(){
    $("#autocompleteContainer").dxAutocomplete({
        // ...
        elementAttr: {
            id: "elementId",
            class: "class-name"
        }
    });
});
Angular
HTML
TypeScript
<dx-autocomplete ...
    [elementAttr]="{ id: 'elementId', class: 'class-name' }">
</dx-autocomplete>
import { DxAutocompleteModule } from "devextreme-angular";
// ...
export class AppComponent {
    // ...
}
@NgModule({
    imports: [
        // ...
        DxAutocompleteModule
    ],
    // ...
})
ASP.NET MVC Control
Razor C#
Razor VB
@(Html.DevExtreme().Autocomplete()
    .ElementAttr("class", "class-name")
    // ===== or =====
    .ElementAttr(new {
        @id = "elementId",
        @class = "class-name"
    })
    // ===== or =====
    .ElementAttr(new Dictionary<string, object>() {
        { "id", "elementId" },
        { "class", "class-name" }
    })

)
@(Html.DevExtreme().Autocomplete() _
    .ElementAttr("class", "class-name")
    ' ===== or =====
    .ElementAttr(New With {
        .id = "elementId",
        .class = "class-name"
    })
    ' ===== or =====
    .ElementAttr(New Dictionary(Of String, Object) From {
        { "id", "elementId" },
        { "class", "class-name" }
    })
)

focusStateEnabled

Specifies whether the widget can be focused using keyboard navigation.

Type:

Boolean

Default Value: true

grouped

Specifies whether data items should be grouped.

Type:

Boolean

Default Value: false

When this option is true, make sure that all data source objects have the following structure:

JavaScript
var dataSource = [{
    key: "Group 1", // Group caption 
    items: [ // Items in the group
        { ... },
        { ... }
    ]
}, {
    // ...
}];

You can supply data to this structure using the DataSource object's group option.

NOTE
Only one-level grouping is supported.
See Also

groupTemplate

Specifies a custom template for group captions.

Type:

template

Function parameters:
itemData:

Object

The group's data.

itemIndex:

Number

The group's index.

itemElement:

Element (jQuery or HTML)

The group's container. It is an HTML Element or a jQuery Element when you use jQuery.

Return Value:

String

|

DOM Node

|

jQuery

A template name or container.

Default Value: 'group'
See Also

height

Specifies the widget's height.

Type:

Number

|

String

|

Function

Return Value:

Number

|

String

The widget's height.

Default Value: undefined

This option accepts a value of one of the following types:

  • Number
    The height in pixels.

  • String
    A CSS-accepted measurement of height. For example, "55px", "80%", "auto", "inherit".

  • Function
    A function returning either of the above. For example:

    JavaScript
    height: function() {
        return window.innerHeight / 1.5;
    }

hint

Specifies text for a hint that appears when a user pauses on the widget.

Type:

String

Default Value: undefined

hoverStateEnabled

Specifies whether the widget changes its state when a user pauses on it.

Type:

Boolean

Default Value: true

inputAttr

Specifies the attributes to be passed on to the underlying HTML element.

Type:

Object

Default Value: {}
jQuery
$(function(){
    $("#autocompleteContainer").dxAutocomplete({
        // ...
        inputAttr: {
            id: "inputId"
        }
    });
});
Angular
HTML
TypeScript
<dx-autocomplete ...
    [inputAttr]="{ id: 'inputId' }">
</dx-autocomplete>
import { DxAutocompleteModule } from "devextreme-angular";
// ...
export class AppComponent {
    // ...
}
@NgModule({
    imports: [
        // ...
        DxAutocompleteModule
    ],
    // ...
})
ASP.NET MVC Control
Razor C#
Razor VB
@(Html.DevExtreme().Autocomplete()
    .InputAttr("id", "inputId")
    // ===== or =====
    .InputAttr(new {
        @id = "inputId"
    })
    // ===== or =====
    .InputAttr(new Dictionary<string, object>() {
        { "id", "inputId" }
    })
)
@(Html.DevExtreme().Autocomplete() _
    .InputAttr("id", "inputId")
    ' ===== or =====
    .InputAttr(New With {
        .id = "inputId"
    })
    ' ===== or =====
    .InputAttr(New Dictionary(Of String, Object) From {
        { "id", "inputId" }
    })
)

isValid

Specifies whether the editor's value is valid.

Type:

Boolean

Default Value: true

In Knockout apps, you may need to inform a user about an error that occurred during the validation of a view model field. For this purpose, set the editor's isValid option to the isValid value of the dxValidator that validates this field. To show an error message, set the editor's validationError option to the dxValidator's validationError value.

JavaScript
var editorValue = ko.observable("").extend({
    dxValidator: {
        validationRules: [{
            type: "required",
            message: "Specify this value"
        }]
    }
});
var viewModel = {
    editorOptions: {
        value: editorValue,
        isValid: editorValue.dxValidator.isValid,
        validationError: editorValue.dxValidator.validationError
    }
};

The editor's isValid and validationError options should also be specified when using a custom validation engine. In this instance, the validation result will be displayed for the editor by the means of the DevExtreme Validation UI.

See Also

items

An array of items displayed by the widget.

Type:

Array<any>

You can use the dataSource option instead. Unlike the items option, the dataSource option can take on the DataSource configuration object as well as a simple array.

NOTE
If you need to modify the data source specified using the items option at runtime, do it only with the help of the items option. Updating data items using the dataSource option may cause unexpected results.

itemTemplate

Specifies a custom template for items.

Type:

template

Function parameters:
itemData:

Object

The current item's data.

itemIndex:

Number

The current item's index.

itemElement:

Element (jQuery or HTML)

The current item's container. It is an HTML Element or a jQuery Element when you use jQuery.

Return Value:

String

|

DOM Node

|

jQuery

A template name or container.

Default Value: 'item'

maxItemCount

Specifies the maximum count of items displayed by the widget.

Type:

Number

Default Value: 10

maxLength

Specifies the maximum number of characters you can enter into the textbox.

Type:

String

|

Number

Default Value: null

If the number of entered characters reaches the value assigned to this option, the widget does not allow you to enter any more characters.

minSearchLength

The minimum number of characters that must be entered into the text box to begin a search.

Type:

Number

Default Value: 1

name

The value to be assigned to the name attribute of the underlying HTML element.

Type:

String

Default Value: ''

Specify this option if the widget lies within an HTML form that will be submitted.

If you configure the widget as an ASP.NET MVC Control, use this option to bind the widget to a model property. If this model property contains Data Annotation validation attributes, you get the client-side validation enabled by default.

onChange

A function that is executed when the widget loses focus after the content has been changed.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

Autocomplete

The widget's instance.

element:

Element (jQuery or HTML)

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

model:

Object

The model data. Available only if Knockout is used.

jQueryEvent:

jQuery.Event

The jQuery event that caused the handler execution. Deprecated in favor of the event field.

event:

Event (jQuery or dxEvent)

The event that caused the handler execution. It is a dxEvent or a jQuery.Event when you use jQuery.

Default Value: null

onClosed

A function that is executed once the drop-down editor is closed.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

Autocomplete

The widget's instance.

element:

Element (jQuery or HTML)

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

model:

Object

The model data. Available only if Knockout is used.

Default Value: null

onContentReady

A function that is executed when the widget's content is ready and each time the content is changed.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

Autocomplete

The widget's instance.

element:

Element (jQuery or HTML)

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

model:

Object

The model data. Available only when using Knockout.

Default Value: null

If data displayed by the widget is specified using a DataSource instance, the contentReady event fires each time the load() method of the DataSource instance is called as well as when widget content is ready. In this case, when you create the widget, the contentReady event is raised twice: when the widget's content is ready (at this moment, the widget does not display items) and when the DataSource is loaded (the widget displays the loaded items).

onCopy

A function that is executed when the widget's input has been copied.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

Autocomplete

The widget's instance.

element:

Element (jQuery or HTML)

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

model:

Object

The model data. Available only if Knockout is used.

jQueryEvent:

jQuery.Event

The jQuery event that caused the handler execution. Deprecated in favor of the event field.

event:

Event (jQuery or dxEvent)

The event that caused the handler execution. It is a dxEvent or a jQuery.Event when you use jQuery.

Default Value: null

onCut

A function that is executed when the widget's input has been cut.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

Autocomplete

The widget's instance.

element:

Element (jQuery or HTML)

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

model:

Object

The model data. Available only if Knockout is used.

jQueryEvent:

jQuery.Event

The jQuery event that caused the handler execution. Deprecated in favor of the event field.

event:

Event (jQuery or dxEvent)

The event that caused the handler execution. It is a dxEvent or a jQuery.Event when you use jQuery.

Default Value: null

onDisposing

A function that is executed before the widget is disposed of.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

Autocomplete

The widget's instance.

element:

Element (jQuery or HTML)

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

model:

Object

The model data. Available only if you use Knockout.

Default Value: null

onEnterKey

A function that is executed when the Enter key has been pressed while the widget is focused.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

Autocomplete

The widget's instance.

element:

Element (jQuery or HTML)

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

model:

Object

The model data. Available only if Knockout is used.

jQueryEvent:

jQuery.Event

The jQuery event that caused the handler execution. Deprecated in favor of the event field.

event:

Event (jQuery or dxEvent)

The event that caused the handler execution. It is a dxEvent or a jQuery.Event when you use jQuery.

Default Value: null

onFocusIn

A function that is executed when the widget gets focus.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

Autocomplete

The widget's instance.

element:

Element (jQuery or HTML)

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

model:

Object

The model data. Available only if Knockout is used.

jQueryEvent:

jQuery.Event

The jQuery event that caused the handler execution. Deprecated in favor of the event field.

event:

Event (jQuery or dxEvent)

The event that caused the handler execution. It is a dxEvent or a jQuery.Event when you use jQuery.

Default Value: null

onFocusOut

A function that is executed when the widget loses focus.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

Autocomplete

The widget's instance.

element:

Element (jQuery or HTML)

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

model:

Object

The model data. Available only if Knockout is used.

jQueryEvent:

jQuery.Event

The jQuery event that caused the handler execution. Deprecated in favor of the event field.

event:

Event (jQuery or dxEvent)

The event that caused the handler execution. It is a dxEvent or a jQuery.Event when you use jQuery.

Default Value: null

onInitialized

A function that is executed only once, after the widget is initialized.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

Autocomplete

The widget's instance.

element:

Element (jQuery or HTML)

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

Default Value: null

You cannot access widget elements in this function because it is executed before they are ready. Use the onContentReady function instead.

onInput

A function that is executed each time the widget's input is changed while the widget is focused.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

Autocomplete

The widget's instance.

element:

Element (jQuery or HTML)

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

model:

Object

The model data. Available only if Knockout is used.

jQueryEvent:

jQuery.Event

The jQuery event that caused the handler execution. Deprecated in favor of the event field.

event:

Event (jQuery or dxEvent)

The event that caused the handler execution. It is a dxEvent or a jQuery.Event when you use jQuery.

Default Value: null

onItemClick

A function that is executed when a list item is clicked or tapped.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

Autocomplete

The widget's instance.

element:

Element (jQuery or HTML)

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

model:

Object

The model data. Available only if Knockout is used.

itemData:

Object

The clicked item's data.

itemElement:

Object

The item's container.

itemIndex:

Number

|

Object

The clicked item's index. If the widget items are grouped, the index represents an object defining the group and item indexes: { group: 0, item: 0 }.

event:

Event (jQuery or dxEvent)

The event that caused the handler execution. It is a dxEvent or a jQuery.Event when you use jQuery.

Default Value: null

onKeyDown

A function that is executed when a user is pressing a key on the keyboard.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

Autocomplete

The widget's instance.

element:

Element (jQuery or HTML)

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

model:

Object

The model data. Available only if Knockout is used.

jQueryEvent:

jQuery.Event

The jQuery event that caused the handler execution. Deprecated in favor of the event field.

event:

Event (jQuery or dxEvent)

The event that caused the handler execution. It is a dxEvent or a jQuery.Event when you use jQuery.

Default Value: null

onKeyPress

A function that is executed when a user presses a key on the keyboard.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

Autocomplete

The widget's instance.

element:

Element (jQuery or HTML)

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

model:

Object

The model data. Available only if Knockout is used.

jQueryEvent:

jQuery.Event

The jQuery event that caused the handler execution. Deprecated in favor of the event field.

event:

Event (jQuery or dxEvent)

The event that caused the handler execution. It is a dxEvent or a jQuery.Event when you use jQuery.

Default Value: null

onKeyUp

A function that is executed when a user releases a key on the keyboard.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

Autocomplete

The widget's instance.

element:

Element (jQuery or HTML)

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

model:

Object

The model data. Available only if Knockout is used.

jQueryEvent:

jQuery.Event

The jQuery event that caused the handler execution. Deprecated in favor of the event field.

event:

Event (jQuery or dxEvent)

The event that caused the handler execution. It is a dxEvent or a jQuery.Event when you use jQuery.

Default Value: null

onOpened

A function that is executed once the drop-down editor is opened.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

Autocomplete

The widget's instance.

element:

Element (jQuery or HTML)

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

model:

Object

The model data. Available only if Knockout is used.

Default Value: null

onOptionChanged

A function that is executed after a widget option is changed.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

Autocomplete

The widget's instance.

name:

String

The option's short name.

fullName:

String

The option's full name.

value: any

The option's new value.

element:

Element (jQuery or HTML)

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

model:

Object

The model data. Available only if you use Knockout.

Default Value: null

onPaste

A function that is executed when the widget's input has been pasted.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

Autocomplete

The widget's instance.

element:

Element (jQuery or HTML)

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

model:

Object

The model data. Available only if Knockout is used.

jQueryEvent:

jQuery.Event

The jQuery event that caused the handler execution. Deprecated in favor of the event field.

event:

Event (jQuery or dxEvent)

The event that caused the handler execution. It is a dxEvent or a jQuery.Event when you use jQuery.

Default Value: null

onSelectionChanged

A function that is executed when a list item is selected or selection is canceled.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

Autocomplete

The widget's instance.

element:

Element (jQuery or HTML)

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

model:

Object

The model data. Available only if Knockout is used.

selectedItem:

Object

The selected item's data.

Default Value: null

onValueChanged

A function that is executed after the widget's value is changed.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

Autocomplete

The widget's instance.

element:

Element (jQuery or HTML)

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

model:

Object

The model data. Available only if Knockout is used.

value:

Object

The widget's new value.

previousValue:

Object

The widget's previous value.

jQueryEvent:

jQuery.Event

The jQuery event that caused the handler execution. Deprecated in favor of the event field.

event:

Event (jQuery or dxEvent)

The event that caused the handler execution. It is a dxEvent or a jQuery.Event when you use jQuery.

Default Value: null

opened

Specifies whether or not the drop-down editor is displayed.

Type:

Boolean

Default Value: false
Raised Events: opened, closed

openOnFieldClick

Specifies whether a user can open the drop-down list by clicking a text field.

Type:

Boolean

Default Value: false

placeholder

The text displayed by the widget when the widget value is empty.

Type:

String

Default Value: ''

readOnly

A Boolean value specifying whether or not the widget is read-only.

Type:

Boolean

Default Value: false

rtlEnabled

Switches the widget to a right-to-left representation.

Type:

Boolean

Default Value: false

When this option is set to true, the widget text flows from right to left, and the layout of elements is reversed. To switch the entire application/site to the right-to-left representation, assign true to the rtlEnabled field of the object passed to the DevExpress.config(config) method.

JavaScript
DevExpress.config({
    rtlEnabled: true
});
See Also

searchExpr

Specifies the name of a data source item field or an expression whose value is compared to the search criterion.

Type:

getter

|

Array<getter>

Default Value: null

In most cases, you should pass the name of a field by whose value data items are searched. If you need to search elements by several field values, assign an array of field names to this option.

JavaScript
searchExpr: ["firstName", "lastName"]

For more information on searching, refer to the Search Api section of the Data Layer article. For information on getters, refer to the Getters and Setters section of the Data Layer article.

searchMode

Specifies a comparison operation used to search widget items.

Type:

String

Default Value: 'contains'
Accepted Values: 'contains' | 'startswith'

Use the DropDownSearchMode enum to specify this option when the widget is used as an ASP.NET MVC Control. This enum accepts the following values: Contains and StartsWith.

searchTimeout

Specifies the time delay, in milliseconds, after the last character has been typed in, before a search is executed.

Type:

Number

Default Value: 500

selectedItem

Gets the currently selected item.

Type: any
Read-only
Default Value: null
NOTE
This option is read-only.

showClearButton

Specifies whether to display the Clear button in the widget.

Type:

Boolean

Default Value: false

The Clear button sets the widget value to null.

showDropDownButton

Specifies whether the drop-down button is visible.

Type:

Boolean

Default Value: false

spellcheck

Specifies whether or not the widget checks the inner text for spelling mistakes.

Type:

Boolean

Default Value: false

stylingMode

Specifies how the widget's text field is styled.

Type:

String

Default Value: 'outlined', 'underlined' (Material)
Accepted Values: 'outlined' | 'underlined' | 'filled'

The following styles are available:

Text Editor Styling Modes

Use the EditorStylingMode enum to specify this option when the widget is used as an ASP.NET MVC Control. This enum accepts the following values: Outlined, Underlined, and Filled.

You can also use the global editorStylingMode setting to specify how the text fields of all editors in your application are styled.

tabIndex

Specifies the number of the element when the Tab key is used for navigating.

Type:

Number

Default Value: 0

The value of this option will be passed to the tabindex attribute of the HTML element that underlies the widget.

text

The read-only option that holds the text displayed by the widget input element.

Type:

String

Read-only

validationError

Specifies information on the validation error when using a custom validation engine. Should be changed at runtime along with the isValid option.

Type:

Object

Default Value: undefined

validationMessageMode

Specifies how the message about the validation rules that are not satisfied by this editor's value is displayed.

Type:

String

Default Value: 'auto'
Accepted Values: 'always' | 'auto'

The following option values are possible:

  • auto
    The tooltip with the message is displayed when the editor is in focus.
  • always
    The tooltip with the message is not hidden when the editor loses focus.

Use the ValidationMessageMode enum to specify this option when the widget is used as an ASP.NET MVC Control. This enum accepts the following values: Auto and Always.

value

Specifies the current value displayed by the widget.

Type:

String

Default Value: null

If autocomplete items represent objects, the value option returns the value of the specified field of the currently selected item object. The field whose value is returned by the value option is specified by using the valueExpr option.

valueChangeEvent

Specifies the DOM events after which the widget's value should be updated.

Type:

String

Default Value: 'input change keyup'

valueExpr

Specifies which data field provides the widget's value. When this option is not set, the value is the entire data object.

Type:

String

|

Function

Default Value: 'this'

visible

Specifies whether the widget is visible.

Type:

Boolean

Default Value: true

width

Specifies the widget's width.

Type:

Number

|

String

|

Function

Return Value:

Number

|

String

The widget's width.

Default Value: undefined

This option accepts a value of one of the following types:

  • Number
    The width in pixels.

  • String
    A CSS-accepted measurement of width. For example, "55px", "80%", "auto", "inherit".

  • Function
    A function returning either of the above. For example:

    JavaScript
    width: function() {
        return window.innerWidth / 1.5;
    }