The Chat web component
An interface for AI chat conversations.
Settings
Chat includes the following configurable options when building apps in the IDE.
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.
assistantName
The name of the AI.
avatarFallback
The text that's displayed when there's no Image URL or icon.
avatarIcon
The icon that's displayed for the avatar.
avatarImageSize
The size of the avatar image.
disableSubmit
Whether to disable form submission.
emptyDescription
The description to display before the first message is sent.
emptyTitle
The title to display before the first message is sent.
Properties
event
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 |
false | A user sets the value to |
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
The JavaScript method to perform when type
is datasource
, widget
, state
, or localStorage
.
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
Whether the object is globally scoped for use in all app pages.
id
The unique identifier.
isHiddenOnDesktop
Whether the component is visible in the desktop layout.
isHiddenOnMobile
Whether the component is visible in the mobile layout.
lastMessage
The last message message sent by the user.
lastResponse
The last response from the AI.
maintainSpaceWhenHidden
Whether the component takes up space on the canvas if hidden
is true
.
messageHistory
A list of messages passed to the component.
placeholder
The text to display within the input field when there is no value.
pluginType
The plugin type.
queryTargetId
The ID of the query to send messageHistory
to.
showAvatar
Whether to display an avatar.
showEmptyState
Whether to display an empty state before a message is sent. Enabled by adding the Empty state add-on.
showHeader
Whether to show a header area.
showInEditor
Whether to remain visible in the editor if hidden
is true
.
showTimestamp
Whether to display a timestamp for messages.
title
The text to display as a title.
tooltipText
The tooltip text to display.
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.
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
The scroll options.
Properties
behavior
The scroll behavior.
Values
auto | Scroll immediately to the specified position. |
smooth | Scroll gradually to the specified position. |
block
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
setShowHeader
Set the showHeader
value to toggle whether the component header is visible.
chat.setShowHeader(showHeader)
Parameters
showHeader
Whether to show a header area.