React Autocomplete Props

An object defining configuration properties for the Autocomplete UI component.

See Also

accessKey

Specifies the shortcut key that sets focus on the UI component.

Type:

String

Default Value: undefined

The value of this property will be passed to the accesskey attribute of the HTML element that underlies the UI component.

activeStateEnabled

Specifies whether the UI component changes its state as a result of user interaction.

Type:

Boolean

Default Value: true

The UI component switches to the active state when users press down the primary mouse button. When this property is set to true, the CSS rules for the active state apply. You can change these rules to customize the component.

Use this property when you display the component on a platform whose guidelines include the active state change for UI components. See the following GitHub repository for an example of this type of platform: MUI.

buttons[]

Allows you to add custom buttons to the input text field.

Selector: Button
Type:

Array<String | Object>

Default Value: undefined
Accepted Values: 'clear' | 'dropDown'

Built-in buttons should also be declared in this array. You can find an example in the following demo:

View Demo

dataSource

Binds the UI component to data.

Default Value: null

The Autocomplete works with collections of objects or string, number, or boolean values.

Depending on your data source, bind the Autocomplete to data as follows. In each case, also specify the valueExpr if the data source provides objects.

  • Data Array
    Assign the array to the dataSource option.

  • Read-Only Data in JSON Format
    Set the dataSource property to the URL of a JSON file or service that returns JSON data.

  • OData
    Implement an ODataStore.

  • Web API, PHP, MongoDB
    Use one of the following extensions to enable the server to process data according to the protocol DevExtreme UI components use:

    Then, use the createStore method to configure access to the server on the client as shown below. This method is part of DevExtreme.AspNet.Data.

    jQuery
    JavaScript
    $(function() {
        let serviceUrl = "https://url/to/my/service";
        $("#autocompleteContainer").dxAutocomplete({
            // ...
            dataSource: DevExpress.data.AspNet.createStore({
                key: "ID",
                loadUrl: serviceUrl + "/GetAction",
                insertUrl: serviceUrl + "/InsertAction",
                updateUrl: serviceUrl + "/UpdateAction",
                deleteUrl: serviceUrl + "/DeleteAction"
            })
        })
    });
    Angular
    app.component.ts
    app.component.html
    app.module.ts
    import { Component } from '@angular/core';
    import CustomStore from 'devextreme/data/custom_store';
    import { createStore } from 'devextreme-aspnet-data-nojquery';
    
    @Component({
        selector: 'app-root',
        templateUrl: './app.component.html',
        styleUrls: ['./app.component.css']
    })
    export class AppComponent {
        store: CustomStore;
        constructor() {
            let serviceUrl = "https://url/to/my/service";
            this.store = createStore({
                key: "ID",
                loadUrl: serviceUrl + "/GetAction",
                insertUrl: serviceUrl + "/InsertAction",
                updateUrl: serviceUrl + "/UpdateAction",
                deleteUrl: serviceUrl + "/DeleteAction"
            })
        }
    }
    <dx-autocomplete ...
        [dataSource]="store">
    </dx-autocomplete>
    import { BrowserModule } from '@angular/platform-browser';
    import { NgModule } from '@angular/core';
    import { AppComponent } from './app.component';
    
    import { DxAutocompleteModule } from 'devextreme-angular';
    
    @NgModule({
        declarations: [
            AppComponent
        ],
        imports: [
            BrowserModule,
            DxAutocompleteModule
        ],
        providers: [],
        bootstrap: [AppComponent]
    })
    export class AppModule { }
    Vue
    App.vue
    <template> 
        <DxAutocomplete ...
            :data-source="store" />
    </template>
    
    <script>
    import 'devextreme/dist/css/dx.light.css';
    
    import CustomStore from 'devextreme/data/custom_store';
    import { createStore } from 'devextreme-aspnet-data-nojquery';
    import { DxAutocomplete } from 'devextreme-vue/autocomplete';
    
    export default {
        components: {
            DxAutocomplete
        },
        data() {
            const serviceUrl = "https://url/to/my/service";
            const store = createStore({
                key: "ID",
                loadUrl: serviceUrl + "/GetAction",
                insertUrl: serviceUrl + "/InsertAction",
                updateUrl: serviceUrl + "/UpdateAction",
                deleteUrl: serviceUrl + "/DeleteAction"
            });
            return {
                store
            }
        }
    }
    </script>
    React
    App.js
    import React from 'react';
    import 'devextreme/dist/css/dx.light.css';
    
    import CustomStore from 'devextreme/data/custom_store';
    import { createStore } from 'devextreme-aspnet-data-nojquery';
    import Autocomplete from 'devextreme-react/autocomplete';
    
    const serviceUrl = "https://url/to/my/service";
    const store = createStore({
        key: "ID",
        loadUrl: serviceUrl + "/GetAction",
        insertUrl: serviceUrl + "/InsertAction",
        updateUrl: serviceUrl + "/UpdateAction",
        deleteUrl: serviceUrl + "/DeleteAction"
    });
    
    class App extends React.Component {
        render() {
            return (
                <Autocomplete ...
                    dataSource={store} />
            );
        }
    }
    export default App;
  • Any other data source
    Implement a CustomStore.

Regardless of the data source on the input, the Autocomplete always wraps it in the DataSource object. This object allows you to sort, filter, group, and perform other data shaping operations. To get its instance, call the getDataSource() method.

NOTE

Review the following notes about data binding:

  • Do not specify the items property if you specified the dataSource, and vice versa.

  • Data field names cannot be equal to this and should not contain the following characters: ., :, [, and ].

  • The stores and DataSource have methods to process and update data. However, the methods do not allow you to perform particular tasks (for example, replace the entire dataset, reconfigure data access at runtime). For such tasks, create a new array, store, or DataSource and assign it to the dataSource property as shown in the articles about changing properties in jQuery, Angular, React, and Vue.

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 UI component responds to user interaction.

Type:

Boolean

Default Value: false

displayValue

Returns the value currently displayed by the UI component.

Type:

String

Read-only
Default Value: undefined

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

dropDownButtonComponent

An alias for the dropDownButtonTemplate property specified in React. Accepts a custom component. Refer to Using a Custom Component for more information.

dropDownButtonRender

An alias for the dropDownButtonTemplate property specified in React. Accepts a rendering function. Refer to Using a Rendering Function for more information.

dropDownButtonTemplate

Specifies a custom template for the drop-down button.

Type:

template

Template Data:
Name Type Description
icon

String

The button's icon.

text

String

The button's text.

Default Name: 'dropDownButton'

dropDownOptions

Configures the drop-down field which holds the content.

Default Value: {}

See Popup Configuration for properties that you can specify in this object.

NOTE
In Angular and Vue, the nested component that configures the dropDownOptions property does not support event bindings and two-way property bindings.

elementAttr

Specifies the global attributes to be attached to the UI component's container element.

Type: any
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
    ],
    // ...
})
Vue
App.vue
<template>
    <DxAutocomplete ...
        :element-attr="autocompleteAttributes">
    </DxAutocomplete>
</template>

<script>
import DxAutocomplete from 'devextreme-vue/autocomplete';

export default {
    components: {
        DxAutocomplete
    },
    data() {
        return {
            autocompleteAttributes: {
                id: 'elementId',
                class: 'class-name'
            }
        }
    }
}
</script>
React
App.js
import React from 'react';

import Autocomplete from 'devextreme-react/autocomplete';

class App extends React.Component {
    autocompleteAttributes = {
        id: 'elementId',
        class: 'class-name'
    }

    render() {
        return (
            <Autocomplete ...
                elementAttr={this.autocompleteAttributes}>
            </Autocomplete>
        );
    }
}
export default App;

focusStateEnabled

Specifies whether the UI component can be focused using keyboard navigation.

Type:

Boolean

Default Value: true

groupComponent

An alias for the groupTemplate property specified in React. Accepts a custom component. Refer to Using a Custom Component for more information.

grouped

Specifies whether data items should be grouped.

Type:

Boolean

Default Value: false

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

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

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

NOTE
Only one-level grouping is supported.

SelectBox Demo TagBox Demo

See Also

groupRender

An alias for the groupTemplate property specified in React. Accepts a rendering function. Refer to Using a Rendering Function for more information.

groupTemplate

Specifies a custom template for group captions.

Type:

template

Template Data:

Object

The group's data.

Default Name: 'group'

See Also

height

Specifies the UI component's height.

Type:

Number

|

String

|

Function

Return Value:

Number

|

String

The UI component's height.

Default Value: undefined

This property 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%", "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 UI component.

Type:

String

Default Value: undefined

hoverStateEnabled

Specifies whether the UI component 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: any
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
    ],
    // ...
})
Vue
App.vue
<template>
    <DxAutocomplete
        :input-attr="inputAttr"
    />
</template>

<script>
import 'devextreme/dist/css/dx.light.css';

import DxAutocomplete from 'devextreme-vue/autocomplete';

export default {
    components: {
        DxAutocomplete
    },
    data() {
        return {
            inputAttr: { id: 'inputId' }
        }
    }
}
</script>
React
App.js
import 'devextreme/dist/css/dx.light.css';

import Autocomplete from 'devextreme-react/autocomplete';

const inputAttr = { id: 'inputId' };

export default function App() {
    return (
        <Autocomplete
            inputAttr={inputAttr}
        />
    );
}
ASP.NET MVC Controls
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 or indicates whether the editor's value is valid.

Type:

Boolean

Default Value: true

NOTE
When you use async rules, isValid is true if the status is "pending" or "valid".
See Also

itemComponent

An alias for the itemTemplate property specified in React. Accepts a custom component. Refer to Using a Custom Component for more information.

itemRender

An alias for the itemTemplate property specified in React. Accepts a rendering function. Refer to Using a Rendering Function for more information.

items[]

An array of items displayed by the UI component.

Selector: Item

The items array can contain:

  • Objects with fields described in this section
  • Objects with any other fields. In this case, specify the itemTemplate.

If you need to update the UI component items, reassign the entire items array as shown in the following example:

JavaScript
autocompleteInstance.option('items', newItems);

As an alternative to items, you can use the dataSource property. It accepts the DataSource object, whose underlying stores provide an API that allows you to update individual items without reassigning the entire item collection.

NOTE
Do not use the items property if you use dataSource, and vice versa.

itemTemplate

Specifies a custom template for items.

Type:

template

Template Data:

Object

The current item's data.

Default Name: 'item'

maxItemCount

Specifies the maximum count of items displayed by the UI component.

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 property, the UI component 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 property if the UI component lies within an HTML form that will be submitted.

onChange

A function that is executed when the UI component loses focus after the text field's content was changed using the keyboard.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

Autocomplete

The UI component's instance.

element

HTMLElement | jQuery

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

event

Event (jQuery or EventObject)

The event that caused the function to execute. It is an EventObject or a jQuery.Event when you use jQuery.

model any

Model data. Available only if Knockout is used.

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:
Name Type Description
component

Autocomplete

The UI component's instance.

element

HTMLElement | jQuery

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

model any

Model data. Available only if Knockout is used.

Default Value: null

onContentReady

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

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

Autocomplete

The UI component's instance.

element

HTMLElement | jQuery

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

model any

Model data. Available only when using Knockout.

Default Value: null

If data displayed by the UI component 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 UI component content is ready. In this case, when you create the UI component, the contentReady event is raised twice: when the UI component's content is ready (at this moment, the UI component does not display items) and when the DataSource is loaded (the UI component displays the loaded items).

onCopy

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

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

Autocomplete

The UI component's instance.

element

HTMLElement | jQuery

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

event

Event (jQuery or EventObject)

The event that caused the function to execute. It is an EventObject or a jQuery.Event when you use jQuery.

model any

Model data. Available only if Knockout is used.

Default Value: null

onCut

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

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

Autocomplete

The UI component's instance.

element

HTMLElement | jQuery

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

event

Event (jQuery or EventObject)

The event that caused the function to execute. It is an EventObject or a jQuery.Event when you use jQuery.

model any

Model data. Available only if Knockout is used.

Default Value: null

onDisposing

A function that is executed before the UI component is disposed of.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

Autocomplete

The UI component's instance.

element

HTMLElement | jQuery

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

model any

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 UI component is focused.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

Autocomplete

The UI component's instance.

element

HTMLElement | jQuery

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

event

Event (jQuery or EventObject)

The event that caused the function to execute. It is an EventObject or a jQuery.Event when you use jQuery.

model any

Model data. Available only if Knockout is used.

Default Value: null

NOTE
This function is executed after the onKeyUp, onKeyDown, and onKeyPress functions.

onFocusIn

A function that is executed when the UI component gets focus.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
model any

Model data. Available only if Knockout is used.

event

Event (jQuery or EventObject)

The event that caused the function to execute. It is an EventObject or a jQuery.Event when you use jQuery.

element

HTMLElement | jQuery

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

component

Autocomplete

The UI component's instance.

Default Value: null

onFocusOut

A function that is executed when the UI component loses focus.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
model any

Model data. Available only if Knockout is used.

event

Event (jQuery or EventObject)

The event that caused the function to execute. It is an EventObject or a jQuery.Event when you use jQuery.

element

HTMLElement | jQuery

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

component

Autocomplete

The UI component's instance.

Default Value: null

onInitialized

A function used in JavaScript frameworks to save the UI component instance.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

Autocomplete

The UI component's instance.

element

HTMLElement | jQuery

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

Default Value: null

See Also

onInput

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

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

Autocomplete

The UI component's instance.

element

HTMLElement | jQuery

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

event

Event (jQuery or EventObject)

The event that caused the function to execute. It is an EventObject or a jQuery.Event when you use jQuery.

model any

Model data. Available only if Knockout is used.

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:
Name Type Description
component

Autocomplete

The UI component's instance.

element

HTMLElement | jQuery

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

event

Event (jQuery or EventObject)

The event that caused the function to execute. It is an EventObject or a jQuery.Event when you use jQuery.

itemData

Object

The clicked item's data.

itemElement

Object

The item's container.

itemIndex

Number

|

Object

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

model any

Model data. Available only if Knockout is used.

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:
Name Type Description
component

Autocomplete

The UI component's instance.

element

HTMLElement | jQuery

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

event

Event (jQuery or EventObject)

The event that caused the function to execute. It is an EventObject or a jQuery.Event when you use jQuery.

model any

Model data. Available only if Knockout is used.

Default Value: null

onKeyPress Deprecated

IMPORTANT
The keyPress event is removed from the web standards and will be deprecated in modern browsers soon. Refer to the MDN topic for details.

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:
Name Type Description
component

Autocomplete

The UI component's instance.

element

HTMLElement | jQuery

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

event

Event (jQuery or EventObject)

The event that caused the function to execute. It is an EventObject or a jQuery.Event when you use jQuery.

model any

Model data. Available only if Knockout is used.

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:
Name Type Description
component

Autocomplete

The UI component's instance.

element

HTMLElement | jQuery

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

event

Event (jQuery or EventObject)

The event that caused the function to execute. It is an EventObject or a jQuery.Event when you use jQuery.

model any

Model data. Available only if Knockout is used.

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:
Name Type Description
component

Autocomplete

The UI component's instance.

element

HTMLElement | jQuery

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

model any

Model data. Available only if Knockout is used.

Default Value: null

onOptionChanged

A function that is executed after a UI component property is changed.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
model any

Model data. Available only if you use Knockout.

fullName

String

The path to the modified property that includes all parent properties.

element

HTMLElement | jQuery

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

component

Autocomplete

The UI component's instance.

name

String

The modified property if it belongs to the first level. Otherwise, the first-level property it is nested into.

value any

The modified property's new value.

Default Value: null

The following example shows how to subscribe to component property changes:

jQuery
index.js
$(function() {
    $("#autocompleteContainer").dxAutocomplete({
        // ...
        onOptionChanged: function(e) {
            if(e.name === "changedProperty") {
                // handle the property change here
            }
        }
    });
});
Angular
app.component.html
app.component.ts
app.module.ts
<dx-autocomplete ...
    (onOptionChanged)="handlePropertyChange($event)"> 
</dx-autocomplete>
import { Component } from '@angular/core'; 

@Component({ 
    selector: 'app-root', 
    templateUrl: './app.component.html', 
    styleUrls: ['./app.component.css'] 
}) 

export class AppComponent { 
    // ...
    handlePropertyChange(e) {
        if(e.name === "changedProperty") { 
            // handle the property change here
        }
    }
}
import { BrowserModule } from '@angular/platform-browser'; 
import { NgModule } from '@angular/core'; 
import { AppComponent } from './app.component'; 
import { DxAutocompleteModule } from 'devextreme-angular'; 

@NgModule({ 
    declarations: [ 
        AppComponent 
    ], 
    imports: [ 
        BrowserModule, 
        DxAutocompleteModule 
    ], 
    providers: [ ], 
    bootstrap: [AppComponent] 
}) 

export class AppModule { }  
Vue
App.vue
<template> 
    <DxAutocomplete ...
        @option-changed="handlePropertyChange"
    />            
</template> 

<script>  
import 'devextreme/dist/css/dx.light.css'; 
import DxAutocomplete from 'devextreme-vue/autocomplete'; 

export default { 
    components: { 
        DxAutocomplete
    }, 
    // ...
    methods: { 
        handlePropertyChange: function(e) {
            if(e.name === "changedProperty") {
                // handle the property change here
            }
        }
    } 
} 
</script> 
React
App.js
import React from 'react';  
import 'devextreme/dist/css/dx.light.css'; 

import Autocomplete from 'devextreme-react/autocomplete'; 

const handlePropertyChange = (e) => {
    if(e.name === "changedProperty") {
        // handle the property change here
    }
}

export default function App() { 
    return ( 
        <Autocomplete ...
            onOptionChanged={handlePropertyChange}
        />        
    ); 
} 

onPaste

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

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

Autocomplete

The UI component's instance.

element

HTMLElement | jQuery

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

event

Event (jQuery or EventObject)

The event that caused the function to execute. It is an EventObject or a jQuery.Event when you use jQuery.

model any

Model data. Available only if Knockout is used.

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:
Name Type Description
component

Autocomplete

The UI component's instance.

element

HTMLElement | jQuery

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

model any

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 UI component's value is changed.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
value

Object

The UI component's new value.

previousValue

Object

The UI component's previous value.

model any

Model data. Available only if Knockout is used.

event

Event (jQuery or EventObject)

The event that caused the function to execute. It is an EventObject or a jQuery.Event when you use jQuery. This field is undefined if the value is changed programmatically.

element

HTMLElement | jQuery

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

component

Autocomplete

The UI component's instance.

Default Value: null

See Also

opened

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

Type:

Boolean

Default Value: false
Raised Events: onOpened onClosed

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 UI component when the UI component value is empty.

Type:

String

Default Value: ''

readOnly

Specifies whether the editor is read-only.

Type:

Boolean

Default Value: false

When this property is set to true, the following applies:

  • The editor's value cannot be changed using the UI.
  • Built-in action buttons are invisible.
  • Custom action buttons are visible but disabled. If a button should not be disabled, set its disabled property to false:

    jQuery
    index.js
    $(function() {
        $("#autocompleteContainer").dxAutocomplete({
            // ...
            buttons: [{
                name: "myCustomButton",
                location: "after",
                options: {
                    onClick: function(e) {
                        // ...
                    },
                    disabled: false
                }
            }]
        });
    });
    Angular
    app.component.html
    app.component.ts
    app.module.ts
    <dx-autocomplete ... >
        <dxi-button
            name="myCustomButton"
            location="after"
            [options]="myCustomButtonConfig">
        </dxi-button>
    </dx-autocomplete>
    import { Component } from '@angular/core';
    
    @Component({
        selector: 'app-root',
        templateUrl: './app.component.html',
        styleUrls: ['./app.component.css']
    })
    export class AppComponent {
        myCustomButtonConfig = {
            onClick: (e) => {
                // ...
            },
            disabled: false
        };
    }
    import { BrowserModule } from '@angular/platform-browser';
    import { NgModule } from '@angular/core';
    import { AppComponent } from './app.component';
    
    import { DxAutocompleteModule } from 'devextreme-angular';
    
    @NgModule({
        declarations: [
            AppComponent
        ],
        imports: [
            BrowserModule,
            DxAutocompleteModule
        ],
        providers: [ ],
        bootstrap: [AppComponent]
    })
    export class AppModule { }
    Vue
    App.vue
    <template>
        <DxAutocomplete ... >
            <DxAutocompleteButton
                name="myCustomButton"
                location="after"
                :options="myCustomButtonConfig"
            />
        </DxAutocomplete>
    </template>
    
    <script>
    import 'devextreme/dist/css/dx.light.css';
    
    import DxAutocomplete, {
        DxButton as DxAutocompleteButton
    } from 'devextreme-vue/autocomplete';
    
    export default {
        components: {
            DxAutocomplete,
            DxAutocompleteButton
        },
        data() {
            return {
                myCustomButtonConfig: {
                    onClick: (e) => {
                        // ...
                    },
                    disabled: false
                }
            }
        }
    }
    </script>
    React
    App.js
    import React from 'react';
    
    import 'devextreme/dist/css/dx.light.css';
    
    import Autocomplete, {
        Button as AutocompleteButton
    } from 'devextreme-react/autocomplete';
    
    class App extends React.Component {
        myCustomButtonConfig = {
            onClick: (e) => {
                // ...
            },
            disabled: false
        };
        render() {
            return (
                <Autocomplete>
                    <AutocompleteButton
                        name="myCustomButton"
                        location="after"
                        options={this.myCustomButtonConfig}
                    />
                </Autocomplete>
            );
        }
    }
    export default App;

    You can also hide a custom action button when the UI component becomes read-only. Set the button's visible property to false in the onOptionChanged function. To get the button, use the getButton(name) method:

    jQuery
    index.js
    $(function() {
        $("#autocompleteContainer").dxAutocomplete({
            // ...
            buttons: [{
                name: "myCustomButton",
                // ...
            }],
            onOptionChanged: function(e) {
                if(e.name == "readOnly") {
                    const myButton = e.component.getButton("myCustomButton");
                    myButton.option("visible", !e.value); // Hide the button when readOnly: true
                }
            }
        });
    });
    Angular
    app.component.html
    app.component.ts
    app.module.ts
    <dx-autocomplete ...
        (onOptionChanged)="changeButtonState">
        <dxi-button
            name="myCustomButton"
            ...
        ></dxi-button>
    </dx-autocomplete>
    import { Component } from '@angular/core';
    
    @Component({
        selector: 'app-root',
        templateUrl: './app.component.html',
        styleUrls: ['./app.component.css']
    })
    export class AppComponent {
        changeButtonState(e) {
            if(e.name == 'readOnly') {
                let myButton = e.component.getButton('myCustomButton');
                myButton.option('visible', !e.value); // Hide the button when readOnly: true
            }
        }
    }
    import { BrowserModule } from '@angular/platform-browser';
    import { NgModule } from '@angular/core';
    import { AppComponent } from './app.component';
    
    import { DxAutocompleteModule } from 'devextreme-angular';
    
    @NgModule({
        declarations: [
            AppComponent
        ],
        imports: [
            BrowserModule,
            DxAutocompleteModule
        ],
        providers: [ ],
        bootstrap: [AppComponent]
    })
    export class AppModule { }
    Vue
    App.vue
    <template>
        <DxAutocomplete ...
            @option-changed="changeButtonState">
            <DxAutocompleteButton
                name="myCustomButton"
                ...
            />
        </DxAutocomplete>
    </template>
    
    <script>
    import 'devextreme/dist/css/dx.light.css';
    
    import DxAutocomplete, {
        DxButton as DxAutocompleteButton
    } from 'devextreme-vue/autocomplete';
    
    export default {
        components: {
            DxAutocomplete,
            DxAutocompleteButton
        },
        data() {
            return {
                // ...
            }
        },
        methods: {
            changeButtonState(e) {
                if(e.name == 'readOnly') {
                    let myButton = e.component.getButton('myCustomButton');
                    myButton.option('visible', !e.value); // Hide the button when readOnly: true
                }
            }
        }
    }
    </script>
    React
    App.js
    import React from 'react';
    
    import 'devextreme/dist/css/dx.light.css';
    
    import Autocomplete, {
        Button as AutocompleteButton
    } from 'devextreme-react/autocomplete';
    
    class App extends React.Component {
        changeButtonState(e) {
            if(e.name == 'readOnly') {
                let myButton = e.component.getButton('myCustomButton');
                myButton.option('visible', !e.value); // Hide the button when readOnly: true
            }
        }
        render() {
            return (
                <Autocomplete ...
                    onOptionChanged={this.changeButtonState}>
                    <AutocompleteButton
                        name="myCustomButton"
                        ...
                    />
                </Autocomplete>
            );
        }
    }
    export default App;

rtlEnabled

Switches the UI component to a right-to-left representation.

Type:

Boolean

Default Value: false

When this property is set to true, the UI component 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
});

DataGrid Demo Navigation UI Demo Editors Demo

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 property.

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 UI component items.

Type:

String

Default Value: 'contains'
Accepted Values: 'contains' | '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

showClearButton

Specifies whether to display the Clear button in the UI component.

Type:

Boolean

Default Value: false

The Clear button calls the reset method.

showDropDownButton

Specifies whether the drop-down button is visible.

Type:

Boolean

Default Value: false

spellcheck

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

Type:

Boolean

Default Value: false

stylingMode

Specifies how the UI component'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

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 property will be passed to the tabindex attribute of the HTML element that underlies the UI component.

text

The read-only property that holds the text displayed by the UI component input element.

Type:

String

Read-only

useItemTextAsTitle

Specifies whether the Autocomplete uses item's text a title attribute.

Type:

Boolean

Default Value: false

If the property is set to true, the text that items within the Autocomplete contain is passed to the title attribute of the respective item.

validationError

Information on the broken validation rule. Contains the first item from the validationErrors array.

Type: any
Default Value: null

See Also

validationErrors

An array of the validation rules that failed.

Type:

Array<any>

Default Value: null

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 property 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.

validationStatus

Indicates or specifies the current validation status.

Type:

String

Default Value: 'valid'
Accepted Values: 'valid' | 'invalid' | 'pending'

The following table illustrates the validation status indicators:

validationStatus Indicator
"pending" DevExtreme editor validation status: pending
"valid" DevExtreme editor validation status: valid
"invalid" DevExtreme editor validation status: invalid

When you assign "invalid" to validationStatus, you can also use the validationErrors array to set an error message as shown below:

jQuery
index.js
$(function() {
    const autocomplete = $("#autocompleteContainer").dxAutocomplete({
        // ...
    }).dxAutocomplete("instance");

    function setInvalidStatus(message) {
        autocomplete.option({
            validationStatus: "invalid",
            validationErrors: [{ message: message }]
        });
    }
});
Angular
app.component.html
app.component.ts
<dx-autocomplete
    [validationStatus]="validationStatus"
    [validationErrors]="validationErrors">
</dx-autocomplete>
// ...
export class AppComponent {
    validationStatus: string = "valid";
    validationErrors: any;
    // ...
    setInvalidStatus(message) {
        this.validationStatus = "invalid";
        this.validationErrors = [{ message: message }];
    }
}
Vue
App.vue
<template>
    <DxAutocomplete ...
        :validation-status="validationStatus"
        :validation-errors="validationErrors"
    />
</template>

<script>
    // ...
    export default {
        // ...
        data() {
            return {
                validationStatus: "valid",
                validationErrors: []
            }
        },
        methods: {
            setInvalidStatus(message) {
                this.validationStatus = "invalid";
                this.validationErrors = [{ message: message }];
            }
        }
    }
</script>
React
App.js
import React, { useState } from 'react';
// ...

function App() {
    const [validationStatus, setValidationStatus] = useState("valid");
    const [validationErrors, setValidationErrors] = useState([]);

    const setInvalidStatus = message => {
        setValidationStatus("invalid");
        setValidationErrors([{ message: message }]);
    }

    return (
        <Autocomplete
            validationStatus={validationStatus}
            validationErrors={validationErrors}
        />
    ); 

};
export default App;

value

Specifies the current value displayed by the UI component.

Type:

String

Default Value: null
Raised Events: onValueChanged

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

View Demo

valueChangeEvent

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

Type:

String

Default Value: 'input change keyup'

This property accepts a single event name or several names separated by spaces.

The recommended events are "keyup", "blur", "change", "input", and "focusout", but you can use other events as well.

See Also

valueExpr

Specifies which data field provides unique values to the UI component's value.

Type:

String

|

Function

Function parameters:
item:

Object

The current item's data object.

Return Value:

String

|

Number

|

Boolean

A unique item identifier.

Default Value: 'this'

When dataSource contains objects, you should define valueExpr to correctly identify data items. Otherwise, the component uses referential equality to compare objects that may result in unexpected behavior.

If you use a store, the valueExpr property should have the same value as the key in the store.

NOTE
You cannot specify valueExpr as a function when the UI component is bound to a remote data source. This is because valueExpr is used in a filter the UI component sends to the server when querying data. Functions with custom logic cannot be serialized for this filter.

visible

Specifies whether the UI component is visible.

Type:

Boolean

Default Value: true

width

Specifies the UI component's width.

Type:

Number

|

String

|

Function

Return Value:

Number

|

String

The UI component's width.

Default Value: undefined

This property 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;
    }

wrapItemText

Specifies whether text that exceeds the drop-down list width should be wrapped.

Type:

Boolean

Default Value: false