Skip to main content

The Alert component for Retool Apps

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

Version: Cloud and 3.234 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
Configurability Inspector
Examples
"/icon:bold/alert"

actionIconPosition​

The position of the action icon.

Type string
Format Plain Text
Configurability Inspector
Allowed Values
ValueDescription
left

Left.

right

Right.

Examples
"left"

actionPosition​

The position of the action button.

Type string
Configurability Inspector
Allowed Values
ValueDescription
top

Top.

bottom

Bottom.

actionText​

The text to display on the action button.

Type string
Format Plain Text
Configurability Inspector
Examples
"Submit"

actionTooltip​

The tooltip to display on hover over the action button.

Type string
Format Plain Text
Configurability Inspector
Examples
"Click to deploy."

backgroundColor​

The background color.

Type string
Format Color
Configurability Inspector
Examples
"#ff0000"

borderColor​

The border color.

Type string
Format Color
Configurability Inspector

closeIcon​

The icon to display when closed.

Type string
Configurability Read-only

closeIconPosition​

The position of the icon relative to the text.

Type string
Format Plain Text
Configurability Inspector > Content > Add-ons > Icon position
Allowed Values
ValueUI OptionDescription
leftLeft

Left of text.

rightRight

Right of text.

replaceReplace text

Replace text.

Default
left
Examples
left

color​

The specified color.

Type string
Configurability Inspector

description​

Descriptive text to display to the user.

Type string
Configurability Inspector

events​

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

Type array
Array values object
Configurability Inspector > Interaction > Event handlers
Array Object Properties

event​

The event that triggers the action. Refer to the events section for details of available events for this object.

Type string
Configurability Inspector > Interaction > Event handlers > Event

method​

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

Type string
Configurability Inspector > Interaction > Event handlers > Edit event handler > Run script actions

type​

The type of action to perform.

Type string
Configurability Inspector > Interaction > Event handlers > Edit event handler > Action
Allowed Values
ValueDescription
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).

hidden​

Whether this object is hidden from view.

Type boolean
Format True/False
Configurability Inspector > Appearance > Hidden
Default
false
Examples
true

icon​

the icon to display.

Type string
Format Icon Key
Configurability 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
Configurability Inspector > Content > Add-ons > Icon position
Allowed Values
ValueUI OptionDescription
leftLeft

Left of text.

rightRight

Right of text.

replaceReplace text

Replace text.

Default
left
Examples
left

id​

The unique identifier (name).

Type string
Format Plain Text
Configurability Inspector
Default
alert1
Examples
query1
button1

isHiddenOnDesktop​

Whether to show or hide this object in the desktop layout.

Type boolean
Format True/False
Configurability 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
Configurability 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
Configurability Inspector > Appearance > Advanced > Maintain space when hidden
Default
false
Examples
true

margin​

The amount of margin to render outside.

Type string
Format Plain Text
Configurability Inspector > Spacing > Margin
Allowed Values
ValueUI OptionDescription
4px 8pxNormal

Normal margin.

0None

No margin.

Default
4px 8px
Examples
4px 8px

onActionClick​

The event handler that runs when the action is clicked.

Type string
Configurability Read-only

onClose​

The event handler that runs when closed.

Type string
Configurability Read-only

showInEditor​

Whether the component remains visible in the editor if hidden is true.

Type boolean
Format True/False
Configurability Inspector > Appearance > Advanced > Always show in edit mode
Default
false
Examples
true

style​

Custom style options.

Type object
Configurability Inspector > Appearance > style

styleVariant​

The style variant to use.

Type string
Format Plain Text
Configurability Inspector > Appearance > Variant
Allowed Values
ValueDescription
solid

Solid style.

outline

Outline style.

Default
solid
Examples
solid

title​

The title text to display.

Type string
Configurability Inspector

tooltip​

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

Type string
Format Markdown
Configurability Inspector > Content > Add-ons > Tooltip

value​

The current or default value.

Type string
Format Plain Text
Configurability Inspector > Content > Default value
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
ValueDescription
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
ValueDescription
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(key, value)
Parameters

key​

The key.

Type string

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.

EventDescription
CloseThe component or item is closed.