Skip to main content

The Steps component for Retool Apps

A group of steps that trigger actions when clicked.

Steps is a set of UI elements that represent sequential steps. It can be linked to Container to create Stepped Container.

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.

captionByIndex

A list of captions for each item, by index.

Type array
Format Plain Text
Array values string
Mutability Read-only
Default
[]
Examples
["Caption 1", "Caption 2"]

data

The data.

Type string | number | boolean | object | array
Format Custom data
Mutability
ControlUsage
Retool UI Inspector
MethodcopyToClipboard()

heightType

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

Type string
Format Plain Text
Mutability
ControlUsage
Retool UI Inspector > Spacing > Height
Allowed Values
ValueDescription
auto

Expand to fit content.

fixed

Fixed height.

fill
Default
fixed

hiddenByIndex

A list of items, by index, and whether they are hidden.

Type array
Array values boolean
Mutability Read-only
Default
[]
Examples
[true, false, true]

horizontalAlign

The horizontal alignment of the contents.

Type string
Format Plain Text
Mutability
ControlUsage
Retool UI Inspector > Appearance > Alignment
Allowed Values
ValueDescription
left

Left alignment.

center

Center alignment.

right

Right alignment.

Default
left

id

The unique identifier (name).

Type string
Format Plain Text
Mutability
ControlUsage
Retool UI Inspector
Default
steps1
Examples
query1
button1

indicateCompletedSteps

Whether to indicate completed steps with check marks when showStepNumbers is true.

Type boolean
Mutability Read-only

isHiddenOnDesktop

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

Type boolean
Format True/False
Mutability
ControlUsage
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
ControlUsage
Retool UI Inspector > Appearance > Advanced > Show on mobile
Default
true
Examples
true

itemMode

The configuration mode for options.

Type string
Mutability
ControlUsage
Retool UI Inspector > Content > Options
Allowed Values
ValueUI OptionDescription
dynamicMapped

Options dynamically mapped from an array.

staticManual

Options manually configured in the IDE.

Default
dynamic
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
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
ControlUsage
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
ControlUsage
Retool UI Inspector > Spacing > Margin
Allowed Values
ValueUI OptionDescription
4px 8pxNormal

Normal margin.

0None

No margin.

Default
4px 8px
Examples
4px 8px

navigateContainer

Whether a container is linked for navigation.

Type boolean
Mutability Read-only

orientation

The orientation.

Type string
Mutability
ControlUsage
Retool UI Inspector
Allowed Values
ValueDescription
horizontal

Horizontal.

vertical

Vertical.


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
Formatstring
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
ControlUsage
Retool UI Inspector > Appearance > Advanced > Always show in edit mode
Default
false
Examples
true

showStepNumbers

Whether to display step numbers for each item.

Type boolean
Mutability Read-only

style

Custom style options.

Type object
Mutability
ControlUsage
Retool UI Inspector > Appearance > style

targetContainerId

The ID of the linked container.

Type string
Mutability Read-only

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
ControlUsage
Retool UI Inspector > Content > Add-ons > Helper text
Default
null
Examples
Submit

value

The current value.

Type string | number | boolean | object | array
Mutability Read-only

values

A list of possible values from which to select.

Type array
Mutability Read-only

Methods

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

steps.resetValue()

Reset the current value to the default value.

Definition
steps.resetValue()
Examples

Reset the current value of steps.

steps.resetValue();

steps.scrollIntoView()

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

Definition
steps.scrollIntoView(options)
Parameters

options

The scroll options.

Type object
Object Properties

behavior

The scroll behavior.

Type string
Allowed Values
ValueDescription
auto

Scroll immediately to the specified position.

smooth

Scroll gradually to the specified position.


block

The scroll position relative to the component.

Type string
Allowed Values
ValueDescription
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.



Examples

Scroll the minimum amount to immediately bring steps into view.

steps.scrollIntoView({behavior: 'auto', block: 'nearest'});

steps.setHidden()

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

Definition
steps.setHidden(hidden)
Parameters

hidden

Whether this object is hidden from view.

Type boolean
Format True/False
Default
false
Examples
true

Examples

Hide steps.

steps.setHidden(true);

Unhide steps.

steps.setHidden(false);

steps.setValue()

Set the current value.

Definition
steps.setValue(value)
Parameters

value

The value.

Type string | number | boolean | object | array

Examples

Set the current value of steps to userValue.

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