@progress/kendo-angular-conversational-ui 19.1.1-develop.1 → 19.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (58) hide show
  1. package/ai-prompt/aiprompt.component.d.ts +26 -15
  2. package/ai-prompt/aiprompt.module.d.ts +8 -11
  3. package/ai-prompt/localization/custom-messages.component.d.ts +12 -2
  4. package/ai-prompt/localization/messages.d.ts +9 -9
  5. package/ai-prompt/models/command-execute-event.d.ts +4 -4
  6. package/ai-prompt/models/command.interface.d.ts +4 -4
  7. package/ai-prompt/models/output-rating-change-event.d.ts +4 -4
  8. package/ai-prompt/models/prompt-output.interface.d.ts +8 -8
  9. package/ai-prompt/models/prompt-request-event.d.ts +5 -5
  10. package/ai-prompt/templates/toolbar-actions.template.d.ts +12 -2
  11. package/ai-prompt/views/base-view.d.ts +5 -5
  12. package/ai-prompt/views/command-view.component.d.ts +8 -1
  13. package/ai-prompt/views/custom-view.component.d.ts +11 -1
  14. package/ai-prompt/views/output-view.component.d.ts +8 -1
  15. package/ai-prompt/views/prompt-view.component.d.ts +8 -1
  16. package/chat/api/action.interface.d.ts +7 -8
  17. package/chat/api/attachment.interface.d.ts +8 -10
  18. package/chat/api/execute-action-event.d.ts +6 -4
  19. package/chat/api/message.interface.d.ts +12 -18
  20. package/chat/api/post-message-event.d.ts +4 -5
  21. package/chat/api/user.interface.d.ts +4 -10
  22. package/chat/attachment-template.directive.d.ts +13 -5
  23. package/chat/cards/hero-card.component.d.ts +17 -5
  24. package/chat/chat.component.d.ts +25 -16
  25. package/chat/chat.module.d.ts +5 -5
  26. package/chat/common/models/message-box-options.d.ts +1 -1
  27. package/chat/l10n/custom-messages.component.d.ts +12 -2
  28. package/chat/l10n/messages.d.ts +6 -7
  29. package/chat/message-box.directive.d.ts +13 -3
  30. package/chat/message-template.directive.d.ts +13 -5
  31. package/conversational-ui.module.d.ts +8 -21
  32. package/directives.d.ts +48 -3
  33. package/esm2022/ai-prompt/aiprompt.component.mjs +26 -15
  34. package/esm2022/ai-prompt/aiprompt.module.mjs +8 -11
  35. package/esm2022/ai-prompt/localization/custom-messages.component.mjs +12 -2
  36. package/esm2022/ai-prompt/localization/messages.mjs +9 -9
  37. package/esm2022/ai-prompt/templates/toolbar-actions.template.mjs +12 -2
  38. package/esm2022/ai-prompt/views/base-view.mjs +5 -5
  39. package/esm2022/ai-prompt/views/command-view.component.mjs +8 -1
  40. package/esm2022/ai-prompt/views/custom-view.component.mjs +11 -1
  41. package/esm2022/ai-prompt/views/output-view.component.mjs +8 -1
  42. package/esm2022/ai-prompt/views/prompt-view.component.mjs +8 -1
  43. package/esm2022/chat/api/action.interface.mjs +0 -1
  44. package/esm2022/chat/api/execute-action-event.mjs +6 -4
  45. package/esm2022/chat/api/post-message-event.mjs +4 -5
  46. package/esm2022/chat/attachment-template.directive.mjs +13 -5
  47. package/esm2022/chat/cards/hero-card.component.mjs +17 -5
  48. package/esm2022/chat/chat.component.mjs +25 -16
  49. package/esm2022/chat/chat.module.mjs +5 -5
  50. package/esm2022/chat/l10n/custom-messages.component.mjs +12 -2
  51. package/esm2022/chat/l10n/messages.mjs +6 -7
  52. package/esm2022/chat/message-box.directive.mjs +13 -3
  53. package/esm2022/chat/message-template.directive.mjs +13 -5
  54. package/esm2022/conversational-ui.module.mjs +8 -21
  55. package/esm2022/directives.mjs +48 -3
  56. package/esm2022/package-metadata.mjs +2 -2
  57. package/fesm2022/progress-kendo-angular-conversational-ui.mjs +279 -133
  58. package/package.json +11 -11
@@ -8,22 +8,16 @@ import { SafeUrl } from '@angular/platform-browser';
8
8
  */
9
9
  export interface User {
10
10
  /**
11
- * A unique ID for this user. Typically, the ID is a number. Can also be a string or an object.
11
+ * Sets a unique ID for the user. Usually a number, but can be a string or object.
12
12
  */
13
13
  id: any;
14
14
  /**
15
- * (Optional) The displayed name for the user.
15
+ * Sets the display name for the user.
16
16
  */
17
17
  name?: string;
18
18
  /**
19
- * (Optional) An avatar image for the user. By default, the URLs of the avatar images will be sanitized. To allow unsafe values,
20
- * for example, a blob URI, [mark the value as a `SafeUrl`](https://angular.io/guide/security#bypass-security-apis)
21
- *
22
- * ```ts-no-run
23
- * import { DomSanitizer } from '@angular/platform-browser';
24
- * ...
25
- * const avatarUrl = sanitizer.bypassSecurityTrustUrl('blob.https://example.com');
26
- * ```
19
+ * Sets an avatar image for the user. By default, the URLs are sanitized.
20
+ * To allow unsafe values, such as a blob URI, [mark the value as a `SafeUrl`](https://angular.io/guide/security#bypass-security-apis).
27
21
  */
28
22
  avatarUrl?: string | SafeUrl;
29
23
  }
@@ -5,12 +5,20 @@
5
5
  import { TemplateRef } from "@angular/core";
6
6
  import * as i0 from "@angular/core";
7
7
  /**
8
- * Defines a template that will be used for displaying message attachments. To define an attachment
9
- * template, nest an `<ng-template>` tag with the `kendoChatAttachmentTemplate` attribute inside the
10
- * `<kendo-chat>` component. The template context is set to the attachment instance. For more information,
11
- * refer to the article on [message attachments]({% slug attachments_chat %}).
8
+ * Defines a template for displaying message attachments.
12
9
  *
13
- * <demo metaUrl="conversational-ui/chat/attachments/templates/" height="700"></demo>
10
+ * To define an attachment template, nest an `<ng-template>` tag with the `kendoChatAttachmentTemplate` attribute inside the `<kendo-chat>` component.
11
+ * The template context is set to the attachment instance.
12
+ * For more information, refer to the article on [message attachments](slug:attachments_chat).
13
+ *
14
+ * @example
15
+ * ```html
16
+ * <kendo-chat>
17
+ * <ng-template kendoChatAttachmentTemplate let-attachment>
18
+ * <div>Attachment: {{ attachment.content }}</div>
19
+ * </ng-template>
20
+ * </kendo-chat>
21
+ * ```
14
22
  */
15
23
  export declare class AttachmentTemplateDirective {
16
24
  templateRef: TemplateRef<any>;
@@ -6,24 +6,33 @@ import { EventEmitter } from '@angular/core';
6
6
  import { Action } from '../api/action.interface';
7
7
  import * as i0 from "@angular/core";
8
8
  /**
9
- * Represents a Hero Card component ([see example]({% slug dialogflow_chat %})).
9
+ * Represents a Hero Card component ([see example](slug:dialogflow_chat)).
10
10
  * Hero cards host a single large image and action buttons with text content.
11
+ *
12
+ * @example
13
+ * ```html
14
+ * <kendo-chat-hero-card
15
+ * title="Card Title"
16
+ * subtitle="Card Subtitle"
17
+ * [actions]="actions">
18
+ * </kendo-chat-hero-card>
19
+ * ```
11
20
  */
12
21
  export declare class HeroCardComponent {
13
22
  /**
14
- * The URL of the hero card image.
23
+ * Sets the URL of the hero card image.
15
24
  */
16
25
  imageUrl: string;
17
26
  /**
18
- * The title of the hero card.
27
+ * Sets the title of the hero card.
19
28
  */
20
29
  title: string;
21
30
  /**
22
- * The subtitle of the hero card.
31
+ * Sets the subtitle of the hero card.
23
32
  */
24
33
  subtitle: string;
25
34
  /**
26
- * An array with the possible quick actions for this hero card.
35
+ * Sets the array of quick actions for this hero card.
27
36
  */
28
37
  actions: Action[];
29
38
  cssClass: boolean;
@@ -31,6 +40,9 @@ export declare class HeroCardComponent {
31
40
  * Fires when the user clicks a button.
32
41
  */
33
42
  executeAction: EventEmitter<Action>;
43
+ /**
44
+ * Emits the `executeAction` event when the user clicks an action button.
45
+ */
34
46
  onClick(action: any): void;
35
47
  static ɵfac: i0.ɵɵFactoryDeclaration<HeroCardComponent, never>;
36
48
  static ɵcmp: i0.ɵɵComponentDeclaration<HeroCardComponent, "kendo-chat-hero-card", never, { "imageUrl": { "alias": "imageUrl"; "required": false; }; "title": { "alias": "title"; "required": false; }; "subtitle": { "alias": "subtitle"; "required": false; }; "actions": { "alias": "actions"; "required": false; }; }, { "executeAction": "executeAction"; }, never, never, true, never>;
@@ -12,44 +12,53 @@ import { ChatMessageBoxTemplateDirective } from './message-box.directive';
12
12
  import { MessageBoxComponent } from './message-box.component';
13
13
  import * as i0 from "@angular/core";
14
14
  /**
15
- * Represents the Kendo UI Chat component for Angular.
15
+ * Represents the [Kendo UI Chat component for Angular](slug:overview_convui).
16
16
  *
17
- * <demo metaUrl="conversational-ui/chat/echo/" height="700"></demo>
17
+ * Provides a conversational UI for chat-based applications.
18
+ * Supports message templates, attachments, localization, and user actions.
18
19
  *
20
+ * @example
21
+ * ```html
22
+ * <kendo-chat
23
+ * [messages]="messages"
24
+ * [user]="user"
25
+ * (sendMessage)="onSendMessage($event)"
26
+ * (executeAction)="onExecuteAction($event)">
27
+ * </kendo-chat>
28
+ * ```
19
29
  */
20
30
  export declare class ChatComponent implements AfterViewInit, OnDestroy {
21
31
  private localization;
22
32
  private zone;
23
33
  /**
24
- * Sets the messages of the Chat.
25
- * The message timestamp, if provided, tracks unique messages.
34
+ * Defines the array of messages displayed in the Chat.
35
+ * Each message can include a timestamp for unique identification.
26
36
  * For more information, refer to [ngFor - Change Tracking](link:site.data.urls.angular['ngforof']#change-propagation).
27
37
  */
28
38
  messages: Message[];
29
39
  /**
30
- * Sets the [`User`]({% slug api_conversational-ui_user %}) instance for the local user.
31
- * The User ID identifies messages that are authored by the local user.
40
+ * Specifies the [`User`](slug:api_conversational-ui_user) instance representing the local user.
41
+ * The User ID is used to distinguish messages authored by the local user.
32
42
  */
33
43
  user: User;
34
44
  /**
35
- * Used to switch between a one-liner input or a textarea.
36
- * ([see example]({% slug message_box %})#toc-message-box-types).
37
- * @default input
45
+ * Determines the type of input used in the message box.
46
+ * Can be set to `textbox` for a single-line input or `textarea` for multi-line input
47
+ * ([see example](slug:message_box#message-box-types)).
48
+ * @default 'textbox'
38
49
  */
39
50
  messageBoxType: MessageBoxType;
40
51
  /**
41
- * Fires when the user types a message and clicks the **Send** button or presses **Enter**.
42
- * Emits the [`SendMessageEvent`]({% slug api_conversational-ui_sendmessageevent %}).
52
+ * Emits when the user sends a message by clicking the **Send** button or pressing **Enter**.
43
53
  *
44
- * > The message is not automatically appended to the `messages` array.
54
+ * > The message is not automatically added to the `messages` array.
45
55
  */
46
56
  sendMessage: EventEmitter<SendMessageEvent>;
47
57
  /**
48
- * Fires when the user clicks a quick action button.
49
- * The Chat internally handles the `reply`, `openUrl`, and `call` [known actions]({% slug api_conversational-ui_actiontype %}).
58
+ * Emits when the user clicks a quick action button.
59
+ * The Chat internally handles [known actions](slug:api_conversational-ui_actiontype) such as `reply`, `openUrl`, and `call`.
50
60
  *
51
- * Emits the [`ExecuteActionEvent`]({% slug api_conversational-ui_executeactionevent %}).
52
- * The event is preventable. If `preventDefault` is called, the built-in action will be suppressed.
61
+ * The event is preventable&mdash;calling `preventDefault` suppresses the built-in action.
53
62
  */
54
63
  executeAction: EventEmitter<ExecuteActionEvent>;
55
64
  get className(): string;
@@ -10,7 +10,7 @@ import * as i4 from "./message-template.directive";
10
10
  import * as i5 from "./cards/hero-card.component";
11
11
  import * as i6 from "./message-box.directive";
12
12
  /**
13
- * The [NgModule](link:site.data.urls.angular['ngmodules']) for the Chat component.
13
+ * Represents the [`NgModule`](link:site.data.urls.angular['ngmodules']) for the Chat component.
14
14
  *
15
15
  * @example
16
16
  * ```ts-no-run
@@ -19,12 +19,12 @@ import * as i6 from "./message-box.directive";
19
19
  * import { BrowserModule } from '@angular/platform-browser';
20
20
  *
21
21
  * import { ChatModule } from '@progress/kendo-angular-conversational-ui';
22
- * import { AppComponent } from './app.component';
22
+ * import { AppComponent } from './app.component';
23
23
  *
24
24
  * _@NgModule({
25
- * imports: [ BrowserModule, ChatModule ],
26
- * declarations: [ AppComponent ],
27
- * bootstrap: [ AppComponent ]
25
+ * imports: [BrowserModule, ChatModule],
26
+ * declarations: [AppComponent],
27
+ * bootstrap: [AppComponent]
28
28
  * })
29
29
  *
30
30
  * export class AppModule { }
@@ -3,6 +3,6 @@
3
3
  * Licensed under commercial license. See LICENSE.md in the project root for more information
4
4
  *-------------------------------------------------------------------------------------------*/
5
5
  /**
6
- * Represents the possible message box options of the Conversational UI.
6
+ * Represents the possible message box options for the Chat component.
7
7
  */
8
8
  export type MessageBoxType = 'textarea' | 'textbox';
@@ -6,8 +6,18 @@ import { LocalizationService } from '@progress/kendo-angular-l10n';
6
6
  import { Messages } from './messages';
7
7
  import * as i0 from "@angular/core";
8
8
  /**
9
- * Custom component messages override default component messages
10
- * ([see example]({% slug globalization_chat %}#toc-custom-messages)).
9
+ * Represents the custom messages component of the Chat.
10
+ *
11
+ * Use this component to override default messages for the Chat
12
+ * ([see example](slug:globalization_chat#custom-messages)).
13
+ *
14
+ * @example
15
+ * ```html
16
+ * <kendo-chat-messages
17
+ * send="Send Message"
18
+ * messagePlaceholder="Type here...">
19
+ * </kendo-chat-messages>
20
+ * ```
11
21
  */
12
22
  export declare class CustomMessagesComponent extends Messages {
13
23
  protected service: LocalizationService;
@@ -9,7 +9,7 @@ import * as i0 from "@angular/core";
9
9
  */
10
10
  export declare class Messages extends ComponentMessages {
11
11
  /**
12
- * Sets the placeholder text of the message text input.
12
+ * Sets the placeholder text for the message text input.
13
13
  */
14
14
  messagePlaceholder: string;
15
15
  /**
@@ -17,24 +17,23 @@ export declare class Messages extends ComponentMessages {
17
17
  */
18
18
  send: string;
19
19
  /**
20
- * The label for the Message list.
20
+ * Sets the label for the message list.
21
21
  */
22
22
  messageListLabel: string;
23
23
  /**
24
- * The label for the Message input box.
25
- *
24
+ * Sets the label for the message input box.
26
25
  */
27
26
  messageBoxInputLabel: string;
28
27
  /**
29
- * The text for the left arrow of the message attachments.
28
+ * Sets the text for the left arrow of the message attachments.
30
29
  */
31
30
  messageAttachmentLeftArrow: string;
32
31
  /**
33
- * The text for the right arrow of the message attachments.
32
+ * Sets the text for the right arrow of the message attachments.
34
33
  */
35
34
  messageAttachmentRightArrow: string;
36
35
  /**
37
- * The alt attribute text for the avatar image.
36
+ * Sets the `alt` attribute text for the avatar image.
38
37
  */
39
38
  messageAvatarAlt: string;
40
39
  static ɵfac: i0.ɵɵFactoryDeclaration<Messages, never>;
@@ -5,9 +5,19 @@
5
5
  import { TemplateRef } from '@angular/core';
6
6
  import * as i0 from "@angular/core";
7
7
  /**
8
- * Creates a message box area that overrides the default message box of the Conversational UI Component.
9
- * To define a message-box template, nest an `<ng-template>` tag with the `kendoChatMessageBoxTemplate` directive inside the `<kendo-chat>` tag
10
- * [see example]({% slug message_box %}#toc-message-box-template).
8
+ * Creates a message box area that overrides the default message box of the Chat component.
9
+ *
10
+ * To define a message box template, nest an `<ng-template>` tag with the `kendoChatMessageBoxTemplate` directive inside the `<kendo-chat>` tag.
11
+ * For more information, see [Message Box Template](slug:message_box#toc-message-box-template).
12
+ *
13
+ * @example
14
+ * ```html
15
+ * <kendo-chat>
16
+ * <ng-template kendoChatMessageBoxTemplate>
17
+ * <input type="text" placeholder="Custom message box..." />
18
+ * </ng-template>
19
+ * </kendo-chat>
20
+ * ```
11
21
  */
12
22
  export declare class ChatMessageBoxTemplateDirective {
13
23
  templateRef: TemplateRef<any>;
@@ -5,12 +5,20 @@
5
5
  import { TemplateRef } from "@angular/core";
6
6
  import * as i0 from "@angular/core";
7
7
  /**
8
- * Defines a template that will be used for displaying Chat messages. To define an attachment
9
- * template, nest an `<ng-template>` tag with the `kendoChatMessageTemplate` attribute inside the
10
- * `<kendo-chat>` component. The template context is set to the message instance. For more information,
11
- * refer to the article on [message templates]({% slug message_templates_chat %}).
8
+ * Defines a template for displaying Chat messages.
12
9
  *
13
- * <demo metaUrl="conversational-ui/chat/messages/templates/" height="700"></demo>
10
+ * To define a message template, nest an `<ng-template>` tag with the `kendoChatMessageTemplate` directive inside the `<kendo-chat>` component.
11
+ * The template context is set to the `message` instance.
12
+ * For more information, refer to the article on [message templates](slug:message_templates_chat).
13
+ *
14
+ * @example
15
+ * ```html
16
+ * <kendo-chat>
17
+ * <ng-template kendoChatMessageTemplate let-message>
18
+ * <div>Message: {{ message.text }}</div>
19
+ * </ng-template>
20
+ * </kendo-chat>
21
+ * ```
14
22
  */
15
23
  export declare class MessageTemplateDirective {
16
24
  templateRef: TemplateRef<any>;
@@ -18,34 +18,21 @@ import * as i12 from "./chat/message-template.directive";
18
18
  import * as i13 from "./chat/cards/hero-card.component";
19
19
  import * as i14 from "./chat/message-box.directive";
20
20
  /**
21
- * Represents the [NgModule](link:site.data.urls.angular['ngmodules'])
22
- * definition for the Conversational UI components.
21
+ * Represents the [`NgModule`](link:site.data.urls.angular['ngmodules']) for the Conversational UI components.
23
22
  *
24
23
  * @example
25
- *
26
- * ```ts-no-run
27
- * // Import the Conversational UI module
28
- * import { ConversationalUIModule } from '@progress/kendo-angular-conversational-ui';
29
- *
30
- * // The browser platform with a compiler
31
- * import { platformBrowserDynamic } from '@angular/platform-browser-dynamic';
32
- *
24
+ * ```ts
33
25
  * import { NgModule } from '@angular/core';
34
- *
35
- * // Import the app component
26
+ * import { BrowserModule } from '@angular/platform-browser';
27
+ * import { ConversationalUIModule } from '@progress/kendo-angular-conversational-ui';
36
28
  * import { AppComponent } from './app.component';
37
29
  *
38
- * // Define the app module
39
- * _@NgModule({
40
- * declarations: [AppComponent], // declare app component
41
- * imports: [BrowserModule, ConversationalUIModule], // import Conversational UI module
42
- * bootstrap: [AppComponent]
30
+ * @NgModule({
31
+ * declarations: [AppComponent],
32
+ * imports: [BrowserModule, ConversationalUIModule],
33
+ * bootstrap: [AppComponent]
43
34
  * })
44
35
  * export class AppModule {}
45
- *
46
- * // Compile and launch the module
47
- * platformBrowserDynamic().bootstrapModule(AppModule);
48
- *
49
36
  * ```
50
37
  */
51
38
  export declare class ConversationalUIModule {
package/directives.d.ts CHANGED
@@ -16,14 +16,59 @@ import { MessageTemplateDirective } from "./chat/message-template.directive";
16
16
  import { HeroCardComponent } from "./chat/cards/hero-card.component";
17
17
  import { ChatMessageBoxTemplateDirective } from "./chat/message-box.directive";
18
18
  /**
19
- * Utility array that contains all `AIPrompt` related components and directives
19
+ * Utility array that contains all AIPrompt related components and directives.
20
+ *
21
+ * @example
22
+ * ```ts
23
+ * import { Component } from '@angular/core';
24
+ * import { KENDO_AIPROMPT } from '@progress/kendo-angular-conversational-ui';
25
+ *
26
+ * @Component({
27
+ * standalone: true,
28
+ * imports: [KENDO_AIPROMPT],
29
+ * selector: 'my-app',
30
+ * template: `<kendo-aiprompt></kendo-aiprompt>`
31
+ * })
32
+ * export class AppComponent {}
33
+ * ```
20
34
  */
21
35
  export declare const KENDO_AIPROMPT: readonly [typeof AIPromptComponent, typeof PromptViewComponent, typeof OutputViewComponent, typeof CommandViewComponent, typeof CustomViewComponent, typeof AIPromptCustomMessagesComponent, typeof AIPromptToolbarActionsDirective, typeof AIPromptToolbarFocusableDirective];
22
36
  /**
23
- * Utility array that contains all `Chat` related components and directives
37
+ * Utility array that contains all Chat related components and directives.
38
+ *
39
+ * @example
40
+ * ```ts
41
+ * import { Component } from '@angular/core';
42
+ * import { KENDO_CHAT } from '@progress/kendo-angular-conversational-ui';
43
+ *
44
+ * @Component({
45
+ * standalone: true,
46
+ * imports: [KENDO_CHAT],
47
+ * selector: 'my-app',
48
+ * template: `<kendo-chat></kendo-chat>`
49
+ * })
50
+ * export class AppComponent {}
51
+ * ```
24
52
  */
25
53
  export declare const KENDO_CHAT: readonly [typeof ChatComponent, typeof CustomMessagesComponent, typeof AttachmentTemplateDirective, typeof MessageTemplateDirective, typeof HeroCardComponent, typeof ChatMessageBoxTemplateDirective];
26
54
  /**
27
- * Utility array that contains all `@progress/kendo-angular-conversational-ui` related components and directives
55
+ * Utility array that contains all `@progress/kendo-angular-conversational-ui` related components and directives.
56
+ *
57
+ * @example
58
+ * ```ts
59
+ * import { Component } from '@angular/core';
60
+ * import { KENDO_CONVERSATIONALUI } from '@progress/kendo-angular-conversational-ui';
61
+ *
62
+ * @Component({
63
+ * standalone: true,
64
+ * imports: [KENDO_CONVERSATIONALUI],
65
+ * selector: 'my-app',
66
+ * template: `
67
+ * <kendo-aiprompt></kendo-aiprompt>
68
+ * <kendo-chat></kendo-chat>
69
+ * `
70
+ * })
71
+ * export class AppComponent {}
72
+ * ```
28
73
  */
29
74
  export declare const KENDO_CONVERSATIONALUI: readonly [typeof AIPromptComponent, typeof PromptViewComponent, typeof OutputViewComponent, typeof CommandViewComponent, typeof CustomViewComponent, typeof AIPromptCustomMessagesComponent, typeof AIPromptToolbarActionsDirective, typeof AIPromptToolbarFocusableDirective, typeof ChatComponent, typeof CustomMessagesComponent, typeof AttachmentTemplateDirective, typeof MessageTemplateDirective, typeof HeroCardComponent, typeof ChatMessageBoxTemplateDirective];
@@ -21,7 +21,18 @@ import * as i1 from "@progress/kendo-angular-l10n";
21
21
  import * as i2 from "./common/aiprompt.service";
22
22
  import * as i3 from "./common/toolbar-navigation.service";
23
23
  /**
24
- * Represents the Kendo UI AIPrompt component for Angular.
24
+ * Represents the [Kendo UI AIPrompt component for Angular](slug:overview_aiprompt).
25
+ *
26
+ * @example
27
+ * ```html
28
+ * <kendo-aiprompt
29
+ * [promptCommands]="commands"
30
+ * [promptSuggestions]="suggestions"
31
+ * [promptOutputs]="outputs"
32
+ * [showOutputRating]="true"
33
+ * (promptRequest)="onPromptRequest($event)">
34
+ * </kendo-aiprompt>
35
+ * ```
25
36
  */
26
37
  export class AIPromptComponent {
27
38
  localization;
@@ -64,52 +75,52 @@ export class AIPromptComponent {
64
75
  return this._activeView;
65
76
  }
66
77
  /**
67
- * The collection of commands that will be rendered in the Command view.
78
+ * Sets the collection of commands to render in the **Command** view.
68
79
  */
69
80
  set promptCommands(value) {
70
81
  this.service.promptCommands = value;
71
82
  }
72
83
  /**
73
- * The collection of suggestions that will be rendered in the Prompt view.
84
+ * Sets the collection of suggestions to render in the **Prompt** view.
74
85
  */
75
86
  set promptSuggestions(value) {
76
87
  this.service.promptSuggestions = value;
77
88
  }
78
89
  /**
79
- * The collection of generated prompt outputs that will be rendered in the Output view.
90
+ * Sets the collection of generated prompt outputs to render in the **Output** view.
80
91
  */
81
92
  set promptOutputs(value) {
82
93
  this.service.promptOutputs = value;
83
94
  }
84
95
  /**
85
- * Specifies if the rating buttons in each Output view card will be rendered.
86
- * By default, rating buttons are not rendered.
87
- *
96
+ * Specifies if the rating buttons appear in each **Output** view card.
97
+ * By default, the rating buttons do not appear.
88
98
  * @default false
89
99
  */
90
100
  set showOutputRating(value) {
91
101
  this.service.showOutputRating = value;
92
102
  }
93
103
  /**
94
- * Fires when the `activeView` property of the component is updated.
95
- * Used to provide a two-way binding for the `activeView` property.
104
+ * Fires when the `activeView` property is updated.
105
+ * Use this event for two-way binding of the `activeView` property.
96
106
  */
97
107
  activeViewChange = new EventEmitter();
98
108
  /**
99
- * Fires each time the user clicks the Prompt view Generate button or the Output view Retry button.
100
- * To distinguish the source element, use the event's `isRetry` field.
109
+ * Fires when the user clicks the **Generate** button in the **Prompt** view or the **Retry** button in the **Output** view.
110
+ * Use the event's `isRetry` field to determine the source element.
101
111
  */
102
112
  promptRequest = new EventEmitter();
103
113
  /**
104
- * Fires each time the user clicks a Command view command. Exposes the selected command as event data.
114
+ * Fires when the user clicks a **Command** view command.
115
+ * The event data contains the selected command.
105
116
  */
106
117
  commandExecute = new EventEmitter();
107
118
  /**
108
- * Fires each time the user clicks any Output view Copy button.
119
+ * Fires when the user clicks a **Copy** button in any **Output** view card.
109
120
  */
110
121
  outputCopy = new EventEmitter();
111
122
  /**
112
- * Fires each time the user clicks a rating button in any Output view card.
123
+ * Fires when the user clicks a rating button in any **Output** view card.
113
124
  */
114
125
  outputRatingChange = new EventEmitter();
115
126
  ngAfterViewInit() {
@@ -125,7 +136,7 @@ export class AIPromptComponent {
125
136
  this.subs.unsubscribe();
126
137
  }
127
138
  /**
128
- * Focuses the first focusable element in the AIPrompt.
139
+ * Focuses the first focusable element in the AIPrompt component.
129
140
  */
130
141
  focus() {
131
142
  this.navigationService.focusFirst();
@@ -19,24 +19,21 @@ import * as i7 from "./templates/toolbar-actions.template";
19
19
  import * as i8 from "./common/toolbar-focusable.directive";
20
20
  // IMPORTANT: NgModule export kept for backwards compatibility
21
21
  /**
22
- * The [NgModule](link:site.data.urls.angular['ngmodules']) for the AIPrompt component.
22
+ * Represents the [`NgModule`](link:site.data.urls.angular['ngmodules']) for the AIPrompt component.
23
23
  *
24
24
  * @example
25
- * ```ts-no-run
25
+ * ```ts
26
26
  * import { NgModule } from '@angular/core';
27
- * import { Component } from '@angular/core';
28
27
  * import { BrowserModule } from '@angular/platform-browser';
29
- *
30
28
  * import { AIPromptModule } from '@progress/kendo-angular-conversational-ui';
31
- * import { AppComponent } from './app.component';
29
+ * import { AppComponent } from './app.component';
32
30
  *
33
- * _@NgModule({
34
- * imports: [ BrowserModule, AIPromptModule ],
35
- * declarations: [ AppComponent ],
36
- * bootstrap: [ AppComponent ]
31
+ * @NgModule({
32
+ * imports: [BrowserModule, AIPromptModule],
33
+ * declarations: [AppComponent],
34
+ * bootstrap: [AppComponent]
37
35
  * })
38
- *
39
- * export class AppModule { }
36
+ * export class AppModule {}
40
37
  * ```
41
38
  */
42
39
  export class AIPromptModule {
@@ -8,8 +8,18 @@ import { Messages } from './messages';
8
8
  import * as i0 from "@angular/core";
9
9
  import * as i1 from "@progress/kendo-angular-l10n";
10
10
  /**
11
- * Custom component messages override the default component messages.
12
- * ([see example]({% slug globalization_chat %}#toc-custom-messages)).
11
+ * Represents the custom messages component of the AIPrompt.
12
+ *
13
+ * Use this component to override default messages for the AIPrompt
14
+ * ([see example](slug:globalization_chat#custom-messages)).
15
+ *
16
+ * @example
17
+ * ```html
18
+ * <kendo-aiprompt-messages
19
+ * promptView="My prompt view"
20
+ * outputView="My output view">
21
+ * </kendo-aiprompt-messages>
22
+ * ```
13
23
  */
14
24
  export class AIPromptCustomMessagesComponent extends Messages {
15
25
  service;
@@ -10,39 +10,39 @@ import * as i0 from "@angular/core";
10
10
  */
11
11
  export class Messages extends ComponentMessages {
12
12
  /**
13
- * The Toolbar button text for the Prompt view.
13
+ * Sets the Toolbar button text for the **Prompt** view.
14
14
  */
15
15
  promptView;
16
16
  /**
17
- * The Toolbar button text for the Output view.
17
+ * Sets the Toolbar button text for the **Output** view.
18
18
  */
19
19
  outputView;
20
20
  /**
21
- * The text for the Generate button in the Prompt view.
21
+ * Sets the text for the **Generate** button in the **Prompt** view.
22
22
  */
23
23
  generateOutput;
24
24
  /**
25
- * The placeholder text for the Prompt View text area.
25
+ * Sets the placeholder text for the **Prompt** view text area.
26
26
  */
27
27
  promptPlaceholder;
28
28
  /**
29
- * The Copy button text in each Output view card.
29
+ * Sets the text for the **Copy** button text in each **Output** view card.
30
30
  */
31
31
  copyOutput;
32
32
  /**
33
- * The Retry button text in each Output view card.
33
+ * Sets the **Retry** button text in each **Output** view card.
34
34
  */
35
35
  retryGeneration;
36
36
  /**
37
- * The title of each Output view card.
37
+ * Sets the title of each card in the **Output** view.
38
38
  */
39
39
  outputTitle;
40
40
  /**
41
- * The title of each Output view retry card.
41
+ * Sets the title of each retry card in the **Output** view.
42
42
  */
43
43
  outputRetryTitle;
44
44
  /**
45
- * The title of the Prompt suggestions button.
45
+ * Sets the title of the **Prompt suggestions** button.
46
46
  */
47
47
  promptSuggestions;
48
48
  static ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "16.2.12", ngImport: i0, type: Messages, deps: null, target: i0.ɵɵFactoryTarget.Directive });