Skip to content

Commit 4ef5241

Browse files
committed
Update docs
1 parent 0925301 commit 4ef5241

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

packages/react-renderer-demo/src/docs-components/pf4-wizard.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ Don't forget hide form controls by settinng \`showFormControls\` to \`false\` as
1515
| setFullHeight | bool | undefined | see Patternfly |
1616
| isDynamic | bool | undefined | will dynamically generate steps navigation (=progressive wizard), please use if you use any condition fields which changes any field in other steps (wizards with conditional steps are dynamic by default) |
1717
|showTitles|bool|undefined|If true, step titles will be shown in the wizard body|
18+
|predictSteps|bool|undefined|If true, dynamic wizard will predict steps in the navigation.|
1819

1920
### Default buttonLabels
2021

@@ -48,6 +49,7 @@ You can rewrite only selection of them, e.g.
4849
| buttons | node, func | Custom buttons component|
4950
|showTitle|bool|If true, step titles will (not if false) be shown in the wizard body|
5051
|Custom title|node|Use if you want to render as the title different/custom title (for example, title with a popover|
52+
|disableForwardJumping|bool|When use return to this step, jumping forward in the navigation is disabled.|
5153

5254

5355
- nextStep can be stepKey of the next step
@@ -164,6 +166,8 @@ First step should have `stepKey: 1` or as a string: `'1'`
164166
- steps are visible as user visits them
165167
- user can jump only back
166168
- use `isDynamic` prop to enforce it
169+
- use `predictSteps` to allow navigation to show future steps
170+
- if you have any conditional fields in the step, you should use `disableForwardJumping` in the step definition, to disable jumping forward in the navigation, otherwise user could miss the changed fields in next steps.
167171

168172
![progressivewizard](https://user-images.githubusercontent.com/32869456/58427241-5b370a80-809f-11e9-8e79-a4a829b8d181.gif)
169173

0 commit comments

Comments
 (0)