Skip to main content

The Status web component

A content area to display a status indicator.

Settings

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

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


fallbackTooltip

string[]

The tooltip text to display for each item.


global

boolean

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


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

Values
fixed

Fixed height.

auto

Expand to fit content.


boolean

Whether the component is visible.


The horizontal alignment of the contents.

Values
left

Left alignment.

center

Center alignment.

right

Right alignment.

stretched

Justified alignment


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


selectedIndex

number

The selected value, by index.


selectedItem

object

The selected item.


selectedLabel

string

The label of the selected value, by index.


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.


tooltipByIndex

string[]

A list of tooltips for each item, by index.


The value.


values

A list of possible values.


verticalAlign

enum

The vertical alignment of the content.

Values
top

Align to the top.

center

Align to the center.

bottom

Align to the bottom.


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

scrollIntoView

Scrolls the canvas or parent container so that the selected component appears in the visible area.

status.scrollIntoView(scrollIntoViewOptions)
Parameters

scrollIntoViewOptions

object

The scroll options.

Properties

behavior

enum

The scroll behavior.

Values
auto

Scroll immediately to the specified position.

smooth

Scroll gradually to the specified position.


block

enum

The scroll position relative to the component.

Values
nearest

Scrolls only the minimum amount required for the component to appear in the visible area. Scrolling does not occur if the component is already in view.

start

Scrolls to position the component at the top of the visible area.

center

Scrolls to position the component in the middle of the visible area.

end

Scrolls to position the component at the bottom of the visible area.




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.