Getting Started with the Kendo UI for Angular Inputs
This guide provides the information you need to start using the Kendo UI for Angular Inputs—it includes instructions about the available installation approaches, the required dependencies, the code for running the project, and links to additional resources.
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
You can choose to use either of the following two approaches for installing the Kendo UI for Angular package and the styles you want to apply:
Quick Setup with Angular CLI
The quick setup presents an automatic approach for adding packages with Angular CLI through the ng-add
command. It is suitable for saving time and efforts as ng-add
executes in a single step a set of otherwise individually needed commands.
To add the Kendo UI for Angular Inputs package, run the following command:
ng add @progress/kendo-angular-inputs
As a result, the ng-add
command will perform the following actions:
- Add the
@progress/kendo-angular-inputs
package as a dependency to thepackage.json
file. - Import the
InputsModule
in the current application module. - Register the Kendo UI Default theme in the
angular.json
file. - Add all required peer dependencies to the
package.json
file. - Trigger
npm install
to install the theme and all peer packages that are added.
Manual Setup
The manual setup provides greater visibility and better control over the files and references installed in your Angular application. You can install the required peer dependencies and a Kendo UI theme by running separate commands for each step and import the desired component modules in your NgModule
.
-
Install the Inputs package together with its dependencies by running the following command:
npm install --save @progress/kendo-angular-inputs @progress/kendo-angular-intl @progress/kendo-angular-l10n @progress/kendo-angular-common @progress/kendo-angular-popup @progress/kendo-angular-dialog @progress/kendo-angular-buttons @progress/kendo-drawing @progress/kendo-licensing @progress/kendo-angular-icons
-
If you need all Inputs components in your application, import all Inputs at once by using the
InputsModule
. Otherwise import the specific components by adding their individual modules.The Inputs package exports the following individual modules for its components:
Module Component CheckBoxModule CheckBox ColorPickerModule ColorPicker, ColorGradient, and ColorPalette FormFieldModule FormField MaskedTextBoxModule MaskedTextBox NumericTextBoxModule NumericTextBox RadioButtonModule RadioButton RangeSliderModule RangeSlider SignatureModule Signature SliderModule Slider SwitchModule Switch TextAreaModule TextArea TextBoxModule TextBox and TextBoxDirective Depending on your Angular application, import the Inputs either into your
NgModule
or standalone component:-
Using Modules
-
To add all Inputs components, import the
InputsModule
in yourNgModule
.import { NgModule } from '@angular/core'; import { BrowserModule } from '@angular/platform-browser'; import { BrowserAnimationsModule } from '@angular/platform-browser/animations'; import { InputsModule } from '@progress/kendo-angular-inputs'; import { AppComponent } from './app.component'; @NgModule({ bootstrap: [AppComponent], declarations: [AppComponent], imports: [BrowserModule, BrowserAnimationsModule, InputsModule] }) export class AppModule { }
-
To add individual Inputs components, import only the modules you need in your
NgModule
.import { NgModule } from '@angular/core'; import { BrowserModule } from '@angular/platform-browser'; import { BrowserAnimationsModule } from '@angular/platform-browser/animations'; // Imports the TextBox module import { TextBoxModule } from '@progress/kendo-angular-inputs'; @NgModule({ bootstrap: [AppComponent], imports: [ BrowserModule, BrowserAnimationsModule, TextBoxModule] }) export class AppModule { }
-
-
Using Standalone Components
-
To add all Inputs components, import
InputsModule
in your standalone component.import { Component } from '@angular/core'; import { InputsModule } from '@progress/kendo-angular-inputs'; @Component({ standalone: true, selector: 'my-app', imports: [InputsModule], template: ` <kendo-colorpicker></kendo-colorpicker> ` })
-
To add individual Inputs components, import only the modules you need in your standalone component.
import { Component } from '@angular/core'; import { InputsModule } from '@progress/kendo-angular-inputs'; @Component({ standalone: true, selector: 'my-app', imports: [TextBoxModule], template: ` <kendo-textbox></kendo-textbox> ` })
-
-
-
The next step is to style the components by installing one of the available Kendo UI themes—Kendo UI Default, Kendo UI Material, or Kendo UI Bootstrap.
3.1 To start using a theme, install its package through NPM.
-
Default theme
npm install --save @progress/kendo-theme-default
-
Bootstrap theme
npm install --save @progress/kendo-theme-bootstrap
-
Material theme
npm install --save @progress/kendo-theme-material
3.2 After the theme package is installed, reference it in your project. You can include a Kendo UI theme in your project in one of the following ways:
- By using an external (CDN) link.
- By using a precompiled CSS file.
- By compiling the theme from the SCSS source files.
-
Using the Components
-
After successfully installing the Inputs package and importing the desired modules, add the corresponding tags of the components you need in the
app.component.html
. For example, if you need the ColorPicker component, add the following code:<kendo-colorpicker> </kendo-colorpicker>
-
Build and serve the application by running the following command in the root folder.
ng serve
-
Point your browser to http://localhost:4200 to see the Kendo UI for Angular ColorPicker component 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.
Next Steps
- CheckBox Overview
- ColorGradient Overview
- ColorPalette Overview
- ColorPicker Overview
- FlatColorPicker Overview
- FormField Overview
- MaskedTextBox Overview
- NumericTextBox Overview
- RadioButton Overview
- RangeSlider Overview
- Signature Overview
- Slider Overview
- Switch Overview
- TextArea Overview
- TextBox Overview
- Globalization
- Inputs API Documentation
Dependencies
The following table lists the specific functionalities that are provided by each of the Inputs dependencies as per package:
Package Name | Description |
---|---|
@angular/common | Provides the commonly-needed services, pipes, and directives provided by the Angular team. For more information, refer to the official Angular documentation. |
@angular/core | Contains critical runtime parts of the Angular framework that are needed by every application. For more information, refer to the official Angular documentation. |
@angular/forms | Provides support for both template-driven and reactive forms. For more information, refer to the official Angular documentation. |
@angular/animations | Contains the library of Angular animations. For more information, refer to the official Angular documentation. |
@progress/kendo-angular-buttons | Contains the Kendo UI for Angular Button component. |
@progress/kendo-angular-common | Contains common utilities that are needed by every Kendo UI for Angular component. |
@progress/kendo-angular-dialog | Contains the Kendo UI for Angular Dialog component. |
@progress/kendo-angular-l10n | Provides the globalization features of Kendo UI for Angular. |
@progress/kendo-angular-icons | Contains the Kendo UI for Angular Icons. |
@progress/kendo-angular-intl | Provides the Kendo UI for Angular services and pipes for the parsing and formatting of dates and numbers. |
@progress/kendo-angular-popup | Contains the Kendo UI for Angular Popup component. |
@progress/kendo-drawing | Provides the Kendo UI cross-browser library for interactive vector graphics. |
@progress/kendo-licensing | Contains the kendo-ui-license CLI utility for license management and the internal infrastructure related to licensing. |
rxjs | Provides the RxJS library for reactive programming which uses Observables for an easier composition of asynchronous or callback-based code. |