Stepper

Steppers display progress through a sequence of separate steps towards a particular goal for more complex tasks. This provides a more manageable experience by allowing the user to focus on smaller pieces of the task at hand.

This stepper can be used not only for initial setup, but also for future configuration changes over time by linking to the relevant step.

Steps

On page load, all steps will display a number and short label to help the user understand the sequence of actions towards setup or creation. Steppers should follow a linear progression, requiring the user to navigate between all steps in chronological order for initial setup Incomplete and active steps will always display a number. Completed steps will display a checkmark icon. Steps missing required input from the user will display the step error state.

The "Next" button, positioned on the right side of the footer, is used to progress to the next step in the process. This button should be active and available at all times. On the final workflow step, this button can display a contextual label related to the action (ex: 'FINISH', or 'APPLY'). When the user has moved past the first step, display a Secondary outline button with a 'Back' label all the way to the left in the footer to allow them to move backwards in a linear progression. The user can navigate back a single step, or multiple, but can only move forward with the 'Next' button in the footer. (The numbered steps and check marks are not interactive) The user may move back a step if they have not completed the active step without validation being required for the current step. Any actions that have been taken on the current step should be retained (data should not be cleared unless the user is warned. Note: Future use cases may require a third action button, positioned directly before the “Next” button, on the right. Examples include saving a draft or launching a preview within the flow.

Errors and warnings

Display the step error state and do not allow the user to move ahead on any step missing required input from the user. The error state should display a contextual label related to the active step. Request confirmation from users who choose to exit and discontinue before completing all steps in the workflow. The user should understand that all edits and changes will be lost if they do so. Display a browser confirmation dialog when closing the tab or navigating with the browser back button before completing all steps in the workflow. The user should understand that all edits and changes will be lost if they proceed.

Basic Usage

A Stepper must wrap a set of composed subcomponents:

  • Stepper.Header
  • Stepper.Step
  • Stepper.ActionRow

The order of steps is dictated by the order of Stepper.Step components in the code.

Stepper.Step and Stepper.ActionRow are hidden until their eventKey props match the activeKey on Stepper.

In a modal

A composition of a stepper with a FullscreenModal.

Error State

A composition of a stepper with the hasError prop. Note that the index prop is also required for steps to rerender correctly here.

Stepper Props API
  • children
    node Required

    Specifies the content of the Stepper.

  • activeKey
    string Required

    The eventKey of the step to display.

StepperStep Props API
  • children
    node Required

    Specifies the content of the Step.

  • className
    string

    Specifies class name to append to the base element

  • eventKey
    string Required

    An identifier of the Step. When activeKey on the Stepper equals to the eventKey, the Step will be displayed.

  • title
    string Required

    A text of the Step.

  • description
    string

    A text under the title.

  • hasError
    bool

    Informs user if this Step has errors.

    Defaultfalse
  • index
    number

    Position of the Step, only required if adding error state or conditionally rendering steps.

StepperActionRow Props API
  • children
    node Required

    Specifies the content of the ActionRow.

  • eventKey
    string Required

    An identifier of the ActionRow. When activeKey on the Stepper equals to the eventKey, the ActionRow will be displayed.

  • as
    elementType

    Specifies the base element

    DefaultActionRow
StepperHeader Props API
  • className
    string

    Specifies class name to append to the base element.

    Defaultnull
  • PageCountComponent
    elementType

    A component that receives activeStepIndex and totalSteps props to display them.

    Default({ activeStepIndex, totalSteps }) => `Step ${activeStepIndex + 1} of ${totalSteps}`
StepperHeaderStep Props API
  • eventKey
    string Required

    An identifier of the HeaderStep. When activeKey on the Stepper equals to the eventKey, the HeaderStep will be displayed.

  • title
    string Required

    A text of the HeaderStep.

  • isActive
    bool

    Specifies that this HeaderStep is active.

    Defaultfalse
  • hasError
    bool

    Informs user if this Step has errors.

    Defaultfalse
  • description
    string

    A text under the title.

  • index
    number

    A number that will be display in the icon of the HeaderStep.

    Default0