Box
Map
Vue

Configuration

An object defining configuration options for the List widget.

See Also

accessKey

Specifies the shortcut key that sets focus on the widget.

Type:

String

Default Value: null

The value of this option will be passed to the accesskey attribute of the HTML element that underlies the widget.

activeStateEnabled

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

Type:

Boolean

Default Value: true

This option is used when the widget is displayed on a platform whose guidelines include the active state change for widgets.

allowItemDeleting

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

Type:

Boolean

Default Value: false

allowItemReordering Deprecated

Use the itemDragging option instead.

Specifies whether a user can reorder list items. Grouped items cannot be moved from one group to another.

Type:

Boolean

Default Value: false

To obtain items in the same order as they are displayed in the widget, read the items option for jQuery or bind it to a component property for Angular, Vue, and React.

NOTE
On Android devices, this option applies only if the useNativeScrolling option is set to false.
See Also

bounceEnabled

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

Type:

Boolean

Default Value: true, false (desktop)

If the option 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 option value is false, you can scroll the list content until you reach the boundary.

See Also

collapsibleGroups

Specifies whether or not an end-user can collapse groups.

Type:

Boolean

Default Value: false

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

If the collapsibleGroups option 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.

See Also

View Demo

dataSource

Binds the widget to data.

Default Value: null

If you use DevExtreme ASP.NET MVC Controls, refer to the Bind Controls to Data article.

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 Default Item Template section.

  • Data Array
    Assign the array to the dataSource option.

  • Read-Only Data in JSON Format
    Set the dataSource option 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 widgets 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> 
        <dx-list ...
            :data-source="store" />
    </template>
    
    <script>
    import 'devextreme/dist/css/dx.common.css';
    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.common.css';
    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 otherwise shape data. To get its instance, call the getDataSource() method.

NOTE

Please review the following notes about data binding:

  • Do not specify the items option if you specified the dataSource, and vice versa.

  • Data field names should not contain the following characters: ., ,, :, [, and ].

  • DataSource and stores provide methods to process and update data. However, the methods do not allow you to perform particular tasks (for example, replace the entire dataset, reconfigure data access at runtime). For such tasks, create a new array, store, or DataSource and assign it to the dataSource option as shown in the articles about changing options in jQuery, Angular, React, and Vue.

disabled

Specifies whether the widget responds to user interaction.

Type:

Boolean

Default Value: false

displayExpr

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

Type:

String

|

Function

Function parameters:
item:

Object

The current item's data object.

Return Value:

String

The displayed value.

Default Value: undefined

Set this option 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 option unspecified or set it to this if the data source contains primitives.

elementAttr

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

Type:

Object

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
    ],
    // ...
})
ASP.NET MVC Controls
Razor C#
Razor VB
@(Html.DevExtreme().List()
    .ElementAttr("class", "class-name")
    // ===== or =====
    .ElementAttr(new {
        @id = "elementId",
        @class = "class-name"
    })
    // ===== or =====
    .ElementAttr(new Dictionary<string, object>() {
        { "id", "elementId" },
        { "class", "class-name" }
    })

)
@(Html.DevExtreme().List() _
    .ElementAttr("class", "class-name")
    ' ===== or =====
    .ElementAttr(New With {
        .id = "elementId",
        .class = "class-name"
    })
    ' ===== or =====
    .ElementAttr(New Dictionary(Of String, Object) From {
        { "id", "elementId" },
        { "class", "class-name" }
    })
)

focusStateEnabled

Specifies whether the widget can be focused using keyboard navigation.

Type:

Boolean

Default Value: false, true (desktop)

grouped

Specifies whether data items should be grouped.

Type:

Boolean

Default Value: false

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

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

View Demo

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

NOTE
Only one-level grouping is supported.
See Also

groupTemplate

Specifies a custom template for group captions.

Type:

template

Function parameters:
groupData:

Object

The current group's data.

groupIndex:

Number

The current group's index.

groupElement:

Element (jQuery or HTML)

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

Return Value:

String

|

DOM Node

|

jQuery

A template name or container.

Default Value: 'group'

height

Specifies the widget's height.

Type:

Number

|

String

|

Function

Return Value:

Number

|

String

The widget's height.

Default Value: undefined

This option accepts a value of one of the following types:

  • Number
    The height in pixels.

  • String
    A CSS-accepted measurement of height. For example, "55px", "80%", "inherit".

  • Function
    A function returning either of the above. For example:

    JavaScript
    height: function() {
        return window.innerHeight / 1.5;
    }

hint

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

Type:

String

Default Value: undefined

hoverStateEnabled

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

Type:

Boolean

Default Value: true

indicateLoading

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

Type:

Boolean

Default Value: true
NOTE
This option 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 option value.

itemDeleteMode

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

Type:

String

Default Value: 'static', 'slideItem' (iOS), 'swipe' (Android)
Accepted Values: 'context' | 'slideButton' | 'slideItem' | 'static' | 'swipe' | 'toggle'
NOTE
If List items are supplied with the context menu, this option is ignored in favor of the menuMode option.

Use the ListItemDeleteMode enum to specify this option when the widget is used as an ASP.NET MVC 5 Control or a DevExtreme-Based ASP.NET Core Control. This enum accepts the following values: Static, Toggle, SlideButton, SlideItem, Swipe, and Context.

View Demo

See Also

itemDragging

Configures item reordering using drag and drop gestures.

See the Sortable configuration for options 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 widget.

Raised Events: optionChanged

If you need to update the widget 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 option. 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 option if you use dataSource, and vice versa.

Particular fields in objects can control the widget's appearance. See Default Templates for more information.

itemTemplate

Specifies a custom template for items.

Type:

template

Function parameters:
itemData:

Object

The item object to be rendered.

itemIndex:

Number

The index of the item to be rendered.

itemElement:

Element (jQuery or HTML)

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

Return Value:

String

|

DOM Node

|

jQuery

A template name or container.

Default Value: 'item'

keyExpr

Specifies which data field provides keys for widget items.

Type:

String

|

Function

Default Value: null
NOTE
The key value should be unique within the data array.
See Also

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:

String

Default Value: 'context', 'slide' (iOS)
Accepted Values: 'context' | 'slide'

Use the ListMenuMode enum to specify this option when the widget is used as an ASP.NET MVC 5 Control or a DevExtreme-Based ASP.NET Core Control. This enum accepts the following values: Context and Slide.

See Also

nextButtonText

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

Type:

String

Default Value: 'More'

noDataText

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

Type:

String

Default Value: 'No data to display'

onContentReady

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

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

List

The widget's instance.

element

Element (jQuery or HTML)

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

model

Object

Model data. Available only when using Knockout.

Default Value: null

onDisposing

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

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

List

The widget's instance.

element

Element (jQuery or HTML)

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

model

Object

Model data. Available only if you use Knockout.

Default Value: null

onGroupRendered

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

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

List

The widget's instance.

element

Element (jQuery or HTML)

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

groupData

Object

The current group's data.

groupElement

Element (jQuery or HTML)

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

groupIndex

Number

The group's index.

model

Object

Model data. Available only if Knockout is used.

Default Value: null
See Also

onInitialized

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

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

List

The widget's instance.

element

Element (jQuery or HTML)

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

Default Value: null
See Also

onItemClick

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

Type:

Function

|

String

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

List

The widget's instance.

element

Element (jQuery or HTML)

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

event

Event (jQuery or dxEvent)

The event that caused the function to execute. It is a dxEvent or a jQuery.Event when you use jQuery.

itemData

Object

The clicked item's data object.

itemElement

Element (jQuery or HTML)

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

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

jQueryEvent

jQuery.Event

Use 'event' instead.

The jQuery event that caused the function's execution. Deprecated in favor of the event field.

model

Object

Model data. Available only if Knockout is used.

Default Value: null

onItemContextMenu

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

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

List

The widget's instance.

element

Element (jQuery or HTML)

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

event

Event (jQuery or dxEvent)

The event that caused the function to execute. It is a dxEvent or a jQuery.Event when you use jQuery.

itemData

Object

The target item's data object.

itemElement

Element (jQuery or HTML)

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

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

jQueryEvent

jQuery.Event

Use 'event' instead.

The jQuery event that caused the function's execution. Deprecated in favor of the event field.

model

Object

Model data. Available only if Knockout is used.

Default Value: null

onItemDeleted

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

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

List

The widget's instance.

element

Element (jQuery or HTML)

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

itemData

Object

The removed item's data.

itemElement

Element (jQuery or HTML)

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

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

model

Object

Model data. Available only if Knockout is used.

Default Value: null

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

See Also

onItemDeleting

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

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
cancel

Boolean

|

Promise<void> (jQuery or native)

Allows you to cancel the item deletion.

component

List

The widget's instance.

element

Element (jQuery or HTML)

The widget'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.

itemElement

Element (jQuery or HTML)

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 group and item indexes: { group: 0, item: 0 }.

model

Object

Model data. Available only if you use Knockout.

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.

JavaScript
var widgetOptions = {
    onItemDeleting: function(e) {
        var 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 widget's UI or API.

onItemHold

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

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

List

The widget's instance.

element

Element (jQuery or HTML)

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

event

Event (jQuery or dxEvent)

The event that caused the function to execute. It is a dxEvent or a jQuery.Event when you use jQuery.

itemData

Object

The data object of the item being held.

itemElement

Element (jQuery or HTML)

The container of the item being held. It is an HTML Element or a jQuery Element when you use jQuery.

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

model

Object

Model data. Available only if Knockout is used.

jQueryEvent

jQuery.Event

Use 'event' instead.

The jQuery event that caused the function's execution. Deprecated in favor of the event field.

Default Value: null

onItemRendered

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

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

List

The widget's instance.

element

Element (jQuery or HTML)

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

itemData

Object

The current item's data.

itemElement

Element (jQuery or HTML)

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

itemIndex

Number

The current item's index.

model

Object

Model data. Available only if you use Knockout.

Default Value: null

onItemReordered

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

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

List

The widget's instance.

element

Element (jQuery or HTML)

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

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

itemData

Object

The reordered item's data.

itemElement

Element (jQuery or HTML)

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

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

model

Object

Model data. Available only if Knockout is used.

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

Default Value: null

onItemSwipe

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

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

List

The widget's instance.

direction

String

The direction in which the item is swiped.

element

Element (jQuery or HTML)

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

event

Event (jQuery or dxEvent)

The event that caused the function to execute. It is a dxEvent or a jQuery.Event when you use jQuery.

itemData

Object

The swiped item's data.

itemElement

Element (jQuery or HTML)

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

jQueryEvent

jQuery.Event

Use 'event' instead.

The jQuery event that caused the handler execution. Deprecated in favor of the event field.

model

Object

Model data. Available only if Knockout is used.

Default Value: null

onOptionChanged

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

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

List

The widget's instance.

fullName

String

The path to the modified option that includes all parent options.

name

String

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

value any

The modified option's new value.

element

Element (jQuery or HTML)

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

model

Object

Model data. Available only if you use Knockout.

Default Value: null

onPageLoading

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

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

List

The widget's instance.

element

Element (jQuery or HTML)

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

model

Object

Model data. Available only if Knockout is used.

Default Value: null
See Also

onPullRefresh

A function that is executed when the "pull to refresh" gesture is performed. Supported in mobile themes only.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

List

The widget's instance.

element

Element (jQuery or HTML)

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

model

Object

Model data. Available only if Knockout is used.

Default Value: null

onScroll

A function that is executed on each scroll gesture.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

List

The widget's instance.

element

Element (jQuery or HTML)

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

event

Event (jQuery or dxEvent)

The event that caused the function to execute. It is a dxEvent or a jQuery.Event when you use jQuery.

jQueryEvent

jQuery.Event

Use 'event' instead.

The jQuery event that caused the handler execution. Deprecated in favor of the event field.

model

Object

Model data. Available only if Knockout is used.

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:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

List

The widget's instance.

element

Element (jQuery or HTML)

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

model

Object

Model data. Available only if Knockout is used.

value

Boolean

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

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
addedItems

Array<any>

The data of the items that have been selected.

component

List

The widget's instance.

element

Element (jQuery or HTML)

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

model

Object

Model data. Available only if you use Knockout.

removedItems

Array<any>

The data of the items whose selection has been canceled.

Default Value: null

pageLoadingText

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

Type:

String

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

pageLoadMode

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

Type:

String

Default Value: 'scrollBottom', 'nextButton' (desktop)
Accepted Values: 'nextButton' | 'scrollBottom'

Use the ListPageLoadMode enum to specify this option when the widget is used as an ASP.NET MVC 5 Control or a DevExtreme-Based ASP.NET Core Control. This enum accepts the following values: ScrollBottom and NextButton.

See Also

pulledDownText

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

Type:

String

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

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...', '' (Material)

pullRefreshEnabled

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

Type:

Boolean

Default Value: false

If the option 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 in mobile themes.
See Also

refreshingText

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

Type:

String

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

repaintChangesOnly

Specifies whether to repaint only those elements whose data changed.

Type:

Boolean

Default Value: false
See Also

rtlEnabled

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

Type:

Boolean

Default Value: false

When this option is set to true, the widget 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
});
See Also

scrollByContent

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

Type:

Boolean

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

scrollByThumb

A Boolean value specifying if the list is scrolled using the scrollbar.

Type:

Boolean

Default Value: false, true (desktop)

scrollingEnabled

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

Type:

Boolean

Default Value: true

searchEditorOptions

Configures the search panel.

Default Value: {}

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

NOTE
The fields of a configuration object passed to this option do not support two-way binding in Angular, AngularJS, and Knockout and event bindings in Angular.

searchEnabled

Specifies whether the search panel is visible.

Type:

Boolean

Default Value: false
NOTE
Searching works only if data is specified using the dataSource option and has a plain structure. Subsequently, data can be transformed to hierarchical structure using the DataSource's group option.

View Demo

See Also

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

searchExpr: ["firstName", "lastName"]

searchMode

Specifies a comparison operation used to search widget items.

Type:

String

Default Value: 'contains'
Accepted Values: 'contains' | 'startswith' | 'equals'

Use the CollectionSearchMode enum to specify this option when the widget is used as an ASP.NET MVC 5 Control or a DevExtreme-Based ASP.NET Core Control. This enum accepts the following values: Contains, StartsWith, and Equals.

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:

String

Default Value: ''

selectAllMode

Specifies the mode in which all items are selected.

Type:

String

Default Value: 'page'
Accepted Values: 'allPages' | '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.

View Demo

See Also

selectedItemKeys

Specifies an array of currently selected item keys.

Type:

Array<any>

Raised Events: selectionChanged

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

See Also

selectedItems

An array of currently selected item objects.

Type:

Array<any>

Raised Events: selectionChanged

selectionMode

Specifies item selection mode.

Type:

String

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

This option 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 option is enabled. Otherwise, the "all" mode works as "multiple".

Use the ListSelectionMode enum to specify this option when the widget is used as an ASP.NET MVC 5 Control or a DevExtreme-Based ASP.NET Core Control. This enum accepts the following values: Single, Multiple, All, and None.

View Demo

See Also

showScrollbar

Specifies when the widget shows the scrollbar.

Type:

String

Default Value: 'onScroll', 'onHover' (desktop)
Accepted Values: 'always' | 'never' | 'onHover' | 'onScroll'

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

Use the ShowScrollbarMode enum to specify this option when the widget is used as an ASP.NET MVC 5 Control or a DevExtreme-Based ASP.NET Core Control. This enum accepts the following values: OnScroll, OnHover, Always, and Never.

See Also

showSelectionControls

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

Type:

Boolean

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 option will be passed to the tabindex attribute of the HTML element that underlies the widget.

useNativeScrolling

Specifies whether or not the widget uses native scrolling.

Type:

Boolean

Default Value: true, false (desktop), true (Mac)

visible

Specifies whether the widget is visible.

Type:

Boolean

Default Value: true

width

Specifies the widget's width.

Type:

Number

|

String

|

Function

Return Value:

Number

|

String

The widget's width.

Default Value: undefined

This option accepts a value of one of the following types:

  • Number
    The width in pixels.

  • String
    A CSS-accepted measurement of width. For example, "55px", "80%", "auto", "inherit".

  • Function
    A function returning either of the above. For example:

    JavaScript
    width: function() {
        return window.innerWidth / 1.5;
    }