JavaScript/jQuery Lookup API

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

import Lookup from "devextreme/ui/lookup"

View Demo Read Guides

See Also
jQuery
Angular
Vue
React
jQuery
Angular
Vue
React

Options

An object defining configuration properties for the Lookup UI component.

Name Description
accessKey

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

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

The text displayed on the Apply button.
applyValueMode

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

The text displayed on the Cancel button.
cleanSearchOnOpening

Specifies whether or not the UI component cleans the search box when the popup window is displayed.
clearButtonText

The text displayed on the Clear button.
dataSource

Binds the UI component to data.
deferRendering

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

Specifies whether the UI component responds to user interaction.
displayExpr

Specifies the data field whose values should be displayed.
displayValue

Returns the value currently displayed by the UI component.
dropDownCentered

Specifies whether to vertically align the drop-down menu so that the selected item is in its center. Applies only in Material Design themes.
dropDownOptions

Configures the drop-down field.
elementAttr

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

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

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

Specifies a custom template for the input field.
focusStateEnabled

Specifies whether the UI component can be focused using keyboard navigation.
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.
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.
height

Specifies the UI component's height.
hint

Specifies text for a hint that appears when a user pauses on the UI component.
hoverStateEnabled

Specifies whether the UI component changes its state when a user pauses on it.
inputAttr

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

Specifies or indicates whether the editor's value is valid.
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.
itemTemplate

Specifies a custom template for items.
label

Specifies a text string used to annotate the editor's value.
labelMode

Specifies the label's display mode.
minSearchLength

The minimum number of characters that must be entered into the text box to begin a search. Applies only if searchEnabled is true.
name

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

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

Specifies the text or HTML markup displayed by the UI component if the item collection is empty.
onClosed

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

A function that is executed when the UI component is rendered and each time the component is repainted.
onDisposing

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

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

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

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

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

A function that is executed before the next page is loaded.
onPullRefresh

A function that is executed when the "pull to refresh" gesture is performed on the drop-down item list. Supported on mobile devices only.
onScroll

A function that is executed on each scroll gesture performed on the drop-down item list.
onSelectionChanged

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

A function that is executed after the UI component's value is changed.
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 UI component is scrolled to the bottom.
pageLoadMode

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

The text displayed by the UI component when nothing is selected.
pulledDownText

Specifies the text displayed in the pullDown panel when the UI component 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 UI component supports the "pull down to refresh" gesture.
refreshingText

Specifies the text displayed in the pullDown panel while the UI component is being refreshed.
rtlEnabled

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

Specifies whether the search box 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 a comparison operation used to search UI component items.
searchPlaceholder

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

Specifies the DOM events after which the UI component's search results should be updated.
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.
showCancelButton

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

Specifies whether to display the Clear button in the lookup window.
showDataBeforeSearch

Specifies whether or not the UI component displays unfiltered values until a user types a number of characters exceeding the minSearchLength property value.
stylingMode

Specifies how the UI component's text field is styled.
tabIndex

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

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

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

Specifies whether or not the UI component uses native scrolling.
usePopover

Specifies whether to show lookup contents in the Popover UI component.
validationError

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

An array of the validation rules that failed.
validationMessageMode

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

Specifies the position of a validation message relative to the component. The validation message describes the validation rules that this component's value does not satisfy.
validationStatus

Indicates or specifies the current validation status.
value

Specifies the currently selected value. May be an object if dataSource contains objects, the store key is specified, and valueExpr is not set.
valueExpr

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

Specifies whether the UI component is visible.
width

Specifies the UI component's width.
wrapItemText

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

See Also
jQuery
Angular
Vue
React

Methods

This section describes the methods that control the Lookup UI component.

Name Description
beginUpdate()

Postpones rendering that can negatively affect performance until the endUpdate() method is called.
blur()

Removes focus from the input element.
close()

Closes the drop-down editor.
content()

Gets the popup window's content.
defaultOptions(rule)

Specifies the device-dependent default configuration properties for this component.
dispose()

Disposes of all the resources allocated to the Lookup instance.
element()

Gets the root UI component element.
endUpdate()

Refreshes the UI component after a call of the beginUpdate() method.
field()

Gets the UI component's <input> element.
focus()

Sets focus to the input element representing the UI component.
getDataSource()

Gets the DataSource instance.
getInstance(element)

Gets the instance of a UI component found using its DOM node.
instance()

Gets the UI component's instance. Use it to access other methods of the UI component.
off(eventName)

Detaches all event handlers from a single event.
off(eventName, eventHandler)

Detaches a particular event handler from a single event.
on(eventName, eventHandler)

Subscribes to an event.
on(events)

Subscribes to events.
open()

Opens the drop-down editor.
option()

Gets all UI component properties.
option(optionName)

Gets the value of a single property.
option(optionName, optionValue)

Updates the value of a single property.
option(options)

Updates the values of several properties.
registerKeyHandler(key, handler)

Registers a handler to be executed when a user presses a specific key.
repaint()

Renders the component again without reloading data. Use the method to update the component's markup and appearance dynamically.
reset()

Resets the value property to the default value.
resetOption(optionName)

Resets a property to its default value.

See Also
jQuery
Angular
Vue
React

Events

This section describes events fired by this UI component.

Name Description
closed

Raised once the drop-down editor is closed.
contentReady

Raised when the UI component's content is ready.
disposing

Raised before the UI component is disposed of.
initialized

Raised only once, after the UI component is initialized.
itemClick

Raised when a list item is clicked or tapped.
opened

Raised once the drop-down editor is opened.
optionChanged

Raised after a UI component property is changed.
pageLoading

Raised before the next page is loaded.
pullRefresh

Raised when the "pull to refresh" gesture is performed on the drop-down item list.
scroll

Raised on each scroll gesture performed on the drop-down item list.
selectionChanged

Raised when a list item is selected or selection is canceled.
valueChanged

Raised after the UI component's value is changed.

See Also
jQuery
Angular
Vue
React

Types

Name Description
ChangeEvent

The type of the change event handler's argument.
ClosedEvent

The type of the closed event handler's argument.
ContentReadyEvent

The type of the contentReady event handler's argument.
CopyEvent

The type of the copy event handler's argument.
CutEvent

The type of the cut event handler's argument.
DisposingEvent

The type of the disposing event handler's argument.
DropDownPredefinedButton

Specifies a custom button for an input text field.
EnterKeyEvent

The type of the enterKey event handler's argument.
FocusInEvent

The type of the focusIn event handler's argument.
FocusOutEvent

The type of the focusOut event handler's argument.
InitializedEvent

The type of the initialized event handler's argument.
InputEvent

The type of the input event handler's argument.
ItemClickEvent

The type of the itemClick event handler's argument.
KeyDownEvent

The type of the keyDown event handler's argument.
KeyUpEvent

The type of the keyUp event handler's argument.
OpenedEvent

The type of the opened event handler's argument.
OptionChangedEvent

The type of the optionChanged event handler's argument.
PageLoadingEvent

The type of the pageLoading event handler's argument.
PasteEvent

The type of the paste event handler's argument.
PullRefreshEvent

The type of the pullRefresh event handler's argument.
ScrollEvent

The type of the scroll event handler's argument.
SelectionChangedEvent

The type of the selectionChanged event handler's argument.
TextBoxType

Specifies the text box type.
ValueChangedEvent

The type of the valueChanged event handler's argument.