The Alert component for Retool Apps

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

Settings

Alert includes the following configurable options when building apps in the IDE.

LabelDescriptionEvent handlersHiddenShow on desktopShow on mobileMaintain space when hiddenMarginAlways show in edit modeStyles

Properties

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

action

Deprecated

function

The event handler that runs when button is clicked. Superseded by the click event handler.

type

enum

The alert type.

Values

info	Info (blue).
success	Success (green).
error	Error (red).
warning	Warning (amber).

buttonText

string

The text label to display.

buttonType

enum

The type of button to display.

Values

action

Action button.

description

string

Descriptive text to display to the user.

events

object[]

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

Properties

event

enum

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 true.
false	A user sets the value to false.
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

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

exportFileName

Deprecated

string

The name of the file to export if action is configured. Superseded by the click event handler.

exportFileType

Deprecated

string

The file type to export if action is configured. Superseded by the click event handler.

exportQuery

Deprecated

string

The query to trigger if action is configured. Superseded by the click event handler.

hidden

boolean

Whether the component is visible.

id

string

The unique identifier.

internalUrlHashParams

Deprecated

string

URL parameters to use if action is configured. Superseded by the click event handler.

internalUrlPath

Deprecated

string

URL path to use if action is configured. Superseded by the click event handler.

internalUrlQuery

Deprecated

string

Query to use if action is configured. Superseded by the click event handler.

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.

newWindow

Deprecated

boolean

Whether to open a new window if action is configured. Superseded by the click event handler.

pluginType

string

The plugin type.

showInEditor

boolean

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

style

object

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

title

string

The text to display as a title.

url

Deprecated

string

URL to use if action is configured. Superseded by the click event handler.

valueToCopy

Deprecated

string

The value to copy if action is configured. Superseded by the click event handler.

Methods

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

scrollIntoView

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

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

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.

click

The item is clicked or pressed.