Skip to main content

The Status component for Retool Mobile

A content area to display status information.

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.

colorByIndex

A list of colors for each item, by index.

Type array
Array values string
Configurability Read-only
Defaultnull

data

The data.

Type string | number | boolean | object | array
Format Custom data
Configurability Inspector
Defaultnull

hidden

Whether this object is hidden from view.

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

iconByIndex

A list of icons for each item, by index.

Type array
Array values string
Configurability Read-only
Default[]
Examples
["/icon:bold/shopping-gift", "/icon:bold/interface-user-single", "/icon:bold/interface-align-layers-1"]

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.

Defaultleft
Examples
left

itemMode

The configuration mode for options.

Type string
Configurability Inspector > Content > Options
Allowed Values
ValueUI OptionDescription
dynamicMapped

Options dynamically mapped from an array.

staticManual

Options manually configured in the IDE.

Defaultdynamic
Examples
"dynamic"

labels

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

Type array
Array values string
Configurability Read-only
Default[]
Examples
["Label 1", "Label 2", "Label 3"]

Examples
Hello world!

values

The value.

Type array
Array values string
Configurability Read-only
Defaultnull

Methods

JavaScript API methods for this object. You can write JavaScript almost anywhere in Retool and use methods to manipulate data and property values.

status.resetValue()

Reset the current value to the default value.

Definition
status.resetValue()
Examples

Reset the current value of status.

status.resetValue();

status.setHidden()

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

Definition
status.setHidden(hidden)
Parameters

hidden

Whether this object is hidden from view.

Type boolean
Format True/False
Default
false
Examples
true

Examples

Hide status.

status.setHidden(true);

Unhide status.

status.setHidden(false);

status.setValue()

Set the current value.

Definition
status.setValue(key, value)
Parameters

key

The key.

Type string

value

The value.

Type string | number | boolean | object | array

Examples

Set the current value of status to userValue.

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