Getting Started with the Kendo UI for Vue Native TreeList

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

All Kendo UI for Vue Native 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-vue-treelist @progress/kendo-data-query @progress/kendo-drawing @progress/kendo-date-math @progress/kendo-vue-data-tools @progress/kendo-vue-dateinputs @progress/kendo-vue-dropdowns @progress/kendo-vue-inputs @progress/kendo-vue-intl @progress/kendo-licensing

Importing the Component

After installing the package, in the src/App.vue file of your Vue project, import the TreeList component from the TreeList package.

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

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

Using the Component

1. Import the data for the TreeList.

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

2. Define the Native TreeList columns as a data property.

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

3. Define a data property with the name of the field that will provide an array representation of the item subitems.

   Copy Code  subItemsField: 'employees',

4. Define a data property with the name of the field that will provide a Boolean representation of the expanded state of each item.

   Copy Code  expandField: 'expanded',

5. Add the following TreeView definition in the template section of the src/App.vue file in your project.

   Copy Code  <TreeList
       :style="{
         'max-height': '510px',
         overflow: 'auto',
       }"
       :expand-field="expandField"
       :sub-items-field="subItemsField"
       :data-items="dataItems"
       :columns="columns"
     />

6. To style the TreeList, 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';

7. 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 TreeList 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 operations
  • Editing
  • Filtering
  • Paging
  • Sorting
• Export options
  • Excel export
  • PDF export
• Advanced implementations
  • Aggregates
• TreeList customization
  • ToolBar configuration
  • Custom cell template
• More settings
  • Column features
  • Virtual Scrolling
  • Rows Drag and Drop
  • Flat data
  • Globalization

Learning Resources

• Getting Started with Kendo UI for Vue Native suite
• 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
• Kendo UI for Vue TypeScript Integration Overview
• Kendo UI for Vue with TypeScript Virtual Classroom Tutorial
• Explore the Coffee Warehouse Sample Application
• Explore the GitHub Dashboard Sample Application
• Kendo UI Productivity Tools extension for VS Code