JavaScript/jQuery List Options

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:

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.

allowItemDeleting

Specifies whether or not an end user can delete list items.

Type:

Default Value: false

bounceEnabled

A Boolean value specifying whether to enable or disable the bounce-back effect.

Type:

Default Value: true, false (desktop)

If the property is set to true, you can scroll the list content up (down) even if you have reached the bottom (top) boundary. But when you release the content, it returns to the bound position. If the property value is false, you can scroll the list content until you reach the boundary.

collapsibleGroups

Specifies whether or not an end user can collapse groups.

Type:

Default Value: false

This property makes sense if the grouped property is set to true.

If the collapsibleGroups property is set to true, the down arrow is displayed to the right of a group header. An end user can collapse or expand a group simply clicking the group header.

dataSource

Binds the UI component to data.

Type:

|

Array<String | dxListItem | any>

|

Store

|

DataSource

|

DataSource Configuration

| null

Default Value: null

The List works with collections of string values or objects.

Depending on your data source, bind the List to data as follows. If the data source provides objects, also specify the itemTemplate. You can skip this part if the objects contain fields described in the items section.

Data Array
Assign the array to the dataSource option. View Demo
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";
    $("#listContainer").dxList({
        // ...
        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-list ...
    [dataSource]="store">
</dx-list>

import { BrowserModule } from '@angular/platform-browser';
import { NgModule } from '@angular/core';
import { AppComponent } from './app.component';

import { DxListModule } from 'devextreme-angular';

@NgModule({
    declarations: [
        AppComponent
    ],
    imports: [
        BrowserModule,
        DxListModule
    ],
    providers: [],
    bootstrap: [AppComponent]
})
export class AppModule { }

Vue

App.vue

<template> 
    <DxList ...
        :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 { DxList } from 'devextreme-vue/list';

export default {
    components: {
        DxList
    },
    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 List from 'devextreme-react/list';

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 (
            <List ...
                dataSource={store} />
        );
    }
}
export default App;

Any other data source
Implement a CustomStore.

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

disabled

Specifies whether the UI component responds to user interaction.

Type:

Default Value: false

displayExpr

Specifies the data field whose values should be displayed. Defaults to "text" when the data source contains objects.

Type:

|

Function parameters:

item:

The current item's data object.

Return Value:

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.

elementAttr

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

Type:

Default Value: {}

jQuery

$(function(){
    $("#listContainer").dxList({
        // ...
        elementAttr: {
            id: "elementId",
            class: "class-name"
        }
    });
});

Angular

HTML

TypeScript

<dx-list ...
    [elementAttr]="{ id: 'elementId', class: 'class-name' }">
</dx-list>

import { DxListModule } from "devextreme-angular";
// ...
export class AppComponent {
    // ...
}
@NgModule({
    imports: [
        // ...
        DxListModule
    ],
    // ...
})

Vue

App.vue

<template>
    <DxList ...
        :element-attr="listAttributes">
    </DxList>
</template>

<script>
import DxList from 'devextreme-vue/list';

export default {
    components: {
        DxList
    },
    data() {
        return {
            listAttributes: {
                id: 'elementId',
                class: 'class-name'
            }
        }
    }
}
</script>

React

App.js

import React from 'react';

import List from 'devextreme-react/list';

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

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

focusStateEnabled

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

Type:

Default Value: true (desktop)

grouped

Specifies whether data items should be grouped.

Type:

Default Value: false

When this property is true, make sure that all data source objects have the following structure:

JavaScript

const dataSource = [{
    key: "Group 1", // Group caption 
    items: [ // Items in the group
        { ... },
        { ... }
    ]
}, {
    // ...
}];

You can supply data to this structure using the DataSource object's group property.

NOTE

Only one-level grouping is supported.

groupTemplate

Specifies a custom template for group captions.

Type:

template

Template Data:

The current group's data.

Default Name: 'group'

height

Specifies the UI component's height.

Type:

|

|

Return Value:

|

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:

Default Value: undefined

hoverStateEnabled

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

Type:

Default Value: true

indicateLoading

Specifies whether or not to show the loading panel when the DataSource bound to the UI component is loading data.

Type:

Default Value: true

NOTE

This property affects only the load panel displayed when the bound DataSource is loading data after the load() method is called. The load indicator displayed when the list is being updated is always enabled regardless of the property value.

itemDeleteMode

Specifies the way a user can delete items from the list.

Type:

ItemDeleteMode

Default Value: 'static', 'slideItem' (iOS), 'swipe' (Android)

NOTE

If List items are supplied with the context menu, this property is ignored in favor of the menuMode property.

itemDragging

Configures item reordering using drag and drop gestures.

Type:

Sortable configuration

See the Sortable configuration for properties that you can specify in this object.

itemHoldTimeout

The time period in milliseconds before the onItemHold event is raised.

Type:

Number

Default Value: 750

items[]

An array of items displayed by the UI component.

Type:

Array<String | dxListItem | any>

Raised Events: onOptionChanged

The items array can contain:

Strings
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

listInstance.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:

The item object to be rendered.

Default Name: 'item'

keyExpr

Specifies the key property that provides key values to access data items. Each key value must be unique.

Type:

|

Default Value: null

menuItems[]

Specifies the array of items for a context menu called for a list item.

Type:

Array<Object>

Default Value: []

menuMode

Specifies whether an item context menu is shown when a user holds or swipes an item.

Type:

ListMenuMode

Default Value: 'context', 'slide' (iOS)

nextButtonText

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

Type:

Default Value: 'More'

noDataText

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

Type:

Default Value: 'No data to display'

The List component evaluates the noDataText property's value. This evaluation, however, makes the List 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.

onContentReady

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

Type:

Function parameters:

e:

ContentReadyEvent

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	List	The UI component's instance.

Name

Type

Description

element

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

component

The UI component's instance.

Default Value: null

onDisposing

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

Type:

Function parameters:

e:

DisposingEvent

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	List	The UI component's instance.

Name

Type

Description

element

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

component

The UI component's instance.

Default Value: null

onGroupRendered

A function that is executed when a group element is rendered.

Type:

Function parameters:

e:

GroupRenderedEvent

Information about the event.

Object structure:

Name	Type	Description
component	List	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.
groupData	Object	The current group's data.
groupElement	HTMLElement \| jQuery	The group's container. It is an HTML Element or a jQuery Element when you use jQuery.
groupIndex	Number	The group's index.

Default Value: null

onInitialized

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

Type:

Function parameters:

e:

InitializedEvent

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	List	The UI component's instance.

Name

Type

Description

element

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

component

The UI component's instance.

Default Value: null

Angular

app.component.html

app.component.ts

<dx-list ...
    (onInitialized)="saveInstance($event)">
</dx-list>

import { Component } from "@angular/core";
import List from "devextreme/ui/data_grid";
// ...
export class AppComponent {
    listInstance: List;
    saveInstance (e) {
        this.listInstance = e.component;
    }
}

Vue

App.vue (Options API)

App.vue (Composition API)

<template>
    <div>
        <DxList ...
            @initialized="saveInstance">
        </DxList>
    </div>
</template>

<script>
import DxList from 'devextreme-vue/list';

export default {
    components: {
        DxList
    },
    data: function() {
        return {
            listInstance: null
        };
    },
    methods: {
        saveInstance: function(e) {
            this.listInstance = e.component;
        }
    }
};
</script>

<template>
    <div>
        <DxList ...
            @initialized="saveInstance">
        </DxList>
    </div>
</template>

<script setup>
import DxList from 'devextreme-vue/list';

let listInstance = null;

const saveInstance = (e) => {
    listInstance = e.component;
}
</script>

React

App.js

import List from 'devextreme-react/list';

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

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

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

    render() {
        return (
            <div>
                <List onInitialized={this.saveInstance} />
            </div>
        );
    }
}

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 collection item is clicked or tapped.

Type:

Function parameters:

e:

ItemClickEvent

Information about the event.

Object structure:

Name	Type	Description
itemIndex	Number \| Object	The clicked item's index. In a grouped list, the index represents an object defining group and item indexes: { group: 0, item: 0 }.
itemElement	HTMLElement \| jQuery	The clicked item's container. It is an HTML Element or a jQuery Element when you use jQuery.
itemData	Object	The clicked item's data object.
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	List	The UI component's instance.

Default Value: null

onItemContextMenu

A function that is executed when a collection item is right-clicked or pressed.

Type:

Function parameters:

e:

ItemContextMenuEvent

Information about the event.

Object structure:

Name	Type	Description
itemIndex	Number \| Object	The target item's index. In a grouped list, the index is specified as an object defining group and item indexes: { group: 0, item: 0 }.
itemElement	HTMLElement \| jQuery	The target item's container. It is an HTML Element or a jQuery Element when you use jQuery.
itemData	Object	The target item's data object.
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	List	The UI component's instance.

Default Value: null

onItemDeleted

A function that is executed after a list item is deleted from the data source.

Type:

Function parameters:

e:

ItemDeletedEvent

Information about the event.

Object structure:

Name	Type	Description
itemIndex	Number \| Object	The removed item's index. In a grouped list, the index represents an object defining the group and item indexes: { group: 0, item: 0 }.
itemElement	HTMLElement \| jQuery	The item's container. It is an HTML Element or a jQuery Element when you use jQuery.
itemData	Object	The removed item's data.
element	HTMLElement \| jQuery	The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.
component	List	The UI component's instance.

Default Value: null

Note that the itemDeleted event is raised only if an item is deleted using the appropriate method of the UI component or end-user interaction. If you delete an item from an observable array passed to the dataSource or items property, the UI component entirely reloads the items array without raising the itemDeleted and itemDeleting events.

onItemDeleting

A function that is executed before a collection item is deleted from the data source.

Type:

Function parameters:

e:

ItemDeletingEvent

Information about the event.

Object structure:

Name	Type	Description
itemIndex	Number \| Object	The item's index. In a grouped list, the index represents an object defining group and item indexes: { group: 0, item: 0 }.
itemElement	HTMLElement \| jQuery	The item's container. It is an HTML Element or a jQuery Element when you use jQuery.
itemData	Object	The data of the item to be removed.
element	HTMLElement \| jQuery	The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.
component	List	The UI component's instance.
cancel	Boolean	Allows you to cancel the item deletion.

Default Value: null

You can cancel item deletion by setting the handler parameter's cancel field to true. This field also accepts a Promise (jQuery or native), which enables you to perform an asynchronous action before an item is deleted.

jQuery

index.js

const widgetOptions = {
    onItemDeleting: function(e) {
        const d = $.Deferred();
        DevExpress.ui.dialog.confirm("Do you really want to delete the item?")
            .done(function(value) { 
                d.resolve(!value);
            })
            .fail(d.reject);
        e.cancel = d.promise();
    }
}

Note that the onItemDeleted and onItemDeleting handlers are not executed if an item is deleted from the data source without using the UI component's UI or API.

onItemHold

A function that is executed when a collection item has been held for a specified period.

Type:

Function parameters:

e:

ItemHoldEvent

Information about the event.

Object structure:

Name	Type	Description
itemIndex	Number \| Object	The index of the item being held. In a grouped list, the index represents an object defining the group and item indexes: { group: 0, item: 0 }.
itemElement	HTMLElement \| jQuery	The container of the item being held. It is an HTML Element or a jQuery Element when you use jQuery.
itemData	Object	The data object of the item being held.
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	List	The UI component's instance.

Default Value: null

onItemRendered

A function that is executed after a collection item is rendered.

Type:

Function parameters:

e:

ItemRenderedEvent

Information about the event.

Object structure:

Name	Type	Description
itemIndex	Number	The current item's index.
itemElement	HTMLElement \| jQuery	The item's container. It is an HTML Element or a jQuery Element when you use jQuery.
itemData	Object	The current item's data.
element	HTMLElement \| jQuery	The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.
component	List	The UI component's instance.

Default Value: null

onItemReordered

A function that is executed after a list item is moved to another position.

Type:

Function parameters:

e:

ItemReorderedEvent

Information about the event.

Object structure:

Name	Type	Description
toIndex	Number	The item's current index. In a grouped list, the index represents an object defining the group and item indexes: { group: 0, item: 0 }.
itemIndex	Number \| Object	The item's index after reordering. This field holds the same value as toIndex. In a grouped list, the index represents an object defining the group and item indexes: { group: 0, item: 0 }.
itemElement	HTMLElement \| jQuery	The item's container. It is an HTML Element or a jQuery Element when you use jQuery.
itemData	Object	The reordered item's data.
fromIndex	Number	The item's previous index. In a grouped list, the index represents an object defining the group and item indexes: { group: 0, item: 0 }.
element	HTMLElement \| jQuery	The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.
component	List	The UI component's instance.

Default Value: null

onItemSwipe

A function that is executed when a list item is swiped.

Type:

Function parameters:

e:

ItemSwipeEvent

Information about the event.

Object structure:

Name	Type	Description
component	List	The UI component's instance.
direction	String	The direction in which the item is swiped.
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.
itemData	Object	The swiped item's data.
itemElement	HTMLElement \| jQuery	The item's container. It is an HTML Element or a jQuery Element when you use jQuery.
itemIndex	Number \| Object	The item's index. In a grouped list, the index represents an object defining the group and item indexes: { group: 0, item: 0 }.

Default Value: null

onOptionChanged

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

Type:

Function parameters:

e:

OptionChangedEvent

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	List	The UI component's instance.

Default Value: null

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

jQuery

index.js

$(function() {
    $("#listContainer").dxList({
        // ...
        onOptionChanged: function(e) {
            if(e.name === "changedProperty") {
                // handle the property change here
            }
        }
    });
});

Angular

app.component.html

app.component.ts

app.module.ts

<dx-list ...
    (onOptionChanged)="handlePropertyChange($event)"> 
</dx-list>

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 { DxListModule } from 'devextreme-angular'; 

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

export class AppModule { }

Vue

App.vue

<template> 
    <DxList ...
        @option-changed="handlePropertyChange"
    />            
</template> 

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

export default { 
    components: { 
        DxList
    }, 
    // ...
    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 List from 'devextreme-react/list'; 

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

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

onPageLoading

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

Type:

Function parameters:

e:

PageLoadingEvent

Information about the event.

Object structure:

Name

Type

Description

component

The UI component's instance.

element

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. Supported on mobile devices only.

Type:

Function parameters:

e:

PullRefreshEvent

Information about the event.

Object structure:

Name

Type

Description

component

The UI component's instance.

element

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.

Type:

Function parameters:

e:

ScrollEvent

Information about the event.

Object structure:

Name	Type	Description
component	List	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

onSelectAllValueChanged

A function that is executed when the "Select All" check box value is changed. Applies only if the selectionMode is "all".

Type:

SelectAllValueChangedEvent

Function parameters:

e:

Information about the event.

Object structure:

Name

Type

Description

component

The UI component's instance.

element

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

value

The "Select All" check box's state.

Default Value: null

onSelectionChanged

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

Type:

Function parameters:

e:

SelectionChangedEvent

Information about the event.

Object structure:

Name	Type	Description
removedItems	Array<any>	The data of the items whose selection has been canceled.
element	HTMLElement \| jQuery	The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.
component	List	The UI component's instance.
addedItems	Array<any>	The data of the items that have been selected.

Default Value: null

pageLoadingText

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

Type:

Default Value: 'Loading...', '' (Fluent, Material)

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', 'nextButton' (desktop except Mac)

pulledDownText

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

Type:

Default Value: 'Release to refresh...', '' (Fluent, Material)

pullingDownText

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

Type:

Default Value: 'Pull down to refresh...', '' (Fluent, Material)

pullRefreshEnabled

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

Type:

Default Value: false

If the property is set to true, list data is refreshed each time you pull down and release list 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 list is being refreshed.

Type:

Default Value: 'Refreshing...', '' (Fluent, Material)

repaintChangesOnly

Specifies whether to repaint only those elements whose data changed.

Type:

Default Value: false

rtlEnabled

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

Type:

DataGrid Demo Navigation UI Demo Editors Demo

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
});

scrollByContent

A Boolean value specifying if the list is scrolled by content.

Type:

Default Value: true, false (non-touch devices)

scrollByThumb

Specifies whether a user can scroll the content with the scrollbar. Applies only if useNativeScrolling is false.

Type:

Default Value: false, true (desktop)

scrollingEnabled

A Boolean value specifying whether to enable or disable list scrolling.

Type:

Default Value: true

searchEditorOptions

Configures the search panel.

Type:

TextBox Configuration

Default Value: {}

See the TextBox Configuration for properties you can specify in this object.

Angular

NOTE

The nested component that configures the searchEditorOptions property does not support event bindings and two-way property bindings.

Vue

NOTE

The nested component that configures the searchEditorOptions property does not support event bindings and two-way property bindings.

searchEnabled

Specifies whether the search panel is visible.

Type:

Default Value: false

NOTE

Searching works only if data is specified using the dataSource property and has a plain structure. Subsequently, data can be transformed to hierarchical structure using the DataSource's group property.

searchExpr

Specifies a data object's field name or an expression whose value is compared to the search string.

Type:

getter

|

Array<getter>

Default Value: null

If you need to search several fields, assign an array of field names to this property.

searchExpr: ["firstName", "lastName"]

searchMode

Specifies a comparison operation used to search UI component items.

Type:

SearchMode

Default Value: 'contains'

searchTimeout

Specifies a delay in milliseconds between when a user finishes typing, and the search is executed.

Type:

Number

Default Value: undefined

searchValue

Specifies the current search string.

Type:

Default Value: ''

selectAllMode

Specifies the mode in which all items are selected.

Type:

SelectAllMode

Default Value: 'page'

The selectAllMode specifies how records should be selected on clicking the "Select All" check box. The following modes are available:

"page"
Selects items on the currently rendered pages.
"allPages"
Selects items on all pages.

NOTE

The selectAllMode applies only if the selectionMode is set to all and the selection controls are shown.

selectAllText

Specifies the text displayed at the "Select All" check box.

Type:

Default Value: 'Select All'

selectByClick

Specifies whether an item is selected if a user clicks it.

Type:

Default Value: 'true'

If you enable selection and selection controls in the List component, checkboxes appear near each item. Assign true to this property to allow users to click anywhere on an item to select it, or false to select List items only by checking checkboxes.

selectedItemKeys

Specifies an array of currently selected item keys.

Type:

Array<any>

Raised Events: onSelectionChanged

The item keys can be specified using the keyExpr property or the key property within the underlying Store.

selectedItems

An array of currently selected item objects.

Type:

Array<any>

Raised Events: onSelectionChanged

selectionMode

Specifies item selection mode.

Type:

SingleMultipleAllOrNone

Default Value: 'none'

Accepted Values: 'multiple' | 'single' | 'all' | 'none'

This property accepts the following values.

"none"
Selection is disabled.
"single"
A user can select only a single item.
"multiple"
A user can select several items.
"all"
The multiple mode with a check box that selects/unselects all items.
If paging is enabled, the select all check box selects only items that have been already loaded.

NOTE

The check box that selects/unselects all items is displayed only if the showSelectionControls property is enabled. Otherwise, the "all" mode works as "multiple".

showScrollbar

Specifies when the UI component shows the scrollbar.

Type:

ScrollbarMode

Default Value: 'onScroll', 'onHover' (desktop)

Setting this property makes sense only when the useNativeScrolling property is set to false.

showSelectionControls

Specifies whether or not to display controls used to select list items.

Type:

Default Value: false

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.

useNativeScrolling

Specifies whether or not the UI component uses native scrolling.

Type:

Default Value: true, false (desktop except Mac)

visible

Specifies whether the UI component is visible.

Type: