Improve this doc View source

pfWizardSubstep
directive in module patternfly.wizard

Description

Component for rendering a Wizard substep. Each substep must be a child of a pf-wizardstep in a pf-wizard directive.

Usage

as element:
<pf-wizard-substep
       step-title="{string}"
       step-id="{string}"
       step-priority="{number}"
       [next-enabled="{boolean}"]
       [prev-enabled="{boolean}"]
       [wz-disabled="{boolean}"]
       ok-to-nav-away="{boolean}"
       [allow-click-nav="{boolean}"]
       [description="{string}"]
       wizard-data="{object}"
       [on-show="{function()}"]
       [focus-selectors="{object}"]
       [show-review-details="{boolean}"]
       [review-template="{string}"]>
</pf-wizard-substep>

Parameters

ParamTypeDetails
stepTitlestring

The step title displayed in the header and used for the review screen when displayed

stepIdstring

Sets the text identifier of the step

stepPrioritynumber

This sets the priority of this wizard step relative to other wizard steps. They should be numbered sequentially in the order they should be viewed.

nextEnabled
(optional)
boolean

Sets whether the next button should be enabled when this step is first displayed

prevEnabled
(optional)
boolean

Sets whether the back button should be enabled when this step is first displayed

wzDisabled
(optional)
boolean

Hides the step when set to True

okToNavAwayboolean

Sets whether or not it's ok for the user to leave this page

allowClickNav
(optional)
boolean

Sets whether the user can click on the numeric step indicators to navigate directly to this step

description
(optional)
string

The step description

wizardDataobject

Data passed to the step that is shared by the entire wizard

onShow
(optional)
function()

The function called when the wizard shows this step

focusSelectors
(optional)
object

Array of selectors to be used (in the order given) to find the initial focus component for the page

showReviewDetails
(optional)
boolean

Indicators whether the review information should be expanded by default when the review step is reached

reviewTemplate
(optional)
string

The template that should be used for the review details screen