Package org.patternfly.component.wizard

package org.patternfly.component.wizard

Provides a wizard component for guiding users through a multi-step workflow.

A wizard presents a series of steps with navigation, back/next buttons, and optional validation. It supports step types (default, review, summary), custom headers with title and description, custom footers, step enter/leave handlers, and asynchronous next/previous handlers using promises.

Key Classes

• Wizard - Main wizard component
• WizardStep - Individual wizard step with content
• WizardHeader - Custom wizard header
• WizardHeaderTitle - Title within the wizard header
• WizardHeaderDescription - Description within the wizard header
• WizardFooter - Custom wizard footer with buttons
• WizardNav - Navigation sidebar
• WizardNavItem - Navigation item for a step
• WizardStepType - Step type variants (default, review, summary)
• WizardContext - Shared context across wizard steps

Usage

Create a basic wizard with steps:

import static org.jboss.elemento.Elements.p;
import static org.patternfly.component.wizard.Wizard.wizard;
import static org.patternfly.component.wizard.WizardStep.wizardStep;
import static org.patternfly.component.wizard.WizardStepType.review;

Wizard wizard = wizard().height(400)
        .addItem(wizardStep("step-0", "Step 1")
                .add(p().text("Step 1 content")))
        .addItem(wizardStep("step-1", "Step 2")
                .add(p().text("Step 2 content")))
        .addItem(wizardStep("step-2", "Review", review)
                .add(p().text("Review your selections")));

See Also:

• Wizard
• WizardStep
• PatternFly Wizard

Related Packages

Package	Description
org.patternfly.component	Provides PatternFly component implementations for building web applications in Java.

Class	Description
Wizard	A wizard provides a guided workflow that offers a path to complete a task, create an object or objects, or finish a series of steps for some other outcome.
WizardContext	A context object for sharing state across steps in a Wizard component.
WizardFooter	The footer area of a Wizard component, typically containing navigation buttons.
WizardFooterButtons	The button container within a WizardFooter.
WizardHeader	The header area of a Wizard component.
WizardHeaderDescription	A description within the header of a Wizard component.
WizardHeaderTitle	The title within the header of a Wizard component.
WizardNav	The navigation sidebar of a Wizard component.
WizardNavItem	An individual navigation item within a WizardNav.
WizardStep	An individual step within a Wizard component.
WizardStepChangeHandler	Functional interface for handling step changes in a wizard flow.
WizardStepEnterHandler
WizardStepLeaveHandler
WizardStepNextHandler	Functional interface representing a callback mechanism for handling the transition from one step to the next in a wizard.
WizardStepNextPromise	Interface to handle the transition to the next step in a Wizard workflow asynchronously.
WizardStepPreviousHandler	Functional interface for handling callbacks when navigating to the previous step in a wizard workflow.
WizardStepPreviousPromise	Interface to handle the transition to the previous step in a Wizard workflow asynchronously.
WizardStepType	Wizard step types.