Skip to main content

The Status component for Retool Mobile

A content area to display status information.

Demo

Settings​

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

DataEvent handlersShow on desktopShow on mobileOptionsMaintain space when hiddenMarginAlways show in edit modeStylesValue

Properties​

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

colorByIndex​

string[]

A list of colors for each item, by index.

data​

any[]

The source data.

events​

object[]

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

Properties

event​

enum

The event type. Refer to the events section for a list of supported events.

method​

enum

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

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

global​

boolean

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

​

boolean

Whether the component is visible.

iconByIndex​

enum[]

A list of icons for each item, by index.

Values

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

Demo

iconPosition​

The position of the icon relative to the label.

id​

string

The unique identifier.

Whether the component is visible in the desktop layout.

Whether the component is visible in the mobile layout.

The configuration mode for option lists. Either dynamic for mapped options or static for manual options.

Values
dynamic

Options dynamically mapped from an array.

manual

Options manually configured in the IDE.

labels​

string

A list of labels for each item. Falls back to the corresponding value if no label is provided.

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.

value​

string

The value.

values​

A list of possible values.

Methods​

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

resetValue​

Reset the current value to the default value.

status.resetValue()

setHidden​

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

status.setHidden(hidden)
Parameters

​

boolean

Whether the component is visible.

setValue​

Set the current value.

status.setValue(value)
Parameters

value​

string

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.