The Steps component for Retool Apps
A group of steps that trigger actions when clicked.
Steps is a set of clickable UI elements to represent sequential steps. It can be linked to Container to create Stepped Container.
Settings
Steps includes the following configurable options when building apps in the IDE.
| DataHeightAlignShow on desktopShow on mobileOptionsMaintain space when hiddenMarginOrientationAlways show in edit modeStylesValue |
Properties
All properties for Steps 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.
global
Whether the object is globally scoped for use in all app pages.
heightType
Whether the height automatically resizes to fit content or is a fixed size.
Values
fixed | Fixed height. |
auto | Expand to fit content. |
Whether the component is visible.
hiddenByIndex
A list of items, by index, and whether they are hidden.
horizontalAlign
The horizontal alignment of the contents.
Values
left | Left alignment. |
center | Center alignment. |
right | Right alignment. |
stretched | Justified alignment |
id
The unique identifier.
indicateCompletedSteps
Whether to indicate completed steps with check marks when showStepNumbers is true.
isHiddenOnDesktop
Whether the component is visible in the desktop layout.
isHiddenOnMobile
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
A list of labels for each item. Falls back to the corresponding value if no label is provided.
maintainSpaceWhenHidden
Whether the component takes up space on the canvas if hidden is true.
navigateContainer
Whether the component is linked to a container for navigation.
orientation
The orientation.
Values
horizontal | Horizontal. |
vertical | Vertical. |
pluginType
The plugin type.
selectedIndex
The selected value, by index.
selectedItem
The selected item.
selectedLabel
The label of the selected value, by index.
showInEditor
Whether to remain visible in the editor if hidden is true.
showStepNumbers
Whether to display step numbers for each item.
targetContainerId
The ID of the linked container.
tooltipByIndex
A list of tooltips for each item, by index.
values
A list of possible values.
Methods
JavaScript API methods for interacting with Steps. 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.
steps.resetValue()
scrollIntoView
Scrolls the canvas or parent container so that the selected component appears in the visible area.
steps.scrollIntoView(scrollIntoViewOptions)
Parameters
scrollIntoViewOptions
The scroll options.
Properties
behavior
The scroll behavior.
Values
auto | Scroll immediately to the specified position. |
smooth | Scroll gradually to the specified position. |
block
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.
steps.setHidden(hidden)
Parameters
Whether the component is visible.