ej2-react-ui-components/components/treegrid/README.md

React TreeGrid Component

The React TreeGrid component is a feature-rich component used to visualize self-referential andhierarchical data effectively in a tabular format. It pulls data from a data source, such as array of JSON objects, OData web services, or DataManager. It also incudes interactions like expanding and collapsing the parent records.

Getting Started . Online demos . Learn more

Trusted by the world's leading companies

Setup

Create a React Application

You can use create-react-app to setup the applications. To create React app use the following command.

npx create-react-app my-app --template typescript
cd my-app
npm start

Adding Syncfusion Tree Grid package

All Syncfusion react packages are published in the npmjs.com registry. To install the react tree grid package, use the following command.

npm install @syncfusion/ej2-react-treegrid --save

Adding CSS references for Tree Grid

Add CSS references needed for a Tree Grid in src/App.css from the ../node_modules/@syncfusion package folder.

@import '../node_modules/@syncfusion/ej2-base/styles/material.css';  
@import '../node_modules/@syncfusion/ej2-buttons/styles/material.css';  
@import '../node_modules/@syncfusion/ej2-calendars/styles/material.css';  
@import '../node_modules/@syncfusion/ej2-dropdowns/styles/material.css';  
@import '../node_modules/@syncfusion/ej2-inputs/styles/material.css';  
@import '../node_modules/@syncfusion/ej2-navigations/styles/material.css';
@import '../node_modules/@syncfusion/ej2-popups/styles/material.css';
@import '../node_modules/@syncfusion/ej2-splitbuttons/styles/material.css';
@import "../node_modules/@syncfusion/ej2-grids/styles/material.css";
@import "../node_modules/@syncfusion/ej2-react-treegrid/styles/material.css";

Add Tree Grid Component

In the src/App.tsx file, use the following code snippet to render the Syncfusion React Tree Grid component and import App.css to apply styles to the tree grid:

import { ColumnDirective, ColumnsDirective, TreeGridComponent } from '@syncfusion/ej2-react-treegrid';
import * as React from 'react';
import './App.css';

function App() {
    let data = [
      {
          taskID: 1,
          taskName: 'Planning',
          startDate: new Date('02/03/2017'),
          duration: 5,
          subtasks: [
              { taskID: 2, taskName: 'Plan timeline', startDate: new Date('02/03/2017'), duration: 5 },
              { taskID: 3, taskName: 'Plan budget', startDate: new Date('02/03/2017'), duration: 5 },
              { taskID: 4, taskName: 'Allocate resources', startDate: new Date('02/03/2017'), duration: 5 },
              { taskID: 5, taskName: 'Planning complete', startDate: new Date('02/07/2017'), duration: 0 }
          ]
      }];
        
    return <TreeGridComponent dataSource={data} treeColumnIndex={1} childMapping= 'subtasks'>
                <ColumnsDirective>
                    <ColumnDirective field='taskID' headerText='Task ID' width='90' textAlign='Right'/>
                    <ColumnDirective field='taskName' headerText='Task Name' width='180'/>
                    <ColumnDirective field='startDate' headerText='Start Date' width='90' format='yMd' textAlign='Right' type='date'/>
                    <ColumnDirective field='duration' headerText='Duration' width='80' textAlign='Right'/>
                </ColumnsDirective>
            </TreeGridComponent>
};
export default App;

Supported frameworks

TreeGrid component is also offered in the following list of frameworks.

JavaScript	Angular	Vue	ASP.NET Core	ASP.NET MVC

Showcase samples

• Loan Calculator - Source, Live Demo
• Fitness Tracker - Source, Live Demo

Key features

• Data sources: Bind the TreeGrid control with an array of JSON objects or DataManager. Large data can be bound to tree grid wth high performance using load-on-demand concept.
• Sorting: Supports n levels of sorting and allows the use of a comparer function for customized sorting.
• Filtering: Offers filter UIs such as filter bar and menu at each column to filter data. Also allows for filtering based on related parent or child records.
• Paging: Provides the option to easily switch between pages using the pager bar. The number of rows in a page can also be customized. The pager also helps provide support for load-on-demand data binding.
• Editing: Provides the options for create, read, update, and delete operations. In addition to built-in editor controls to edit a particular column value, using template support users can use custom editor components that suit their application needs.
• Virtual scrolling: This feature improves the performance of the tree grid control when binding large amounts of data by only rendering the currently visible parts of the user interface and rendering other elements as needed while scrolling. Both column and row virtualization are supported.
• Columns: Column definitions are used as the dataSource schema in the TreeGrid. This plays a vital role in rendering column values in the required format. Column functionalities such as resizing, reordering, column template, show or hide columns, stacked header, etc., are supported.
• Column re-ordering: Drag any column and drop it at any position in the TreeGrid’s column header row, to reposition the column.
• Column resizing: Resizing allows changing column width on the fly by simply dragging the right corner of the column header.
• Row re-ordering: Allows rows to be rearranged through drag and drop actions, changing their position and hierarchy level. A child row can be moved as a sibling within the same parent row or as a child to a different parent row.
• Cell styling: Customize treegrid cells by using CSS or programmatically.
• Selection: Rows or cells can be selected in the TreeGrid. One or more rows or cells can also be selected by holding Shift, Ctrl or Command, or programmatically.
• Templates: Templates can be used to create custom user experiences in the TreeGrid.
• Aggregation: Provides the option to easily visualize aggregates for column values. Also allows for the display of aggregates for each group of child rows within different parent rows.
• Context menu: The context menu provides a list of actions to be performed in the TreeGrid. It appears when a cell, header, or the pager is right-clicked. Also allows for the addition of custom items with unique functionality to the context menu.
• Export: Provides the option to export the tree grid data to Excel, PDF, and CSV formats.
• RTL support: Provides the right-to-left mode which aligns content in the TreeGrid component from right to left. This improves user experience and accessibility for those who work with RTL languages like Hebrew and Arabic.
• Localization: Provides inherent support to localize the UI.

Support

Product support is available through the following mediums.

• Support ticket - Guaranteed Response in 24 hours | Unlimited tickets | Holiday support
• Community forum
• GitHub issues
• Request feature or report bug
• Live chat

Changelog

Check the changelog here. Get minor improvements and bug fixes every week to stay up to date with frequent updates.

License and copyright

This is a commercial product and requires a paid license for possession or use. Syncfusion’s licensed software, including this component, is subject to the terms and conditions of Syncfusion's EULA. To acquire a license for 80+ React UI components, you can purchase or start a free 30-day trial.

A free community license is also available for companies and individuals whose organizations have less than $1 million USD in annual gross revenue and five or fewer developers.

See LICENSE FILE for more info.

© Copyright 2022 Syncfusion, Inc. All Rights Reserved. The Syncfusion Essential Studio license and copyright applies to this distribution.