Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(licensing): add details about licensing watermark and banner #446

Merged
merged 1 commit into from
Sep 11, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion docs/getting-started/get-started-nuxt-3.md
Original file line number Diff line number Diff line change
Expand Up @@ -508,7 +508,10 @@ npm run dev
## 10. Activate Your Trial or Commercial License
Kendo UI for Vue is a professionally developed library distributed under a [commercial license](https://www.telerik.com/purchase/license-agreement/kendo-ui). Starting from [version 2.0.0](https://www.telerik.com/kendo-vue-ui/components/changelogs/ui-for-vue/), 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.

Follow the instructions on the Kendo UI for Vue [My License page](slug:my_license_vue) to activate your license.
> Since version 3.14.0 (13 September 2023) of Kendo UI for Vue, a missing license causes a watermark to appear over selected components. For more information, see the [Invalid License](slug:my_license#toc-invalid-license) section.

To experience the full potential of the Kendo UI for Vue components, follow the [license activation instructions](slug:my_license) and hide the invalid/not-activated license messages and attributes. You can skip this step if your application already contains a Kendo UI for Vue license file.

## 11. Get the Complete Source Code
Your Kendo UI for Vue Getting Started application is complete! You can download and run the complete sample application from the [kendo-vue-examples GitHub repository](https://github.com/telerik/kendo-vue/tree/master/getting-started-nuxt3/).

Expand Down
5 changes: 4 additions & 1 deletion docs/getting-started/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -566,7 +566,10 @@ You can learn more about the `Window component` and what it can do on the [Kendo
## 9. Activate Your Trial or Commercial License
Kendo UI for Vue is a professionally developed library distributed under a [commercial license](https://www.telerik.com/purchase/license-agreement/kendo-ui). Starting from [version 2.0.0](https://www.telerik.com/kendo-vue-ui/components/changelogs/ui-for-vue/), 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.

Follow the instructions on the Kendo UI for Vue [My License page](slug:my_license_vue) to activate your license.
> Since version 3.14.0 (13 September 2023) of Kendo UI for Vue, a missing license causes a watermark to appear over selected components. For more information, see the [Invalid License](slug:my_license#toc-invalid-license) section.

To experience the full potential of the Kendo UI for Vue components, follow the [license activation instructions](slug:my_license) and hide the invalid/not-activated license messages and attributes. You can skip this step if your application already contains a Kendo UI for Vue license file.

## 10. Get the Complete Source Code
Your Kendo UI for Vue Getting Started application is complete! You can download and run the complete sample application from the [kendo-vue GitHub repository](https://github.com/telerik/kendo-vue/tree/master/getting-started-javascript-composition-api). Alternatively, run, fork and [experiment with the application directly in StackBlitz](https://stackblitz.com/edit/vue3-vite-starter-vfbur6?file=src%2FApp.vue).

Expand Down
5 changes: 4 additions & 1 deletion docs/getting-started/javascript-options-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -549,7 +549,10 @@ You can learn more about the `Window component` and what it can do on the [Kendo
## 9. Activate Your Trial or Commercial License
Kendo UI for Vue is a professionally developed library distributed under a [commercial license](https://www.telerik.com/purchase/license-agreement/kendo-ui). Starting from [version 2.0.0](https://www.telerik.com/kendo-vue-ui/components/changelogs/ui-for-vue/), 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.

Follow the instructions on the Kendo UI for Vue [My License page](slug:my_license_vue) to activate your license.
> Since version 3.14.0 (13 September 2023) of Kendo UI for Vue, a missing license causes a watermark to appear over selected components. For more information, see the [Invalid License](slug:my_license#toc-invalid-license) section.

To experience the full potential of the Kendo UI for Vue components, follow the [license activation instructions](slug:my_license) and hide the invalid/not-activated license messages and attributes. You can skip this step if your application already contains a Kendo UI for Vue license file.

## 10. Get the Complete Source Code
Your Kendo UI for Vue Getting Started application is complete! You can download and run the complete sample application from the [kendo-vue GitHub repository](https://github.com/telerik/kendo-vue/tree/master/getting-started-javascript-options-api). Alternatively, run, fork and [experiment with the application directly in StackBlitz](https://stackblitz.com/edit/vue3-vite-starter-75eowq?file=src%2FApp.vue).

Expand Down
5 changes: 4 additions & 1 deletion docs/getting-started/typescript-composition-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -614,7 +614,10 @@ You can learn more about the `Window component` and what it can do on the [Kendo
## 9. Activate Your Trial or Commercial License
Kendo UI for Vue is a professionally developed library distributed under a [commercial license](https://www.telerik.com/purchase/license-agreement/kendo-ui). Starting from [version 2.0.0](https://www.telerik.com/kendo-vue-ui/components/changelogs/ui-for-vue/), 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.

Follow the instructions on the Kendo UI for Vue [My License page](slug:my_license_vue) to activate your license.
> Since version 3.14.0 (13 September 2023) of Kendo UI for Vue, a missing license causes a watermark to appear over selected components. For more information, see the [Invalid License](slug:my_license#toc-invalid-license) section.

To experience the full potential of the Kendo UI for Vue components, follow the [license activation instructions](slug:my_license) and hide the invalid/not-activated license messages and attributes. You can skip this step if your application already contains a Kendo UI for Vue license file.

## 10. Get the Complete Source Code
Your Kendo UI for Vue Getting Started application is complete! You can download and run the complete sample application from the [kendo-vue-examples GitHub repository](https://github.com/telerik/kendo-vue/tree/master/getting-started-typescript-composition-api).

Expand Down
5 changes: 4 additions & 1 deletion docs/getting-started/typescript-options-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -585,7 +585,10 @@ You can learn more about the `Window component` and what it can do on the [Kendo
## 9. Activate Your Trial or Commercial License
Kendo UI for Vue is a professionally developed library distributed under a [commercial license](https://www.telerik.com/purchase/license-agreement/kendo-ui). Starting from [version 2.0.0](https://www.telerik.com/kendo-vue-ui/components/changelogs/ui-for-vue/), 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.

Follow the instructions on the Kendo UI for Vue [My License page](slug:my_license_vue) to activate your license.
> Since version 3.14.0 (13 September 2023) of Kendo UI for Vue, a missing license causes a watermark to appear over selected components. For more information, see the [Invalid License](slug:my_license#toc-invalid-license) section.

To experience the full potential of the Kendo UI for Vue components, follow the [license activation instructions](slug:my_license) and hide the invalid/not-activated license messages and attributes. You can skip this step if your application already contains a Kendo UI for Vue license file.

## 10. Get the Complete Source Code
Your Kendo UI for Vue Getting Started application is complete! You can download and run the complete sample application from the [kendo-vue-examples GitHub repository](https://github.com/telerik/kendo-vue/tree/master/getting-started-typescript-options-api).

Expand Down
4 changes: 3 additions & 1 deletion docs/getting-started/vscode-extension.md
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,9 @@ Last but not least, navigate to <http://localhost:8080/chartPage> and see the ad

Using any of the UI components in the Kendo UI for Vue library requires either a commercial license key or an active trial license key.

Follow the instructions on the Kendo UI for Vue [My License page]({% slug my_license %}) to activate your trial or commercial license. You can skip this step if your application already contains a Kendo UI for Vue license file.
> Since version 3.14.0 (13 September 2023) of Kendo UI for Vue, a missing license causes a watermark to appear over selected components. For more information, see the [Invalid License](slug:my_license#toc-invalid-license) section.

To experience the full potential of the Kendo UI for Vue components, follow the [license activation instructions](slug:my_license) and hide the invalid/not-activated license messages and attributes. You can skip this step if your application already contains a Kendo UI for Vue license file.


## Suggested Links
Expand Down
Binary file added docs/my-license/console-warning.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/my-license/grid-watermark-dark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/my-license/grid-watermark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
49 changes: 48 additions & 1 deletion docs/my-license/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ title: Set Up Your Kendo UI for Vue License Key
page_title: Kendo UI for Vue License Key - Setup and FAQs
description: "Set up your license key to use the Kendo UI for Vue components in your Vue projects."
slug: my_license_vue
tag: updated
noindex: true
---

Expand All @@ -14,6 +15,8 @@ import LicenseScriptKey from "gatsby-theme-k3-docs/src/components/license/licens

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

> Since version 3.14.0 (13 September 2023) of Kendo UI for Vue, a missing license causes a watermark to appear over selected components. For more information, see the [Invalid License](#toc-invalid-license) section below.

Kendo UI for Vue is a professionally developed library distributed under a [commercial license](https://www.telerik.com/purchase/license-agreement/kendo-ui).
Starting from [version 2.0.0](https://www.telerik.com/kendo-vue-ui/components/changelogs/ui-for-vue/), 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.

Expand Down Expand Up @@ -194,14 +197,44 @@ To activate the license of the `@progress/kendo-ui` package, you can follow the

>The above instructions should be followed `only` when you are using the `Kendo UI for Vue Wrapper` components. If you are using the Kendo UI for Vue Native components, you should skip the current section of this article.

## Invalid License

An invalid license can be caused by any of the following:

* Using an invalid or expired commercial license.
* Using an expired trial license.
* Not [installing or updating the Kendo UI for Vue license key](#toc-install-or-update-a-license-key) in your application.

If you use Kendo UI for Vue in a project with an expired or missing license, the UI components will exhibit the following behavior:
1. A watermark appears over a number of selected components:
* A watermark appearing in the `Light Theme` mode.
![Kendo UI for Vue Grid with a watermark - Light theme](grid-watermark.png)
* A watermark appearing in the `Dark Theme` mode.
![Kendo UI for Vue Grid with a watermark - Dark theme](grid-watermark-dark.png)
1. A banner appears on pages that use unlicensed Kendo UI for Vue components.
![Invalid Kendo UI for Vue License Banner](license-banner.png)
* Clicking the **?** button of the banner takes you to the Kendo UI for Vue licensing documentation.
* Clicking the **x** button of the banner closes the banner until the page is reloaded or a license is activated.
1. A warning message similar to the following is logged in the browser's console
![Kendo UI for Vue Console Warning for a missing or invalid license](console-warning.png)

## 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.
Yes, the product will continue to function normally without a license key. However, the following will happen if a valid license key is not present:
* A watermark will appear above selected Kendo UI for Vue components.
* A licensing banner will pop over a page that uses unlicensed Kendo UI for Vue components.
* A warning message will appear in the browser console.

See the [Invalid License](#toc-invalid-license) section for more information.

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

### Will a watermark and license banner appear if I use a Kendo UI for Vue version that was released prior to v.3.14.0?

If you have a valid license activated for your project, you won't get any [invalid license attributes](#toc-invalid-license).

### Does the license key expire?

Yes, the license key expires at the end of your support subscription.
Expand All @@ -212,6 +245,20 @@ You will need to obtain and install a new license key after starting a trial, re

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](https://www.telerik.com/kendo-vue-ui/components/changelogs/ui-for-vue/).

### I am using Vite in my project. I can't hide the invalid license watermarks, banner, and console warning even though the license activation is successful. What should I do?

The described scenario happens in Vite context and most often when you have previously activated a commercial or trial license in your project and now you want to renew this license. In the discussed case, once you run `npx kendo-ui-license activate`, the console message says you have successfully activated your license but in fact, all [invalid license attributes](#toc-invalid-license) are still presented.

The reason for the issue is that Vite is not updating its cache after the licensing command is executed. To make the warning disappear:
1. Delete the `.vite` folder in the `node_modules` folder of the project.
1. Execute the `npx kendo-ui-license activate` command.

### I updated the version of the Kendo UI for Vue packages in my project and the invalid license attributes appeared. How to hide these items?

If this happens, the possible reason is that the end date of the license activated in your application is before the release date of the newly installed Kendo UI for Vue packages. To fix this issue:
1. [Download a new license key](#toc-download-your-license-key).
1. [Activate the new license key](#toc-install-or-update-a-license-key) in your project.

### Do I need an Internet connection to activate the license?

No, the license activation and validation are performed entirely offline.
Expand Down
Binary file added docs/my-license/license-banner.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading