The Alert component for Retool Apps

A message box to display important information with optional title and clickable action.

Version: Cloud and 3.185 Edge

For more information about this component, refer to the Informational components guide.

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.

actionIcon

The icon to display on the action button.

Type	string
Format	Plain Text
Mutability	Control Usage Retool UI Inspector

Examples

"/icon:bold/alert"

---

actionIconPosition

The position of the action icon.

Type	string
Format	Plain Text
Mutability	Control Usage Retool UI Inspector
Allowed Values	Value Description left Left. right Right.

Examples

"left"

---

actionPosition

The position of the action button.

Type	string
Mutability	Control Usage Retool UI Inspector
Allowed Values	Value Description top Top. bottom Bottom.

---

actionText

The text to display on the action button.

Type	string
Format	Plain Text
Mutability	Control Usage Retool UI Inspector

Examples

"Submit"

---

actionTooltip

The tooltip to display on hover over the action button.

Type	string
Format	Plain Text
Mutability	Control Usage Retool UI Inspector

Examples

"Click to deploy."

---

backgroundColor

The background color.

Type	string
Format	Color
Mutability	Control Usage Retool UI Inspector

Examples

"#ff0000"

---

borderColor

The border color.

Type	string
Format	Color
Mutability	Control Usage Retool UI Inspector

---

closeIcon

The icon to display when closed.

Type	string
Mutability	Read-only

---

closeIconPosition

The position of the icon relative to the text.

Type	string
Format	Plain Text
Mutability	Control Usage Retool UI Inspector > Content > Add-ons > Icon position
Allowed Values	Value UI Option Description left Left Left of text. right Right Right of text. replace Replace text Replace text.
Default	left

Examples

left

---

color

The specified color.

Type	string
Mutability	Control Usage Retool UI Inspector

---

description

Descriptive text to display to the user.

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

---

icon

the icon to display.

Type	string
Format	Icon Key
Mutability	Control Usage Retool UI Inspector > Content > Add-ons > Icon
Default	null

Examples

/icon:bold/shopping-gift

---

iconPosition

The position of the icon relative to the text.

Type	string
Format	Plain Text
Mutability	Control Usage Retool UI Inspector > Content > Add-ons > Icon position
Allowed Values	Value UI Option Description left Left Left of text. right Right Right of text. replace Replace text Replace text.
Default	left

Examples

left

---

id

The unique identifier (name).

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

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

---

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

---

onActionClick

The event handler that runs when the action is clicked.

Type	string
Mutability	Read-only

---

onClose

The event handler that runs when closed.

Type	string
Mutability	Read-only

---

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

---

style

Custom style options.

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

---

styleVariant

The style variant to use.

Type	string
Format	Plain Text
Mutability	Control Usage Retool UI Inspector > Appearance > Variant
Allowed Values	Value Description solid Solid style. outline Outline style.
Default	solid

Examples

solid

---

title

The title text to display.

Type	string
Mutability	Control Usage Retool UI Inspector

---

tooltip

The tooltip text to display next to the label on hover.

Type	string
Format	Markdown
Mutability	Control Usage Retool UI Inspector > Content > Add-ons > Tooltip

---

value

The current or default value.

Type	string
Format	Plain Text
Mutability	Control Usage Retool UI Inspector > Content > Default value Method setValue()
Default	null

Examples

Hello world!

---

Methods

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

alert.clearValue()

Clear the current values.

Definition

alert.clearValue()

Examples

Clear the current value of alert.

alert.clearValue();

---

alert.resetValue()

Reset the current value to the default value.

Definition

alert.resetValue()

Examples

Reset the current value of alert.

alert.resetValue();

---

alert.scrollIntoView()

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

Definition

alert.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 alert into view.

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

---

alert.setHidden()

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

Definition

alert.setHidden(hidden)

Parameters

hidden

Whether this object is hidden from view.

Type	boolean
Format	True/False
Default	false

Examples

true

---

Examples

Hide alert.

alert.setHidden(true);

Unhide alert.

alert.setHidden(false);

---

alert.setValue()

Set the current value.

Definition

alert.setValue(value)

Parameters

value

The value.

Type	string | number | boolean | object | array

---

Examples

Set the current value of alert to userValue.

alert.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
Close	The component or item is closed.