Getting Started with the Kendo UI for Vue Native ListView

This guide provides essential information about using the Kendo UI for Vue Native ListView package—you will learn how to install the ListView package, add a ListView 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 ListView, 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 ListView Package

All Kendo UI for Vue Native packages are distributed through npm and offer a similar installation experience. To use the ListView component, start with the installation of the ListView npm package and its dependencies. Use Node.js v5.0.0 or later.

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

Importing the Component

After installing the package, import the ListView component and the products data in the Vue App.

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

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

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

Using the Component

1. Import the products data in the src/App.vue file.

   Copy Code    import products from './products.json';

2. Add the ListView component in the App component.

   Copy Code<ListView
       :style="{ width: '100%', height: '600px' }"
       :data-items="products"
       :item="'myItem'"
   >
   </ListView>

3. Create and add inside the ListBox definition, the myItem slot template responsible for rendering each ListView item.

   Copy Code<template v-slot:myItem="{ props }">
     <div
       class="k-listview-item"
       :style="{ padding: '10px', borderBottom: '1px solid lightgrey' }"
     >
       {{ props.dataItem.ProductName }}
     </div>
   </template>

4. To style the ListView, 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';

5. 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 ListView 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

• Paging
• Scrolling
• Templates
• Editing
• Filtering

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