An object defining configuration properties for the List UI component.
Specifies the shortcut key that sets focus on the UI component.
Selector: access-key
Default Value: undefined
The value of this property will be passed to the accesskey
attribute of the HTML element that underlies the UI component.
Specifies whether the UI component changes its visual state as a result of user interaction.
Selector: active-state-enabled
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.
Specifies whether or not an end user can delete list items.
Selector: allow-item-deleting
Default Value: false
A Boolean value specifying whether to enable or disable the bounce-back effect.
Selector: bounce-enabled
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.
See AlsoSpecifies whether or not an end user can collapse groups.
Selector: collapsible-groups
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.
See AlsoBinds the UI component to data.
Selector: data-source
Default Value: null
The List works with collections of string
values or objects.
Depending on your data source, bind 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$(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
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
<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
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.
Review the following notes about data binding:
Do not specify the items property if you specified the dataSource, and vice versa.
Field names cannot be equal to this
and should not contain the following characters: .
, :
, [
, and ]
.
List does not execute dataSource.sort functions. To implement custom sorting logic, implement columns[].calculateSortValue.
Specifies whether the UI component responds to user interaction.
Specifies the data field whose values should be displayed. Defaults to "text" when the data source contains objects.
Selector: display-expr
Function parameters:The current item's data object.
Default Value: undefined
Set this property to the name of a data field that provides displayed values...
... 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.
Specifies the global attributes to be attached to the UI component's container element.
Selector: DxElementAttr
Default Value: {}
jQuery$(function(){ $("#listContainer").dxList({ // ... elementAttr: { id: "elementId", class: "class-name" } }); });Angular
<dx-list ... [elementAttr]="{ id: 'elementId', class: 'class-name' }"> </dx-list>
import { DxListModule } from "devextreme-angular"; // ... export class AppComponent { // ... } @NgModule({ imports: [ // ... DxListModule ], // ... })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
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;
Specifies whether the UI component can be focused using keyboard navigation.
Selector: focus-state-enabled
Default Value: true (desktop)
Specifies whether data items should be grouped.
When this property is true, make sure that all data source objects have the following structure:
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.
Only one-level grouping is supported.
See AlsoSpecifies a custom template for group captions.
Selector: group-template
Template Data:The current group's data.
Default Name: 'group'
Specifies the UI component's height.
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"
.
Specifies text for a hint that appears when a user pauses on the UI component.
Specifies whether the UI component changes its state when a user pauses on it.
Selector: hover-state-enabled
Default Value: true
Specifies whether or not to show the loading panel when the DataSource bound to the UI component is loading data.
Selector: indicate-loading
Default Value: true
This property affects only the load panel displayed when the bound
DataSourceis 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.
Specifies the way a user can delete items from the list.
Selector: item-delete-mode
Default Value: 'static', 'slideItem' (iOS), 'swipe' (Android)
Configures item reordering using drag and drop gestures.
The time period in milliseconds before the onItemHold event is raised.
Selector: item-hold-timeout
Default Value: 750
An array of items displayed by the UI component.
The items array can contain:
If you need to update the UI component items, reassign the entire items array as shown in the following example:
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.
Do not use the items property if you use dataSource, and vice versa.
Specifies a custom template for items.
Selector: item-template
Template Data:The item object to be rendered.
Default Name: 'item'
Specifies the key property that provides key values to access data items. Each key value must be unique.
Selector: key-expr
Default Value: null
Specifies the array of items for a context menu called for a list item.
Selector: DxMenuItem
Default Value: []
Specifies whether an item context menu is shown when a user holds or swipes an item.
Selector: menu-mode
Default Value: 'context', 'slide' (iOS)
The text displayed on the button used to load the next page from the data source.
Selector: next-button-text
Default Value: 'More'
Specifies the text or HTML markup displayed by the UI component if the item collection is empty.
Selector: no-data-text
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.
A function that is executed when the UI component is rendered and each time the component is repainted.
Selector: @content-ready
Function parameters:Information about the event.
Object structure:
Default Value: null
A function that is executed before the UI component is disposed of.
Selector: @disposing
Function parameters:Information about the event.
Object structure:
Default Value: null
A function that is executed when a group element is rendered.
Selector: @group-rendered
Function parameters:Information about the event.
Object structure:
Default Value: null
A function used in JavaScript frameworks to save the UI component instance.
Selector: @initialized
Function parameters:Information about the event.
Object structure:
Default Value: null
Angular<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 (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
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> ); } }See Also jQuery
A function that is executed when a collection item is clicked or tapped.
Selector: @item-click
Function parameters:Information about the event.
Object structure:
Default Value: null
A function that is executed when a collection item is right-clicked or pressed.
Selector: @item-context-menu
Function parameters:Information about the event.
Object structure:
Default Value: null
A function that is executed after a list item is deleted from the data source.
Selector: @item-deleted
Function parameters:Information about the event.
Object structure:
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.
See AlsoA function that is executed before a collection item is deleted from the data source.
Selector: @item-deleting
Function parameters:Information about the event.
Object structure:
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.
jQueryconst 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.
A function that is executed when a collection item has been held for a specified period.
Selector: @item-hold
Function parameters:Information about the event.
Object structure:
Default Value: null
A function that is executed after a collection item is rendered.
Selector: @item-rendered
Function parameters:Information about the event.
Object structure:
Default Value: null
A function that is executed after a list item is moved to another position.
Selector: @item-reordered
Function parameters:Information about the event.
Object structure:
Name Type Description toIndexThe item's current index. In a grouped list, the index represents an object defining the group and item indexes: { group: 0, item: 0 }.
itemIndex |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 }.
The item's container. It is an HTML Element or a jQuery Element when you use jQuery.
itemDataThe reordered item's data.
fromIndexThe item's previous index. In a grouped list, the index represents an object defining the group and item indexes: { group: 0, item: 0 }.
elementThe UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.
componentThe UI component's instance.
Default Value: null
A function that is executed when a list item is swiped.
Selector: @item-swipe
Function parameters:Information about the event.
Object structure:
Default Value: null
A function that is executed after a UI component property is changed.
Selector: @option-changed
Function parameters:Information about the event.
Object structure:
Name Type Description value anyThe modified property's new value.
previousValue anyThe UI component's previous value.
nameThe modified property if it belongs to the first level. Otherwise, the first-level property it is nested into.
fullNameThe path to the modified property that includes all parent properties.
elementThe UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.
componentThe UI component's instance.
Default Value: null
The following example shows how to subscribe to component property changes:
jQuery$(function() { $("#listContainer").dxList({ // ... onOptionChanged: function(e) { if(e.name === "changedProperty") { // handle the property change here } } }); });Angular
<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
<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
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} /> ); }
A function that is executed before the next page is loaded.
Selector: @page-loading
Function parameters:Information about the event.
Object structure:
Default Value: null
A function that is executed when the "pull to refresh" gesture is performed. Supported on mobile devices only.
Selector: @pull-refresh
Function parameters:Information about the event.
Object structure:
Default Value: null
A function that is executed on each scroll gesture.
Selector: @scroll
Function parameters:Information about the event.
Object structure:
Name Type Description componentThe UI component's instance.
elementThe UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.
eventEvent (jQuery or EventObject)
The event that caused the function to execute. It is an EventObject or a jQuery.Event when you use jQuery.
reachedBottomIndicates whether the container's bottom boundary is reached.
reachedLeftIndicates whether the container's left boundary is reached.
reachedRightIndicates whether the container's right boundary is reached.
reachedTopIndicates whether the container's top boundary is reached.
scrollOffsetThe current scroll offset in the following format { top: topOffset, left: leftOffset }.
Default Value: null
A function that is executed when the "Select All" check box value is changed. Applies only if the selectionMode is "all".
Selector: @select-all-value-changed
Function parameters:Information about the event.
Object structure:
Default Value: null
A function that is called after selection changes.
Selector: @selection-changed
Function parameters:Information about the event.
Object structure:
Name Type Description removedItemsArray<any>
The data of the items removed from selection.
elementThe UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.
componentThe UI component's instance.
addedItemsArray<any>
The data of the selected items.
Default Value: null
A function that is called before selection changes.
Selector: @selection-changing
Function parameters:Information about the event.
Object structure:
Default Value: null
Specifies the text shown in the pullDown panel, which is displayed when the list is scrolled to the bottom.
Selector: page-loading-text
Default Value: 'Loading...', '' (Fluent, Material)
Specifies whether the next page is loaded when a user scrolls the UI component to the bottom or when the "next" button is clicked.
Selector: page-load-mode
Default Value: 'scrollBottom', 'nextButton' (desktop except Mac)
Specifies the text displayed in the pullDown panel when the list is pulled below the refresh threshold.
Selector: pulled-down-text
Default Value: 'Release to refresh...', '' (Fluent, Material)
Specifies the text shown in the pullDown panel while the list is being pulled down to the refresh threshold.
Selector: pulling-down-text
Default Value: 'Pull down to refresh...', '' (Fluent, Material)
A Boolean value specifying whether or not the UI component supports the "pull down to refresh" gesture.
Selector: pull-refresh-enabled
Default Value: false
If the property is set to true, list data is refreshed each time you pull down and release list contents.
The "pull down to refresh" gesture is not supported by desktop browsers. You can use it only on mobile devices.
See AlsoSpecifies the text displayed in the pullDown panel while the list is being refreshed.
Selector: refreshing-text
Default Value: 'Refreshing...', '' (Fluent, Material)
Specifies whether to repaint only those elements whose data changed.
Selector: repaint-changes-only
Default Value: false
Switches the UI component to a right-to-left representation.
Selector: rtl-enabled
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.
DevExpress.config({ rtlEnabled: true });
DataGrid Demo Navigation UI Demo Editors Demo
A Boolean value specifying if the list is scrolled by content.
Selector: scroll-by-content
Default Value: true, false (non-touch devices)
Specifies whether a user can scroll the content with the scrollbar. Applies only if useNativeScrolling is false.
Selector: scroll-by-thumb
Default Value: false, true (desktop)
A Boolean value specifying whether to enable or disable list scrolling.
Selector: scrolling-enabled
Default Value: true
Configures the search panel.
Selector: search-editor-options
Default Value: {}
The component implements a DevExtreme TextBox component to display a search panel. Define TextBox Configuration properties in searchEditorOptions to customize the search panel:
jQuery$('#list').dxList({ searchEditorOptions: { label: "Email", labelMode: "floating", showClearButton: true, } })Angular
<dx-list ... [searchEnabled]="true" [searchEditorOptions]="textboxOptions" ></dx-list>
import { DxListModule } from "devextreme-angular/ui/list" import { DxTextBoxTypes } from 'devextreme-angular/ui/text-box'; // ... export class AppComponent { textboxOptions: DxTextBoxTypes.Properties = { label: "Email", labelMode: "floating", showClearButton: true, } }Vue
<script setup lang="ts"> import { DxList } from 'devextreme-vue/list'; import { type DxTextBoxTypes } from 'devextreme-vue/text-box'; const textboxOptions: DxTextBoxTypes.Properties = { label: "Email", labelMode: "floating", showClearButton: true, } </script> <template> <DxList :search-enabled="true" :search-editor-options="textboxOptions" /> </template>React
import { List } from 'devextreme-react/list'; import { type TextBoxTypes } from 'devextreme-react/text-box'; function App() { const textboxOptions: TextBoxTypes.Properties = { label: "Email", labelMode: "floating", showClearButton: true, } return ( <> <List searchEnabled={true} searchEditorOptions={textboxOptions} /> </> ) }Angular
The nested component that configures the searchEditorOptions property does not support event bindings and two-way property bindings.
VueThe nested component that configures the searchEditorOptions property does not support event bindings and two-way property bindings.
Specifies whether the search panel is visible.
Selector: search-enabled
Default Value: false
Searching works only if data is specified using the
dataSourceproperty and has a plain structure. Subsequently, data can be transformed to hierarchical structure using the
DataSource's
groupproperty.
See AlsoSpecifies a data object's field name or an expression whose value is compared to the search string.
Selector: search-expr
Default Value: null
If you need to search several fields, assign an array of field names to this property.
searchExpr: ["firstName", "lastName"]
Specifies a comparison operation used to search UI component items.
Selector: search-mode
Default Value: 'contains'
Specifies a delay in milliseconds between when a user finishes typing, and the search is executed.
Selector: search-timeout
Default Value: undefined
Specifies the current search string.
Selector: search-value
Default Value: ''
Specifies the mode in which all items are selected.
Selector: select-all-mode
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.
Specifies the text displayed at the "Select All" check box.
Selector: select-all-text
Default Value: 'Select All'
Specifies whether an item is selected if a user clicks it.
Selector: select-by-click
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.
Specifies an array of currently selected item keys.
Selector: selected-item-keys
An array of currently selected item objects.
Specifies item selection mode.
Selector: selection-mode
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.
The check box that selects/unselects all items is displayed only if the
showSelectionControlsproperty is enabled. Otherwise, the "all" mode works as "multiple".
Specifies when the UI component shows the scrollbar.
Selector: show-scrollbar
Default Value: 'onScroll', 'onHover' (desktop)
Specifies whether or not to display controls used to select list items. Not available if selectionMode is set to 'none'.
Selector: show-selection-controls
Default Value: false
Specifies the number of the element when the Tab key is used for navigating.
Selector: tab-index
Default Value: 0
The value of this property will be passed to the tabindex
attribute of the HTML element that underlies the UI component.
Specifies whether or not the UI component uses native scrolling.
Selector: use-native-scrolling
Default Value: true, false (desktop except Mac)
Specifies whether the UI component is visible.
Specifies the UI component's width.
This property accepts a value of one of the following types:
Number
The width in pixels.
String
A CSS-accepted measurement of width. For example, "55px"
, "20vw"
, "80%"
, "auto"
, "inherit"
.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4