React List Props

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:

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:

Default Value: false

allowItemReordering

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

Type:

Default Value: false

NOTE

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

bounceEnabled

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

Type:

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.

collapsibleGroups

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

Type:

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.

dataSource

A data source used to fetch data to be displayed by the widget.

Type:

|

Array<String | template>

|

DataSource

|

DataSource Configuration

Default Value: null

This option accepts one of the following.

Array of objects
A simple JavaScript array containing a collection of plain objects.
URL
The URL of a JSON file or service that returns JSON data.
DataSource or its configuration object
A DataSource is an object that provides a handy API for data processing. A DataSource is a stateful object, which means that it saves data processing settings and applies them each time data is loaded. All underlying data access logic of a DataSource is isolated in a Store. A Store provides an API for reading and modifying data. Unlike the DataSource, a Store is a stateless object.

NOTE

Data field names should not contain the following characters: ., ,, :, [, and ]. Their presence may cause issues in the widget's operation.

If the data source is specified using the dataSource option, use the items option only for reading. Updating data items using the items option may cause unexpected results.

To display widget items, a default template can be used. This template is based on the data source fields that are listed in the Default Item Template section of the widget's API.

disabled

Specifies whether the widget responds to user interaction.

Type:

Default Value: false

elementAttr

Specifies the attributes to be attached to the widget's root 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
    ],
    // ...
})

ASP.NET MVC Control

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:

Default Value: true (desktop)

grouped

Specifies whether data items should be grouped.

Type:

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
        { ... },
        { ... }
    ]
}, {
    // ...
}];

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

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 widget's height.

Type:

|

|

Return Value:

|

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%", "auto", "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:

Default Value: undefined

hoverStateEnabled

Specifies whether the widget 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 widget is loading data.

Type:

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:

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

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 Control. This enum accepts the following values: Static, Toggle, SlideButton, SlideItem, Swipe, and Context.

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.

Type:

Array<String | Object>

Raised Events: onOptionChanged

You can use the dataSource option instead. Unlike the items option, the dataSource option can take on the DataSource configuration object as well as a simple array.

NOTE

If you need to modify the data source specified using the items option at runtime, do it only with the help of the items option. Updating data items using the dataSource option may cause unexpected results.

To display widget items, a default template can be used. This template is based on the data source fields that are listed in the Default Item Template section of the widget's API.

itemTemplate

Specifies a custom template for items.

Type:

template

Template Data:

The item object to be rendered.

Default Name: 'item'

keyExpr

Specifies which data field provides keys for widget items.

Type:

|

Default Value: null

NOTE

The key value should be unique within the data array.

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:

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 Control. This enum accepts the following values: Context and Slide.

nextButtonText

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

Type:

Default Value: 'More'

noDataText

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

Type:

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 parameters:

e:

Information about the event.

Object structure:

Name

Type

Description

component

The widget's instance.

element

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

model

The model data. Available only when using Knockout.

Default Value: null

onDisposing

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

Type:

Function parameters:

e:

Information about the event.

Object structure:

Name

Type

Description

component

The widget's instance.

element

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

model

The 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 parameters:

e:

Information about the event.

Object structure:

Name	Type	Description
component	List	The widget's instance.
element	HTMLElement \| jQuery	The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.
model	Object	The model data. Available only if Knockout is used.
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 that is executed only once, after the widget is initialized.

Type:

Function parameters:

e:

Information about the event.

Object structure:

Name

Type

Description

component

The widget's instance.

element

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

Default Value: null

You cannot access widget elements in this function because it is executed before they are ready. Use the onContentReady function instead.

onItemClick

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

Type:

|

Function parameters:

e:

Information about the event.

Object structure:

Name	Type	Description
event	Event (jQuery or EventObject)	The event that caused the function's execution. It is a dxEvent or a jQuery.Event when you use jQuery.
jQueryEvent	jQuery.Event	The jQuery event that caused the function's execution. Deprecated in favor of the event field.
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.
model	Object	The model data. Available only if Knockout is used.
element	HTMLElement \| jQuery	The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.
component	List	The widget's instance.

Default Value: null

onItemContextMenu

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

Type:

Function parameters:

e:

Information about the event.

Object structure:

Name	Type	Description
event	Event (jQuery or EventObject)	The event that caused the function's execution. It is a dxEvent or a jQuery.Event when you use jQuery.
jQueryEvent	jQuery.Event	The jQuery event that caused the function's execution. Deprecated in favor of the event field.
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.
model	Object	The model data. Available only if Knockout is used.
element	HTMLElement \| jQuery	The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.
component	List	The widget'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:

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.
model	Object	The model data. Available only if Knockout is used.
element	HTMLElement \| jQuery	The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.
component	List	The widget's instance.

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.

onItemDeleting

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

Type:

Function parameters:

e:

Information about the event.

Object structure:

Name	Type	Description
cancel	Boolean \| Promise<void> (jQuery or native)	Allows you to cancel the item deletion.
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.
model	Object	The model data. Available only if you use Knockout.
element	HTMLElement \| jQuery	The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.
component	List	The widget's instance.

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 parameters:

e:

Information about the event.

Object structure:

Name	Type	Description
jQueryEvent	jQuery.Event	The jQuery event that caused the function's execution. Deprecated in favor of the event field.
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.
model	Object	The model data. Available only if Knockout is used.
element	HTMLElement \| jQuery	The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.
component	List	The widget's instance.
event	Event (jQuery or EventObject)	The event that caused the function's execution. It is a dxEvent or a jQuery.Event when you use jQuery.

Default Value: null

onItemRendered

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

Type:

Function parameters:

e:

Information about the event.

Object structure:

Name	Type	Description
component	List	The widget's instance.
element	HTMLElement \| jQuery	The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.
model	Object	The model data. Available only if you use Knockout.
itemData	Object	The current 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	The current item's index.

Default Value: null

onItemReordered

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

Type:

Function parameters:

e:

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 }.
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 }.
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.
model	Object	The model data. Available only if Knockout is used.
element	HTMLElement \| jQuery	The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.
component	List	The widget's instance.

Default Value: null

onItemSwipe

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

Type:

Function parameters:

e:

Information about the event.

Object structure:

Name	Type	Description
component	List	The widget's instance.
element	HTMLElement \| jQuery	The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.
model	Object	The model data. Available only if Knockout is used.
jQueryEvent	jQuery.Event	Use 'event' instead. The jQuery event that caused the handler execution. Deprecated in favor of the event field.
event	Event (jQuery or EventObject)	The event that caused the handler execution. It is a dxEvent 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 }.
direction	String	The direction in which the item is swiped.

Default Value: null

onOptionChanged

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

Type:

Function parameters:

e:

Information about the event.

Object structure:

Name	Type	Description
name	String	The option's short name.
model	Object	The model data. Available only if you use Knockout.
element	HTMLElement \| jQuery	The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.
component	List	The widget's instance.
fullName	String	The option's full name.
value	any	The option's new value.

Default Value: null

onPageLoading

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

Type:

Function parameters:

e:

Information about the event.

Object structure:

Name

Type

Description

component

The widget's instance.

element

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

model

The model data. Available only if Knockout is used.

Default Value: null

onPullRefresh

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

Type:

Function parameters:

e:

Information about the event.

Object structure:

Name

Type

Description

component

The widget's instance.

element

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

model

The model data. Available only if Knockout is used.

Default Value: null

onScroll

A function that is executed on each scroll gesture.

Type:

Function parameters:

e:

Information about the event.

Object structure:

Name	Type	Description
component	List	The widget's instance.
element	HTMLElement \| jQuery	The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.
model	Object	The model data. Available only if Knockout is used.
jQueryEvent	jQuery.Event	Use 'event' instead. The jQuery event that caused the handler execution. Deprecated in favor of the event field.
event	Event (jQuery or EventObject)	The event that caused the handler execution. It is a dxEvent or a jQuery.Event when you use jQuery.
scrollOffset	Object	The current scroll offset in the following format { top: topOffset, left: leftOffset }.
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.
reachedBottom	Boolean	Indicates whether the container's bottom boundary is reached.

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 parameters:

e:

Information about the event.

Object structure:

Name	Type	Description
component	List	The widget's instance.
element	HTMLElement \| jQuery	The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.
model	Object	The 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 the selection is canceled.

Type:

Function parameters:

e:

Information about the event.

Object structure:

Name	Type	Description
component	List	The widget's instance.
element	HTMLElement \| jQuery	The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.
model	Object	The model data. Available only if you use Knockout.
addedItems	Array<any>	The data of the items that have been selected.
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:

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:

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 Control. This enum accepts the following values: ScrollBottom and NextButton.

pulledDownText

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

Type:

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:

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:

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.

refreshingText

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

Type:

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

rtlEnabled

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

Type:

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

scrollByContent

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

Type:

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

scrollByThumb

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

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

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.

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:

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

Default Value: ''

selectAllMode

Specifies the mode in which all items are selected.

Type:

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.

selectedItemKeys

Specifies an array of currently selected item keys.

Type:

Array<any>

Raised Events: onSelectionChanged

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

selectedItems

An array of currently selected item objects.

Type:

Array<any>

Raised Events: onSelectionChanged

selectionMode

Specifies item selection mode.

Type:

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 Control. This enum accepts the following values: Single, Multiple, All, and None.

showScrollbar

Specifies when the widget shows the scrollbar.

Type:

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 Control. This enum accepts the following values: OnScroll, OnHover, Always, and Never.

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

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

visible

Specifies whether the widget is visible.

Type: