The Status component for Retool Apps

A content area to display a status indicator.

Version: Cloud and 3.188 Edge

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

Demo

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
Mutability	Read-only

---

fallbackValue

The fallback value to use.

Type	string
Mutability	Control Usage Retool UI Inspector

---

heightType

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

Type	string
Format	Plain Text
Mutability	Control Usage Retool UI Inspector > Spacing > Height
Allowed Values	Value Description auto Expand to fit content. fixed Fixed height. fill
Default	fixed

---

horizontalAlign

The horizontal alignment of the contents.

Type	string
Format	Plain Text
Mutability	Control Usage Retool UI Inspector > Appearance > Alignment
Allowed Values	Value Description left Left alignment. center Center alignment. right Right alignment.
Default	left

---

iconByIndex

A list of icons for each item, by index.

Type	array
Array values	string
Mutability	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
Mutability	Control Usage Retool UI Inspector > Content > Add-ons > Icon position
Allowed Values	Value UI Option Description left Left Left of text. right Right Right of text. replace Replace text Replace text.
Default	left

Examples

left

---

id

The unique identifier (name).

Type	string
Format	Plain Text
Mutability	Control Usage Retool UI Inspector
Default	status1

Examples

query1

button1

---

isHiddenOnDesktop

Whether to show or hide this object in the desktop layout.

Type	boolean
Format	True/False
Mutability	Control Usage Retool UI Inspector > Appearance > Advanced > Show on desktop
Default	false

Examples

true

---

isHiddenOnMobile

Whether to show or hide this object in the mobile layout.

Type	boolean
Format	True/False
Mutability	Control Usage Retool UI Inspector > Appearance > Advanced > Show on mobile
Default	true

Examples

true

---

labels

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

Type	array
Array values	string
Mutability	Read-only
Default	[]

Examples

["Label 1", "Label 2", "Label 3"]

---

maintainSpaceWhenHidden

Whether to take up space on the canvas if hidden is true.

Type	boolean
Format	True/False
Mutability	Control Usage Retool UI Inspector > Appearance > Advanced > Maintain space when hidden
Default	false

Examples

true

---

margin

The amount of margin to render outside.

Type	string
Format	Plain Text
Mutability	Control Usage Retool UI Inspector > Spacing > Margin
Allowed Values	Value UI Option Description 4px 8px Normal Normal margin. 0 None No margin.
Default	4px 8px

Examples

4px 8px

---

selectedIndex

The selected values, by index.

Type	number
Format	Integer
Mutability	Read-only
Default	[]

Examples

["Value 1", "Value 2"]

---

selectedItem

The selected item.

Type	string | number | boolean | object | array
Format	Custom data
Mutability	Read-only
Default	null

Examples

{"id": "1", "name": "Item 1"}

---

selectedLabel

The label of the selected value, by index.

Type	string
Format	string
Mutability	Read-only
Default	null

Examples

Value 1

---

showInEditor

Whether the component remains visible in the editor if hidden is true.

Type	boolean
Format	True/False
Mutability	Control Usage Retool UI Inspector > Appearance > Advanced > Always show in edit mode
Default	false

Examples

true

---

style

Custom style options.

Type	object
Mutability	Control Usage Retool UI Inspector > Appearance > style

---

tooltipByIndex

A list of tooltips for each item, by index.

Type	array
Array values	string
Mutability	Read-only
Default	[]

Examples

["Tooltip 1", "Tooltip 2"]

---

tooltipText

The tooltip text to display next to the label on hover.

Type	string
Format	Markdown
Mutability	Control Usage Retool UI Inspector > Content > Add-ons > Helper text
Default	null

Examples

Submit

---

value

The current value.

Type	string
Mutability	Read-only

---

values

A list of possible values from which to select.

Type	array
Mutability	Read-only

---

verticalAlign

The vertical alignment of the content.

Type	string
Mutability	Read-only
Allowed Values	Value Description top Align to the top. center Align to the center. bottom Align to the bottom.

---

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(value)

Parameters

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.

Event	Description