Wizards

Use wizards to guide users through sequential steps for completing a task. Wizards also help to break long forms up into more manageable components.

Don’t design wizards that require users to frequently reference previous steps to complete the current step.

Wizard with milestones

Use a milestone component to show the user’s progress. Include links on the milestone component when you want users to easily navigate to previous steps.

DON'T

Don’t use a horizontal milestone component when there are a large number of steps, as this can result in a cluttered look. If a wizard contains more than 5 or 6 steps, it’s worthwhile to consider a side navigation bar instead.

Instead of showing wizard steps in a milestone component, you may choose to implement a side navigation bar using a card layout and rich text display component in a fixed-width column. Consider this approach if you want more control over the appearance of the wizard navigation. This approach also works well when there are too many steps to comfortably fit in a milestone component or when each step in the wizard has a relatively narrow interface. Utilizing available horizontal space to display the navigation also reduces vertical scrolling.

Pattern expression

a!localVariables(
  local!activeStep: 2,
  {
    a!columnsLayout(
      columns: {
        a!columnLayout(
          contents: {
            a!cardLayout(
              contents: {
                a!sectionLayout(),
                a!sectionLayout(),
                a!forEach(
                  items: {
                    "Getting Started",
                    "About the Applicant",
                    "Assets",
                    "Income",
                    "Other Real Estate",
                    "Additional Questions",
                    "Demographic Data (Optional)",
                    "Final Review"
                  },
                  expression: {
                    a!sectionLayout(
                      contents: {
                        a!sideBySideLayout(
                          items: {
                            a!sideBySideItem(
                              item: a!richTextDisplayField(
                                labelPosition: "COLLAPSED",
                                value: a!richTextIcon(
                                  icon: if(fv!index = local!activeStep, "chevron-right",
                                    if(fv!index < local!activeStep, "check",
                                    "circle-o")
                                  ),
                                  color: if(fv!index <= local!activeStep, "POSITIVE", "SECONDARY"),
                                  size: "MEDIUM"
                                )
                              )
                            ),
                            a!sideBySideItem(
                              item: a!richTextDisplayField(
                                labelPosition: "COLLAPSED",
                                value: a!richTextItem(
                                  text: fv!item,
                                  size: "MEDIUM",
                                  style: if(fv!index = local!activeStep, "STRONG", "PLAIN")
                                )
                              ),
                              width: "10X"
                            )
                          }
                        )
                      }
                    ),
                    a!sectionLayout(),
                    a!sectionLayout()
                  }
                )
              },
              style: "#fbfbfb",
              height: "AUTO"
            )
          },
          width: "MEDIUM"
        ),
        a!columnLayout(),
        a!columnLayout(
          contents: {
            a!sectionLayout(
              contents: {
                a!richTextDisplayField(
                  labelPosition: "COLLAPSED",
                  value: {
                    a!richTextItem(
                      text: "Basic Information",
                      size: "LARGE"
                    )
                  }
                )
              }
            ),
            a!sectionLayout(
              contents: {
                a!richTextDisplayField(
                  labelPosition: "COLLAPSED",
                  value: {
                    a!richTextItem(
                      text: "NAME",
                      color: "SECONDARY",
                      style: "STRONG"
                    )
                  }
                ),
                a!sideBySideLayout(
                 items: {
                   a!sideBySideItem(
                     item: a!textField(
                       label: "First Name"
                     ),
                     width: "4X"
                   ),
                   a!sideBySideItem(
                     item: a!textField(
                       label: "M.I."
                     )
                   ),
                   a!sideBySideItem(
                     item: a!textField(
                       label: "Last Name"
                     ),
                     width: "4X"
                   ),
                   a!sideBySideItem(
                     item: a!textField(
                       label: "Suffix"
                     )
                   )
                 },
                 spacing: "DENSE"
               )
             }
            ),
            a!sectionLayout(
              contents: {
                a!richTextDisplayField(
                  labelPosition: "COLLAPSED",
                  value: {
                    a!richTextItem(
                      text: "CONTACT",
                      color: "SECONDARY",
                      style: "STRONG"
                    )
                  }
                ),
                a!sideBySideLayout(
                 items: {
                   a!sideBySideItem(
                     item: a!textField(
                       label: "Email Address"
                     )
                   ),
                   a!sideBySideItem(
                     item: a!textField(
                       label: "Confirm Email Address"
                     )
                   )
                 }
                ),
                a!sideBySideLayout(
                 items: {
                   a!sideBySideItem(
                     item: a!textField(
                       label: "Telephone"
                     )
                   ),
                   a!sideBySideItem(
                     item: a!radioButtonField(
                       label: "Type",
                       choiceLabels: {"Mobile", "Home", "Office"},
                       choiceValues: {1, 2, 3},
                       value: 1,
                       choiceLayout: "COMPACT"
                     )
                   )
                 }
                )
              }
            ),
            a!sectionLayout(
              contents: {
                a!richTextDisplayField(
                  labelPosition: "COLLAPSED",
                  value: {
                    a!richTextItem(
                      text: "MAILING ADDRESS",
                      color: "SECONDARY",
                      style: "STRONG"
                    )
                  }
                ),
                a!sideBySideLayout(
                 items: {
                   a!sideBySideItem(
                     item: a!textField(
                       label: "Street Address or PO Box"
                     ),
                     width: "2X"
                   ),
                   a!sideBySideItem(
                     item: a!textField(
                       label: "Apartment or Unit #"
                     )
                   )
                 }
                ),
                a!sideBySideLayout(
                 items: {
                   a!sideBySideItem(
                     item: a!textField(
                       label: "City"
                     ),
                     width: "3X"
                   ),
                   a!sideBySideItem(
                     item: a!dropdownField(
                       label: "State",
                       placeholder: "Select State",
                       choiceLabels: {"DC", "MD", "VA"},
                       choiceValues: {1, 2, 3}
                     )
                   ),
                   a!sideBySideItem(
                     item: a!textField(
                       label: "ZIP Code"
                     ),
                     width: "2X"
                   )
                 }
                )
              }
            ),
            a!columnsLayout(
              columns: {
                a!columnLayout(
                  contents: {
                    a!buttonArrayLayout(
                      buttons: {
                        a!buttonWidget(
                          label: "Go Back",
                          size: "LARGE"
                        )
                      },
                      align: "START",
                      marginBelow: "NONE"
                    )
                  }
                ),
                a!columnLayout(
                  contents: {
                    a!buttonArrayLayout(
                      buttons: {
                        a!buttonWidget(
                          label: "Continue",
                          size: "LARGE",
                          style: "SOLID",
                          submit: true
                        )
                      },
                      align: "END",
                      marginBelow: "NONE"
                    )
                  }
                )
              }
            )
          },
          width: "WIDE"
        ),
        a!columnLayout()
      }
    )
  }
)

Feedback

Was this page helpful?

Wizards

Wizard with milestones

Wizard with side navigation bar

Pattern expression

Feedback