Getting Started with the Kendo UI for Vue Native Layout Package
This guide provides essential information about using the Kendo UI for Vue Native Layout package—you will learn how to install the package, add a PanelBar component to your project, style the component, and activate your license. The steps demonstrated in this guide are applicable to all Vue Layout components.
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 Layout package, 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 Layout Package
All Kendo UI for Vue Native packages are distributed through npm and offer a similar installation experience. To use the PanelBar
(for example) component, start with the installation of the Layout npm package and its dependencies. Use Node.js v5.0.0 or later.
Navigate to the root folder of your Vue project and run the following command:
npm install --save @progress/kendo-vue-layout @progress/kendo-vue-progressbars @progress/kendo-licensing @progress/kendo-vue-intl @progress/kendo-svg-icons
Importing the Components
After installing the package, in the src/App.vue
file of your Vue project, import the PanelBar
component from the Layout
package.
// ES2015 module syntax
import { PanelBar } from "@progress/kendo-vue-layout";
// CommonJS format
const { PanelBar } = require('@progress/kendo-vue-layout');
If your project requires more Layout components, you can import them too. The Layout package provides the following components:
- AppBar
- Avatar
- BottomNavigation
- Card
- ContextMenu
- Drawer
- ExpansionPanel
- GridLayout
- Menu
- PanelBar
- Splitter
- StackLayout
- Stepper
- TabStrip
- TileLayout
- Wizard
Using the Components
-
Define the Native PanelBar's rows as a data property.
jsxitems: [ { title: 'Competition', content: 'competitionOverview', }, { title: 'Winners', items: [ { title: 'Winners 2022' }, { title: 'Winner 2021' }, { title: 'Winner 2020' }, ], }, ],
-
Add the following PanelBar definition in the
template
section of thesrc/App.vue
file in your project.html<div class="panelbar-wrapper"> <PanelBar :expand-mode="'single'" :items="items"> <template v-slot:competitionOverview> <div style="padding: 10px"> A very demanding competition with more than 5000 participants. </div> </template> </PanelBar> </div>
-
To style the
PanelBar
, install and import the Default theme, which is one of the four beautiful themes for Kendo UI for Vue.-
Install the Default theme package.
shnpm install --save @progress/kendo-theme-default
-
Import the Theme package in
src/App.vue
.jsximport '@progress/kendo-theme-default';
-
-
Build, run and test the application by typing the following command in the root folder of your project:
shnpm run dev
-
Try the other Kendo UI for Vue Native Layout components
After going through the above steps, now you can try the all Layout components by yourself. Add other components to the newly created project by importing and then defining them in the template section. More details about how the different component can be configured you can find in each of the links in the Suggested Links section below.
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 Layout package requires you to install the following peer dependencies in your application:
Package Name | Description |
---|---|
vue 2.6.11 or 3.0.0 | Contains the functionality necessary to define Vue components. |
@progress/kendo-licensing | Contains the internal infrastructure related to the licensing of the Kendo UI for Vue Native components. |
@progress/kendo-svg-icons | Contains the SVG icons for the components |
@progress/kendo-vue-layout | Contains the Kendo UI for Vue Native Layout components. |
@progress/kendo-vue-intl | Contains the Internationalization package that handles the desired cultures and applies data formatting in all Native Kendo UI for Vue components of your project. |
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
- AppBar Overview
- Avatar Overview
- BottomNavigation Overview
- Card Overview
- ContextMenu Overview
- Drawer Overview
- ExpansionPanel Overview
- GridLayout Overview
- Menu Overview
- PanelBar Overview
- Splitter Overview
- StackLayout Overview
- Stepper Overview
- TabStrip Overview
- TileLayout Overview
- Wizard Overview
- Kendo UI Productivity Tools extension for VS Code
- API Reference of the Layout Components
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