New to Kendo UI for Vue? Start a free 30-day trial

Set Up Your Kendo UI for Vue License Key

In this article, you’ll learn how to activate the Kendo UI for Vue components by installing a personal license key.

Kendo UI for Vue is a professionally developed library distributed under a commercial license. Starting from version 2.0.0, using any of the UI components from the Kendo UI for Vue library requires either a commercial license key or an active trial license key.

To follow the way modern web applications are developed, Kendo UI for Vue serves its packages through npm. While this makes using it in Vue projects seamless, npm hosting does not provide a way for commercial library providers to manage trial and licensed users.

Our community is very important to us and we want to make sure that licensing does not get in your way. Please, let us know if you experience any issues.

You can send us feedback through the Contact Us form or by opening a support ticket.

The license key installation process involves three steps:

  1. Download a license key from this page (see next section).
  2. Install or update your license key file in your project.
  3. Register the license key by running a CLI command.

Download Your License Key

This section contains auto-generated content based on the license information for your account.

Please wait...

Install or update a License Key

  1. Copy the license key file (kendo-ui-license.txt) to the root folder of your application. This is the folder that contains the package.json file.
    • Alternatively, copy the contents of the file to the KENDO_UI_LICENSE environment variable.
  2. Install @progress/kendo-licensing as a project dependency by running npm install --save @progress/kendo-licensing or yarn add @progress/kendo-licensing.
  3. Run npx kendo-ui-license activate or yarn run kendo-ui-license activate in the console.

Add the License Key to CI services

The license key must be present at build time. The recommended approach is to use an environment variable.

Each platform has a different process for setting environment variables. Some popular examples are listed below.

GitHub Actions

  1. Create a new Repository Secret or an Organization Secret. Set the name of the secret to KENDO_UI_LICENSE and paste the contents of the license file as value.
  2. Add a build step to activate the license after running npm install or yarn:
steps:
    # ... install modules before activating the license
    - name: Install NPM modules
      run: npm install

    - name: Activate Kendo UI License
      run: npx kendo-ui-license activate
      # Set working directory if the application is not in the repository root folder:
      # working-directory: 'ClientApp'
      env:
        KENDO_UI_LICENSE: ${{ secrets.KENDO_UI_LICENSE }}

    # ... run application build after license activation
    - name: Build Application
      run: npm run build

Azure Pipelines (YAML)

  1. Create a new User-defined Variable named KENDO_UI_LICENSE. Paste the contents of the license key file as value.
  2. Add a build step to activate the license after running npm install or yarn:

Syntax for Windows build agents:

pool:
  vmImage: 'windows-latest'

steps:

# ... install modules before activating the license
- script: call npm install
  displayName: 'Install NPM modules'

- script: call npx kendo-ui-license activate
  displayName: 'Activate Kendo UI License'
  # Set working directory if the application is not in the repository root folder:
  # workingDirectory: 'ClientApp'
  env:
    KENDO_UI_LICENSE: $(KENDO_UI_LICENSE)

# ... run application build after license activation
- script: call npm run build
  displayName: 'Build Application'

Syntax for Linux build agents:

pool:
  vmImage: 'ubuntu-latest'

steps:

# ... install modules before activating the license
- script: npm install
  displayName: 'Install NPM modules'

- script: npx kendo-ui-license activate
  displayName: 'Activate Kendo UI License'
  # Set working directory if the application is not in the repository root folder:
  # workingDirectory: 'ClientApp'
  env:
    KENDO_UI_LICENSE: $(KENDO_UI_LICENSE)

# ... run application build after license activation
- script: npm run build
  displayName: 'Build Application'

Azure Pipelines (Classic)

  1. Create a new User-defined Variable named KENDO_UI_LICENSE. Paste the contents of the license key file as value.
  2. Add a new Bash task to the Agent job (before the npm build task)

screenshot

  1. Change the step to inline and use the following command
# Activate the license
npx kendo-ui-license activate

screenshot

Frequently Asked Questions

Will the product function without a license key?

Yes, the product will continue to function normally without a license key. However, a warning message will appear in the browser console if a valid license key is not present.

Please, be aware that future updates of the library may restrict or disable some features when no valid license is present.

Does the license key expire?

Yes, the license key expires at the end of your support subscription.

For trial users, this is at the end of your 30-day trial. For licensed developers, this is when your subscription expires.

You will need to obtain and install a new license key after starting a trial, renewing a license, or upgrading a license.

An expired license key is valid for all Kendo UI for Vue versions published before its expiration date. The publish date of each version is available in the Kendo UI for Vue changelog.

Do I need an Internet connection to activate the license?

No, the license activation and validation are performed entirely offline.

No network requests are made at any point of the project lifecycle.

Should I add the license key to source control?

No, the license key file (kendo-ui-license.txt) or its contents should not be added to source control.

Build servers should use the KENDO_UI_LICENSE environment variable as described above.

DO NOT Store the license key in plaintext, for example in a GitHub Actions Workflow definition.

Is it possible to activate the license without executing commands?

Yes, the license will be activated automatically if it is present during package installation. This applies to both license key files and the environment variable. A diagnostic message will be printed in the npm install log.

Using the kendo-ui-license activate command is optional, but recommended in builds as it will return an error if the activation fails.

What happens if both the environment variable and the license key file are present?

If both the KENDO_UI_LICENSE environment variable and the kendo-ui-license.txt file are present, then the environment variable is used.

To enforce the use of the license key file, unset the environment variable.

My team has more than one licensed developer. Which key should we use?

Any of the keys associated with your subscription(s) could be used to activate Kendo UI for Vue.

Are older versions of Kendo UI for Vue affected?

No, versions prior to v2.0.0 do not require a license key.