Progress Stepper
A progress stepper displays a timeline of tasks in a workflow and tracks the user's current progress through this workflow.
Installation
We recommend loading elements via a CDN such as JSPM and using an import map to manage your dependencies.
For more information on import maps and how to use them, see the import map reference on MDN Web Docs.
If you are using node and NPM, you can install this component using npm:
npm install @patternfly/elementsThen import this component into your project by using a bare module specifier:
import '@patternfly/elements/pf-progress-stepper/pf-progress-stepper.js';Please Note You should either load elements via a CDN or install them locally through NPM. Do not do both.
Overview
Installation
npm install @patternfly/elementsUsage
View HTML Source
<pf-progress-stepper>
<pf-progress-step variant="success">Completed</pf-progress-step>
<pf-progress-step current variant="warning">Issue</pf-progress-step>
<pf-progress-step variant="danger">Failure</pf-progress-step>
<pf-progress-step variant="info">Running</pf-progress-step>
<pf-progress-step>Last</pf-progress-step>
</pf-progress-stepper>
Slots
None
Slots on pf-progress-step
- Default Slot
-
Short description of the current step.
-
description -
Longer description of the current step.
-
icon -
Overrides the icon property
Attributes
vertical-
Whether to use the vertical layout
- DOM Property
vertical- Type
-
boolean - Default
-
false
center-
Whether to use the center alignment
- DOM Property
center- Type
-
boolean - Default
-
false
compact-
Whether to use the compact layout
- DOM Property
compact- Type
-
boolean - Default
-
false
Methods
None
Events
None
CSS Custom Properties
| CSS Property | Description | Default |
|---|---|---|
--pf-c-progress-stepper--m-vertical--GridAutoFlow |
row
|
|
--pf-c-progress-stepper--m-vertical--GridTemplateColumns |
auto 1fr
|
|
--pf-c-progress-stepper--m-vertical__step-connector--before--Top |
0
|
|
--pf-c-progress-stepper--m-vertical__step-connector--before--Left |
calc(var(--pf-c-progress-stepper__step-icon--Width) / 2)
|
|
--pf-c-progress-stepper--m-vertical__step-connector--before--Width |
auto
|
|
--pf-c-progress-stepper--m-vertical__step-connector--before--Height |
100%
|
|
--pf-c-progress-stepper--m-vertical__step-connector--before--BorderRightWidth |
var(--pf-global--BorderWidth--md, 2px)
|
|
--pf-c-progress-stepper--m-vertical__step-connector--before--BorderRightColor |
var(--pf-global--BorderColor--100, #d2d2d2)
|
|
--pf-c-progress-stepper--m-vertical__step-connector--before--BorderBottomWidth |
0
|
|
--pf-c-progress-stepper--m-vertical__step-connector--before--BorderBottomColor |
transparent
|
|
--pf-c-progress-stepper--m-vertical__step-connector--before--Transform |
translateX(-50%)
|
|
--pf-c-progress-stepper--m-vertical__step-main--MarginTop |
var(--pf-global--spacer--xs, 0.25rem)
|
|
--pf-c-progress-stepper--m-vertical__step-main--MarginRight |
0
|
|
--pf-c-progress-stepper--m-vertical__step-main--MarginBottom |
var(--pf-global--spacer--xl, 2rem)
|
|
--pf-c-progress-stepper--m-vertical__step-main--MarginLeft |
var(--pf-global--spacer--xs, 0.25rem)
|
|
--pf-c-progress-stepper--m-vertical--m-compact--GridTemplateColumns |
1fr
|
|
--pf-c-progress-stepper--m-vertical--m-compact__step-connector--PaddingBottom |
var(--pf-global--spacer--xs, 0.25rem)
|
|
--pf-c-progress-stepper--m-vertical--m-compact__step-connector--GridRow |
auto
|
|
--pf-c-progress-stepper--m-vertical--m-compact__step-main--MarginRight |
0
|
|
--pf-c-progress-stepper--m-vertical--m-center__step-main--MarginRight |
0
|
|
--pf-c-progress-stepper--m-vertical--m-center__step-main--MarginLeft |
0
|
|
--pf-c-progress-stepper--m-horizontal--GridAutoFlow |
column
|
|
--pf-c-progress-stepper--m-horizontal--GridTemplateColumns |
initial
|
|
--pf-c-progress-stepper--m-horizontal__step-connector--before--Top |
calc(var(--pf-c-progress-stepper__step-icon--Height) / 2)
|
|
--pf-c-progress-stepper--m-horizontal__step-connector--before--Left |
0
|
|
--pf-c-progress-stepper--m-horizontal__step-connector--before--Width |
100%
|
|
--pf-c-progress-stepper--m-horizontal__step-connector--before--Height |
auto
|
|
--pf-c-progress-stepper--m-horizontal__step-connector--before--BorderRightWidth |
0
|
|
--pf-c-progress-stepper--m-horizontal__step-connector--before--BorderRightColor |
unset
|
|
--pf-c-progress-stepper--m-horizontal__step-connector--before--BorderBottomWidth |
var(--pf-global--BorderWidth--md, 2px)
|
|
--pf-c-progress-stepper--m-horizontal__step-connector--before--BorderBottomColor |
var(--pf-global--BorderColor--100, #d2d2d2)
|
|
--pf-c-progress-stepper--m-horizontal__step-connector--before--Transform |
translateY(-50%)
|
|
--pf-c-progress-stepper--m-horizontal__step-main--MarginTop |
var(--pf-global--spacer--xs, 0.25rem)
|
|
--pf-c-progress-stepper--m-horizontal__step-main--MarginRight |
var(--pf-global--spacer--xs, 0.25rem)
|
|
--pf-c-progress-stepper--m-horizontal__step-main--MarginBottom |
0
|
|
--pf-c-progress-stepper--m-horizontal__step-main--MarginLeft |
0
|
|
--pf-c-progress-stepper--m-horizontal--m-compact--GridTemplateColumns |
repeat(auto-fill, 1.75rem)
|
|
--pf-c-progress-stepper--m-horizontal--m-compact__step-connector--PaddingBottom |
0
|
|
--pf-c-progress-stepper--m-horizontal--m-compact__step-connector--GridRow |
2
|
|
--pf-c-progress-stepper--m-compact--GridAutoFlow |
row
|
|
--pf-c-progress-stepper--m-compact__step-main--MarginTop |
0
|
|
--pf-c-progress-stepper--m-compact__step-main--MarginBottom |
var(--pf-global--spacer--xs, 0.25rem)
|
|
--pf-c-progress-stepper--m-compact__step-connector--MinWidth |
1.75rem
|
|
--pf-c-progress-stepper--m-compact__step-icon--Width |
1.125rem
|
|
--pf-c-progress-stepper--m-compact__step-icon--FontSize |
var(--pf-global--icon--FontSize--sm, 0.625rem)
|
|
--pf-c-progress-stepper--m-compact__step-title--FontSize |
var(--pf-global--FontSize--sm, 0.875rem)
|
|
--pf-c-progress-stepper--m-compact__step-title--FontWeight |
var(--pf-global--FontWeight--normal, 400)
|
|
--pf-c-progress-stepper--m-compact__pficon--MarginTop |
2px
|
|
--pf-c-progress-stepper--m-compact__fa-exclamation-triangle--MarginTop |
-3px
|
|
--pf-c-progress-stepper--m-center__step-connector--before--Left |
50%
|
|
--pf-c-progress-stepper--m-center--GridTemplateColumns |
1fr
|
|
--pf-c-progress-stepper--m-center__step-connector--JustifyContent |
center
|
|
--pf-c-progress-stepper--m-center__step-main--MarginRight |
var(--pf-global--spacer--xs, 0.25rem)
|
|
--pf-c-progress-stepper--m-center__step-main--MarginLeft |
var(--pf-global--spacer--xs, 0.25rem)
|
|
--pf-c-progress-stepper--m-center__step-main--TextAlign |
center
|
|
--pf-c-progress-stepper--m-center__step-description--MarginRight |
0
|
|
--pf-c-progress-stepper--m-center__step-description--MarginLeft |
0
|
|
--pf-c-progress-stepper--GridTemplateRows |
auto 1fr
|
|
--pf-c-progress-stepper__step-connector--JustifyContent |
start
|
|
--pf-c-progress-stepper__step-icon--ZIndex |
var(--pf-global--ZIndex--xs, 100)
|
|
--pf-c-progress-stepper__step-icon--Width |
1.75rem
|
|
--pf-c-progress-stepper__step-icon--Height |
var(--pf-c-progress-stepper__step-icon--Width)
|
|
--pf-c-progress-stepper__step-icon--FontSize |
var(--pf-global--FontSize--md, 1rem)
|
|
--pf-c-progress-stepper__step-icon--Color |
var(--pf-global--Color--100, #151515)
|
|
--pf-c-progress-stepper__step-icon--BackgroundColor |
var(--pf-global--BackgroundColor--light-200, #fafafa)
|
|
--pf-c-progress-stepper__step-icon--BorderWidth |
var(--pf-global--BorderWidth--md, 2px)
|
|
--pf-c-progress-stepper__step-icon--BorderColor |
var(--pf-global--BorderColor--100, #d2d2d2)
|
|
--pf-c-progress-stepper__pficon--MarginTop |
3px
|
|
--pf-c-progress-stepper__fa-exclamation-triangle--MarginTop |
-5px
|
|
--pf-c-progress-stepper__step-title--Color |
var(--pf-global--Color--100, #151515)
|
|
--pf-c-progress-stepper__step-title--TextAlign |
left
|
|
--pf-c-progress-stepper__step-title--FontSize |
var(--pf-global--FontSize--md, 1rem)
|
|
--pf-c-progress-stepper__step-title--FontWeight |
var(--pf-global--FontWeight--normal, 400)
|
|
--pf-c-progress-stepper__step--m-current__step-title--FontWeight |
var(--pf-global--FontWeight--bold, 700)
|
|
--pf-c-progress-stepper__step--m-current__step-title--Color |
var(--pf-global--Color--100, #151515)
|
|
--pf-c-progress-stepper__step--m-pending__step-title--Color |
var(--pf-global--Color--200, #6a6e73)
|
|
--pf-c-progress-stepper__step--m-danger__step-title--Color |
var(--pf-global--danger-color--100, #c9190b)
|
|
--pf-c-progress-stepper__step-title--m-help-text--TextDecorationColor |
var(--pf-global--BorderColor--200, #8a8d90)
|
|
--pf-c-progress-stepper__step-title--m-help-text--TextDecorationThickness |
var(--pf-global--BorderWidth--sm, 1px)
|
|
--pf-c-progress-stepper__step-title--m-help-text--TextUnderlineOffset |
0.25rem
|
|
--pf-c-progress-stepper__step-title--m-help-text--hover--TextDecorationColor |
var(--pf-global--Color--100, #151515)
|
|
--pf-c-progress-stepper__step-title--m-help-text--focus--TextDecorationColor |
var(--pf-global--Color--100, #151515)
|
|
--pf-c-progress-stepper__step-title--m-help-text--hover--Color |
var(--pf-global--Color--100, #151515)
|
|
--pf-c-progress-stepper__step-title--m-help-text--focus--Color |
var(--pf-global--Color--100, #151515)
|
|
--pf-c-progress-stepper__step--m-danger__step-title--m-help-text--hover--Color |
var(--pf-global--danger-color--200, #a30000)
|
|
--pf-c-progress-stepper__step--m-danger__step-title--m-help-text--focus--Color |
var(--pf-global--danger-color--200, #a30000)
|
|
--pf-c-progress-stepper__step--m-danger__step-title--m-help-text--TextDecorationColor |
var(--pf-global--danger-color--100, #c9190b)
|
|
--pf-c-progress-stepper__step--m-danger__step-title--m-help-text--hover--TextDecorationColor |
var(--pf-global--danger-color--200, #a30000)
|
|
--pf-c-progress-stepper__step--m-danger__step-title--m-help-text--focus--TextDecoerationColor |
var(--pf-global--danger-color--200, #a30000)
|
|
--pf-c-progress-stepper__step-description--MarginTop |
var(--pf-global--spacer--xs, 0.25rem)
|
|
--pf-c-progress-stepper__step-description--FontSize |
var(--pf-global--FontSize--sm, 0.875rem)
|
|
--pf-c-progress-stepper__step-description--Color |
var(--pf-global--Color--200, #6a6e73)
|
|
--pf-c-progress-stepper__step-description--TextAlign |
left
|
|
--pf-c-progress-stepper--GridAutoFlow |
var(--pf-c-progress-stepper--m-vertical--GridAutoFlow)
|
|
--pf-c-progress-stepper--GridTemplateColumns |
var(--pf-c-progress-stepper--m-vertical--GridTemplateColumns)
|
|
--pf-c-progress-stepper__step-connector--before--Top |
var(--pf-c-progress-stepper--m-vertical__step-connector--before--Top)
|
|
--pf-c-progress-stepper__step-connector--before--Left |
var(--pf-c-progress-stepper--m-vertical__step-connector--before--Left)
|
|
--pf-c-progress-stepper__step-connector--before--Width |
var(--pf-c-progress-stepper--m-vertical__step-connector--before--Width)
|
|
--pf-c-progress-stepper__step-connector--before--Height |
var(--pf-c-progress-stepper--m-vertical__step-connector--before--Height)
|
|
--pf-c-progress-stepper__step-connector--before--BorderRightWidth |
var(--pf-c-progress-stepper--m-vertical__step-connector--before--BorderRightWidth)
|
|
--pf-c-progress-stepper__step-connector--before--BorderRightColor |
var(--pf-c-progress-stepper--m-vertical__step-connector--before--BorderRightColor)
|
|
--pf-c-progress-stepper__step-connector--before--BorderBottomWidth |
var(--pf-c-progress-stepper--m-vertical__step-connector--before--BorderBottomWidth)
|
|
--pf-c-progress-stepper__step-connector--before--BorderBottomColor |
var(--pf-c-progress-stepper--m-vertical__step-connector--before--BorderBottomColor)
|
|
--pf-c-progress-stepper__step-connector--before--Transform |
var(--pf-c-progress-stepper--m-vertical__step-connector--before--Transform)
|
|
--pf-c-progress-stepper__step-main--MarginTop |
var(--pf-c-progress-stepper--m-vertical__step-main--MarginTop)
|
|
--pf-c-progress-stepper__step-main--MarginRight |
var(--pf-c-progress-stepper--m-vertical__step-main--MarginRight)
|
|
--pf-c-progress-stepper__step-main--MarginBottom |
var(--pf-c-progress-stepper--m-vertical__step-main--MarginBottom)
|
|
--pf-c-progress-stepper__step-main--MarginLeft |
var(--pf-c-progress-stepper--m-vertical__step-main--MarginLeft)
|
|
--pf-c-progress-stepper--m-compact--GridTemplateColumns |
var(--pf-c-progress-stepper--m-vertical--m-compact--GridTemplateColumns)
|
|
--pf-c-progress-stepper--m-compact__step-connector--GridRow |
var(--pf-c-progress-stepper--m-vertical--m-compact__step-connector--GridRow)
|
|
--pf-c-progress-stepper--m-compact__step-connector--PaddingBottom |
var(--pf-c-progress-stepper--m-vertical--m-compact__step-connector--PaddingBottom)
|
|
--pf-c-progress-stepper--m-center__step-connector--before--Content |
none
|
|
--pf-c-progress-stepper--m-center__step-main--before--Content |
''
|
|
--pf-c-progress-stepper__step-connector--before--Content |
''
|
|
--pf-c-progress-stepper__step-main--before--Content |
none
|
CSS Shadow Parts
None
