ChatProps

Enables expand or collapse for messages to save space.

Field name for message attachments.

React functional or class component used as an attachment template (see example). The corresponding attachment is passed as an item property.

ID of the local user. Identifies messages authored by the local user.

Field name for message author ID.

Field name for alt text of the author's avatar (when flattened).

Field name for message author avatar URL (when flattened).

Configuration settings for author messages (messages from the local user). These settings override global message settings for author messages. If both global and author-specific settings are provided, the author-specific settings take precedence.

Field name for message author name (when flattened).

Specifies the minimum offset between the top of the latest receiver message and the top edge of the visible message area when auto-scrolling on new receiver messages.

Accepts a percentage string relative to the visible message area height (for example, '30%') or an absolute pixel value as a number.

When a new receiver message arrives and the user is near or at the bottom of the scrollable message list, the Chat scrolls down so that at least this much space is kept between the new message and the top of the visible area. This ensures older messages remain partially in view rather than being scrolled out entirely.

Has no effect on author messages, which always scroll to the bottom.

Negative values are intentionally allowed so receiver messages can scroll fully to the bottom if needed.

CSS class of the Chat DOM element.

Direction of the Chat component.

The index (exclusive) in the full conversation that marks the end of the current batch. Only relevant in remote mode (messages.length < total).

Actions displayed for files in the message.

Field name for file attachments.

Template for the header of the Chat component.

Height of the Chat.

ID of the Chat component.

Field name for message ID.

Sets the controlled input value of the Chat component. When provided, the Chat operates in controlled mode and you must handle onInputValueChange to update the value.

Field name for message deletion status.

Field name for message failed status. Indicates whether the message has failed to send.

Field name for message pinned status.

Specifies whether the Send button is transformed to a stop button.

Enables customization or override of the default message box item (see example).

Configuration for the Message Box (PromptBox component).

React functional or class component used as a message content template. Rendered inside the .k-bubble-content element when provided. The corresponding message is passed as an item property.

Actions displayed in the message context menu.

Sets the file layout mode for file attachments in messages.

• vertical—Files are displayed in a vertical list layout.
• wrap—Files are displayed in a wrapped layout.
• horizontal—Files are displayed in a horizontal list layout with scrollable overflow.

Messages of the Chat. Can be an array of Message objects or raw data objects that map using the field mapping configuration.

React functional or class component used as a message template. The corresponding message is passed as an item property.

Actions displayed in the message toolbar.

Sets the message width mode.

• full—Message occupies the full width of the Chat.
• standard—Message occupies a standard width for a compact display.

Template for the empty Chat state when no messages are present. Only renders when there are no messages and this template is provided.

Fires when the user clicks a quick action button. The Chat internally handles the reply, openUrl, and call known actions. Emits ExecuteActionEvent. The event is preventable. If you call preventDefault, the built-in action is suppressed.

Fires when a context menu action is executed on a message. Provides the action and target message.

Fires when a download action is executed on a message. Provides the selected files and parent message.

Fires when a file action is executed on a message. Provides the action and target file.

Fires when the input value changes. Provides the new input value.

Fires in both built-in and remote endless scroll modes when the user scrolls near the edge of the rendered message window. In built-in mode, the Chat manages rendering internally and this callback is informational. In remote mode (messages.length < total), the consumer must provide the requested range. The event contains the full range that should be rendered (not just the delta).

Fires when the user clicks a referenced message (pinned indicator or reply preview).

Fires when the user clicks the Retry button on a failed message. Emits ChatResendMessageEvent.

Fires when the user types a message and clicks Send or presses Enter. Emits SendMessageEvent.

The Chat does not automatically update with the new message.

Fires when a suggestion is clicked. Provides the clicked suggestion.

Fires when a toolbar action is executed on a message. Provides the action and target message.

Fires when a message is unpinned. Provides the message.

How many messages to load per scroll-triggered batch.

The full set of pinned messages in the conversation. Only needed in remote mode (messages.length < total). The Chat uses this to render the pinned message indicator when the pinned message is outside the current batch. In built-in mode, the Chat has all messages and can look them up directly. This collection is stable — set once on load and updated only when pins change.

Text displayed inside the new message input when empty.

Controls how quick actions behave when they exceed available space.

• scroll—Quick actions scroll horizontally without navigation buttons.
• wrap—Quick actions wrap to new lines when they overflow.
• scrollbuttons—Quick actions scroll horizontally with navigation buttons.

Configuration settings for receiver messages (messages from other users). These settings override global message settings for receiver messages. If both global and receiver-specific settings are provided, the receiver-specific settings take precedence.

Messages that are reply targets for messages in the current batch but live outside messages[]. Only needed in remote mode (messages.length < total). The Chat uses this to render reply previews when the replied-to message is not in the current batch. This collection is scoped per batch — rebuilt on each onLoadMoreMessages or batch replacement.

Field name for reply-to message ID.

Controls the scroll behavior of the message list.

• scrollable—Default mode. All messages are rendered with standard scroll behavior.
• endless—Endless scroll mode. The Chat starts by rendering the last pageSize messages and prepends older ones as the user scrolls up.

Enables or disables the scroll-to-bottom button that appears when the user scrolls up. When enabled, a floating action button appears to allow quick navigation to the latest messages.

Configures the appearance and behavior of the send button in the Chat component.

Controls whether avatars are displayed for messages. Can be overridden by author-specific and receiver-specific settings.

Controls whether author names are displayed for messages. Can be overridden by author-specific and receiver-specific settings.

Enables the speech-to-text functionality in the Chat. This allows users to dictate messages instead of typing them.

The index in the full conversation that messages[0] corresponds to. Only relevant in remote mode (messages.length < total).

Field name for message status.

Template for status items below each message.

Represents the styles that are applied to the Chat.

Field name for the suggestedActions property of a message.

List of message suggestions displayed above the message input.

Controls how suggestions behave when they exceed available space.

• scroll—Suggestions scroll horizontally without navigation buttons.
• wrap—Suggestions wrap to new lines when they overflow.
• scrollbuttons—Suggestions scroll horizontally with navigation buttons.

Template for suggestion items displayed above the message input.

Field name for message text content.

Field name for message timestamp.

Template for the timestamp of the message.

Controls when timestamps are visible for messages.

• onFocus—Timestamps are only visible for selected/focused messages.
• hidden—Timestamps are never visible for any messages.

The total number of messages in the conversation. Used to determine the mode: when messages.length === total, the Chat manages rendering internally (built-in mode); when messages.length < total, the consumer manages data (remote mode).

Field name for the typing property of a message.

Sets the upload configuration for the Chat component. This can be used to customize the file upload behavior, such as accepted file types and maximum file size.

Template for user status display next to avatars. Only rendered when an avatar for the user is provided.

Enables browser-native AI agent tools via Web MCP (Chrome 146+).

Pass true for defaults or an object for fine-grained control. AI agents are multilingual — dataName accepts any language.

Width of the Chat.