@syncfusion/ej2-lists

What is @syncfusion/ej2-lists?

@syncfusion/ej2-lists is a comprehensive package for creating and managing various types of lists in web applications. It provides a range of features for building interactive and customizable list views, including support for nested lists, checklists, and virtual scrolling.

What are @syncfusion/ej2-lists's main functionalities?

Basic ListView

This code demonstrates how to create a basic ListView with a header and a few items.

const listView = new ej.lists.ListView({
  dataSource: ['Item 1', 'Item 2', 'Item 3'],
  headerTitle: 'Basic List',
  showHeader: true
});
listView.appendTo('#listView');

Nested ListView

This code demonstrates how to create a nested ListView, where each item can have its own sub-items.

const nestedList = [
  { text: 'Item 1', id: '1', child: [{ text: 'Sub Item 1.1', id: '1.1' }, { text: 'Sub Item 1.2', id: '1.2' }] },
  { text: 'Item 2', id: '2', child: [{ text: 'Sub Item 2.1', id: '2.1' }, { text: 'Sub Item 2.2', id: '2.2' }] }
];
const listView = new ej.lists.ListView({
  dataSource: nestedList,
  fields: { id: 'id', text: 'text', child: 'child' },
  headerTitle: 'Nested List',
  showHeader: true
});
listView.appendTo('#nestedListView');

Checklist

This code demonstrates how to create a checklist where each item has a checkbox.

const checklist = new ej.lists.ListView({
  dataSource: ['Option 1', 'Option 2', 'Option 3'],
  showCheckBox: true,
  headerTitle: 'Checklist',
  showHeader: true
});
checklist.appendTo('#checklist');

Virtual Scrolling

This code demonstrates how to create a ListView with virtual scrolling enabled, which is useful for handling large datasets efficiently.

const largeData = Array.from({ length: 1000 }, (_, i) => `Item ${i + 1}`);
const listView = new ej.lists.ListView({
  dataSource: largeData,
  enableVirtualization: true,
  height: '400px',
  headerTitle: 'Virtual Scrolling',
  showHeader: true
});
listView.appendTo('#virtualListView');

Other packages similar to @syncfusion/ej2-lists

react-list

react-list is a versatile library for rendering lists in React applications. It supports features like infinite scrolling and variable item heights. Compared to @syncfusion/ej2-lists, react-list is more focused on performance and flexibility in React environments.

react-virtualized

react-virtualized is a collection of React components for efficiently rendering large lists and tabular data. It offers features like virtual scrolling, fixed headers, and dynamic row heights. While @syncfusion/ej2-lists provides a more comprehensive set of UI components, react-virtualized excels in performance optimization for large datasets.

antd

Ant Design (antd) is a popular React UI library that includes a List component among its many offerings. The List component in antd supports features like pagination, infinite scrolling, and customizable item rendering. Compared to @syncfusion/ej2-lists, antd provides a broader range of UI components and is widely used in enterprise applications.

README

Overview

Displays a list of items from an unordered list or custom data as customized flat or grouped lists. It comes with full documentation and support and is available under commercial and community licenses – please visit www.syncfusion.com to get started.

Resources

Demos

Changelog

Check the changelog here