Syncfusion.AspNetMvc.Lists

Syncfusion ASP.NET MVC Lists component

The Syncfusion ASP.NET MVC ListView component displays a collection of items in various layouts and supports interaction patterns commonly used in modern applications. It includes support for hierarchical lists, selection, grouping, and virtualization.

Using this package with an AI coding agent

Before generating Syncfusion code, ask your AI coding agent to run the Syncfusion setup using the following prompt:

Set up this project for Syncfusion before generating code. Fetch and follow the official instructions at https://ai.syncfusion.com, then report the detected platform, installed skill pack, MCP status, and any required licensing action.

The setup detects your project's platform and loads the appropriate Syncfusion skill pack. No Syncfusion account or MCP key is required to install or read Syncfusion agent skills.

Platform reference: https://ai.syncfusion.com/aspnet-mvc/llms.txt

Key features

• Hierarchical list rendering: Display flat and nested (hierarchical) list rendering
• Single and multiple selection: Enable users to select single and multiple selection modes
• Checkbox selection: Support checkbox-based item selection with "Select All" support
• Grouping: Organize items into categorized groups for improved navigation and readability.
• Sorting and filtering: Sort and filter list items to improve data discoverability.
• Custom templates: Customize item, group, and header layouts with rich templates.
• Virtualization: Virtualization for high-performance rendering of large lists
• Pull-to-refresh: Pull-to-refresh for mobile scenarios
• Accessibility and keyboard navigation: Deliver accessible experiences with keyboard navigation and ARIA support.

Common setup

These setup steps are required only once for your application, regardless of which Syncfusion components you use.

1. Install NuGet package

Install-Package Syncfusion.AspNetMvc.Lists

2. Add namespace reference

Edit Web.config under the Views folder and add the Syncfusion.EJ2 namespace:

<namespaces>
    <add namespace="Syncfusion.EJ2"/>
</namespaces>

3. Add stylesheet and script references

In your layout file (~/Views/Shared/_Layout.cshtml), add the following in the <head> section:

<head>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
    <title>@ViewBag.Title - Syncfusion Application</title>
    
    <!-- Syncfusion ASP.NET MVC controls styles -->
    <link rel="stylesheet" href="https://cdn.syncfusion.com/ej2/35.1.40/fluent2.css" />
    
    <!-- Syncfusion ASP.NET MVC controls scripts -->
    <script src="https://cdn.syncfusion.com/ej2/35.1.40/dist/ej2.min.js"></script>
</head>

4. Register script manager

At the end of the <body> tag in your layout file (~/Views/Shared/_Layout.cshtml):

<body>
    @RenderBody()
    
    <!-- Syncfusion ASP.NET MVC Script Manager -->
    @Html.EJS().ScriptManager()
</body>

Quick start

Step 1: Add ASP.NET MVC ListView control

Add the Syncfusion ASP.NET MVC ListView control in the ~/Views/Home/Index.cshtml page:

@model List<object>

@Html.EJS().ListView("listview")
    .DataSource((IEnumerable<object>)Model)
    .Render()

Step 2: Create controller ~/Controllers/HomeController.cs

public IActionResult Index()
{
    //define the array of JSON
    List<object> data = new List<object>();
    data.Add(new { text = "Artwork", id = "01" });
    data.Add(new { text = "Abstract", id = "02" });
    data.Add(new { text = "Modern Painting", id = "03" });
    data.Add(new { text = "Ceramics", id = "04" });
    data.Add(new { text = "Animation Art", id = "05" });
    data.Add(new { text = "Oil Painting", id = "06" });   
    return View(data);
}

Step 3: Run the application

Press Ctrl+F5 to run the application in your browser.

Documentation

• Getting started
• API reference
• Live demos

Support

• Submit a support ticket

• Community forums

• Feature requests

License

This is a commercial product and requires a paid license for possession or use. Review the Syncfusion EULA

• Purchase a license

• Start a free 30-day trial

About Syncfusion

Syncfusion provides 1800+ components and frameworks for web, mobile, and desktop development across multiple platforms:

Web: Blazor | ASP.NET Core | ASP.NET MVC | JavaScript | Angular | React | Vue

Mobile: Flutter | MAUI | UWP

Desktop: WinForms | WPF | WinUI

Learn more at www.syncfusion.com

[email protected] | Toll Free: 1-888-9-DOTNET