Vue List Props
See Also
accessKey
The value of this property will be passed to the accesskey
attribute of the HTML element that underlies the UI component.
activeStateEnabled
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.
bounceEnabled
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 Also
collapsibleGroups
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 Also
dataSource
The List works with collections of string
values or objects.
Depending on your data source, bind the List to data as follows. If the data source provides objects, also specify the itemTemplate. You can skip this part if the objects contain fields described in the items section.
Data Array
Assign the array to the dataSource option. View DemoRead-Only Data in JSON Format
Set the dataSource property to the URL of a JSON file or service that returns JSON data.OData
Implement an ODataStore.Web API, PHP, MongoDB
Use one of the following extensions to enable the server to process data according to the protocol DevExtreme UI components use:Then, use the createStore method to configure access to the server on the client as shown below. This method is part of DevExtreme.AspNet.Data.
jQuery
JavaScript$(function() { let serviceUrl = "https://url/to/my/service"; $("#listContainer").dxList({ // ... dataSource: DevExpress.data.AspNet.createStore({ key: "ID", loadUrl: serviceUrl + "/GetAction", insertUrl: serviceUrl + "/InsertAction", updateUrl: serviceUrl + "/UpdateAction", deleteUrl: serviceUrl + "/DeleteAction" }) }) });
Angular
app.component.tsapp.component.htmlapp.module.tsimport { Component } from '@angular/core'; import CustomStore from 'devextreme/data/custom_store'; import { createStore } from 'devextreme-aspnet-data-nojquery'; @Component({ selector: 'app-root', templateUrl: './app.component.html', styleUrls: ['./app.component.css'] }) export class AppComponent { store: CustomStore; constructor() { let serviceUrl = "https://url/to/my/service"; this.store = createStore({ key: "ID", loadUrl: serviceUrl + "/GetAction", insertUrl: serviceUrl + "/InsertAction", updateUrl: serviceUrl + "/UpdateAction", deleteUrl: serviceUrl + "/DeleteAction" }) } }
<dx-list ... [dataSource]="store"> </dx-list>
import { BrowserModule } from '@angular/platform-browser'; import { NgModule } from '@angular/core'; import { AppComponent } from './app.component'; import { DxListModule } from 'devextreme-angular'; @NgModule({ declarations: [ AppComponent ], imports: [ BrowserModule, DxListModule ], providers: [], bootstrap: [AppComponent] }) export class AppModule { }
Vue
App.vue<template> <DxList ... :data-source="store" /> </template> <script> import 'devextreme/dist/css/dx.light.css'; import CustomStore from 'devextreme/data/custom_store'; import { createStore } from 'devextreme-aspnet-data-nojquery'; import { DxList } from 'devextreme-vue/list'; export default { components: { DxList }, data() { const serviceUrl = "https://url/to/my/service"; const store = createStore({ key: "ID", loadUrl: serviceUrl + "/GetAction", insertUrl: serviceUrl + "/InsertAction", updateUrl: serviceUrl + "/UpdateAction", deleteUrl: serviceUrl + "/DeleteAction" }); return { store } } } </script>
React
App.jsimport 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.
Data field names cannot be equal to
this
and should not contain the following characters:.
,:
,[
, and]
.
jQuery
- The stores are immutable. You cannot change their configurations at runtime. Instead, create a new store or DataSource and assign it to the dataSource property as shown in the following help topic: Get and Set Properties.
Angular
- The stores are immutable. You cannot change their configurations at runtime. Instead, create a new store or DataSource and assign it to the dataSource property as shown in the following help topic: Two-Way Property Binding.
Vue
- The stores are immutable. You cannot change their configurations at runtime. Instead, create a new store or DataSource and assign it to the dataSource property as shown in the following help topic: Two-Way Property Binding.
React
- The stores are immutable. You cannot change their configurations at runtime. Instead, create a new store or DataSource and assign it to the dataSource property as shown in the following help topic: Controlled Mode.
displayExpr
Specifies the data field whose values should be displayed. Defaults to "text" when the data source contains objects.
Set this property to the name of a data field that provides displayed values...
displayExpr: "name"
... or to a function that returns the displayed value:
displayExpr: function(item) { // "item" can be null return item && 'ID: ' + item.id + ', Name: ' + item.name; }
Leave this property unspecified or set it to this
if the data source contains primitives.
elementAttr
Specifies the global attributes to be attached to the UI component's container element.
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;
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.
See Also
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"
.Function (deprecated since v21.2)
Refer to the W0017 warning description for information on how you can migrate to viewport units.
indicateLoading
Specifies whether or not to show the loading panel when the DataSource bound to the UI component is loading data.
itemDeleteMode
See Also
items[]
The items array can contain:
- Strings
- Objects with fields described in this section
- Objects with any other fields. In this case, specify the itemTemplate.
If you need to update the UI component items, reassign the entire items array as shown in the following example:
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.
keyExpr
Specifies the key property that provides key values to access data items. Each key value must be unique.
noDataText
The List component evaluates the noDataText property's value. This evaluation, however, makes the List potentially vulnerable to XSS attacks. To guard against these attacks, encode the HTML markup before you assign it to the noDataText property. Refer to the following help topic for more information: Potentially Vulnerable API - noDataText.
onContentReady
A function that is executed when the UI component is rendered and each time the component is repainted.
Name | Type | Description |
---|---|---|
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
component |
The UI component's instance. |
onDisposing
A function that is executed before the UI component is disposed of.
Name | Type | Description |
---|---|---|
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
component |
The UI component's instance. |
onGroupRendered
Name | Type | Description |
---|---|---|
component |
The UI component's instance. |
|
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
groupData |
The current group's data. |
|
groupElement |
The group's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
groupIndex |
The group's index. |
onInitialized
Name | Type | Description |
---|---|---|
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
component |
The UI component's instance. |
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
<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
onItemClick
Name | Type | Description |
---|---|---|
itemIndex | | |
The clicked item's index. In a grouped list, the index represents an object defining group and item indexes: { group: 0, item: 0 }. |
itemElement |
The clicked item's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
itemData |
The clicked item's data object. |
|
event | Event (jQuery or EventObject) |
The event that caused the function to execute. It is an EventObject or a jQuery.Event when you use jQuery. |
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
component |
The UI component's instance. |
onItemContextMenu
Name | Type | Description |
---|---|---|
itemIndex | | |
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 |
The target item's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
itemData |
The target item's data object. |
|
event | Event (jQuery or EventObject) |
The event that caused the function to execute. It is an EventObject or a jQuery.Event when you use jQuery. |
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
component |
The UI component's instance. |
onItemDeleted
Name | Type | Description |
---|---|---|
itemIndex | | |
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 |
The item's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
itemData |
The removed item's data. |
|
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
component |
The UI component's instance. |
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 Also
onItemDeleting
Name | Type | Description |
---|---|---|
itemIndex | | |
The item's index. In a grouped list, the index represents an object defining group and item indexes: { group: 0, item: 0 }. |
itemElement |
The item's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
itemData |
The data of the item to be removed. |
|
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
component |
The UI component's instance. |
|
cancel |
Allows you to cancel the item deletion. |
You can cancel item deletion by setting the handler parameter's cancel field to true. This field also accepts a Promise (jQuery or native), which enables you to perform an asynchronous action before an item is deleted.
jQuery
const widgetOptions = { onItemDeleting: function(e) { const d = $.Deferred(); DevExpress.ui.dialog.confirm("Do you really want to delete the item?") .done(function(value) { d.resolve(!value); }) .fail(d.reject); e.cancel = d.promise(); } }
Note that the onItemDeleted and onItemDeleting handlers are not executed if an item is deleted from the data source without using the UI component's UI or API.
onItemHold
A function that is executed when a collection item has been held for a specified period.
Name | Type | Description |
---|---|---|
itemIndex | | |
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 |
The container of the item being held. It is an HTML Element or a jQuery Element when you use jQuery. |
|
itemData |
The data object of the item being held. |
|
event | Event (jQuery or EventObject) |
The event that caused the function to execute. It is an EventObject or a jQuery.Event when you use jQuery. |
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
component |
The UI component's instance. |
onItemRendered
Name | Type | Description |
---|---|---|
itemIndex |
The current item's index. |
|
itemElement |
The item's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
itemData |
The current item's data. |
|
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
component |
The UI component's instance. |
onItemReordered
Name | Type | Description |
---|---|---|
toIndex |
The item's current index. In a grouped list, the index represents an object defining the group and item indexes: { group: 0, item: 0 }. |
|
itemIndex | | |
The item's index after reordering. This field holds the same value as toIndex. |
itemElement |
The item's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
itemData |
The reordered item's data. |
|
fromIndex |
The item's previous index. In a grouped list, the index represents an object defining the group and item indexes: { group: 0, item: 0 }. |
|
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
component |
The UI component's instance. |
onItemSwipe
Name | Type | Description |
---|---|---|
component |
The UI component's instance. |
|
direction |
The direction in which the item is swiped. |
|
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
event | Event (jQuery or EventObject) |
The event that caused the function to execute. It is an EventObject or a jQuery.Event when you use jQuery. |
itemData |
The swiped item's data. |
|
itemElement |
The item's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
itemIndex | | |
The item's index. In a grouped list, the index represents an object defining the group and item indexes: { group: 0, item: 0 }. |
onOptionChanged
Name | Type | Description |
---|---|---|
value | any |
The modified property's new value. |
previousValue | any |
The UI component's previous value. |
name |
The modified property if it belongs to the first level. Otherwise, the first-level property it is nested into. |
|
fullName |
The path to the modified property that includes all parent properties. |
|
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
component |
The UI component's instance. |
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} /> ); }
onPageLoading
Name | Type | Description |
---|---|---|
component |
The UI component's instance. |
|
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
onPullRefresh
A function that is executed when the "pull to refresh" gesture is performed. Supported on mobile devices only.
Name | Type | Description |
---|---|---|
component |
The UI component's instance. |
|
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
onScroll
Name | Type | Description |
---|---|---|
component |
The UI component's instance. |
|
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
event | Event (jQuery or EventObject) |
The event that caused the function to execute. It is an EventObject or a jQuery.Event when you use jQuery. |
reachedBottom |
Indicates whether the container's bottom boundary is reached. |
|
reachedLeft |
Indicates whether the container's left boundary is reached. |
|
reachedRight |
Indicates whether the container's right boundary is reached. |
|
reachedTop |
Indicates whether the container's top boundary is reached. |
|
scrollOffset |
The current scroll offset in the following format { top: topOffset, left: leftOffset }. |
onSelectAllValueChanged
A function that is executed when the "Select All" check box value is changed. Applies only if the selectionMode is "all".
Name | Type | Description |
---|---|---|
component |
The UI component's instance. |
|
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
value |
The "Select All" check box's state. |
onSelectionChanged
Name | Type | Description |
---|---|---|
removedItems | Array<any> |
The data of the items whose selection has been canceled. |
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
component |
The UI component's instance. |
|
addedItems | Array<any> |
The data of the items that have been selected. |
pageLoadingText
Specifies the text shown in the pullDown panel, which is displayed when the list is scrolled to the bottom.
pageLoadMode
Specifies whether the next page is loaded when a user scrolls the UI component to the bottom or when the "next" button is clicked.
pulledDownText
Specifies the text displayed in the pullDown panel when the list is pulled below the refresh threshold.
pullingDownText
Specifies the text shown in the pullDown panel while the list is being pulled down to the refresh threshold.
pullRefreshEnabled
A Boolean value specifying whether or not the UI component supports the "pull down to refresh" gesture.
If the property is set to true, list data is refreshed each time you pull down and release list contents.
See Also
repaintChangesOnly
See Also
- push(changes) in: ArrayStore | CustomStore | LocalStore | ODataStore
- DataSource.reshapeOnPush
rtlEnabled
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 });
scrollByThumb
Specifies whether a user can scroll the content with the scrollbar. Applies only if useNativeScrolling is false.
searchEditorOptions
See the TextBox Configuration for properties you can specify in this object.
Angular
Vue
searchEnabled
See Also
searchExpr
If you need to search several fields, assign an array of field names to this property.
searchExpr: ["firstName", "lastName"]
selectAllMode
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.
See Also
selectByClick
If you enable selection and selection controls in the List component, checkboxes appear near each item. Assign true
to this property to allow users to click anywhere on an item to select it, or false
to select List items only by checking checkboxes.
selectedItemKeys
The item keys can be specified using the keyExpr property or the key property within the underlying Store.
See Also
- key in ArrayStore | CustomStore | LocalStore | ODataStore
selectionMode
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.NOTEThe check box that selects/unselects all items is displayed only if the showSelectionControls property is enabled. Otherwise, the "all" mode works as "multiple".
See Also
showScrollbar
Setting this property makes sense only when the useNativeScrolling property is set to false.
See Also
tabIndex
The value of this property will be passed to the tabindex
attribute of the HTML element that underlies the UI component.
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"
.Function (deprecated since v21.2)
Refer to the W0017 warning description for information on how you can migrate to viewport units.
If you have technical questions, please create a support ticket in the DevExpress Support Center.