Skip to main content

The Chat web component

An interface for AI chat conversations.

Settings

Chat includes the following configurable options when building apps in the IDE.

AI nameFallback textFallback iconAvatar sizeImage URLDataDescriptionTitleEvent handlersShow on desktopShow on mobileLoadingMaintain space when hiddenMarginPlaceholderQuery to triggerAvatarEmpty stateHeaderAlways show in edit modeTimestampStylesHelper textValue

Properties

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

The name of the AI.


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


The icon that's displayed for the avatar.


The size of the avatar image.


The image URL to use for the avatar.


data

any[]

The source data.


disableSubmit

boolean

Whether to disable form submission.


The description to display before the first message is sent.


The title to display before the first message is sent.


events

object[]

A list of configured event handlers that trigger actions or queries.

Properties

event

enum

The event type.

Values
change

A user changes the value.

click

A user clicks or taps the component.

submit

A user submits the value.

focus

A user selects the input field.

blur

A user deselects the input field.

scan

A user scans a barcode.

open

A user opens the component.

close

A user closes the component.

true

A user sets the value to true.

false

A user sets the value to false.

select

A user selects a value.

clear

A user clears the value.

upload

A user uploads a file.

parse

An uploaded file is parsed.

inputValueChange

A user changes the value of the input field.


method

enum

The JavaScript method to perform when type is datasource, widget, state, or localStorage.


The type of action to perform.

Values
datasource

Control query.

widget

Control component.

script

Run script.

state

Set variable.

localStorage

Set localStorage.

util

Perform utility action (e.g., Open URL or Confetti).



global

boolean

Whether the object is globally scoped for use in all app pages.


boolean

Whether the component is visible.


id

string

The unique identifier.


Whether the component is visible in the desktop layout.


Whether the component is visible in the mobile layout.


lastMessage

string

The last message message sent by the user.


lastResponse

string

The last response from the AI.


loading

boolean

Whether to display a loading indicator.


Whether the component takes up space on the canvas if hidden is true.


The amount of margin to render outside.

Values
4px 8px

Normal margin.

0

No margin.


messageHistory

string[]

A list of messages passed to the component.


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


pluginType

string

The plugin type.


The ID of the query to send messageHistory to.


Whether to display an avatar.


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


Whether to show a header area.


Whether to remain visible in the editor if hidden is true.


Whether to display a timestamp for messages.


style

object

Custom style options in use. Not all style options may be available for all components.


title

string

The text to display as a title.


The tooltip text to display.


value

string

The value.


Methods

JavaScript API methods for interacting with Chat. You can write JavaScript almost anywhere in Retool and use methods to manipulate data and property values.

clearHistory

Clear the history.

chat.clearHistory()

clearValue

Clear the current values.

chat.clearValue()

exportData

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

chat.exportData(exportDataOptions)
Parameters

exportDataOptions

object
Properties

data

any[]

The source data.


fileName

string

The file name.


fileType

string

The file extension.




resetValue

Reset the current value to the default value.

chat.resetValue()

scrollIntoView

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

chat.scrollIntoView(scrollIntoViewOptions)
Parameters

scrollIntoViewOptions

object

The scroll options.

Properties

behavior

enum

The scroll behavior.

Values
auto

Scroll immediately to the specified position.

smooth

Scroll gradually to the specified position.


block

enum

The scroll position relative to the component.

Values
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.




sendMessage

Send the current message.

chat.sendMessage()

setHidden

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

chat.setHidden(hidden)
Parameters

boolean

Whether the component is visible.



setShowHeader

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

chat.setShowHeader(showHeader)
Parameters

Whether to show a header area.



setValue

Set the current value.

chat.setValue(value)
Parameters

value

string

The value.