The Chat component for Retool Apps

An interface for AI chat conversations.

Version: Cloud and 3.185 Edge

Refer to Getting started with the Chat component for more information about this component.

Demo

Properties

All properties for this object with supported data types or values. You can write JavaScript almost anywhere in Retool to manipulate or read property values.

assistantName

The name of the AI.

Type	string
Format	Plain Text
Mutability	Control Usage Retool UI Inspector
Default	Retool AI

Examples

"Retool AI"

---

avatarFallback

The text that is displayed when there is no Image URL or icon.

Type	string
Format	Plain Text
Mutability	Control Usage Retool UI Inspector

Examples

"Jenny Appleseed"

---

avatarIcon

The icon that's displayed for the avatar.

Type	string
Format	Icon Key
Mutability	Control Usage Retool UI Inspector

Examples

"/icon:bold/user"

---

avatarImageSize

The size of the avatar image.

Type	string
Mutability	Control Usage Retool UI Inspector

---

avatarSrc

The image URL to use for the avatar.

Type	string
Format	URL
Mutability	Control Usage Retool UI Inspector

Examples

"https://example.com/image.jpg"

---

data

The data.

Type	string | number | boolean | object | array
Format	Custom data
Mutability	Control Usage Retool UI Inspector Method copyToClipboard()

---

disableSubmit

Whether to disable form submission.

Type	boolean
Mutability	Control Usage Retool UI Inspector

---

emptyDescription

The description to display before the first message is sent.

Type	string
Mutability	Control Usage Retool UI Inspector

---

emptyTitle

The title to display before the first message is sent.

Type	string
Mutability	Control Usage Retool UI Inspector

---

hidden

Whether this object is hidden from view.

Type	boolean
Format	True/False
Mutability	Control Usage Retool UI Inspector > Appearance > Hidden Method setHidden()
Default	false

Examples

true

---

id

The unique identifier (name).

Type	string
Format	Plain Text
Mutability	Control Usage Retool UI Inspector
Default	chat1

Examples

query1

button1

---

isHiddenOnDesktop

Whether to show or hide this object in the desktop layout.

Type	boolean
Format	True/False
Mutability	Control Usage Retool UI Inspector > Appearance > Advanced > Show on desktop
Default	false

Examples

true

---

isHiddenOnMobile

Whether to show or hide this object in the mobile layout.

Type	boolean
Format	True/False
Mutability	Control Usage Retool UI Inspector > Appearance > Advanced > Show on mobile
Default	true

Examples

true

---

lastMessage

The last message message sent by the user.

Type	string
Mutability	Read-only

---

lastResponse

The last response from the AI.

Type	string
Mutability	Read-only

---

maintainSpaceWhenHidden

Whether to take up space on the canvas if hidden is true.

Type	boolean
Format	True/False
Mutability	Control Usage Retool UI Inspector > Appearance > Advanced > Maintain space when hidden
Default	false

Examples

true

---

margin

The amount of margin to render outside.

Type	string
Format	Plain Text
Mutability	Control Usage Retool UI Inspector > Spacing > Margin
Allowed Values	Value UI Option Description 4px 8px Normal Normal margin. 0 None No margin.
Default	4px 8px

Examples

4px 8px

---

messageHistory

A list of messages previously sent and received.

Type	array
Array values	string
Mutability	Read-only

---

placeholder

The text to display within the input field when there is no value.

Type	string
Format	string
Mutability	Control Usage Retool UI Inspector > Content > Placeholder
Default	Enter a value

Examples

Enter a value

---

queryTargetId

The ID of the query to send messageHistory to.

Type	string
Mutability	Control Usage Retool UI Inspector

---

showAvatar

Whether to display an avatar.

Type	boolean
Mutability	Control Usage Retool UI Inspector

---

showEmptyState

Whether to display an empty state before a message is sent. Enabled by adding the Empty state add-on.

Type	boolean
Mutability	Control Usage Retool UI Inspector

---

showHeader

Whether to show the header area.

Type	boolean
Format	True/False
Mutability	Control Usage Retool UI Inspector > Content > Add-ons > Header > Appearance > Show header Method setShowHeader()
Default	false

Examples

true

---

showInEditor

Whether the component remains visible in the editor if hidden is true.

Type	boolean
Format	True/False
Mutability	Control Usage Retool UI Inspector > Appearance > Advanced > Always show in edit mode
Default	false

Examples

true

---

showTimestamp

Whether to display a timestamp for messages.

Type	array
Array values	boolean
Mutability	Control Usage Retool UI Inspector

---

style

Custom style options.

Type	object
Mutability	Control Usage Retool UI Inspector > Appearance > style

---

title

The title text to display.

Type	string
Mutability	Control Usage Retool UI Inspector

---

value

The value.

Type	string | number | boolean | object | array
Mutability	Read-only

---

Methods

JavaScript API methods for this object. You can write JavaScript almost anywhere in Retool and use methods to manipulate data and property values.

chat.clearHistory()

Clear the history.

Definition

chat.clearHistory()

Examples

Clear the history from chat.

chat.clearHistory();

---

chat.clearValue()

Clear the current values.

Definition

chat.clearValue()

Examples

Clear the current value of chat.

chat.clearValue();

---

chat.exportData()

Exports data as a file in a CSV, TSV, JSON, or Excel format.

Definition

chat.exportData(options)

Parameters

options

The options for the export.

Type

object

Object Properties

data

The data.

Type	string | number | boolean | object | array
Format	Custom data

---

fileName

The file name.

Type

string

---

fileType

The file extension.

Type

string

---

---

---

chat.resetValue()

Reset the current value to the default value.

Definition

chat.resetValue()

Examples

Reset the current value of chat.

chat.resetValue();

---

chat.scrollIntoView()

Scrolls the canvas or parent container so that the selected component appears in the visible area.

Definition

chat.scrollIntoView(options)

Parameters

options

The scroll options.

Type

object

Object Properties

behavior

The scroll behavior.

Type	string
Allowed Values	Value Description auto Scroll immediately to the specified position. smooth Scroll gradually to the specified position.

---

block

The scroll position relative to the component.

Type	string
Allowed Values	Value Description nearest Scrolls only the minimum amount required for the component to appear in the visible area. Scrolling does not occur if the component is already in view. start Scrolls to position the component at the top of the visible area. center Scrolls to position the component in the middle of the visible area. end Scrolls to position the component at the bottom of the visible area.

---

---

Examples

Scroll the minimum amount to immediately bring chat into view.

chat.scrollIntoView({behavior: 'auto', block: 'nearest'});

---

chat.sendMessage()

Send the current message.

Definition

chat.sendMessage()

---

chat.setHidden()

Set the hidden value to toggle whether the component is visible. Defaults to true without a parameter.

Definition

chat.setHidden(hidden)

Parameters

hidden

Whether this object is hidden from view.

Type	boolean
Format	True/False
Default	false

Examples

true

---

Examples

Hide chat.

chat.setHidden(true);

Unhide chat.

chat.setHidden(false);

---

chat.setShowHeader()

Set the showHeader value to toggle whether the component header is visible.

Definition

chat.setShowHeader(showHeader)

Parameters

showHeader

Whether to show the header area.

Type	boolean
Format	True/False
Default	false

Examples

true

---

Examples

Show the header of chat.

chat.setShowHeader(true);

Hide the header of chat.

chat.setShowHeader(false);

---

chat.setValue()

Set the current value.

Definition

chat.setValue(value)

Parameters

value

The value.

Type	string | number | boolean | object | array

---

Examples

Set the current value of chat to userValue.

chat.setValue(userValue);

---

Events

Events triggered by user interactions. You can configure event handlers in the IDE to trigger queries or other actions in response to events.

Event	Description