Getting Started with the Kendo UI for Angular Utilities
This guide provides the information you need to start using the Kendo UI for Angular Utilities—it includes instructions about the recommended installation approach, the code for running the project, and links to additional resources.
Start Free TrialAs of version
17.0.0
, Angular makes standalone component enabled by default. If you useNgModules
, refer to these articles:
After the completion of this guide, you will be able to achieve an end result as demonstrated in the following example.
Setting Up Your Angular Project
Before you start with the installation of any Kendo UI for Angular control, ensure that you have a running Angular project. The prerequisites to accomplish the installation of the components are always the same regardless of the Kendo UI for Angular package you want to use, and are fully described in the section on setting up your Angular project.
Installing the Components
The following command demonstrates an efficient, automated method for adding packages using the Angular CLI through the ng-add
command. This approach saves time and effort by executing a series of commands in a single step, which otherwise need to be run individually. Refer to the Manual Setup for more details.
To add the Kendo UI for Angular Utils package:
-
Run the following command.
shng add @progress/kendo-angular-utils
As a result, the
ng-add
command will perform the following actions:- Add the
@progress/kendo-angular-utils
package as a dependency to thepackage.json
file. - Add all required peer dependencies to the
package.json
file. - Register the Kendo UI Default theme in the
angular.json
file. - Trigger
npm install
to install the theme and all peer packages that are added.
- Add the
-
Import the required components and directives:
-
To add all components from the Utils package, import the
KENDO_UTILS
utility array in your standalone component.tsimport { Component } from '@angular/core'; import { KENDO_UTILS } from '@progress/kendo-angular-utils'; @Component({ standalone: true, selector: 'my-app', imports: [KENDO_UTILS] })
-
To add individual Utility components, import the corresponding utility arrays in your standalone component. See the list of available utility arrays.
For example if you only need the Drag and Drop functionality, import
KENDO_DRAGANDDROP
.tsimport { Component } from '@angular/core'; import { KENDO_DRAGANDDROP } from '@progress/kendo-angular-utils'; @Component({ standalone: true, selector: 'my-app', imports: [KENDO_DRAGANDDROP] })
-
Using the Components
-
After successfully installing the Utils package and importing the required components and directives, add the corresponding directives you need in the
app.component.html
. For example, if you need the DragTarget directive, add the following code:html<div kendoDragTarget> <span class="k-icon k-font-icon k-i-drag-and-drop"></span> Drag me! </div>
-
Build and serve the application by running the following command in the root folder.
shng serve
-
Point your browser to http://localhost:4200 to see the Kendo UI for Angular DragTarget on the page.
Activating Your License Key
As of December 2020, using any of the UI components from the Kendo UI for Angular library requires either a commercial license key or an active trial license key. If your application does not contain a Kendo UI license file, activate your license key.