Lookup

The Lookup is a widget that allows an end user to search for an item in a collection shown in a drop-down menu.

Included in: dx.mobile.js, dx.web.js, dx.viz-web.js, dx.all.js
Module: ui/lookup
Lookup interactive configuration
Copy Code
Copy to Codepen
$("#lookup").dxLookup({
});

                    

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

  • jQuery
    Use the dxLookup jQuery plug-in.

    HTML
    <div id="lookup"></div>
    JavaScript
    $("#lookup").dxLookup({
        dataSource: lookupData,
        displayExpr: 'name',
        title: 'Lookup title',
        searchEnabled: true
    });
  • Knockout
    Add a div element and apply the dxLookup binding to this element.

    HTML
    <div data-bind="dxLookup: {
        dataSource: lookupData,
        displayExpr: 'name',
        title: 'Lookup title',
        searchEnabled: true
    }"></div>
  • AngularJS
    Add a div element and apply the dx-lookup directive to this element.

    HTML
    <div dx-lookup="{
        dataSource: lookupData,
        displayExpr: 'name',
        title: 'Lookup title',
        searchEnabled: true
    }"></div>

Note that DevExtreme widgets require you to link the jQuery library to your application. If you use the Knockout or AngularJS approach, the Knockout or AngularJS library is also required. For detailed information on linking these libraries to your project, refer to the Installation article.

The Lookup widget supports common Collection Container, Editor, and Overlay widget functionality. Refer to the Collection Container Widgets, Editor Widgets and Overlay Widgets articles for details on using common functions. For detailed information on working with the Lookup widget, refer to the dxLookup guide.

View Demo

Configuration

An object defining configuration options for the Lookup 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.

animation

An object that defines widget animation options.

applyButtonText

The text displayed on the Apply button.

applyValueMode

Specifies the way an end-user applies the selected value.

attr

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

cancelButtonText

The text displayed on the Cancel button.

cleanSearchOnOpening

Specifies whether or not the widget cleans the search box when the popup window is displayed.

clearButtonText

The text displayed on the Clear button.

closeOnOutsideClick

A Boolean value specifying whether or not a widget is closed if a user clicks outside of the overlaying window.

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.

displayExpr

Specifies the name of the data source item field whose value is displayed by the widget.

displayValue

Returns the value currently displayed by the widget.

fieldTemplate

The template to be used for rendering the widget text field.

focusStateEnabled

Specifies whether or not the widget can be focused.

fullScreen

A Boolean value specifying whether or not to display the lookup in full-screen mode.

grouped

A Boolean value specifying whether or not to group widget items.

groupTemplate

The name of the template used to display a group header.

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.

minSearchLength

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

nextButtonText

The text displayed on the button used to load the next page from the data source.

noDataText

The text or HTML markup displayed by the widget if the item collection is empty.

onClosed

A handler for the closed event.

onContentReady

A handler for the contentReady event.

onDisposing

A handler for the disposing event.

onInitialized

A handler for the initialized event.

onItemClick

A handler for the itemClick event.

onOpened

A handler for the opened event.

onOptionChanged

A handler for the optionChanged event.

onPageLoading

A handler for the pageLoading event.

onPullRefresh

A handler for the pullRefresh event.

onScroll

A handler for the scroll event.

onSelectionChanged

A handler for the selectionChanged event.

onTitleRendered

A handler for the titleRendered event.

onValueChanged

A handler for the valueChanged event.

opened

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

pageLoadingText

Specifies the text shown in the pullDown panel, which is displayed when the widget is scrolled to the bottom.

pageLoadMode

Specifies whether the next page is loaded when a user scrolls the widget to the bottom or when the "next" button is clicked.

placeholder

The text displayed by the widget when nothing is selected.

popupHeight

The height of the widget popup element.

popupWidth

The width of the widget popup element.

position

An object defining widget positioning options.

pulledDownText

Specifies the text displayed in the pullDown panel when the widget is pulled below the refresh threshold.

pullingDownText

Specifies the text shown in the pullDown panel while the list is being pulled down to the refresh threshold.

pullRefreshEnabled

A Boolean value specifying whether or not the widget supports the "pull down to refresh" gesture.

refreshingText

Specifies the text displayed in the pullDown panel while the widget is being refreshed.

rtlEnabled

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

searchEnabled

A Boolean value specifying whether or not the search bar is visible.

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.

searchPlaceholder

The text that is provided as a hint in the lookup's search bar.

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.

shading

A Boolean value specifying whether or not the main screen is inactive while the lookup is active.

showCancelButton

Specifies whether to display the Cancel button in the lookup window.

showClearButton

Specifies whether or not to display the Clear button in the lookup window.

showDataBeforeSearch

Specifies whether or not the widget displays unfiltered values until a user types a number of characters exceeding the minSearchLength option value.

showPopupTitle

A Boolean value specifying whether or not to display the title in the popup window.

tabIndex

Specifies the widget tab index.

text

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

title

The title of the lookup window.

titleTemplate

A template to be used for rendering the widget title.

useNativeScrolling

Specifies whether or not the widget uses native scrolling.

usePopover

Specifies whether or not to show lookup contents in a Popover widget.

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

The currently selected value in 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 held in the value configuration option.

visible

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

width

Specifies the width of the widget.

Methods

This section describes 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.

close()

Closes the drop-down editor.

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.

open()

Opens the drop-down editor.

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 fired by this widget.

Name Description
closed

Fires after a drop-down list has been hidden.

contentReady

Fires when widget content is ready.

disposing

Fires when the widget is being removed.

initialized

Fires when the widget is initialized.

itemClick

Fires when a widget item is clicked.

opened

Fires when the drop-down editor is shown.

optionChanged

Fires after an option of the component is changed.

pageLoading

Fires before loading the next page in the lookup list if autopaging is enabled.

pullRefresh

Fires before the lookup list is refreshed as a result of the "pull down to refresh" gesture.

scroll

Fires on each scroll gesture.

selectionChanged

Fires when the selection changes.

titleRendered

Fires after the widget title is rendered.

valueChanged

Fires when the editor value changes.

Default Item Template

This section lists the data source fields that are used in a default item template.

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 the 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