List

The List is a widget that represents a collection of items in a scrollable list.

Included in: dx.mobile.js, dx.web.js, dx.viz-web.js, dx.all.js
Module: ui/list
List interactive configuration
Copy Code
Copy to Codepen
$("#list").dxList({
});
Type:

Object

You can create the widget using one of the following approaches.

  • jQuery
    Use the dxList jQuery plug-in.

    HTML
    <div id="list"></div>
    JavaScript
    $("#list").dxList({
        dataSource: listData,
        grouped: true,
        showDeleteControls: true,
        showReorderControls: true,
        showSelectionControls: true
    });
  • Knockout
    Add a div element and apply the dxList binding to this element.

    HTML
    <div data-bind="dxList: {
        dataSource: listData,
        grouped: true,
        showDeleteControls: true,
        showReorderControls: true,
        showSelectionControls: true
    }"></div>
  • AngularJS
    Add a div element and apply the dx-list directive to this element.

    HTML
    <div dx-list="{
        dataSource: listData,
        grouped: true,
        showDeleteControls: true,
        showReorderControls: true,
        showSelectionControls: true
    }"></div>

Note that DevExtreme widgets require you to link the jQuery library to your application. If you use the Knockout or AngularJS approach, the Knockout or AngularJS library is also required. For detailed information on linking these libraries to your project, refer to the Installation article.

The List widget supports common Collection Container functionality. You can find detailed information on the principles of working with collection container widgets in the Collection Container Widgets guide. For detailed information on working with the List widget, refer to the dxList guide.

View Demo

Show Example:
AngularJS
Knockout
jQuery

Configuration

An object defining configuration options for the List widget.

Methods

This section describes members used to manipulate the widget.

Events

This section describes events fired by this widget.

Default Item Template

This section lists the data source fields that are used in a default template for list items.

By default, a predefined item template is applied to display the items of this widget. This template is based on certain fields of the data source provided for this widget. Below is a list of these fields. If the default item template is not appropriate for your task, implement a custom item template based on these or other fields of your data source.

See Also