Getting Started with the Kendo UI for Angular Conversational UI
This guide provides the information you need to start using the Kendo UI for Angular Conversational UI—it includes instructions about the recommended installation approach, the code for running the project, and links to additional resources.
As of version
17.0.0, Angular makes standalone component enabled by default. If you useNgModules, refer to these articles:
The standalone components in Angular streamline development by removing the need for NgModules, reducing complexity, and enhancing component reuse and modularity. This approach simplifies dependency management, making applications more maintainable and scalable.
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 Conversational UI package:
-
Run the following command.
shng add @progress/kendo-angular-conversational-uiAs a result, the
ng-addcommand will perform the following actions:- Add the
@progress/kendo-angular-conversational-uipackage as a dependency to thepackage.jsonfile. - Add all required peer dependencies to the
package.jsonfile. - Register the Kendo UI Default theme in the
angular.jsonfile. - Trigger
npm installto install the theme and all peer packages that are added.
- Add the
-
Import the required components, directives and utility arrays:
The utility arrays are available starting from
v16.6.0. If you use an older version of the package, please follow the approach from the Using Kendo Angular Components with NgModules article.-
To add all components from the Conversational UI package, import the
KENDO_CONVERSATIONALUIutility array in your standalone component.tsimport { Component } from '@angular/core'; import { KENDO_CONVERSATIONALUI } from '@progress/kendo-angular-conversational-ui'; @Component({ standalone: true, selector: 'my-app', imports: [KENDO_CONVERSATIONALUI] }) -
To add individual Conversational UI components, import the corresponding utility arrays in your standalone component. See the list of available utility arrays.
For example if you only need the AIPrompt component, import
KENDO_AIPROMPT.tsimport { Component } from '@angular/core'; import { KENDO_AIPROMPT } from '@progress/kendo-angular-conversational-ui'; @Component({ standalone: true, selector: 'my-app', imports: [KENDO_AIPROMPT] })
-
Using the Components
-
After successfully installing the Conversational UI package and importing the required components and directives, add the corresponding tags of the components you need in the
app.component.html. For example, if you need the Chat component, add the following code.html<kendo-chat [user]="user" [messages]="messages" (sendMessage)="sendMessage($event)" > </kendo-chat> -
Bind the
userproperty to an instance for the local user. TheUserid identifies messages that are authored by the local user:tspublic user: User = { id: 1 }; -
Bind the
messagesoption to a set of Chat messages:tspublic bot: User = { id: 0 }; public messages: Message[] = [ { author: this.bot, text: 'Do you like Angular?' }, { author: this.user, text: 'Definitely!', } ]; -
Handle the
sendMessageevent and update the collection of messages:tspublic sendMessage(e: SendMessageEvent): void { this.messages = [...this.messages, e.message]; } -
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 Chat 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.