Usage
Progress steps are best used when displaying content that must be completed in a particular order.
Mobile
If a task has fewer steps and short text labels, the horizontal orientation can be used on mobile. Otherwise, if a task has more steps and longer text labels, the vertical orientation should be used instead.
Warning
Do not use more than four steps because the layout will become crowded and a user might feel overwhelmed by the number of steps.
Progression
Steps are organized from left to right or top to bottom to demonstrate a user completing a task by moving through a linear multi-step process. A user should be able to return to any previously completed step in order to review data before finishing and submitting.
Helpful tip
If a user needs to return to a previously completed step, they should be able to unless the task is complete.
Error validation
Error validation is a state that displays if there is an error that needs to be resolved first before a user can proceed. If a user tries to continue to the next step without inputting the required data, a Danger severity alert is displayed to inform them of what they should do.
Completion
At any time before a task is completed, a user is able to return to any previous steps. When all data in the final step is submitted, a user is not able to go back to review or change anything.
Helpful tip
When a user reaches the Finished state, they cannot go back to any previous steps without starting the task all over again.
Character and word counts
Each step indicator text label should be written clearly and use ideally one word to avoid crowding. The recommended maximum character and word counts count for the elements of progress steps are listed below and include spaces.
Element | Character count | Word count |
---|---|---|
Label | 20 | 2 |
Behavior
When a user navigates through steps, each step should present content relevant to the step text label. For example, if the current step text label states Choose trial, a user should be presented with the opportunity to choose a trial. Displaying relevant content and being clear about where a user is in the process will make them feel in control and encourage them to finish the task.
Interaction states
The interaction states within both orientations are the same.
Link
Hover
Focus
Active
Tab order
When the Tab key is pressed repeatedly, the focus highlights each step icon and text label in order, from left to right in the horizontal component or from top to bottom in the vertical component.
Accessibility
Key | Action |
---|---|
Tab | Moves the focus to the next step. |
Shift + Tab | Moves the focus to the previous step. |
Enter | Selects the step with focus. |
Left arrow | Moves the focus and selects the previous step. |
Right arrow | Moves the focus and selects the next step. |
Home | Moves the focus and selects the first step. |
End | Moves the focus and selects the current or final step. |
Best practices
Too many or too few steps
Do not use too many or too few steps, there should be between three and five steps visible.
Usage on mobile
Avoid using the horizontal orientation on mobile if there are too many steps present or if text labels are too long, switch to the vertical orientation instead.
Validation
Do not use the Error step icon for any previous steps, a user cannot proceed to the next step without resolving any errors first nor can they go back to resolve any errors and then continue.
Text labels
Do not use Progress steps without text labels, color or icons alone cannot be used to represent step position or validation if a user is colorblind or uses assistive technologies like a screen reader.
Carousel
Do not use Progress steps as an image carousel without including text labels and other types of content.
Tabs
Do not use Progress steps as Tabs. Progress steps are used for guiding a user through a task by displaying sequential steps and instructional content.
Related elements or patterns
Feedback
To give feedback about anything on this page, contact us.
Red Hat legal and privacy links
- About Red Hat
- Jobs
- Events
- Locations
- Contact Red Hat
- Red Hat Blog
- Diversity, equity, and inclusion
- Cool Stuff Store
- Red Hat Summit