Allow Optional Header in Wizard Component

[mmocniak-rh]

Some workflows do not require the header to display on every step of the wizard. Since each step dynamically changes what displays in the primary section of the wizard, the header does not always need to be present.

This issue is being logged to make allow for an option to disable the header in the wizard component.

[mcoker]

@mcarrano what do you think? From slack, Matthew also said:

Unless the title and description can change as the user completes each step, it seems redundant to have the title pinned at the top the whole time.

[mcarrano]

@mmocniak-rh @mcoker Are we saying that the header may appear or disappear per each step? I'd be concerned about the position of the steps bar jumping if the header is hidden. Is there a reason you'd want to hide the header other than avoiding redundancy?

[mmocniak-rh]

@mcarrano I'd expect the header to either be visible or hidden for the entire wizard, depending on which version is used.

Maybe I am missing something from the provided examples in PF4 documentation, but I am looking for a title that is more dynamic than the same, static title across all steps.

Making the header optional also cuts down on the required vertical space. If the same effect of a title with content can be achieved in the main section of a wizard without a header, then a "condensed" version of the wizard may be ideal.

[jeperry]

We could improve the doc a bit. Here is my interpretation and suggestions when I look at https://www.patternfly.org/v4/design-guidelines/usage-and-behavior/wizard#simple-wizard

• In annotation 1, the Wizard title should reinforce the outcome of the entire wizard flow (e.g. "Create a new project") and the description line (optional) supports this with further detail. As stated, the Wizard title remains unchanged across all steps. The question is whether we want to allow for a variant where the wizard title is omitted. I am curious how this is dealt with in the embedded (non modal) wizard that has been discussed.
• There should also be an annotation pointing to the header in the form ("Configure your project"), and I would call the this Step title. The Step title is unique to each step, and should reinforce the outcome of the individual step. It may match the Current step indicated in the stepfinder, or as in the example image, it may be more verbose.

[mcarrano]

@mmocniak-rh I feel like the Wizard title is important for the reasons @jeperry stated. It reinforces that intended outcome of the wizard. I agree that our design guidelines could be better and we should clarify what these fields are used for and how to reflect the current step as @jeperry suggests. I don't want to make the header optional, but I do have one question for you @mcoker . Description is optional, I believe. If a consumer of this chooses not to add a description, is the space collapsed or does that space just remain blank? If the later, we might want to make a change to reduce the space that the header consumes. Thoughts?

[mcoker]

@mcarrano since it's optional, we balance out the layout when the description isn't present.

[mcarrano]

That's great @mcoker .

[mcarrano]

@mmocniak-rh thanks for submitting this, but after discussion with @mcoker and @kybaker we have determined that the Wizard header should not be optional and this issue will be closed. It is important that the Wizard always have a title to identify the action that they will take. Being able to hide the description as shown above helps compress the space required. Also note that the height and width of the wizard modal can be adjusted if you need to create more space for content.

A related documentation issue has been created to provide better guidance about this (patternfly/patternfly-org#1454).