List

• Oct 13, 2025
• 2 minutes to read

List is a UI control that displays data from local or remote data storage and allows users to group, select, search, reorder, and delete items.

Run Demo: List Read Tutorial

Getting Started

The List UI Control is based on the DevExtreme List component.

To add this control to your project, follow instructions in the following help topics:

• Configure a Visual Studio Project or Configure a non Visual Studio Project
• Add Controls to a Project
• Razor Syntax

Basic Syntax

ListBasics.cshtml

@(Html.DevExtreme().List()
    .Items(i => {
        i.Add().Text("Item One");
        i.Add().Text("Item Two");
        i.Add().Text("Item Three");
    })
)

ListController.cs

using Microsoft.AspNetCore.Mvc;

namespace ASP.NET_Core.Controllers {
    public class ListController : Controller {
        public IActionResult GettingStarted() {
            return View();
        }
    }
}

Built-in Capabilities and Configuration Guides

• Selection
  Users can select one or multiple items in the List component.

• Search
  Activate the search bar by setting the searchEnabled property to true.

• Reorder and Delete Items
  You can also configure reordering and deletion of List items.

• Grouping
  Display items in a two-level hierarchy with groups. Use the groupTemplate option to customize group headers.

• Customize Item Appearance
  Use the itemTemplate property to customize the appearance of List items.

API

Server-Side API

Initialization

Call the List() method to create a List control. This action initializes a ListBuilder instance. Use the instance methods to specify List options and event handlers.

Options

For a complete option list, see Options. For details on how to specify control options, refer to the following help topic: Specify Options.

Events

For available events, see Events. For details on how to handle events, refer to the following help topic: Handle Events and Define Callbacks.

Client-Side API

Options

If you need to specify the List options dynamically on the client side, use client-side API. For a complete option list, see DevExtreme List options.

Methods

For a list of available methods, see DevExtreme List methods. For details on how to call methods, refer to the following help topic: Call Methods.

Accessibility

For more information on List accessibility compliance, refer to the following help topic: Accessibility.

Demos

Run Demo: List