Skip to main content

The Alert component for Retool Apps

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

Demo

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

Settings​

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

PositionHeightShow on desktopShow on mobileMaintain space when hiddenMarginAlways show in edit modeStylesValue

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.

The icon to display.

Values

You can select an icon or dynamically set one with a valid icon key.

Demo

The position of the close icon.

Values
top

Top.

center

Center.

global​

boolean

Whether the object is globally scoped for use in all app pages.

Whether the height automatically resizes to fit content or is a fixed size.

Values
fixed

Fixed height.

auto

Expand to fit content.

​

boolean

Whether the component is visible.

id​

string

The unique identifier.

Whether the component is visible in the desktop layout.

Whether the component is visible in the mobile layout.

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

The amount of margin to render outside.

Values
4px 8px

Normal margin.

0

No margin.

pluginType​

string

The plugin type.

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.

The value.

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.

clearValue​

Clear the current values.

alert.clearValue()

resetValue​

Reset the current value to the default value.

alert.resetValue()

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.

setHidden​

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

alert.setHidden(hidden)
Parameters

​

boolean

Whether the component is visible.

setValue​

Set the current value.

alert.setValue(value)
Parameters

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.

close​

The component is closed.