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 |
| Default | null |
data
The data.
| Type | string | number | boolean | object | array |
| Format | Custom data |
| Configurability | Inspector |
| Default | null |
hidden
Whether this object is hidden from view.
| Type | boolean |
| Format | True/False |
| Configurability | Inspector > Appearance > Hidden |
| Default | false |
Examples
falsetrue
iconByIndex
A list of icons for each item, by index.
| Type | array |
| Array values | string |
| Configurability | Read-only |
| Default | [] |
Examples
false["/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 |
| ||||||||||||
| Default | left |
Examples
falseleft
itemMode
The configuration mode for options.
| Type | string | |||||||||
| Configurability | Inspector > Content > Options | |||||||||
| Allowed Values |
| |||||||||
| Default | dynamic |
Examples
false"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
false["Label 1", "Label 2", "Label 3"]
value
The current or default value.
| Type | string |
| Format | Plain Text |
| Configurability | Inspector > Content > Default value |
| Default | null |
Examples
falseHello 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.
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.
status.setHidden(hidden)
Parameters
Examples
true
Examples
Hide status.
status.setHidden(true);
Unhide status.
status.setHidden(false);
status.setValue(value)
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.
| Event | Description |
|---|