Getting Started with the KendoReact TreeList

This guide provides essential information about using the KendoReact TreeList package—you will learn how to install the TreeList package, add a TreeList component to your project, style the component, and activate your license.

After completing this guide, you will be able to reproduce the following example.

Setting Up Your React Project

Before you install the KendoReact TreeList, make sure that you have a running React project. The easiest way to set up a React project is to use the Create React App approach that is described in the Get Started with KendoReact article.

Installing the TreeList Package

All KendoReact packages are distributed through npm and offer a similar installation experience. To use the TreeList component, start with the installation of the TreeList npm package and its dependencies. Use Node.js v5.0.0 or later.

Copy Codenpm install --save @progress/kendo-react-treelist @progress/kendo-data-query @progress/kendo-drawing @progress/kendo-date-math @progress/kendo-react-data-tools @progress/kendo-react-dateinputs @progress/kendo-react-dropdowns @progress/kendo-react-inputs @progress/kendo-react-intl @progress/kendo-licensing @progress/kendo-svg-icons

Importing the Component

After installing the package, import the TreeList component in the React App. To enable the sending of messages, also import the Message entity and the TreeListMessageSendEvent.

In the src/App.js file of your React project, import the TreeList component from the TreeList package.

Copy Code// ES2015 module syntax
import { TreeList } from "@progress/kendo-react-treelist";

Copy Code// CommonJS format
const { TreeList } = require('@progress/kendo-react-treelist');

Using the Component

1. Get the data for the TreeList.

   Copy Code  import data from './simple-data';

2. Create the columns for the TreeList.

   Copy Code  const columns = [
       { field: 'name', title: 'Name', width: '250px', expandable: true },
       { field: 'title', title: 'Title'}
     ];

3. Specify the field's name, which will provide an array representation of the item subitems.

   Copy Code  const subItemsField: string = 'employees';

4. Specify the field's name, which will provide a Boolean representation of the expanded state of each item.

   Copy Code  const expandField = 'expanded';

5. Add the component's markup to the src/App.js file in your project.

   Copy Code  return (
       <TreeList
         style={{ maxHeight: '510px', overflow: 'auto' }}
         expandField={expandField}
         subItemsField={subItemsField}
         data={data}
         columns={columns}
       />
     );

6. To style the TreeList, install and import the Default theme, which is one of the three beautiful themes for KendoReact.

   6.1. Install the Default theme package.

   Copy Codenpm install --save @progress/kendo-theme-default

   6.2. Import the CSS file from the package in src/App.js. Add this import before your existing App.css import.

   Copy Codeimport '@progress/kendo-theme-default/dist/all.css';

7. Build and run the application by typing the following command in the root folder of your project:

   Copy Codenpm start

8. Navigate to http://localhost:3000 to see the KendoReact TreeList component on the page.

Activating Your License Key

Using any of the UI components in the KendoReact library requires either a commercial license key or an active trial license key.

Follow the instructions on the KendoReact My License page to activate your trial or commercial license. You can skip this step if your application already contains a KendoReact license file.

Dependencies

The TreeList package requires you to install the following peer dependencies in your application:

Suggested Links

• Data operations
  • Editing
  • Filtering
  • Paging
  • Sorting
• Export options
  • Excel export
  • PDF export
• Advanced implementations
  • Aggregates
• More settings
  • Column features
  • Cell features
  • Virtual Scrolling
  • Rows Drag and Drop
  • Selection
  • Flat data
  • Globalization

Learning Resources

• Getting Started with KendoReact
• Virtual Classroom (Introductory Course Available to Trial and Commercial License Holders)
• Explore the Finance Portfolio Sample Application
• Explore the Coffee Warehouse Sample Application
• Explore the Github Issues Grid Sample Application