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

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 (35) hide show
  1. package/chat/api/post-message-event.d.ts +1 -2
  2. package/chat/cards/hero-card.component.d.ts +1 -1
  3. package/chat/chat.component.d.ts +15 -17
  4. package/chat/common/models/message-box-options.d.ts +1 -0
  5. package/chat/l10n/messages.d.ts +9 -9
  6. package/chat/templates/attachment-template.directive.d.ts +5 -1
  7. package/chat/templates/suggestion-template.directive.d.ts +5 -2
  8. package/chat/templates/timestamp-template.directive.d.ts +4 -1
  9. package/esm2022/chat/api/post-message-event.mjs +1 -2
  10. package/esm2022/chat/cards/hero-card.component.mjs +1 -1
  11. package/esm2022/chat/chat.component.mjs +15 -17
  12. package/esm2022/chat/l10n/messages.mjs +9 -9
  13. package/esm2022/chat/templates/attachment-template.directive.mjs +5 -1
  14. package/esm2022/chat/templates/suggestion-template.directive.mjs +5 -2
  15. package/esm2022/chat/templates/timestamp-template.directive.mjs +4 -1
  16. package/esm2022/inline-ai-prompt/inlineaiprompt.component.mjs +18 -16
  17. package/esm2022/inline-ai-prompt/inlineaiprompt.service.mjs +17 -10
  18. package/esm2022/inline-ai-prompt/localization/custom-messages.component.mjs +1 -3
  19. package/esm2022/inline-ai-prompt/localization/messages.mjs +3 -3
  20. package/esm2022/inline-ai-prompt/models/inlineaiprompt-settings.mjs +5 -5
  21. package/esm2022/package-metadata.mjs +2 -2
  22. package/fesm2022/progress-kendo-angular-conversational-ui.mjs +86 -72
  23. package/inline-ai-prompt/inlineaiprompt.component.d.ts +18 -16
  24. package/inline-ai-prompt/inlineaiprompt.service.d.ts +17 -10
  25. package/inline-ai-prompt/localization/custom-messages.component.d.ts +1 -3
  26. package/inline-ai-prompt/localization/messages.d.ts +3 -3
  27. package/inline-ai-prompt/models/command.interface.d.ts +8 -8
  28. package/inline-ai-prompt/models/inlineaiprompt-popupsettings.d.ts +1 -1
  29. package/inline-ai-prompt/models/inlineaiprompt-settings.d.ts +5 -5
  30. package/inline-ai-prompt/models/messages.d.ts +3 -3
  31. package/inline-ai-prompt/models/output-action-click-event.d.ts +2 -2
  32. package/inline-ai-prompt/models/output-action.interface.d.ts +10 -11
  33. package/inline-ai-prompt/models/prompt-output.interface.d.ts +5 -5
  34. package/inline-ai-prompt/models/prompt-request-event.d.ts +3 -3
  35. package/package.json +14 -14
@@ -10,8 +10,7 @@ export declare class SendMessageEvent {
10
10
  /**
11
11
  * Represents the message that contains the metadata and user input.
12
12
  *
13
- * > The Chat does not automatically add the message to its data.
14
- * > For more information, see [Data Binding](slug:databinding_chat).
13
+ * The Chat does not automatically add the message to its data. For more information, see [Data Binding](slug:databinding_chat).
15
14
  */
16
15
  message: Message;
17
16
  /**
@@ -7,7 +7,7 @@ import { Action } from '../api/action.interface';
7
7
  import * as i0 from "@angular/core";
8
8
  /**
9
9
  * Represents a Hero Card component.
10
- * Hero cards host a single large image and action buttons with text content.
10
+ * Hero cards display a single large image and action buttons with text content.
11
11
  *
12
12
  * @example
13
13
  * ```html
@@ -51,7 +51,7 @@ export declare class ChatComponent implements OnInit, AfterViewInit, OnDestroy {
51
51
  /**
52
52
  * Defines the array of messages displayed in the Chat.
53
53
  * Each message can include a timestamp for unique identification.
54
- * For more information, refer to [ngFor - Change Tracking](link:site.data.urls.angular['ngforof']#change-propagation).
54
+ * For more information, see [ngFor - Change Tracking](link:site.data.urls.angular['ngforof']#change-propagation).
55
55
  */
56
56
  messages: Message[];
57
57
  /**
@@ -68,13 +68,13 @@ export declare class ChatComponent implements OnInit, AfterViewInit, OnDestroy {
68
68
  messageBoxType: MessageBoxType;
69
69
  /**
70
70
  * Sets the height of the Chat component.
71
- * Accepts a string with CSS units (e.g., '400px', '50%') or a number (interpreted as pixels).
71
+ * Accepts a string with CSS units (for example, `'400px'`, `'50%'`) or a number (interpreted as pixels).
72
72
  * The minimum height is `600px`.
73
73
  */
74
74
  height: string | number;
75
75
  /**
76
76
  * Sets the width of the Chat component.
77
- * Accepts a string with CSS units (e.g., '400px', '50%') or a number (interpreted as pixels).
77
+ * Accepts a string with CSS units (for example, `'400px'`, `'50%'`) or a number (interpreted as pixels).
78
78
  * The minimum width is `320px`.
79
79
  */
80
80
  width: string | number;
@@ -89,9 +89,8 @@ export declare class ChatComponent implements OnInit, AfterViewInit, OnDestroy {
89
89
  */
90
90
  messageWidthMode: MessageWidthMode;
91
91
  /**
92
- * Enables the expand/collapse functionality of the messages.
93
- *
94
- * @default `false`
92
+ * Enables the expand or collapse functionality for messages.
93
+ * @default false
95
94
  */
96
95
  allowMessageCollapse: boolean;
97
96
  /**
@@ -108,13 +107,13 @@ export declare class ChatComponent implements OnInit, AfterViewInit, OnDestroy {
108
107
  enableFileSelect: boolean | FileSelectSettings;
109
108
  /**
110
109
  * Specifies the actions available in the message toolbar.
111
- * These actions are displayed in the message toolbar and can be used to perform specific operations on the message.
112
- *
110
+ * These actions display in the message toolbar and let you perform specific operations on the message.
113
111
  * @default []
114
112
  */
115
113
  messageToolbarActions: MessageAction[];
116
114
  /**
117
115
  * Sets the value of the Message Box.
116
+ * @default ''
118
117
  */
119
118
  inputValue: string;
120
119
  /**
@@ -125,7 +124,7 @@ export declare class ChatComponent implements OnInit, AfterViewInit, OnDestroy {
125
124
  defaultContextMenuActions: MessageAction[];
126
125
  /**
127
126
  * Specifies the actions available in the message as a context menu.
128
- * These actions are displayed as menu items and can be used to perform specific operations on the message.
127
+ * These actions display as menu items and let you perform specific operations on the message.
129
128
  * The default actions are `copy` and `reply` and are defined by their `id`.
130
129
  */
131
130
  set messageContextMenuActions(actions: MessageAction[] | null);
@@ -136,7 +135,7 @@ export declare class ChatComponent implements OnInit, AfterViewInit, OnDestroy {
136
135
  defaultFileActions: FileAction[];
137
136
  /**
138
137
  * Specifies the actions available in the file as items of a DropDownButton.
139
- * These actions are displayed when clicking on the file DropDownButton and can be used to perform specific operations on the file.
138
+ * These actions display when you click the file DropDownButton and let you perform specific operations on the file.
140
139
  * The default action is `download` and is defined by its `id`.
141
140
  *
142
141
  * @default [{ id: 'download', label: 'Download', icon: 'download', svgIcon: downloadIcon, disabled: false }]
@@ -145,8 +144,7 @@ export declare class ChatComponent implements OnInit, AfterViewInit, OnDestroy {
145
144
  get fileActions(): FileAction[];
146
145
  /**
147
146
  * Sets the suggestions to display in the message input box.
148
- * Suggestions are displayed as a list of clickable items that can be used to quickly insert predefined text into the message input.
149
- *
147
+ * Suggestions display as a list of clickable items that let you quickly insert predefined text into the message input.
150
148
  * @default []
151
149
  */
152
150
  suggestions: ChatSuggestion[];
@@ -160,19 +158,19 @@ export declare class ChatComponent implements OnInit, AfterViewInit, OnDestroy {
160
158
  * Sets the send button settings for the Chat component.
161
159
  * Allows customization of the send button appearance, icons and disabled state.
162
160
  *
163
- * @default defaultButtonSettings
161
+ * @default { fillMode: 'solid', rounded: 'full', size: 'medium', themeColor: 'primary', icon: 'paper-plane', svgIcon: paperPlaneIcon}
164
162
  */
165
163
  sendButtonSettings: SendButtonSettings;
166
164
  /**
167
165
  * Sets the names of the model fields from which the Chat reads its data.
168
- * Allows mapping of custom data structures to the expected Message format.
166
+ * Lets you map custom data structures to the expected `Message` format.
169
167
  */
170
168
  set modelFields(value: ConversationalUIModelFields);
171
169
  get modelFields(): ConversationalUIModelFields;
172
170
  /**
173
171
  * Emits when the user sends a message by clicking the **Send** button or pressing **Enter**.
174
172
  *
175
- * > The message is not automatically added to the `messages` array.
173
+ * The message is not automatically added to the `messages` array.
176
174
  */
177
175
  sendMessage: EventEmitter<SendMessageEvent>;
178
176
  /**
@@ -195,7 +193,7 @@ export declare class ChatComponent implements OnInit, AfterViewInit, OnDestroy {
195
193
  * Emits when the user clicks a quick action button.
196
194
  * The Chat internally handles [known actions](slug:api_conversational-ui_actiontype) such as `reply`, `openUrl`, and `call`.
197
195
  *
198
- * The event is preventable&mdash;calling `preventDefault` suppresses the built-in action.
196
+ * The event is preventable. Calling [`preventDefault`](https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault) suppresses the built-in action.
199
197
  */
200
198
  executeAction: EventEmitter<ExecuteActionEvent>;
201
199
  /**
@@ -212,7 +210,7 @@ export declare class ChatComponent implements OnInit, AfterViewInit, OnDestroy {
212
210
  fileRemove: EventEmitter<ChatFile>;
213
211
  /**
214
212
  * Emits when the user unpins the pinned message.
215
- * This event is triggered when the user clicks the delete button on the pinned message.
213
+ * This event triggers when the user clicks the delete button on the pinned message.
216
214
  */
217
215
  unpin: EventEmitter<Message>;
218
216
  /**
@@ -4,5 +4,6 @@
4
4
  *-------------------------------------------------------------------------------------------*/
5
5
  /**
6
6
  * Represents the possible message box options for the Chat component.
7
+ * @hidden
7
8
  */
8
9
  export type MessageBoxType = 'textarea';
@@ -9,16 +9,16 @@ import * as i0 from "@angular/core";
9
9
  */
10
10
  export declare class Messages extends ComponentMessages {
11
11
  /**
12
- * Sets the text that is displayed when the sender deletes a message.
12
+ * Sets the text that displays when the sender deletes a message.
13
13
  */
14
14
  deletedMessageSenderText: string;
15
15
  /**
16
- * Sets the text that is displayed when the receiver deletes a message.
16
+ * Sets the text that displays when the receiver deletes a message.
17
17
  */
18
18
  deletedMessageReceiverText: string;
19
19
  /**
20
- * Sets the text that is displayed in the download section of the message.
21
- * This message is displayed below all files in the message.
20
+ * Sets the text that displays in the download section of the message.
21
+ * This message displays below all files in the message.
22
22
  */
23
23
  downloadAllFilesText: string;
24
24
  /**
@@ -54,23 +54,23 @@ export declare class Messages extends ComponentMessages {
54
54
  */
55
55
  fileSelectButtonTitle: string;
56
56
  /**
57
- * Sets the title of the icon which removes the reply reference in the Message Box.
57
+ * Sets the title of the icon that removes the reply reference in the Message Box.
58
58
  */
59
59
  removeReplyTitle: string;
60
60
  /**
61
- * Sets the title of the icon which removes a selected file in the Message Box.
61
+ * Sets the title of the icon that removes a selected file in the Message Box.
62
62
  */
63
63
  removeFileTitle: string;
64
64
  /**
65
- * Sets the title of the icon which demonstrates that the message can be expanded.
65
+ * Sets the title of the icon that shows the message can expand.
66
66
  */
67
67
  expandTitle: string;
68
68
  /**
69
- * Sets the title of the icon which demonstrates that the message can be collapsed.
69
+ * Sets the title of the icon that shows the message can collapse.
70
70
  */
71
71
  collapseTitle: string;
72
72
  /**
73
- * Sets the title of the DropDownButton which opens the File actions.
73
+ * Sets the title of the DropDownButton that opens the File actions.
74
74
  */
75
75
  fileActionsTitle: string;
76
76
  static ɵfac: i0.ɵɵFactoryDeclaration<Messages, never>;
@@ -11,10 +11,14 @@ import * as i0 from "@angular/core";
11
11
  * The template context is set to the attachment instance.
12
12
  * For more information, refer to the article on [message attachments](slug:attachments_chat).
13
13
  *
14
+ * You can use the following field:
15
+ * - `attachment`&mdash;The attachment instance.
16
+ * - `message`&mdash;The message instance.
17
+ *
14
18
  * @example
15
19
  * ```html
16
20
  * <kendo-chat>
17
- * <ng-template kendoChatAttachmentTemplate let-attachment>
21
+ * <ng-template kendoChatAttachmentTemplate let-attachment let-message>
18
22
  * <div>Attachment: {{ attachment.content }}</div>
19
23
  * </ng-template>
20
24
  * </kendo-chat>
@@ -7,11 +7,14 @@ import * as i0 from "@angular/core";
7
7
  /**
8
8
  * Represents the template for a suggestion in the Chat component.
9
9
  *
10
+ * You can use the following field:
11
+ * - `suggestion`&mdash;The suggestion instance.
12
+ *
10
13
  * @example
11
14
  * ```html
12
15
  * <kendo-chat>
13
- * <ng-template kendoChatSuggestionTemplate>
14
- * Suggestion Text
16
+ * <ng-template kendoChatSuggestionTemplate let-suggestion>
17
+ * {{ suggestion.text }}
15
18
  * </ng-template>
16
19
  * </kendo-chat>
17
20
  * ```
@@ -5,12 +5,15 @@
5
5
  import { TemplateRef } from "@angular/core";
6
6
  import * as i0 from "@angular/core";
7
7
  /**
8
- * Defines a template for displaying the timestamp of the messages.
8
+ * Defines a template for displaying the chat timestamp.
9
9
  *
10
10
  * To define a timestamp template, nest an `<ng-template>` tag with the `kendoChatTimestampTemplate` directive inside the `<kendo-chat>` component.
11
11
  * The template context is set to the current timestamp.
12
12
  * For more information, refer to the article on [message templates](slug:message_templates_chat).
13
13
  *
14
+ * You can use the following field:
15
+ * - `timestamp`&mdash;The current timestamp.
16
+ *
14
17
  * @example
15
18
  * ```html
16
19
  * <kendo-chat>
@@ -9,8 +9,7 @@ export class SendMessageEvent {
9
9
  /**
10
10
  * Represents the message that contains the metadata and user input.
11
11
  *
12
- * > The Chat does not automatically add the message to its data.
13
- * > For more information, see [Data Binding](slug:databinding_chat).
12
+ * The Chat does not automatically add the message to its data. For more information, see [Data Binding](slug:databinding_chat).
14
13
  */
15
14
  message;
16
15
  /**
@@ -8,7 +8,7 @@ import { ButtonComponent } from '@progress/kendo-angular-buttons';
8
8
  import * as i0 from "@angular/core";
9
9
  /**
10
10
  * Represents a Hero Card component.
11
- * Hero cards host a single large image and action buttons with text content.
11
+ * Hero cards display a single large image and action buttons with text content.
12
12
  *
13
13
  * @example
14
14
  * ```html
@@ -61,7 +61,7 @@ export class ChatComponent {
61
61
  /**
62
62
  * Defines the array of messages displayed in the Chat.
63
63
  * Each message can include a timestamp for unique identification.
64
- * For more information, refer to [ngFor - Change Tracking](link:site.data.urls.angular['ngforof']#change-propagation).
64
+ * For more information, see [ngFor - Change Tracking](link:site.data.urls.angular['ngforof']#change-propagation).
65
65
  */
66
66
  messages;
67
67
  /**
@@ -78,13 +78,13 @@ export class ChatComponent {
78
78
  messageBoxType = 'textarea';
79
79
  /**
80
80
  * Sets the height of the Chat component.
81
- * Accepts a string with CSS units (e.g., '400px', '50%') or a number (interpreted as pixels).
81
+ * Accepts a string with CSS units (for example, `'400px'`, `'50%'`) or a number (interpreted as pixels).
82
82
  * The minimum height is `600px`.
83
83
  */
84
84
  height;
85
85
  /**
86
86
  * Sets the width of the Chat component.
87
- * Accepts a string with CSS units (e.g., '400px', '50%') or a number (interpreted as pixels).
87
+ * Accepts a string with CSS units (for example, `'400px'`, `'50%'`) or a number (interpreted as pixels).
88
88
  * The minimum width is `320px`.
89
89
  */
90
90
  width;
@@ -99,9 +99,8 @@ export class ChatComponent {
99
99
  */
100
100
  messageWidthMode = 'standard';
101
101
  /**
102
- * Enables the expand/collapse functionality of the messages.
103
- *
104
- * @default `false`
102
+ * Enables the expand or collapse functionality for messages.
103
+ * @default false
105
104
  */
106
105
  allowMessageCollapse = false;
107
106
  /**
@@ -118,13 +117,13 @@ export class ChatComponent {
118
117
  enableFileSelect = true;
119
118
  /**
120
119
  * Specifies the actions available in the message toolbar.
121
- * These actions are displayed in the message toolbar and can be used to perform specific operations on the message.
122
- *
120
+ * These actions display in the message toolbar and let you perform specific operations on the message.
123
121
  * @default []
124
122
  */
125
123
  messageToolbarActions = [];
126
124
  /**
127
125
  * Sets the value of the Message Box.
126
+ * @default ''
128
127
  */
129
128
  inputValue = '';
130
129
  /**
@@ -135,7 +134,7 @@ export class ChatComponent {
135
134
  defaultContextMenuActions = CONTEXT_MENU_ACTIONS;
136
135
  /**
137
136
  * Specifies the actions available in the message as a context menu.
138
- * These actions are displayed as menu items and can be used to perform specific operations on the message.
137
+ * These actions display as menu items and let you perform specific operations on the message.
139
138
  * The default actions are `copy` and `reply` and are defined by their `id`.
140
139
  */
141
140
  set messageContextMenuActions(actions) {
@@ -150,7 +149,7 @@ export class ChatComponent {
150
149
  defaultFileActions = FILE_ACTIONS;
151
150
  /**
152
151
  * Specifies the actions available in the file as items of a DropDownButton.
153
- * These actions are displayed when clicking on the file DropDownButton and can be used to perform specific operations on the file.
152
+ * These actions display when you click the file DropDownButton and let you perform specific operations on the file.
154
153
  * The default action is `download` and is defined by its `id`.
155
154
  *
156
155
  * @default [{ id: 'download', label: 'Download', icon: 'download', svgIcon: downloadIcon, disabled: false }]
@@ -163,8 +162,7 @@ export class ChatComponent {
163
162
  }
164
163
  /**
165
164
  * Sets the suggestions to display in the message input box.
166
- * Suggestions are displayed as a list of clickable items that can be used to quickly insert predefined text into the message input.
167
- *
165
+ * Suggestions display as a list of clickable items that let you quickly insert predefined text into the message input.
168
166
  * @default []
169
167
  */
170
168
  suggestions = [];
@@ -178,12 +176,12 @@ export class ChatComponent {
178
176
  * Sets the send button settings for the Chat component.
179
177
  * Allows customization of the send button appearance, icons and disabled state.
180
178
  *
181
- * @default defaultButtonSettings
179
+ * @default { fillMode: 'solid', rounded: 'full', size: 'medium', themeColor: 'primary', icon: 'paper-plane', svgIcon: paperPlaneIcon}
182
180
  */
183
181
  sendButtonSettings = SEND_BTN_DEFAULT_SETTINGS;
184
182
  /**
185
183
  * Sets the names of the model fields from which the Chat reads its data.
186
- * Allows mapping of custom data structures to the expected Message format.
184
+ * Lets you map custom data structures to the expected `Message` format.
187
185
  */
188
186
  set modelFields(value) {
189
187
  this._modelFields = { ...defaultModelFields, ...value };
@@ -194,7 +192,7 @@ export class ChatComponent {
194
192
  /**
195
193
  * Emits when the user sends a message by clicking the **Send** button or pressing **Enter**.
196
194
  *
197
- * > The message is not automatically added to the `messages` array.
195
+ * The message is not automatically added to the `messages` array.
198
196
  */
199
197
  sendMessage = new EventEmitter();
200
198
  /**
@@ -217,7 +215,7 @@ export class ChatComponent {
217
215
  * Emits when the user clicks a quick action button.
218
216
  * The Chat internally handles [known actions](slug:api_conversational-ui_actiontype) such as `reply`, `openUrl`, and `call`.
219
217
  *
220
- * The event is preventable&mdash;calling `preventDefault` suppresses the built-in action.
218
+ * The event is preventable. Calling [`preventDefault`](https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault) suppresses the built-in action.
221
219
  */
222
220
  executeAction = new EventEmitter();
223
221
  /**
@@ -234,7 +232,7 @@ export class ChatComponent {
234
232
  fileRemove = new EventEmitter();
235
233
  /**
236
234
  * Emits when the user unpins the pinned message.
237
- * This event is triggered when the user clicks the delete button on the pinned message.
235
+ * This event triggers when the user clicks the delete button on the pinned message.
238
236
  */
239
237
  unpin = new EventEmitter();
240
238
  /**
@@ -10,16 +10,16 @@ import * as i0 from "@angular/core";
10
10
  */
11
11
  export class Messages extends ComponentMessages {
12
12
  /**
13
- * Sets the text that is displayed when the sender deletes a message.
13
+ * Sets the text that displays when the sender deletes a message.
14
14
  */
15
15
  deletedMessageSenderText;
16
16
  /**
17
- * Sets the text that is displayed when the receiver deletes a message.
17
+ * Sets the text that displays when the receiver deletes a message.
18
18
  */
19
19
  deletedMessageReceiverText;
20
20
  /**
21
- * Sets the text that is displayed in the download section of the message.
22
- * This message is displayed below all files in the message.
21
+ * Sets the text that displays in the download section of the message.
22
+ * This message displays below all files in the message.
23
23
  */
24
24
  downloadAllFilesText;
25
25
  /**
@@ -55,23 +55,23 @@ export class Messages extends ComponentMessages {
55
55
  */
56
56
  fileSelectButtonTitle;
57
57
  /**
58
- * Sets the title of the icon which removes the reply reference in the Message Box.
58
+ * Sets the title of the icon that removes the reply reference in the Message Box.
59
59
  */
60
60
  removeReplyTitle;
61
61
  /**
62
- * Sets the title of the icon which removes a selected file in the Message Box.
62
+ * Sets the title of the icon that removes a selected file in the Message Box.
63
63
  */
64
64
  removeFileTitle;
65
65
  /**
66
- * Sets the title of the icon which demonstrates that the message can be expanded.
66
+ * Sets the title of the icon that shows the message can expand.
67
67
  */
68
68
  expandTitle;
69
69
  /**
70
- * Sets the title of the icon which demonstrates that the message can be collapsed.
70
+ * Sets the title of the icon that shows the message can collapse.
71
71
  */
72
72
  collapseTitle;
73
73
  /**
74
- * Sets the title of the DropDownButton which opens the File actions.
74
+ * Sets the title of the DropDownButton that opens the File actions.
75
75
  */
76
76
  fileActionsTitle;
77
77
  static ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "16.2.12", ngImport: i0, type: Messages, deps: null, target: i0.ɵɵFactoryTarget.Directive });
@@ -11,10 +11,14 @@ import * as i0 from "@angular/core";
11
11
  * The template context is set to the attachment instance.
12
12
  * For more information, refer to the article on [message attachments](slug:attachments_chat).
13
13
  *
14
+ * You can use the following field:
15
+ * - `attachment`&mdash;The attachment instance.
16
+ * - `message`&mdash;The message instance.
17
+ *
14
18
  * @example
15
19
  * ```html
16
20
  * <kendo-chat>
17
- * <ng-template kendoChatAttachmentTemplate let-attachment>
21
+ * <ng-template kendoChatAttachmentTemplate let-attachment let-message>
18
22
  * <div>Attachment: {{ attachment.content }}</div>
19
23
  * </ng-template>
20
24
  * </kendo-chat>
@@ -7,11 +7,14 @@ import * as i0 from "@angular/core";
7
7
  /**
8
8
  * Represents the template for a suggestion in the Chat component.
9
9
  *
10
+ * You can use the following field:
11
+ * - `suggestion`&mdash;The suggestion instance.
12
+ *
10
13
  * @example
11
14
  * ```html
12
15
  * <kendo-chat>
13
- * <ng-template kendoChatSuggestionTemplate>
14
- * Suggestion Text
16
+ * <ng-template kendoChatSuggestionTemplate let-suggestion>
17
+ * {{ suggestion.text }}
15
18
  * </ng-template>
16
19
  * </kendo-chat>
17
20
  * ```
@@ -5,12 +5,15 @@
5
5
  import { Directive, Optional, TemplateRef } from "@angular/core";
6
6
  import * as i0 from "@angular/core";
7
7
  /**
8
- * Defines a template for displaying the timestamp of the messages.
8
+ * Defines a template for displaying the chat timestamp.
9
9
  *
10
10
  * To define a timestamp template, nest an `<ng-template>` tag with the `kendoChatTimestampTemplate` directive inside the `<kendo-chat>` component.
11
11
  * The template context is set to the current timestamp.
12
12
  * For more information, refer to the article on [message templates](slug:message_templates_chat).
13
13
  *
14
+ * You can use the following field:
15
+ * - `timestamp`&mdash;The current timestamp.
16
+ *
14
17
  * @example
15
18
  * ```html
16
19
  * <kendo-chat>
@@ -23,18 +23,20 @@ import * as i1 from "@progress/kendo-angular-popup";
23
23
  *
24
24
  * @example
25
25
  * ```html
26
- * <kendo-inlineaiprompt
27
- * placeholder="Enter your prompt..."
28
- * [promptOutput]="promptOutput"
29
- * (promptRequest)="onPromptRequest($event)">
30
- * </kendo-inlineaiprompt>
26
+ * <kendo-inlineaiprompt
27
+ * placeholder="Enter your prompt..."
28
+ * [promptOutput]="promptOutput"
29
+ * (promptRequest)="onPromptRequest($event)">
30
+ * </kendo-inlineaiprompt>
31
31
  * ```
32
32
  */
33
33
  export class InlineAIPromptComponent {
34
34
  ngZone;
35
35
  element;
36
36
  /**
37
- * Sets the text of the TextArea.
37
+ * Sets the TextArea value.
38
+ *
39
+ * @default ""
38
40
  */
39
41
  promptValue = "";
40
42
  /**
@@ -53,8 +55,7 @@ export class InlineAIPromptComponent {
53
55
  */
54
56
  enableSpeechToText = true;
55
57
  /**
56
- * Sets the streaming state of the component.
57
- * When set to `true`, the send button displays a generating state and the component emits a `promptRequestCancel` event when you click it.
58
+ * When set to `true`, the **Send** button displays a generating state and the component emits a `promptRequestCancel` event when you click it.
58
59
  *
59
60
  * @default false
60
61
  */
@@ -89,7 +90,8 @@ export class InlineAIPromptComponent {
89
90
  */
90
91
  promptCommands;
91
92
  /**
92
- * Sets the popup settings for the component.
93
+ * Sets the Popup settings.
94
+ *
93
95
  */
94
96
  set popupSettings(settings) {
95
97
  this._popupSettings = { ...defaultPopupSettings, ...settings };
@@ -98,27 +100,27 @@ export class InlineAIPromptComponent {
98
100
  return this._popupSettings;
99
101
  }
100
102
  /**
101
- * Fires when you click the send button.
103
+ * Fires when the send button is clicked.
102
104
  */
103
105
  promptRequest = new EventEmitter();
104
106
  /**
105
- * Fires when you click a command.
107
+ * Fires when a command is executed.
106
108
  */
107
109
  commandExecute = new EventEmitter();
108
110
  /**
109
- * Fires when you click an output action button.
111
+ * Fires when an output action button is clicked.
110
112
  */
111
113
  outputActionClick = new EventEmitter();
112
114
  /**
113
- * Fires when you cancel the prompt request by clicking the stop button.
115
+ * Fires when the stop button is clicked during streaming.
114
116
  */
115
117
  promptRequestCancel = new EventEmitter();
116
118
  /**
117
- * Fires when the component closes, either by clicking outside the popup, clicking the Discard action, or after pressing the Escape key.
119
+ * Fires when the component closes (Escape key, Discard action or outside click).
118
120
  */
119
121
  close = new EventEmitter();
120
122
  /**
121
- * Fires when the value of the TextArea changes.
123
+ * Fires when the TextArea value changes.
122
124
  */
123
125
  promptValueChange = new EventEmitter();
124
126
  popupElement;
@@ -150,7 +152,7 @@ export class InlineAIPromptComponent {
150
152
  this.subs.unsubscribe();
151
153
  }
152
154
  /**
153
- * Focuses the TextArea of the Inline AI Prompt.
155
+ * Focus the TextArea.
154
156
  */
155
157
  focus() {
156
158
  if (this.contentComponent?.textArea) {
@@ -9,31 +9,38 @@ import { defaultPopupSettings } from './utils';
9
9
  import * as i0 from "@angular/core";
10
10
  import * as i1 from "@progress/kendo-angular-popup";
11
11
  /**
12
- * Provides a service for opening Inline AI Prompt components dynamically.
12
+ * Provides a service for opening and configuring the Inline AI Prompt component dynamically.
13
13
  *
14
14
  * @example
15
15
  * ```ts
16
- * import { InlineAIPromptService } from '@progress/kendo-angular-conversational-ui';
16
+ * export class DemoComponent {
17
+ * @ViewChild('anchor', { read: ElementRef }) anchor: ElementRef;
18
+ * constructor(private promptService: InlineAIPromptService) {}
17
19
  *
18
- * constructor(private inlineAIPromptService: InlineAIPromptService) {}
19
- *
20
- * openPrompt(anchor: ElementRef) {
21
- * const promptRef = this.inlineAIPromptService.open({
22
- * anchor: anchor,
23
- * placeholder: 'Enter your prompt...'
24
- * });
20
+ * open(): void {
21
+ * this.promptService.open({
22
+ * popupSettings: { anchor: this.anchor },
23
+ * placeholder: 'Enter your prompt...'
24
+ * });
25
+ * }
25
26
  * }
26
27
  * ```
28
+ * ```html
29
+ * <button #anchor (click)="open()">Ask AI</button>
30
+ * ```
27
31
  */
28
32
  export class InlineAIPromptService {
29
33
  popupService;
34
+ /**
35
+ * @hidden
36
+ */
30
37
  constructor(popupService) {
31
38
  this.popupService = popupService;
32
39
  }
33
40
  /**
34
41
  * Opens an Inline AI Prompt component in a popup. The popup appears near the specified anchor element or at the provided offset coordinates.
35
42
  *
36
- * @param {InlineAIPromptSettings} options - The options for the InlineAIPromptComponent.
43
+ * @param {InlineAIPromptSettings} options The options for the InlineAIPromptComponent.
37
44
  * @returns {PopupRef} A reference to the popup.
38
45
  */
39
46
  open(options) {
@@ -8,9 +8,7 @@ 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
- * Represents the custom messages component of the Inline AI Prompt.
12
- *
13
- * Use this component to override default messages for the Inline AI Prompt.
11
+ * Provides a component for customizing messages in the Inline AI Prompt. [See example](slug:globalization_chat#custom-messages).
14
12
  *
15
13
  * @example
16
14
  * ```html