Box
Map

jQuery Lookup Options

An object defining configuration properties for the Lookup UI component.

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

applyButtonText

The text displayed on the Apply button.

Type:

String

Default Value: 'OK'

applyValueMode

Specifies the way an end user applies the selected value.

Default Value: 'instantly'

The property accepts the following values.

  • "useButtons"
    Enables an end user to apply the selected value or cancel the selection using the Apply and Cancel buttons respectively.

  • "instantly"
    Applies the selected value immediately after a user clicks the required value in the drop-down menu. To cancel the selection, click outside the drop-down menu.

cancelButtonText

The text displayed on the Cancel button.

Type:

String

Default Value: 'Cancel'

cleanSearchOnOpening

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

Type:

Boolean

Default Value: true

clearButtonText

The text displayed on the Clear button.

Type:

String

Default Value: 'Clear'

dataSource

Binds the UI component to data.

Default Value: null

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

Depending on your data source, bind Lookup to data as follows. In each case, also specify the valueExpr, displayExpr, or both 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";
        $("#lookupContainer").dxLookup({
            // ...
            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-lookup ...
        [dataSource]="store">
    </dx-lookup>
    import { BrowserModule } from '@angular/platform-browser';
    import { NgModule } from '@angular/core';
    import { AppComponent } from './app.component';
    
    import { DxLookupModule } from 'devextreme-angular';
    
    @NgModule({
        declarations: [
            AppComponent
        ],
        imports: [
            BrowserModule,
            DxLookupModule
        ],
        providers: [],
        bootstrap: [AppComponent]
    })
    export class AppModule { }
    Vue
    App.vue
    <template> 
        <DxLookup ...
            :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 { DxLookup } from 'devextreme-vue/lookup';
    
    export default {
        components: {
            DxLookup
        },
        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 Lookup from 'devextreme-react/lookup';
    
    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 (
                <Lookup ...
                    dataSource={store} />
            );
        }
    }
    export default App;
  • Any other data source
    Implement a CustomStore.

Regardless of the data source on the input, the Lookup 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 ].

jQuery
  • The stores are immutable. You cannot change their configurations at runtime. Instead, create a new store or DataSource and assign it to the dataSource property as shown in the following help topic: Get and Set Properties.
Angular
  • The stores are immutable. You cannot change their configurations at runtime. Instead, create a new store or DataSource and assign it to the dataSource property as shown in the following help topic: Two-Way Property Binding.
Vue
  • The stores are immutable. You cannot change their configurations at runtime. Instead, create a new store or DataSource and assign it to the dataSource property as shown in the following help topic: Two-Way Property Binding.
React
  • The stores are immutable. You cannot change their configurations at runtime. Instead, create a new store or DataSource and assign it to the dataSource property as shown in the following help topic: Controlled Mode.

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

Angular

If you set the deferRendering property to true, wrap the content in the Angular named template.

Vue

If you set the deferRendering property to true, wrap the content in the Vue named template.

disabled

Specifies whether the UI component responds to user interaction.

Type:

Boolean

Default Value: false

displayExpr

Specifies the data field whose values should be displayed.

Type:

String

|

Function

Function parameters:
item:

Object

The current item's data object.

Return Value:

String

The displayed value.

Default Value: undefined

Set this property to the name of a data field that provides displayed values...

displayExpr: "name"

... or to a function that returns the displayed value:

displayExpr: function(item) {
    // "item" can be null
    return item && 'ID: ' + item.id + ', Name: ' + item.name;
}

Leave this property unspecified or set it to this if the data source contains primitives.

See Also

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.

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.

Type:

Boolean

Default Value: false, true (Material)

The drop-down menu can be displayed under the input field (dropDownCentered is false) or over it and centered on the selected item (dropDownCentered is true). The following live example illustrates the difference:

dropDownOptions

Configures the drop-down field.

Default Value: {}

Refer to the Popover configuration for information on properties that you can specify in this object.

Angular
NOTE
The nested component that configures the dropDownOptions property does not support event bindings and two-way property bindings.
Vue
NOTE
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:

Object

Default Value: {}

jQuery
$(function(){
    $("#lookupContainer").dxLookup({
        // ...
        elementAttr: {
            id: "elementId",
            class: "class-name"
        }
    });
});
Angular
HTML
TypeScript
<dx-lookup ...
    [elementAttr]="{ id: 'elementId', class: 'class-name' }">
</dx-lookup>
import { DxLookupModule } from "devextreme-angular";
// ...
export class AppComponent {
    // ...
}
@NgModule({
    imports: [
        // ...
        DxLookupModule
    ],
    // ...
})
Vue
App.vue
<template>
    <DxLookup ...
        :element-attr="lookupAttributes">
    </DxLookup>
</template>

<script>
import DxLookup from 'devextreme-vue/lookup';

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

import Lookup from 'devextreme-react/lookup';

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

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

fieldTemplate

Specifies a custom template for the input field.

Type:

template

Template Data:

Object

The selected item's data.

Default Name: null

focusStateEnabled

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

Type:

Boolean

Default Value: false, true (desktop)

fullScreen Deprecated

Use the dropDownOptions property instead.

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

Type:

Boolean

Default Value: false, true (iPhone)

grouped

Specifies whether data items should be grouped.

Type:

Boolean

Default Value: false

If this property is set to true, the object assigned to the items property should include key and items properties. The key property specifies the group caption in the list. The items property represents an array listing group items.

NOTE
  • Only one-level grouping is supported.

  • If you enable both this property and DataSource.paginate, the pagination works only on the group level.

View Demo

groupTemplate

Specifies a custom template for group captions.

Type:

template

Template Data:

Object

The current group's data.

Default Name: 'group'

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", "20vh", "80%", "inherit".

  • Function (deprecated since v21.2)
    Refer to the W0017 warning description for information on how you can migrate to viewport units.

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(){
    $("#lookupContainer").dxLookup({
        // ...
        inputAttr: {
            id: "inputId"
        }
    });
});
Angular
HTML
TypeScript
<dx-lookup ...
    [inputAttr]="{ id: 'inputId' }">
</dx-lookup>
import { DxLookupModule } from "devextreme-angular";
// ...
export class AppComponent {
    // ...
}
@NgModule({
    imports: [
        // ...
        DxLookupModule
    ],
    // ...
})
Vue
App.vue
<template>
    <DxLookup
        :input-attr="inputAttr"
    />
</template>

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

import DxLookup from 'devextreme-vue/lookup';

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

import Lookup from 'devextreme-react/lookup';

const inputAttr = { id: 'inputId' };

export default function App() {
    return (
        <Lookup
            inputAttr={inputAttr}
        />
    );
}
ASP.NET MVC Controls
Razor C#
Razor VB
@(Html.DevExtreme().Lookup()
    .InputAttr("id", "inputId")
    // ===== or =====
    .InputAttr(new {
        @id = "inputId"
    })
    // ===== or =====
    .InputAttr(new Dictionary<string, object>() {
        { "id", "inputId" }
    })
)
@(Html.DevExtreme().Lookup() _
    .InputAttr("id", "inputId")
    ' ===== or =====
    .InputAttr(New With {
        .id = "inputId"
    })
    ' ===== or =====
    .InputAttr(New Dictionary(Of String, Object) From {
        { "id", "inputId" }
    })
)

To improve accessibility, use this property to specify aria-label for the component.

jQuery
index.js
$(function(){
    $("#lookupContainer").dxLookup({
        // ...
        inputAttr: {
            'aria-label': 'your-label',
        },
    });
});
Angular
app.component.html
<dx-lookup ...
    [inputAttr]="{ 'aria-label': 'your-label' }">
</dx-lookup>
Vue
App.vue
<template>
    <DxLookup
        :input-attr="inputAttr"
    />
</template>

<script>
import DxLookup from 'devextreme-vue/lookup';

export default {
    components: {
        DxLookup
    },
    data() {
        return {
            inputAttr: { 'aria-label': 'your-label' }
        }
    }
}
</script>
React
App.js
import Lookup from 'devextreme-react/lookup';

const inputAttr = { 'aria-label': 'your-label' };

export default function App() {
    return (
        <Lookup
            inputAttr={inputAttr}
        />
    );
}

You do not need to specify aria-label if you use label.

isDirty

Specifies whether the component's current value differs from the initial value.

Type:

Boolean

Default Value: false

This property is a read-only flag. You can use it to check if the editor value changed.

jQuery
index.js
$(() => {
    const lookup = $('#lookup').dxLookup({
        // ...
    }).dxLookup('instance');

    $('#button').dxButton({
        // ...
        onClick () {
            if (lookup.option('isDirty')) {
                DevExpress.ui.notify("Do not forget to save changes", "warning", 500);
            }
        }
    });
});
Angular
app.component.ts
app.component.html
import { Component, ViewChild } from '@angular/core';
import { DxLookupComponent, DxButtonModule } from 'devextreme-angular';
import notify from 'devextreme/ui/notify';

@Component({
    selector: 'app-root',
    templateUrl: './app.component.html',
    styleUrls: ['./app.component.css']
})
export class AppComponent {
    @ViewChild('lookupRef', { static: false }) lookup: DxLookupComponent;

    onClick () {
        if (this.lookup.instance.option('isDirty')) {
            notify("Do not forget to save changes", "warning", 500);
        }
    }
}
<dx-lookup ... 
    #lookupRef
>
</dx-lookup>
<dx-button ...
    (onClick)="onClick($event)"
>
</dx-button>
Vue
App.vue
<template>
    <DxLookup ...
        :ref="lookupRef"
    >
    </DxLookup>
    <DxButton ...
        @click="onClick"
    />
</template>

<script>
import 'devextreme/dist/css/dx.light.css';
import DxLookup from 'devextreme-vue/lookup';
import DxButton from 'devextreme-vue/button';
import notify from 'devextreme/ui/notify';

export default {
    components: {
        DxLookup,
        DxButton
    },

    data() {
        return {
            lookupRef
        }
    },

    methods: {
        onClick () {
            if (this.lookup.option('isDirty')) {
                notify("Do not forget to save changes", "warning", 500);
            }
        }
    },

    computed: {
        lookup: function() {
            return this.$refs[lookupRef].instance;
        }
    }
}
</script>
React
App.js
import React, { useRef } from 'react';
import Lookup from 'devextreme-react/lookup';
import Button from 'devextreme-react/button';
import 'devextreme/dist/css/dx.light.css';

const App = () => {
    const lookupRef = useRef(null);

    const onClick = () => {
        if (this.lookupRef.current.instance.option('isDirty')) {
            notify("Do not forget to save changes", "warning", 500);
        }
    };

    return (
        <Lookup ...
            ref={lookupRef}
        >
        </Lookup>
        <Button ...
            onClick={onClick}
        />
    );
};

export default App;
See Also

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

items[]

An array of items displayed by the UI component.

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
lookupInstance.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'

label

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

Type:

String

Default Value: ''

labelMode

Specifies the label's display mode.

Type:

LabelMode

Default Value: 'static', 'floating' (Material), 'outside' (Fluent)

This property can have one of the following values:

labelMode Description Illustration
"static" The label is displayed above the input field.
"floating" The label is used as a placeholder, but when the editor gets focus,
the label moves to the position above the input field.
"hidden" The label is hidden.
"outside" The label is outside.
NOTE

If autofill is enabled in the browser, we do not recommend that you use "floating" mode. The autofill values will overlap the label when it is displayed as a placeholder. Use "static" mode instead.

minSearchLength

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

Type:

Number

Default Value: 0

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.

nextButtonText

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

Type:

String

Default Value: 'More'

noDataText

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

Type:

String

Default Value: 'No data to display'

The Lookup component evaluates the noDataText property's value. This evaluation, however, makes the Lookup potentially vulnerable to XSS attacks. To guard against these attacks, encode the HTML markup before you assign it to the noDataText property. Refer to the following help topic for more information: Potentially Vulnerable API - noDataText.

onClosed

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

Type:

Function

Function parameters:

Information about the event.

Object structure:
Name Type Description
element

HTMLElement | jQuery

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

component

Lookup

The UI component's instance.

Default Value: null

onContentReady

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

Type:

Function

Function parameters:

Information about the event.

Object structure:
Name Type Description
element

HTMLElement | jQuery

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

component

Lookup

The UI component's instance.

Default Value: null

onDisposing

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

Type:

Function

Function parameters:

Information about the event.

Object structure:
Name Type Description
element

HTMLElement | jQuery

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

component

Lookup

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:

Information about the event.

Object structure:
Name Type Description
element

HTMLElement | jQuery

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

component

Lookup

The UI component's instance.

Default Value: null

Angular
app.component.html
app.component.ts
<dx-lookup ...
    (onInitialized)="saveInstance($event)">
</dx-lookup>
import { Component } from "@angular/core";
import Lookup from "devextreme/ui/data_grid";
// ...
export class AppComponent {
    lookupInstance: Lookup;
    saveInstance (e) {
        this.lookupInstance = e.component;
    }
}
Vue
App.vue (Options API)
App.vue (Composition API)
<template>
    <div>
        <DxLookup ...
            @initialized="saveInstance">
        </DxLookup>
    </div>
</template>

<script>
import DxLookup from 'devextreme-vue/lookup';

export default {
    components: {
        DxLookup
    },
    data: function() {
        return {
            lookupInstance: null
        };
    },
    methods: {
        saveInstance: function(e) {
            this.lookupInstance = e.component;
        }
    }
};
</script>
<template>
    <div>
        <DxLookup ...
            @initialized="saveInstance">
        </DxLookup>
    </div>
</template>

<script setup>
import DxLookup from 'devextreme-vue/lookup';

let lookupInstance = null;

const saveInstance = (e) => {
    lookupInstance = e.component;
}
</script>
React
App.js
import Lookup from 'devextreme-react/lookup';

class App extends React.Component {
    constructor(props) {
        super(props);

        this.saveInstance = this.saveInstance.bind(this);
    }

    saveInstance(e) {
        this.lookupInstance = e.component;
    }

    render() {
        return (
            <div>
                <Lookup onInitialized={this.saveInstance} />
            </div>
        );
    }
}
See Also
jQuery
  • Get a UI component Instance in jQuery
Angular
  • Get a UI component Instance in Angular
Vue
  • Get a UI component Instance in Vue
React
  • Get a UI component Instance in React

onItemClick

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

Type:

Function

Function parameters:

Information about the event.

Object structure:
Name Type Description
itemIndex

Number

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

itemElement

HTMLElement | jQuery

The item's container.

itemData

Object

The clicked item's data.

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

Lookup

The UI component's instance.

Default Value: null

onOpened

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

Type:

Function

Function parameters:

Information about the event.

Object structure:
Name Type Description
element

HTMLElement | jQuery

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

component

Lookup

The UI component's instance.

Default Value: null

onOptionChanged

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

Type:

Function

Function parameters:

Information about the event.

Object structure:
Name Type Description
value any

The modified property's new value.

previousValue any

The UI component's previous value.

name

String

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

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

Lookup

The UI component's instance.

Default Value: null

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

jQuery
index.js
$(function() {
    $("#lookupContainer").dxLookup({
        // ...
        onOptionChanged: function(e) {
            if(e.name === "changedProperty") {
                // handle the property change here
            }
        }
    });
});
Angular
app.component.html
app.component.ts
app.module.ts
<dx-lookup ...
    (onOptionChanged)="handlePropertyChange($event)"> 
</dx-lookup>
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 { DxLookupModule } from 'devextreme-angular'; 

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

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

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

export default { 
    components: { 
        DxLookup
    }, 
    // ...
    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 Lookup from 'devextreme-react/lookup'; 

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

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

onPageLoading

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

Type:

Function

Function parameters:

Information about the event.

Object structure:
Name Type Description
component

Lookup

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

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.

Type:

Function

Function parameters:

Information about the event.

Object structure:
Name Type Description
component

Lookup

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

onScroll

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

Type:

Function

Function parameters:

Information about the event.

Object structure:
Name Type Description
component

Lookup

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.

reachedBottom

Boolean

Indicates whether the container's bottom boundary is reached.

reachedLeft

Boolean

Indicates whether the container's left boundary is reached.

reachedRight

Boolean

Indicates whether the container's right boundary is reached.

reachedTop

Boolean

Indicates whether the container's top boundary is reached.

scrollOffset

Object

The current scroll offset in the following format { top: topOffset, left: leftOffset }.

Default Value: null

onSelectionChanged

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

Type:

Function

Function parameters:

Information about the event.

Object structure:
Name Type Description
removedItems

Array<any>

element

HTMLElement | jQuery

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

component

Lookup

The UI component's instance.

addedItems

Array<any>

Default Value: null

onValueChanged

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

Type:

Function

Function parameters:

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.

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

Lookup

The UI component's instance.

Default Value: null

opened

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

Type:

Boolean

Default Value: false
Raised Events: onClosed onOpened

pageLoadingText

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

Type:

String

Default Value: 'Loading...'

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.

Type:

PageLoadMode

Default Value: 'scrollBottom'

placeholder

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

Type:

String

Default Value: 'Select'

See Also

pulledDownText

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

Type:

String

Default Value: 'Release to refresh...'

pullingDownText

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

Type:

String

Default Value: 'Pull down to refresh...'

pullRefreshEnabled

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

Type:

Boolean

Default Value: false

If the property is set to true, the UI component data is refreshed each time you pull down and release UI component contents.

NOTE
The "pull down to refresh" gesture is not supported by desktop browsers. You can use it only on mobile devices.

refreshingText

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

Type:

String

Default Value: 'Refreshing...'

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

searchEnabled

Specifies whether the search box is visible.

Type:

Boolean

Default Value: true, false (Material)

NOTE
Searching works with source data of plain structure only. Subsequently, data can be transformed to hierarchical structure using the DataSource's group property.
See Also

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.

Default Value: 'contains'

searchPlaceholder

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

Type:

String

Default Value: 'Search'

searchStartEvent

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

jQuery
index.js
$(function() {
    $("#lookup").dxLookup({
        // ...
        searchStartEvent: 'change'
    });
});
Angular
app.component.html
app.module.ts
<dx-lookup ...
    searchStartEvent="change"
</dx-lookup>
import { BrowserModule } from '@angular/platform-browser'; 
import { NgModule } from '@angular/core'; 
import { AppComponent } from './app.component'; 
import { DxLookupModule } from 'devextreme-angular'; 

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

export class AppModule { }  
Vue
App.vue
<template> 
    <DxLookup ...
        search-start-event="change"
    />            
</template> 

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

export default { 
    components: { 
        DxLookup
    }
} 
</script> 
React
App.js
import React from 'react';  
import 'devextreme/dist/css/dx.light.css'; 

import Lookup from 'devextreme-react/lookup'; 

export default function App() { 
    return ( 
        <Lookup ...
            searchStartEvent="change"
        />        
    ); 
} 

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

showCancelButton

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

Type:

Boolean

Default Value: true, false (Material)

The Cancel button cancels the attempt to change the lookup UI component value.

showClearButton

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

Type:

Boolean

Default Value: false

The Clear button calls the reset method which resets the value property to its default value (null). The lookup window closes and the text specified by the placeholder property is shown in the lookup editor.

showDataBeforeSearch

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

Type:

Boolean

Default Value: false

If this property is disabled, the UI component does not display values until the number of typed characters exceeds the minSearchLength value, otherwise it displays all values regardless of the specified filtering condition.

stylingMode

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

Type:

EditorStyle

Default Value: 'outlined', 'filled' (Material)

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 Lookup 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 Lookup contain is passed to the title attribute of the respective item.

useNativeScrolling

Specifies whether or not the UI component uses native scrolling.

Type:

Boolean

Default Value: true, false (desktop except Mac)

usePopover

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

Type:

Boolean

Default Value: false, false (Material), true (desktop, iOS)

Lookup contents can be displayed in a Popover only if dropDownOptions.fullScreen is disabled. Otherwise, lookup contents are displayed within the Popup UI component.

Material Design themes always use the Popup UI component, ignoring the usePopover property.

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.

Default Value: '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.

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.

Type:

Position

|

Mode

Default Value: 'auto'

If you set this property to auto, the component specifies the validation message position automatically.

The following example positions a validation message at the component's right:

jQuery
index.js
$(function() {
    $("#lookupContainer").dxLookup({
        // ...
        validationMessagePosition: 'right'
    }).dxValidator({
        validationRules: [{
            type: 'required',
            message: 'Required',
        }],
    });
});
Angular
app.component.html
<dx-lookup ...
    validationMessagePosition="right">
    <dx-validator>
        <dxi-validation-rule
            type="required"
            message="Required"
        >
        </dxi-validation-rule>
    </dx-validator>
</dx-lookup>
Vue
App.vue
<template>
    <DxLookup ...
        validation-message-position="right"
    >
        <DxValidator>
            <DxRequiredRule message="Required" />
        </DxValidator>
    </DxLookup>
</template>

<script>
    // ...
</script>
React
App.js
import React from 'react';
// ...

function App() {
    return (
        <Lookup ...
            validationMessagePosition="right"
        >
            <Validator>
                <RequiredRule message="Required" />
            </Validator>
        </Lookup>
    ); 

};
export default App;

validationStatus

Indicates or specifies the current validation status.

Default Value: 'valid'

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 lookup = $("#lookupContainer").dxLookup({
        // ...
    }).dxLookup("instance");

    function setInvalidStatus(message) {
        lookup.option({
            validationStatus: "invalid",
            validationErrors: [{ message: message }]
        });
    }
});
Angular
app.component.html
app.component.ts
<dx-lookup
    [validationStatus]="validationStatus"
    [validationErrors]="validationErrors">
</dx-lookup>
// ...
export class AppComponent {
    validationStatus: string = "valid";
    validationErrors: any;
    // ...
    setInvalidStatus(message) {
        this.validationStatus = "invalid";
        this.validationErrors = [{ message: message }];
    }
}
Vue
App.vue
<template>
    <DxLookup ...
        :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 (
        <Lookup
            validationStatus={validationStatus}
            validationErrors={validationErrors}
        />
    ); 

};
export default App;

value

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

Type: any
Default Value: null
Raised Events: onValueChanged

When dataSource contains objects, you should define valueExpr to correctly identify data items. Otherwise, the component uses referential equality to compare objects. For example, when valueExpr is not specified and you assign an object with the same field and values as dataSource to the value property, these two objects are not equal, and the component displays nothing.

valueChangeEvent Deprecated

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, which may result in unexpected behavior.

If you use a store, the valueExpr property should have the same value as the key in the store. Alternatively, you can use this as a valueExpr but the key should be specified. Refer to the following article for more information: Troubleshooting - A Drop-Down Editor Does Not Show Data.

Do not use template as a valueExpr value.

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.
See Also

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", "20vw", "80%", "auto", "inherit".

  • Function (deprecated since v21.2)
    Refer to the W0017 warning description for information on how you can migrate to viewport units.

wrapItemText

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

Type:

Boolean

Default Value: false