The Alert component for Retool Apps

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

Version: Self-hosted 3.114 Stable

This is a legacy component that is no longer supported. Use the newer version of this component which has more features and functionality.

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.

action

The event handler that runs when the action button is clicked.

Type	string
Mutability	Read-only

---

alertType

The alert type.

Type	string
Format	Plain Text
Mutability	Control Usage Retool UI Inspector
Allowed Values	Value Description info Info (blue). success Success (green). error Error (red). warning Warning (amber).
Default	info

Examples

"info"

---

buttonText

The text label to display.

Type	string
Format	Plain Text
Mutability	Control Usage Retool UI Inspector > Content > Add-ons > Label > Label
Default	null

Examples

"Label"

---

buttonType

The type of button to display.

Type	string
Mutability	Read-only
Allowed Values	Value Description action Action button.

---

description

Descriptive text to display to the user.

Type	string
Mutability	Control Usage Retool UI Inspector

---

exportFileName

The name of the file to export if action is configured.

Type	string
Mutability	Read-only

---

exportFileType

The file type to export if action is configured.

Type	string
Mutability	Read-only

---

exportQuery

The query to trigger if action is configured.

Type	string
Mutability	Read-only

---

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	legacyAlert1

Examples

query1

button1

---

internalUrlHashParams

URL parameters to use if action is configured.

Type	string
Mutability	Read-only

---

internalUrlPath

URL path to use if action is configured.

Type	string
Mutability	Read-only

---

internalUrlQuery

Query to use if action is configured.

Type	string
Mutability	Read-only

---

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

---

newWindow

Whether to open a new window if action is configured.

Type	boolean
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

---

title

The title text to display.

Type	string
Mutability	Control Usage Retool UI Inspector

---

urlAlert

URL to use if action is configured.

Type	string
Mutability	Read-only

---

valueToCopy

The value to copy if action is configured.

Type	string
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.

legacyAlert.scrollIntoView()

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

Definition

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

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

---

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
Click	An item is clicked or pressed.