Skip to main content

Steps

Rocket 2.0

The Steps component shows progress through a multi-step process, such as onboarding or an order's stages, with finished steps checked and the current one highlighted. It only shows progress; use Stepper for a wizard with content in each step.

Properties​

Property
Description
Expected Value
StepsSteps in order, as plain names or as items with an id and name that can add a description, tooltip, visible or disabled.Array
Current step (id)Id of the current step. When this changes, the indicator moves to that step.Text
Current step (0-based)Position of the current step, starting at 0. It updates as the step changes.Number. Default: 1
Steps selectableLets the user click a step to make it current.On or off. Default: On
OrientationWhether the steps run across or down.Horizontal, Vertical. Default: Horizontal
MarkerMarker for each step: a numbered circle or a small dot.Numbers, Dots. Default: Numbers
Loading lookWhat shows while the component is loading: a spinner or a skeleton outline.Spinner, Skeleton. Default: Spinner

Additional Actions​

Each of these can be switched on or off, or set with a logical expression by clicking fx.

Property
Description
Expected Value
VisibilityShows or hides the component. Hidden components keep their space unless Collapse when hidden is on.On or off. Default: On
Collapse when hiddenRemoves the hidden component's space, so the components below it move up.On or off. Default: Off
Loading stateShows the component's loading look and blocks interaction, for example while a query runs.On or off. Default: Off
DisableStops the user from interacting with the component.On or off. Default: Off
Dynamic heightLets the component grow with its content in the running app instead of keeping a fixed height.On or off. Default: Off

Devices​

Property
Description
Expected Value
Show on desktopShows the component in the desktop layout.On or off. Default: On
Show on mobileShows the component in the mobile layout.On or off. Default: Off

Events​

Add a handler from the Events section of the properties panel. See Event Triggers for the steps.

Event
Description
On selectTriggers when the user clicks a step.

Component Specific Actions (CSA)​

Run these from an event handler with Control Component, or from a RunJS query. See Component Specific Actions.

Action
Description
How To Access
Set stepMakes the step with the given Step id current. A disabled step is ignored.components.steps1.setStep("")
Next stepMoves to the next step that isn't disabled.components.steps1.nextStep()
Previous stepMoves to the previous step that isn't disabled.components.steps1.previousStep()
Reset stepsMoves back to the first step that isn't disabled.components.steps1.resetSteps()
Set step visibilityShows or hides the step with the given Step id until Steps changes.components.steps1.setStepVisible("", "{{true}}")
Set step disableDisables or enables the step with the given Step id until Steps changes.components.steps1.setStepDisable("", "{{true}}")
Set visibilityShows the component when true, hides it when false.components.steps1.setVisibility(false)
Set disableDisables the component when true, enables it when false.components.steps1.setDisable(false)
Set loadingTurns the loading state on with true, off with false.components.steps1.setLoading(false)

Exposed Variables​

Variable
Description
How To Access
stepsSteps in order, as plain names or as items with an id and name that can add a description, tooltip, visible or disabled.{{components.steps1.steps}}
currentStepId of the current step. When this changes, the indicator moves to that step.{{components.steps1.currentStep}}
currentStepIndexPosition of the current step, starting at 0. It updates as the step changes.{{components.steps1.currentStepIndex}}
stepsSelectableLets the user click a step to make it current.{{components.steps1.stepsSelectable}}
orientationWhether the steps run across or down.{{components.steps1.orientation}}
variantMarker for each step: a numbered circle or a small dot.{{components.steps1.variant}}
loadingIndicatorWhat shows while the component is loading: a spinner or a skeleton outline.{{components.steps1.loadingIndicator}}
currentStepIdThe id of the current step.{{components.steps1.currentStepId}}
isVisibleWhether the component is visible.{{components.steps1.isVisible}}
isLoadingWhether the component is in its loading state.{{components.steps1.isLoading}}
isDisabledWhether the component is disabled.{{components.steps1.isDisabled}}

Styles​

Style
Default
Completed and current accentTheme: Brand primary
Upcoming step accent (circle border, line)Theme: Default border
Completed step labelTheme: Primary text
Current step labelTheme: Primary text
Upcoming step labelTheme: Placeholder text
Description colorTheme: Placeholder text
Box shadow0px 0px 0px 0px #00000040

A default that starts with Theme: follows the app's theme until the style is set to another value. See App Themes.