Progress stepper
On this page
On this page
Overview
A progress stepper conveys the steps necessary to complete a process or task, and the status of each step. Steps have titles and descriptions; and each step can be in one of a number of possible states:
- inactive (yet to be performed)
- active (currently being performed)
- warn (succeeded, but with warnings)
- fail (failed to occur)
Or a custom state, set using the
icon
attribute.
Edit element properties
import '@rhds/elements/rh-progress-stepper/rh-progress-stepper.js';
<rh-progress-stepper>
<rh-progress-step state="complete" description="This step has been completed successfully">
Complete Step
</rh-progress-step>
<rh-progress-step state="warn" description="This step has a warning that needs attention">
Warning Step
</rh-progress-step>
<rh-progress-step state="fail" description="This step has failed and needs to be retried">
Failed Step
</rh-progress-step>
<rh-progress-step state="active" description="Currently working on this step">
Active Step
</rh-progress-step>
<rh-progress-step description="This step is not yet started">
Inactive Step
</rh-progress-step>
</rh-progress-stepper>
Makes the element vertical
at various container query based breakpoints.
Breakpoints available 'xs' | 'sm' | 'md' | 'lg' | 'xl' | '2xl'
Sets the orientation of the progress stepper
horizontal
- Steps are displayed in a horizontal rowvertical
- Steps are displayed in a vertical column
Makes element display as compact
Status
What do these mean?
- Figma library:
-
Ready - RH Elements:
-
Ready - RH Shared Libs:
-
In Progress
When to use
- Keep users informed about how much time or effort a task will take to complete
- Track progress in a step-by-step linear process on a single page
- Display the total number of steps at all times
Status checklist
Property | Status | Meaning |
---|---|---|
Figma library |
|
Component is available in the Figma library |
RH Elements |
|
Component is available in the RH Elements repo |
RH Shared Libs |
|
Component will be added to the RH Shared Libs repo when finished |
Other libraries
To learn more about our other libraries, visit this page.
Feedback
To give feedback about anything on this page, contact us.