Skip to main content

Stepper

Rocket 2.0

The Stepper component is a wizard container that splits a long task into steps, each with its own area to drop components into, and Back, Next and Finish buttons. Values entered in earlier steps are kept as the user moves between them.

Properties​

Property
Description
Expected Value
StepsSteps in order, each with an id and a label. Keep the ids the same, since components dropped into a step stay with its id.Array
Start stepId of the step shown. It updates as the user moves between steps.Text. Default: account
Finish buttonText on the button shown on the last step.Text. Default: Finish
Next buttonText on the button that moves to the next step.Text. Default: Next
Back buttonText on the button that moves to the previous step.Text. Default: Back
Steps in order onlyStops the user from jumping ahead by clicking a later step in the header. They can still go back.On or off. Default: Off

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

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 step changeTriggers when the stepper moves to another step.
On finishTriggers when the user clicks the finish button on the last 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
Next stepMoves to the next step.components.stepper1.nextTab()
Previous stepMoves to the previous step.components.stepper1.previousTab()
Go to stepMoves to the step with the given Step id.components.stepper1.setTab("")
Set visibilityShows the component when true, hides it when false.components.stepper1.setVisibility(false)
Set disableDisables the component when true, enables it when false.components.stepper1.setDisable(false)
Set loadingTurns the loading state on with true, off with false.components.stepper1.setLoading(false)

Exposed Variables​

Variable
Description
How To Access
stepsSteps in order, each with an id and a label. Keep the ids the same, since components dropped into a step stay with its id.{{components.stepper1.steps}}
currentStepId of the step shown. It updates as the user moves between steps.{{components.stepper1.currentStep}}
finishLabelText on the button shown on the last step.{{components.stepper1.finishLabel}}
nextLabelText on the button that moves to the next step.{{components.stepper1.nextLabel}}
backLabelText on the button that moves to the previous step.{{components.stepper1.backLabel}}
linearStepsStops the user from jumping ahead by clicking a later step in the header. They can still go back.{{components.stepper1.linearSteps}}
currentStepIndexThe position of the current step, starting at 0.{{components.stepper1.currentStepIndex}}
isFirstStepWhether the first step is shown.{{components.stepper1.isFirstStep}}
isLastStepWhether the last step is shown.{{components.stepper1.isLastStep}}
isVisibleWhether the component is visible.{{components.stepper1.isVisible}}
isLoadingWhether the component is in its loading state.{{components.stepper1.isLoading}}
isDisabledWhether the component is disabled.{{components.stepper1.isDisabled}}

Styles​

Style
Default
AccentTheme: Brand primary
BackgroundTheme: Surface 1
Border radius—
Padding12
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.