JavaScript/jQuery Lookup API

Specifies the shortcut key that sets focus on the widget.

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

Configures widget visibility animations. This object contains two fields: show and hide.

The text displayed on the Apply button.

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

The text displayed on the Cancel button.

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

The text displayed on the Clear button.

Specifies whether to close the drop-down menu if a user clicks outside it.

Binds the widget to data.

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

Specifies whether the widget responds to user interaction.

Specifies the data field whose values should be displayed.

Returns the value currently displayed by the widget.

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

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

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

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

Specifies a custom template for the input field.

Specifies whether the widget can be focused using keyboard navigation.

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

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

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

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

Specifies a custom template for group captions.

Specifies the widget's height.

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

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

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

Specifies or indicates whether the editor's value is valid.

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

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

An array of items displayed by the widget.

Specifies a custom template for items.

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

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

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

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

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

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

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

A function used in JavaScript frameworks to save the widget instance.

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

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

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

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

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

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

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

A function that is executed when the drop-down list's title is rendered.

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

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

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

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

The text displayed by the widget when nothing is selected.

Specifies the popup element's height. Applies only if fullScreen is false.

Specifies the popup element's width. Applies only if fullScreen is false.

An object defining widget positioning options.

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

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

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

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

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

Specifies whether the search box is visible.

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

Specifies a comparison operation used to search widget items.

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

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

Gets the currently selected item.

Specifies whether to shade the container when the lookup is active. Applies only if usePopover is false.

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

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

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

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

Specifies how the widget's text field is styled.

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

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

The title of the lookup window.

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

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

Specifies a custom template for the title.

Specifies whether or not the widget uses native scrolling.

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

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

An array of the validation rules that failed.

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

Indicates or specifies the current validation status.

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

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

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

Specifies whether the widget is visible.

Specifies the widget's width.

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

Prevents the widget from refreshing until the endUpdate() method is called.

Removes focus from the input element.

Closes the drop-down editor.

Gets the popup window's content.

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

Disposes of all the resources allocated to the Lookup instance.

Gets the root widget element.

Refreshes the widget after a call of the beginUpdate() method.

Gets the widget's <input> element.

Sets focus to the input element representing the widget.

Gets the DataSource instance.

Gets the instance of a widget found using its DOM node.

Gets the widget's instance. Use it to access other methods of the widget.

Detaches all event handlers from a single event.

Detaches a particular event handler from a single event.

Subscribes to an event.

Subscribes to events.

Opens the drop-down editor.

Gets all widget options.

Gets the value of a single option.

Updates the value of a single option.

Updates the values of several options.

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

Repaints the widget without reloading data. Call it to update the widget's markup.

Resets the value option to the default value.

Resets an option to its default value.

Raised once the drop-down editor is closed.

Raised when the widget's content is ready.

Raised before the widget is disposed of.

Raised only once, after the widget is initialized.

Raised when a list item is clicked or tapped.

Raised once the drop-down editor is opened.

Raised after a widget option is changed.

Raised before the next page is loaded.

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

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

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

Raised when the drop-down list's title is rendered.

Raised after the widget's value is changed.