Skip to content

Progress

<ns-progress>

Overview

To indicate to a user how far through a journey they are and how many steps they have left to complete.

✨ This is an auto-generated AI summary of the ns-progress's documentation. It may not be accurate. ✨

Examples

Guidance

Standard

Labelled diagram of ns-progress

Key

KeyField typeGuidelines
AStep CountThis text informs you of the current step you are on and how many steps there are in total.
BInfoThis is a heading statement about this particular step. It is optional.
CBarThis represents the current step and those that have been already been completed. They overlay the track.
DTrackThis represents each step there is in in the process in total. Up to 20 steps are permitted.
ENextA statement of what the following step will be. It is optional.
FCompletedThe status shown on completion of the journey.

Implementation

Placement

The ns-progress component can be used in the following components:

Specification

Attributes

steps
Property
steps
Description
The total number of steps in the journey.
Type
number
complete
Property
complete
Description
The toggle to indicate the journey is completed.
Type
boolean
current
Property
current
Description
The step number currently on in the journey.
Type
number
next
Property
next
Description
The information about the next step of the journey.
Type
string
info
Property
info
Description
The information about the current step of the journey.
Type
string
type
Property
type
Type
string
Default
standard

Last updated: