	Language
	English
	English
	English
	French
	German
	German
	German
	Italian
	Korean
	Spanish
	Catalan
	Dutch
	Portuguese
	Portuguese
	Arabic
	Arabic
	Bulgarian
	Bangla
	Bosnian
	Czech
	Greek
	Estonian
	Persian
	Finnish
	Danish
	Hindi
	Indonesian
	Icelandic
	Croatian
	Japanese
	Hungarian
	Hebrew
	Georgian
	Central Kurdish
	Khmer
	Kyrgyz
	Kazakh
	Lithuanian
	Latvian
	Malay
	Norwegian
	Polish
	Romanian
	Russian
	Slovak
	Slovenian
	Serbian
	Serbian
	Swedish
	Thai
	Turkish
	Ukrainian
	Uzbek
	Vietnamese
	Chinese
	Chinese

Wizard

Wizard creates a workflow by creating multiple steps out of a single page form. Only current step is processed partially and next step is displayed if current step passes validations. Wizard flow is sequential by default and this can be managed using the optional ajax flowListeners, simply outcome of a flowListener defines the next step to display.

Wizard Tag Documentation

Wizard provides an enhanced UI to implement a workflow easily in a single page. Wizard consists of several child tab components where each tab represents a step in the process.

Name	Type	Required	Default	Description
id	String	false	generated	Unique identifier of the component in a namingContainer.
rendered	boolean	false	true	Boolean value to specify the rendering of the component, when set to false component will not be rendered.
binding	UIComponent	false	generated	An EL expression referring to a server side UIComponent instance in a backing bean.
widgetVar	String	false	generated ('widget_' + componentClientId)	Name of the client side component.
backLabel	String	false	Back	Label of back navigation button.
disableOnAjax	boolean	false	true	If true, next and back navigation buttons will be disabled during Ajax requests triggered by them.
effect	String	false	No animation	Animation effect to use when showing and hiding wizard panel.
effectDuration	int	false	400	Duration of the animation effect in milliseconds.
flowListener	MethodExpression	false		Server side listener to invoke when wizard attempts to go forward or back.
highlightCompletedSteps	boolean	false	false	If true, all completed steps are highlighted. If false, only the current step is highlighted.
nextLabel	String	false	Next	Label of next navigation button.
onback	String	false		Javascript event handler to be invoked when flow goes back.
onnext	String	false		Javascript event handler to be invoked when flow goes forward.
showNavBar	boolean	false	true	Specifies visibility of default navigator arrows.
showStepStatus	boolean	false	true	Specifies visibility of default step title bar.
step	String	false		Id of the current step in flow.
style	String	false		Inline style of the component.
styleClass	String	false		Style class of the component.
updateModelOnPrev	boolean	false	false	If yes, the model will be updated when the "Back" button is clicked.

Name	Description
No records found.

Name	Type	Default	Description
next	AjaxBehaviorEvent	false	When "next" is triggered.
back	AjaxBehaviorEvent	false	When "back" is triggered.

Name	Library	Target
components.css	primefaces
jquery/jquery.js	primefaces
core.js	primefaces
components.js	primefaces

Family org.primefaces.component

Type org.primefaces.component.Wizard

Class org.primefaces.component.wizard.Wizard

Renderer Type org.primefaces.component.WizardRenderer

Renderer Class org.primefaces.component.wizard.WizardRenderer

Handler Class org.primefaces.component.wizard.WizardHandler

RESOURCES

Tag Documentation Documentation Documentation JSDoc

Usage


<div class="card">
    <h:form>

        <p:growl id="growl" sticky="true" showDetail="true"/>

        <p:wizard flowListener="#{userWizard.onFlowProcess}" widgetVar="wizard">
            <p:tab id="personal" title="Personal">
                <p:focus context="@next"/>
                <p:panel header="Personal Details">
                    <p:messages/>
                    <div class="formgrid grid p-fluid">
                        <div class="field col-12 md:col-6">
                            <p:outputLabel for="@next" value="Firstname"/>
                            <p:inputText value="#{userWizard.user.firstname}" required="true" label="Firstname"/>
                        </div>
                        <div class="field col-12 md:col-6">
                            <p:outputLabel for="@next" value="Lastname"/>
                            <p:inputText value="#{userWizard.user.lastname}" required="true" label="Lastname"/>
                        </div>
                        <div class="field col-12 md:col-6">
                            <p:outputLabel for="@next" value="Age"/>
                            <p:inputText value="#{userWizard.user.age}"/>
                        </div>
                        <div class="field col-12 md:col-6">
                            <p:outputLabel for="@next" value="Skip to last"/>
                            <h:selectBooleanCheckbox value="#{userWizard.skip}"/>
                        </div>
                    </div>
                </p:panel>
            </p:tab>

            <p:tab id="address" title="Address">
                <p:focus context="@next"/>
                <p:panel header="Address Details">
                    <p:messages/>
                    <div class="formgrid grid p-fluid">
                        <div class="field col-12 md:col-6">
                            <p:outputLabel for="@next" value="Street"/>
                            <p:inputText value="#{userWizard.user.street}"/>
                        </div>
                        <div class="field col-12 md:col-6">
                            <p:outputLabel for="@next" value="Postal Code"/>
                            <p:inputText value="#{userWizard.user.postalCode}"/>
                        </div>
                        <div class="field col-12 md:col-6">
                            <p:outputLabel for="@next" value="City"/>
                            <p:inputText value="#{userWizard.user.city}"/>
                        </div>
                        <div class="field col-12 md:col-6">
                            <p:outputLabel for="@next" value="Skip to last"/>
                            <h:selectBooleanCheckbox value="#{userWizard.skip}"/>
                        </div>
                    </div>
                </p:panel>
            </p:tab>

            <p:tab id="contact" title="Contact">
                <p:focus context="@next"/>
                <p:panel header="Contact Information">
                    <p:messages/>
                    <div class="formgrid grid p-fluid">
                        <div class="field col-12 md:col-6">
                            <p:outputLabel for="@next" value="Email"/>
                            <p:inputText value="#{userWizard.user.email}" required="true" label="Email"/>
                        </div>
                        <div class="field col-12 md:col-6">
                            <p:outputLabel for="@next" value="Phone"/>
                            <p:inputText value="#{userWizard.user.phone}"/>
                        </div>
                        <div class="field col-12 md:col-6">
                            <p:outputLabel for="@next" value="Additional Info"/>
                            <p:inputText value="#{userWizard.user.info}"/>
                        </div>
                    </div>
                </p:panel>
            </p:tab>

            <p:tab id="confirm" title="Confirmation">
                <p:focus context="@next"/>
                <p:panel header="Confirmation">
                    <div class="grid">
                        <div class="col-12 md:col-4">
                            <div class="mb-2">Firstname: <h:outputText value="#{userWizard.user.firstname}" styleClass="font-bold"/></div>
                            <div class="mb-2">Lastname: <h:outputText value="#{userWizard.user.lastname}" styleClass="font-bold"/></div>
                            <div class="mb-2">Age: <h:outputText value="#{userWizard.user.age}" styleClass="font-bold"/></div>
                        </div>
                        <div class="col-12 md:col-4">
                            <div class="mb-2">Street: <h:outputText value="#{userWizard.user.street}" styleClass="font-bold"/></div>
                            <div class="mb-2">Postal: <h:outputText value="#{userWizard.user.postalCode}" styleClass="font-bold"/></div>
                            <div class="mb-2">City: <h:outputText value="#{userWizard.user.city}" styleClass="font-bold"/></div>
                        </div>
                        <div class="col-12 md:col-4">
                            <div class="mb-2">Email: <h:outputText value="#{userWizard.user.email}" styleClass="font-bold"/></div>
                            <div class="mb-2">Phone: <h:outputText value="#{userWizard.user.phone}" styleClass="font-bold"/></div>
                            <div class="mb-2">Info: <h:outputText value="#{userWizard.user.info}" styleClass="font-bold"/></div>
                        </div>
                    </div>

                    <p:commandButton value="Submit" action="#{userWizard.save}" update="growl" process="@this"/>
                </p:panel>
            </p:tab>
        </p:wizard>

    </h:form>
</div>


package org.primefaces.showcase.view.panel;

import org.primefaces.event.FlowEvent;
import org.primefaces.showcase.domain.User;

import java.io.Serializable;

import jakarta.faces.application.FacesMessage;
import jakarta.faces.context.FacesContext;
import jakarta.faces.view.ViewScoped;
import jakarta.inject.Named;

@Named
@ViewScoped
public class UserWizard implements Serializable {

    private User user = new User();

    private boolean skip;

    public User getUser() {
        return user;
    }

    public void setUser(User user) {
        this.user = user;
    }

    public void save() {
        FacesMessage msg = new FacesMessage("Successful", "Welcome :" + user.getFirstname());
        FacesContext.getCurrentInstance().addMessage(null, msg);
    }

    public boolean isSkip() {
        return skip;
    }

    public void setSkip(boolean skip) {
        this.skip = skip;
    }

    public String onFlowProcess(FlowEvent event) {
        if (skip) {
            skip = false; //reset in case user goes back
            return "confirm";
        }
        else {
            return event.getNewStep();
        }
    }
}


package org.primefaces.showcase.domain;

import java.io.Serializable;

public class User implements Serializable {

    private String firstname;
    private String lastname;
    private Integer age;
    private String street;
    private String city;
    private String postalCode;
    private String info;
    private String email;
    private String phone;

    public String getFirstname() {
        return firstname;
    }

    public void setFirstname(String firstname) {
        this.firstname = firstname;
    }

    public String getLastname() {
        return lastname;
    }

    public void setLastname(String lastname) {
        this.lastname = lastname;
    }

    public Integer getAge() {
        return age;
    }

    public void setAge(Integer age) {
        this.age = age;
    }

    public String getStreet() {
        return street;
    }

    public void setStreet(String street) {
        this.street = street;
    }

    public String getCity() {
        return city;
    }

    public void setCity(String city) {
        this.city = city;
    }

    public String getPostalCode() {
        return postalCode;
    }

    public void setPostalCode(String postalCode) {
        this.postalCode = postalCode;
    }

    public String getInfo() {
        return info;
    }

    public void setInfo(String info) {
        this.info = info;
    }

    public String getEmail() {
        return email;
    }

    public void setEmail(String email) {
        this.email = email;
    }

    public String getPhone() {
        return phone;
    }

    public void setPhone(String phone) {
        this.phone = phone;
    }
}

Wizard

Wizard Tag Documentation

Usage

Reloading page