Skip to main content Home
About About the Design SystemRoadmap
Get started OverviewDesignersDevelopers
Foundations OverviewColorGridIconographyInteractionsSpacingTypography
Tokens Overview Global colorbox shadowTypographyborderopacityspacelengthIconBreakpointsMedia Queries
Elements All elements Accordion Alert Announcement Audio player Avatar Back to top Badge Blockquote Breadcrumb Button Card Chip Code block Call to action Dialog Disclosure Footer Health index Icon Jump links Navigation (primary) Navigation (secondary) Pagination PopoverPlanned Progress stepper Scheme toggle Site status Skeleton Skip link Spinner Statistic Subnavigation Surface Switch Table Tabs Tag Tile Timestamp Tooltip Video embed
Theming OverviewColor PalettesCustomizingDevelopers
Patterns All PatternsCardFilterFormLink with iconLogo wallSearch barSticky bannerSticky cardTabsTagTile
Personalization All Personalization PatternsAnnouncement
Accessibility FundamentalsAccessibility toolsAssistive technologiesCI/CDContentContributorsDesignDevelopmentManual testingResourcesScreen readers
Design/code status Release notes Get support

Progress stepper

OverviewStyleGuidelinesCodeAccessibilityDemos
ImportingUsagerh-progress-stepperrh-progress-stepImportingUsagerh-progress-stepperrh-progress-step

Importing

Add rh-progress-stepper to your page with this import statement:

<script type="module">
  import '@rhds/elements/rh-progress-stepper/rh-progress-stepper.js';
</script>
Copy to Clipboard Wrap lines

To learn more about installing RHDS elements on your site using an import map read our getting started docs.

Usage 

<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>

<script type="module">
  import '@rhds/elements/rh-progress-stepper/rh-progress-stepper.js';
</script>
Copy to Clipboard Wrap lines

rh-progress-stepper

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.
Slots 1
Slot Name Summary Description

Use this slot for <rh-progress-step> items
Attributes 3
Attribute DOM Property Description Type Default
vertical-at verticalAt

Makes the element vertical at various container query based breakpoints. Breakpoints available 'xs' | 'sm' | 'md' | 'lg' | 'xl' | '2xl'

 
'xs' | 'sm' | 'md' | 'lg' | 'xl' | '2xl'
 
undefined
orientation orientation

Sets the orientation of the progress stepper

  • horizontal - Steps are displayed in a horizontal row
  • vertical - Steps are displayed in a vertical column
 
ProgressStepsOrientation
 
'horizontal'
compact compact

Makes element display as compact

 
boolean
 
false
Methods 0
None
Events 0
None
CSS Shadow Parts 0
None
CSS Custom Properties 0
None
Design Tokens 16
Token Copy
--rh-color-border-strong
--rh-color-text-primary
--rh-length-xl
--rh-size-icon-02
--rh-font-weight-body-text-medium
--rh-color-border-subtle
--rh-length-2xl
--rh-length-xs
--rh-length-lg
--rh-color-status-note
--rh-color-status-success
--rh-color-yellow-50
--rh-color-yellow-30
--rh-color-yellow-60
--rh-color-yellow-20
--rh-color-status-danger

rh-progress-step

A progress step represents a single step in a progress stepper. Each step can have different states and may include an icon, label, and description. Steps can also be linked to URLs.

Slots 3
Slot Name Summary Description

A short title for the step, which also serves as the step's accessible name
icon

custom icon for the step

Overrides the icon and icon-set attributes. Prefer using the icon attribute and the (default) UI Icon set. Avoid slotting content here if the step is in the warn or fail state, Since those states should always show their prescribed icons.
description

Elaborative description for the step

Rich HTML content can be slotted here , to override the (plain text) description attribute. Avoid slotting links, images, block-level content, etc.: descriptions should be prose only.
Attributes 5
Attribute DOM Property Description Type Default
state state

Sets the state of the progress step

  • inactive - The step is not active
  • active - The step is currently active
  • complete - The step has been completed
  • warn - The step is in a warning state
  • fail - The step has failed
  • custom - The step uses a custom icon
 
ProgressStepState
 
unknown
description description

Sets the description text for the progress step Overridden by the description slot.

 
string
 
unknown
icon icon

Custom icon for the step. Overridden by the icon slot. When the step is in the warn or fail state, it should not have a custom icon.

 
IconNameFor<IconSetName>
 
unknown
icon-set iconSet

Icon set for the icon property - 'ui' by default

 
IconSetName
 
'ui'
href href

Sets a URL to make the step clickable

 
string
 
unknown
Methods 0
None
Events 1
Event Name Description
fired
CSS Shadow Parts 0
None
CSS Custom Properties 0
None
Design Tokens 21
Token Copy
--rh-color-text-primary
--rh-length-5xl
--rh-color-text-secondary
--rh-font-family-body-text
--rh-font-size-body-text-md
--rh-border-width-md
--rh-color-surface-lightest
--rh-color-surface-darkest
--rh-color-gray-50
--rh-color-gray-40
--rh-color-interactive-primary-hover
--rh-font-weight-body-text-regular
--rh-font-size-body-text-xs
--rh-color-status-note
--rh-color-status-success
--rh-color-yellow-50
--rh-color-yellow-30
--rh-color-yellow-60
--rh-color-yellow-20
--rh-color-status-danger
--rh-font-weight-body-text-medium
Edit this page on GitHub
© 2025 Red Hat Deploys by Netlify