Getting Started with the Kendo UI for Vue Native TreeView

This guide provides essential information about using the Kendo UI for Vue Native 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.

Setting Up Your Vue Project

Before you install the Kendo UI for Vue Native TreeView, make sure that you have a running Vue project. The easiest way to set up a Vue project is to use the approach described in the Set up the Vue project section of the First Steps with JavaScript article.

Installing the TreeView Package

All Kendo UI for Vue 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.

Copy Codenpm install --save @progress/kendo-vue-treeview @progress/kendo-licensing @progress/kendo-svg-icons

Importing the Component

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

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

Copy Code// ES2015 module syntax
import { TreeView } from "@progress/kendo-vue-treeview";

Copy Code// CommonJS format
const { TreeView } = require('@progress/kendo-vue-treeview');

Using the Component

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

   Copy Code  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. Add the component's markup to the template section of the src/App.vue file in your project.

   Copy Code  <div>
       <TreeView :dataItems="tree" />
     </div>

3. To style the TreeView, install and import the Default theme, which is one of the four beautiful themes for Kendo UI for Vue.

   1. Install the Default theme package.

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

   2. Import the Theme package in src/App.vue.

      Copy Codeimport '@progress/kendo-theme-default';

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

   Copy Codenpm run dev

Activating Your License Key

Using any of the UI components in the Kendo UI for Vue Native library requires either a commercial license key or an active trial license key.

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

Dependencies

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

Vue 2 is currently in its end-of-support phase till Nov 2024. After our last major release for 2024, Vue 2 will no longer be supported in the new versions of the Kendo UI for Vue components. Please check our Vue 2 End of Support article for more details.

Suggested Links

• Data binding
• Expanding items
• Selection
• Checkboxes
• Dragging and dropping
• Custom rendering of items
• Keyboard navigation
• Accessibility

Learning Resources

• Kendo UI for Vue - First Steps with JavaScript
• Kendo UI for Vue - First Steps with JavaScript + Options API
• Kendo UI for Vue - First Steps with TypeScript
• Kendo UI for Vue - First Steps with TypeScript + Options API
• Virtual Classroom - Kendo UI for Vue with TypeScript(Course Available to Trial and Commercial License Holders)
• Kendo UI Productivity Tools extension for VS Code