Skip to content

Commit 2539433

Browse files
authored
docs(licensing): add details about licensing watermark and banner (#446)
1 parent fb8bd98 commit 2539433

File tree

11 files changed

+71
-7
lines changed

11 files changed

+71
-7
lines changed

docs/getting-started/get-started-nuxt-3.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -508,7 +508,10 @@ npm run dev
508508
## 10. Activate Your Trial or Commercial License
509509
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.
510510

511-
Follow the instructions on the Kendo UI for Vue [My License page](slug:my_license_vue) to activate your license.
511+
> 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.
512+
513+
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.
514+
512515
## 11. Get the Complete Source Code
513516
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/).
514517

docs/getting-started/index.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -566,7 +566,10 @@ You can learn more about the `Window component` and what it can do on the [Kendo
566566
## 9. Activate Your Trial or Commercial License
567567
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.
568568
569-
Follow the instructions on the Kendo UI for Vue [My License page](slug:my_license_vue) to activate your license.
569+
> 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.
570+
571+
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.
572+
570573
## 10. Get the Complete Source Code
571574
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).
572575

docs/getting-started/javascript-options-api.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -549,7 +549,10 @@ You can learn more about the `Window component` and what it can do on the [Kendo
549549
## 9. Activate Your Trial or Commercial License
550550
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.
551551
552-
Follow the instructions on the Kendo UI for Vue [My License page](slug:my_license_vue) to activate your license.
552+
> 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.
553+
554+
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.
555+
553556
## 10. Get the Complete Source Code
554557
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).
555558

docs/getting-started/typescript-composition-api.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -614,7 +614,10 @@ You can learn more about the `Window component` and what it can do on the [Kendo
614614
## 9. Activate Your Trial or Commercial License
615615
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.
616616
617-
Follow the instructions on the Kendo UI for Vue [My License page](slug:my_license_vue) to activate your license.
617+
> 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.
618+
619+
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.
620+
618621
## 10. Get the Complete Source Code
619622
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).
620623

docs/getting-started/typescript-options-api.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -585,7 +585,10 @@ You can learn more about the `Window component` and what it can do on the [Kendo
585585
## 9. Activate Your Trial or Commercial License
586586
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.
587587
588-
Follow the instructions on the Kendo UI for Vue [My License page](slug:my_license_vue) to activate your license.
588+
> 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.
589+
590+
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.
591+
589592
## 10. Get the Complete Source Code
590593
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).
591594

docs/getting-started/vscode-extension.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -129,7 +129,9 @@ Last but not least, navigate to <http://localhost:8080/chartPage> and see the ad
129129

130130
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.
131131

132-
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.
132+
> 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.
133+
134+
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.
133135

134136

135137
## Suggested Links
51.9 KB
Loading
200 KB
Loading

docs/my-license/grid-watermark.png

184 KB
Loading

docs/my-license/index.mdx

Lines changed: 48 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ title: Set Up Your Kendo UI for Vue License Key
33
page_title: Kendo UI for Vue License Key - Setup and FAQs
44
description: "Set up your license key to use the Kendo UI for Vue components in your Vue projects."
55
slug: my_license_vue
6+
tag: updated
67
noindex: true
78
---
89

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

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

18+
> 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.
19+
1720
Kendo UI for Vue is a professionally developed library distributed under a [commercial license](https://www.telerik.com/purchase/license-agreement/kendo-ui).
1821
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.
1922

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

195198
>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.
196199

200+
## Invalid License
201+
202+
An invalid license can be caused by any of the following:
203+
204+
* Using an invalid or expired commercial license.
205+
* Using an expired trial license.
206+
* Not [installing or updating the Kendo UI for Vue license key](#toc-install-or-update-a-license-key) in your application.
207+
208+
If you use Kendo UI for Vue in a project with an expired or missing license, the UI components will exhibit the following behavior:
209+
1. A watermark appears over a number of selected components:
210+
* A watermark appearing in the `Light Theme` mode.
211+
![Kendo UI for Vue Grid with a watermark - Light theme](grid-watermark.png)
212+
* A watermark appearing in the `Dark Theme` mode.
213+
![Kendo UI for Vue Grid with a watermark - Dark theme](grid-watermark-dark.png)
214+
1. A banner appears on pages that use unlicensed Kendo UI for Vue components.
215+
![Invalid Kendo UI for Vue License Banner](license-banner.png)
216+
* Clicking the **?** button of the banner takes you to the Kendo UI for Vue licensing documentation.
217+
* Clicking the **x** button of the banner closes the banner until the page is reloaded or a license is activated.
218+
1. A warning message similar to the following is logged in the browser's console
219+
![Kendo UI for Vue Console Warning for a missing or invalid license](console-warning.png)
220+
197221
## Frequently Asked Questions
198222

199223
### Will the product function without a license key?
200224

201-
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.
225+
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:
226+
* A watermark will appear above selected Kendo UI for Vue components.
227+
* A licensing banner will pop over a page that uses unlicensed Kendo UI for Vue components.
228+
* A warning message will appear in the browser console.
229+
230+
See the [Invalid License](#toc-invalid-license) section for more information.
202231

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

234+
### 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?
235+
236+
If you have a valid license activated for your project, you won't get any [invalid license attributes](#toc-invalid-license).
237+
205238
### Does the license key expire?
206239

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

213246
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/).
214247

248+
### 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?
249+
250+
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.
251+
252+
The reason for the issue is that Vite is not updating its cache after the licensing command is executed. To make the warning disappear:
253+
1. Delete the `.vite` folder in the `node_modules` folder of the project.
254+
1. Execute the `npx kendo-ui-license activate` command.
255+
256+
### 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?
257+
258+
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:
259+
1. [Download a new license key](#toc-download-your-license-key).
260+
1. [Activate the new license key](#toc-install-or-update-a-license-key) in your project.
261+
215262
### Do I need an Internet connection to activate the license?
216263

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

0 commit comments

Comments
 (0)