Skip to main content

The Status mobile component

A content area to display status information.

Status

Settings

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

ContentDataOptionsValue
InteractionEvent handlers
AppearanceShow on desktopShow on mobileMaintain space when hiddenMarginAlways show in edit modeStyles

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.

Values

A user changes the value.

A user clicks or taps the component.

A user submits the value.

A user selects the input field.

A user deselects the input field.

A user scans a barcode.

A user opens the component.

A user closes the component.

A user sets the value to true.

A user sets the value to false.

10

A user selects a value.

11

A user clears the value.

12

A user uploads a file.

13

An uploaded file is parsed.

14

A user changes the value of the input field.

change

A user changes the value.

click

A user clicks or taps the component.

submit

A user submits the value.

focus

A user selects the input field.

blur

A user deselects the input field.

scan

A user scans a barcode.

open

A user opens the component.

close

A user closes the component.

true

A user sets the value to true.

false

A user sets the value to false.

select

A user selects a value.

clear

A user clears the value.

upload

A user uploads a file.

parse

An uploaded file is parsed.

inputValueChange

A user changes the value of the input field.

method

enum

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

The type of action to perform.

Values

Control query.

Control component.

Run script.

Set variable.

Set localStorage.

Perform utility action (e.g., Open URL or Confetti).

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

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.

iconPosition

The position of the icon relative to the label.

id

string

The name.

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.