Getting Started with the Kendo UI for Vue Native Icons

This guide provides the information you need to start using the Kendo UI for Vue Native Icons—it includes instructions about the available installation approaches, the required dependencies, the code for running the project, and links to additional resources.

The Icons Package is part of Kendo UI for Vue, a professional grade UI library with 100+ components for building modern and feature-rich applications. To try it out sign up for a free 30-day trial.

After the completion of this guide, you will be able to achieve an end result as demonstrated in the following example.

Example
View Source
Change Theme:

Setting Up Your Vue Project

Before you install the Kendo UI for Vue Native Icons, 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 Icons Package

All Kendo UI for Vue Native packages are distributed through npm and offer a similar installation experience. To use the SvgIcon component, start with the installation of the @progress/kendo-vue-common npm package and its dependencies.

npm install --save @progress/kendo-vue-common @progress/kendo-svg-icons @progress/kendo-licensing

Importing the Component

After installing the package, import the SvgIcon component in the src/App.vue file.

// ES2015 module syntax
import { SvgIcon } from '@progress/kendo-vue-common';
// CommonJS format
const { SvgIcon } = require('@progress/kendo-vue-common');

Using the Component

  1. Import the cameraIcon icon from the @progress/kendo-svg-icons package.

    import { cameraIcon } from '@progress/kendo-svg-icons';
  2. Define the cameraIcon as a data property.

      data() {
        return {
            cameraIcon
        };
      }
  3. Add the markup of the SvgIcon to the template section of the src/App.vue file in your project.

        <SvgIcon :icon="cameraIcon" />
  4. To style the SvgIcon, 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.

      npm install --save @progress/kendo-theme-default
    2. Import the Theme package in src/App.vue..

      import '@progress/kendo-theme-default';
  5. 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 Vue Common package requires you to install the following peer dependencies in your application:

Package NameDescription
vue 2.6.14 or 3.0.0+Contains the functionality necessary to define Vue components.
@progress/kendo-vue-commonContains logic and features that are common for many Kendo UI for Vue components.
@progress/kendo-svg-iconsContains the definitions of the SVG icons provided by the Kendo UI for Vue Native suite.
@progress/kendo-licensingContains 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.

Next Steps

Learning Resources