The Comment Thread component for Retool Apps

An interface to display and enter comments.

Demo

Settings

Comment Thread includes the following configurable options when building apps in the IDE.

Auto-grow with contentFallback textFallback iconAvatar sizeImage URLDataDescriptionTitleEvent handlersHiddenShow on desktopShow on mobileMaintain space when hiddenMarginPlaceholderAvatarEmpty stateAlways show in edit modeTimestampShow titleStylesNote keyValue

Properties

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

autoRefreshInterval

number

The frequency, in seconds, at which to reload data.

---

avatarFallback

string

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

---

avatarIcon

enum

The icon that's displayed for the avatar.

---

avatarImageSize

enum

The size of the avatar image.

---

avatarSrc

string

The image URL to use for the avatar.

---

data

any[]

The source data.

---

disableSubmit

boolean

Whether to disable form submission.

---

emptyDescription

string

The description to display before the first message is sent.

---

emptyTitle

string

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. Refer to the events section for a list of supported events.

---

method

enum

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

---

type

enum

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.

---

hidden

boolean

Whether the component is visible.

---

id

string

The unique identifier.

---

isHiddenOnDesktop

boolean

Whether the component is visible in the desktop layout.

---

isHiddenOnMobile

boolean

Whether the component is visible in the mobile layout.

---

maintainSpaceWhenHidden

boolean

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

---

margin

enum

The amount of margin to render outside.

Values

4px 8px	Normal margin.
0	No margin.

---

placeholder

string

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

---

pluginType

string

The plugin type.

---

showAvatar

boolean

Whether to display an avatar.

---

showEmptyState

boolean

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

---

showInEditor

boolean

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

---

showTimestamp

boolean[]

Whether to display a timestamp for messages.

---

showTitle

boolean

Whether to display the title.

---

style

object

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

---

threadId

string

The ID with which to record comments. You can reference dynamic values, such as table1.selectedRow.id, to switch between comment threads automatically.

---

title

string

The text to display as a title.

---

value

The value.

---

Methods

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

clearValue

Clear the current values.

commentThread.clearValue()

---

exportData

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

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

commentThread.resetValue()

---

scrollIntoView

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

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

commentThread.sendMessage()

---

setHidden

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

commentThread.setHidden(hidden)

Parameters

hidden

boolean

Whether the component is visible.

---

---

setValue

Set the current value.

commentThread.setValue(value)

Parameters

value

string

The value.

---

---

Events

Events are triggered by user interactions, such as clicking a button or entering a value. Use event handlers to trigger queries or other actions in response to events.

clickAction

An action button is clicked or pressed.

---

submit

Input values are submitted.

---