Getting Started with the KendoReact TreeView

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


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

Example
View Source
Change Theme:

Setting Up Your React Project

Before you install the KendoReact TreeView, 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 TreeView Package

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

npm install --save @progress/kendo-react-treeview @progress/kendo-licensing @progress/kendo-svg-icons

Importing the Component

After installing the package, import the TreeView component in the React App.

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

// ES2015 module syntax
import { TreeView } from "@progress/kendo-react-treeview";
// CommonJS format
const { TreeView } = require('@progress/kendo-react-treeview');

Using the Component

  1. Add the hierarchical data that you will display in the TreeView.

      const tree = [
        {
          text: 'Furniture',
          expanded: true,
          items: [
            {
              text: 'Tables & Chairs'
            },
            {
              text: 'Sofas'
            },
            {
              text: 'Occasional Furniture'
            }
          ]
        },
        {
          text: 'Decor',
          expanded: true,
          items: [
            {
              text: 'Bed Linen'
            },
            {
              text: 'Curtains & Blinds'
            },
            {
              text: 'Carpets'
            }
          ]
        }
      ];
  2. Render the TreeView with the defined data.

      return <TreeView data={tree} />;
  3. To style the TreeView, install and import the Default theme, which is one of the three beautiful themes for KendoReact.

    3.1. Install the Default theme package.

    npm install --save @progress/kendo-theme-default

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

    import '@progress/kendo-theme-default/dist/all.css';
  4. Build and run the application by typing the following command in the root folder of your project:

    npm start
  5. Navigate to http://localhost:3000 to see the KendoReact TreeView 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 TreeView package requires you to install the following peer dependencies in your application:

Package NameDescription
react 16.8.2*Contains the functionality necessary to define React components.
react-domContains the React renderer for the web.
@progress/kendo-licensingContains the internal infrastructure related to licensing.
@progress/kendo-svg-iconsContains the KendoReact SVG icons.

Learning Resources