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.
npm 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.
// ES2015 module syntax
import { ListView } from "@progress/kendo-vue-listview";
// CommonJS format
const { ListView } = require('@progress/kendo-vue-listview');
Using the Component
-
Import the
products
data in thesrc/App.vue
file.import products from './products.json';
-
Add the ListView component in the
App
component.<ListView :style="{ width: '100%', height: '600px' }" :data-items="products" :item="'myItem'" > </ListView>
-
Create and add inside the ListBox definition, the
myItem
slot template responsible for rendering each ListView item.<template v-slot:myItem="{ props }"> <div class="k-listview-item" :style="{ padding: '10px', borderBottom: '1px solid lightgrey' }" > {{ props.dataItem.ProductName }} </div> </template>
-
To style the ListView, install and import the Default theme, which is one of the four beautiful themes for Kendo UI for Vue.
-
Install the Default theme package.
npm install --save @progress/kendo-theme-default
-
Import the Theme package in
src/App.vue
..import '@progress/kendo-theme-default';
-
-
Build, run and test the application by typing the following command in the root folder of your project:
npm 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:
Package Name | Description |
---|---|
vue 2.6.14 or 3.0.0+ | Contains the functionality necessary to define Vue components. |
@progress/kendo-licensing | Contains the internal infrastructure related to licensing. |
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
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