Package org.patternfly.component.progressstepper


package org.patternfly.component.progressstepper
Provides the PatternFly progress stepper component and its subcomponents.

A progress stepper displays progress through a sequence of discrete steps. Each step can have a variant indicating its status (success, info, warning, danger, or pending), an optional description, and custom icons. The stepper supports vertical, centered, and compact layout options.

Usage

 import static org.patternfly.component.progressstepper.ProgressStep.progressStep;
 import static org.patternfly.component.progressstepper.ProgressStepVariant.info;
 import static org.patternfly.component.progressstepper.ProgressStepVariant.pending;
 import static org.patternfly.component.progressstepper.ProgressStepVariant.success;
 import static org.patternfly.component.progressstepper.ProgressStepper.progressStepper;

 ProgressStepper stepper = progressStepper()
         .ariaLabel("Basic progress stepper")
         .add(progressStep("step-1", "First step")
                 .variant(success))
         .add(progressStep("step-2", "Second step")
                 .variant(info))
         .add(progressStep("step-3", "Third step")
                 .variant(pending))
         .first().next();

A progress stepper with step descriptions:

 import static org.patternfly.component.progressstepper.ProgressStep.progressStep;
 import static org.patternfly.component.progressstepper.ProgressStepVariant.info;
 import static org.patternfly.component.progressstepper.ProgressStepVariant.pending;
 import static org.patternfly.component.progressstepper.ProgressStepVariant.success;
 import static org.patternfly.component.progressstepper.ProgressStepper.progressStepper;

 ProgressStepper stepper = progressStepper()
         .ariaLabel("Progress stepper with descriptions")
         .add(progressStep("step-1", "First step")
                 .variant(success)
                 .description("This is the first thing to happen"))
         .add(progressStep("step-2", "Second step")
                 .variant(info)
                 .description("This is the second thing to happen"))
         .add(progressStep("step-3", "Third step")
                 .variant(pending)
                 .description("This is the last thing to happen"))
         .first().next();
See Also:
  • Class
    Description
    Represents a single step in a progress stepper component.
    A progress stepper displays a timeline of tasks in a workflow and tracks a user's progress through the workflow.
    Represents the variants of a progress step in a progress stepper component.