Autocomplete

A textbox widget that supports autocompletion.

Included in: dx.phonejs.js, dx.webappjs.js, dx.all.js

The dxAutocomplete widget is a textbox that suggests ways of completing the text being typed.

You can create a widget using one of the following approaches.

  • jQuery
    Use the dxAutocomplete jQuery plug-in.

    HTML
    <div id="autoComplete"></div>
    JavaScript
    $("#actionSheet").dxAutocomplete({
        dataSource: autoCompleteData,
        placeholder: 'Type country name',
        valueExpr: 'name'
    });
  • Knockout
    Add a div element and apply the dxAutocomplete binding to this element.

    HTML
    <div data-bind="dxAutocomplete: {
        dataSource: autoCompleteData,
        placeholder: 'Type country name',
        valueExpr: 'name'
    }"></div>
  • Angular
    Add a div element and apply the dx-autocomplete directive to this element.

    HTML
    <div dx-autocomplete="{
        dataSource: autoCompleteData,
        placeholder: 'Type country name',
        valueExpr: 'name'
    }"></div>

Note that DevExtreme widgets require you to link the jQuery and Globalize libraries to your application. If you use the Knockout or Angular approach, the Knockout or Angular library is also required.

See Also

The dxAutocomplete widget supports common Collection Container and Editor widget functionality. You can find detailed information on principles of working with the widget in the dxAutocomplete section of the Editor Widgets article. For the information on using Collection Container functionality refer to the Collection Container Widgets guide.

View Demo

Configuration

An object defining configuration options for the dxAutocomplete widget.

Name Description
accessKey

Specifies a shortcut key that sets focus on the widget element.

activeStateEnabled

A Boolean value specifying whether or not the widget changes its state when interacting with a user.

attr

Specifies HTML attributes applied to the inner input element of the widget.

dataSource

A data source used to fetch data to be displayed by the widget.

deferRendering

Specifies whether widget content is rendered when the widget is shown or when rendering the widget.

disabled

A Boolean value specifying whether or not the widget can respond to user interaction.

displayValue

Returns the value currently displayed by the widget.

fieldEditEnabled

Specifies whether or not the widget allows an end-user to enter a custom value.

focusStateEnabled

Specifies whether or not the widget supports the focused state and keyboard navigation.

height

Specifies the height of the widget.

hint

Specifies the text of the hint displayed for the widget.

hoverStateEnabled

A Boolean value specifying whether or not the widget changes its state when being hovered by an end user.

isValid

Specifies whether the editor's value is valid.

items

An array of items displayed by the widget.

itemTemplate

The template to be used for rendering items.

maxItemCount

Specifies the maximum count of items displayed by the widget.

maxLength

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

minSearchLength

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

mode

The "mode" attribute value of the actual HTML input element representing the text box.

onChange

A handler for the change event.

onClosed

A handler for the closed event.

onContentReady

A handler for the contentReady event.

onCopy

A handler for the copy event.

onCut

A handler for the cut event.

onDisposing

A handler for the disposing event.

onEnterKey

A handler for the enterKey event.

onFocusIn

A handler for the focusIn event.

onFocusOut

A handler for the focusOut event.

onInitialized

A handler for the initialized event.

onInput

A handler for the input event.

onItemClick

A handler for the itemClick event.

onKeyDown

A handler for the keyDown event.

onKeyPress

A handler for the keyPress event.

onKeyUp

A handler for the keyUp event.

onOpened

A handler for the opened event.

onOptionChanged

A handler for the optionChanged event.

onPaste

A handler for the paste event.

onSelectionChanged

A handler for the selectionChanged event.

onValueChanged

A handler for the valueChanged event.

opened

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

placeholder

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

readOnly

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

rtlEnabled

Specifies whether or not the current component supports a right-to-left representation.

searchExpr

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

searchMode

Specifies the binary operation used to filter data.

searchTimeout

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

selectedItem

Gets the currently selected item.

showClearButton

Specifies whether to display the Clear button in the widget.

spellcheck

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

tabIndex

Specifies the widget tab index.

text

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

validationError

Holds the object that defines the error that occurred during validation.

validationMessageMode

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

value

Specifies the current value displayed by the widget.

valueChangeEvent

Specifies DOM event names that update a widget's value.

valueExpr

Specifies the name of a data source item field whose value is displayed in the list of suggested values.

visible

A Boolean value specifying whether or not the widget is visible.

width

Specifies the width of the widget.

Methods

This section describes the members used to manipulate the widget.

Name Description
beginUpdate()

Prevents the component from refreshing until the endUpdate method is called.

blur()

Removes focus from the input element.

content()

Returns an HTML element of the popup window content.

defaultOptions(rule)

Specifies the device-dependent default configuration options for this component.

element()

Returns the root HTML element of the widget.

endUpdate()

Enables the component to refresh after the beginUpdate method call.

field()

Returns an <input> element of the widget.

focus()

Sets focus to the input element representing the widget.

instance()

Returns an instance of this component class.

off(eventName)

Detaches all event handlers from the specified event.

off(eventName, eventHandler)

Detaches a particular event handler from the specified event.

on(eventName, eventHandler)

Subscribes to a specified event.

on(events)

Subscribes to the specified events.

option()

Returns the configuration options of this component.

option(optionName)

Gets the value of the specified configuration option of this component.

option(optionName, optionValue)

Sets a value to the specified configuration option of this component.

option(options)

Sets one or more options of this component.

registerKeyHandler(key, handler)

Registers a handler when a specified key is pressed.

repaint()

Redraws the widget.

reset()

Resets the widget's value to null.

Events

This section describes events exposed by this widget.

Name Description
change

Fires when a change within the widget's input element is committed by an end user.

closed

Fires after a drop-down list has been hidden.

contentReady

Fires when widget content is ready.

copy

Fires after the widget's input has been copied.

cut

Fires after the Cut DOM event has fired.

disposing

Fires when the widget is being removed.

enterKey

Fires after a key has been entered within the widget's input element.

focusIn

Fires after the widget's input has been focused.

focusOut

Fires after the widget's input element has lost focus.

initialized

Fires when the widget is initialized.

input

Fires when a value within the widget's input element is changed by an end user.

itemClick

Fires when a widget item is clicked.

keyDown

Fires when a key is pressed down within the widget's input element.

keyPress

Fires when the keypress DOM event has been raised for the current input element.

keyUp

Fires when a key is released within the widget's input element.

opened

Fires when the drop-down editor is shown.

optionChanged

Fires after an option of the component is changed.

paste

Fires after the widget's input has been pasted.

selectionChanged

Fires when the selection changes.

valueChanged

Fires when the editor value changes.

Default Item Template

This section lists the data source fields that are used in a default template for auto-complete drop-down items.

By default, a predefined item template is applied to display the items of this widget. This template is based on certain fields of the data source provided for this widget. Below is a list of these fields. If the default item template is not appropriate for your task, implement a custom item template based on these or other fields of your data source.

See Also