Getting Started with the Kendo UI for Vue Native Inputs
This guide provides essential information about using the Kendo UI for Vue Native Inputs package—you will learn how to install the package, add Input components to your project, style the components, and activate your license. You can apply the steps in this guide to all Kendo UI for Vue Native Inputs.
After completing this guide, you will reproduce the following example.
Setting Up Your Vue Project
Before you install the Kendo UI for Vue Native Inputs, 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 Components
All Kendo UI for Vue packages are distributed through npm and offer a similar installation experience. To use any of the Indicators, start with the installation of the 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-inputs @progress/kendo-vue-intl @progress/kendo-drawing @progress/kendo-licensing @progress/kendo-svg-icons
Importing the Components
After installing the Inputs package, import the desired components in the Vue App. This guide shows how to add the ColorPicker.
In the App component file of your Vue project (for example, src/App.vue
), add the following code:
// ES2015 module syntax
import { ColorPicker } from '@progress/kendo-vue-inputs';
// CommonJS format
const { ColorPicker } = require('@progress/kendo-vue-inputs');
If your project requires more Input components, you can import them. The Inputs package provides the following components:
- Checkbox
- ColorGradient
- ColorPalette
- ColorPicker
- FlatColorPicker
- Input
- MaskedTextBox
- NumericTextBox
- RadioButton
- RadioGroup
- RangeSlider
- Slider
- Switch
- TextArea
Using the Components
-
After installing the Inputs package and importing the components, add the ColorPicker to the template section of the App component file of your Vue project (for example,
src/App.vue
).<div class="example-wrapper"> <ColorPicker :view="'gradient'" :default-value="'green'" /> </div>
-
To style the Loader, 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
Now try to add another component from the Inputs package yourself. The procedures for installing, importing, and using the Input components are identical for all components in the package.
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 license file.
Dependencies
The Inputs 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. |
@progress/kendo-svg-icons | Contains the SVG icons for the components |
@progress/kendo-vue-intl | Contains the Kendo UI for Vue Native Internationalization package that applies the desired cultures by providing services and pipes for the parsing and formatting of dates and numbers. |
@progress/kendo-drawing | Contains the Drawing library, which provides interactive vector graphics. |
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
- Checkbox Overview
- ColorPicker Overview
- ColorGradient Overview
- ColorPalette Overview
- FlatColorPicker Overview
- Input Overview
- MaskedTextBox Overview
- NumericTextBox Overview
- RadioButton Overview
- RadioGroup Overview
- Slider Overview
- RangeSlider Overview
- Switch Overview
- TextArea Overview
- API Reference of the Inputs
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
- Virtual Classroom - Kendo UI for Vue with TypeScript(Course Available to Trial and Commercial License Holders)
- Explore the Coffee Warehouse Sample Application
- Kendo UI Productivity Tools extension for VS Code