Steps

Steps also known as Stepper, is an indicator for the steps in a workflow. Layout of steps component is optimized for responsive design.

Import#


import { Steps } from 'primereact/steps';

Basic#

Steps requires a collection of menuitems as its model.


<Steps model={items} />

Interactive#

In order to add interactivity to the component, disable readOnly and use a binding to activeIndex along with onSelect to control the Steps.


<Toast ref={toast}></Toast>
<Steps model={items} activeIndex={activeIndex} onSelect={(e) => setActiveIndex(e.index)} readOnly={false} />

Style#

Following is the list of structural style classes, for theming classes visit theming page.

Name	Element
p-steps	Container element.
p-steps-item	Menuitem element.
p-steps-number	Number of menuitem.
p-steps-title	Label of menuitem.

Accessibility guide documents the specification of this component based on WCAG guidelines, the implementation is in progress.

Accessibility#

Screen Reader

Steps component uses the nav element and since any attribute is passed to the root implicitly aria-labelledby or aria-label can be used to describe the component. Inside an ordered list is used where the current step item defines aria-current as "step".

Keyboard Support

Key	Function
tab	Adds focus to the active step when focus moves in to the component, if there is already a focused tab header then moves the focus out of the component based on the page tab sequence.
enter	Activates the focused step if readonly is not enabled.
space	Activates the focused step if readonly is not enabled.
right arrow	Moves focus to the next step if readonly is not enabled.
left arrow	Moves focus to the previous step if readonly is not enabled.
home	Moves focus to the first step if readonly is not enabled.
end	Moves focus to the last step if readonly is not enabled.