Steps also known as Stepper, is an indicator for the steps in a workflow. Layout of steps component is optimized for responsive design.
import { StepsModule } from 'primeng/steps';
Steps requires a collection of menuitems as its model.
<p-steps [model]="items" [readonly]="true"></p-steps>
In order to add interactivity to the component, disable readonly and use a binding to activeIndex along with activeIndexChange to control the Steps.
<p-toast></p-toast>
<p-steps [model]="items" [readonly]="false" [activeIndex]="activeIndex" (activeIndexChange)="onActiveIndexChange($event)"></p-steps>
Example below uses nested routes with Steps.
<div class="card">
<p-toast></p-toast>
<p-steps [model]="items" [readonly]="false"></p-steps>
</div>
<router-outlet></router-outlet>
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. |
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".
| 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. |
API defines helper props, events and others for the PrimeNG Steps module.
Steps components is an indicator for the steps in a wizard workflow.
Defines the input properties of the component.
Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.
Defines the custom interfaces used by the module.
MenuItem provides the following properties. Note that not all of them may be utilized by the tabmenu component.