pfWizardStep
patternfly.wizard
Directive for rendering a Wizard step. Each step can stand alone or have substeps. This directive can only be used as a child of pf-wizard.
<ANY pf-wizard-step step-title="{string}" step-id="{string}" step-priority="{number}" substeps="{boolean}" [next-enabled="{boolean}"] [prev-enabled="{boolean}"] [next-tooltip="{string}"] [prev-tooltip="{string}"] [wz-disabled="{boolean}"] ok-to-nav-away="{boolean}" allow-click-nav="{boolean}" [description="{string}"] wizard-data="{object}" [on-show="{function()}"] [show-review="{boolean}"] [show-review-details="{boolean}"] [review-template="{string}"]> ... </ANY>
Param | Type | Details |
---|---|---|
stepTitle | string | The step title displayed in the header and used for the review screen when displayed |
stepId | string | Sets the text identifier of the step |
stepPriority | number | 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. |
substeps | boolean | Sets whether this step has substeps |
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 |
nextTooltip (optional) | string | The text to display as a tooltip on the next button |
prevTooltip (optional) | string | The text to display as a tooltip on the back button |
wzDisabled (optional) | boolean | Disables the wizard when this page is shown |
okToNavAway | boolean | Sets whether or not it's ok for the user to leave this page |
allowClickNav | boolean | Sets whether the user can click on the numeric step indicators to navigate directly to this step |
description (optional) | string | The step description (optional) |
wizardData | object | Data passed to the step that is shared by the entire wizard |
onShow (optional) | function() | The function called when the wizard shows this step |
showReview (optional) | boolean | Indicates whether review information should be displayed for this step when the review step is reached |
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 |