Skip to content

Commit 6d3bc17

Browse files
committed
Update docs
1 parent 110049d commit 6d3bc17

File tree

2 files changed

+12
-0
lines changed

2 files changed

+12
-0
lines changed

packages/react-renderer-demo/src/app/pages/renderer/field-provider.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -119,6 +119,10 @@ and informations about the formState.
119119
}
120120
```
121121

122+
# FormSpy provider
123+
124+
Every component also receives component `FormSpyProvider` as a prop. You can find more info <a href="https://final-form.org/docs/react-final-form/api/FormSpy" rel="noopener noreferrer" target="_blank">here!</a>
125+
122126
</Grid>
123127
<Grid item xs={false} md={2}>
124128
<ListOfContents file="renderer/field-provider" />

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

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ Don't forget hide form controls by setting \`showFormControls\` to \`false\` as
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|
1818
|predictSteps|bool|undefined|If true, dynamic wizard will predict steps in the navigation.|
19+
|crossroads|array|undefined|Array of field names, which change next steps|
1920

2021
**Default buttonLabels**
2122

@@ -37,6 +38,12 @@ You can rewrite only selection of them, e.g.
3738

3839
(Others will stay default)
3940

41+
**Crossroads**
42+
43+
With the help of `crossroads` you can manually defined which fields change next steps and together with `predictSteps`, it will cause that the wizard navigation is always refreshed, when one of the crossroads name is changed.
44+
45+
Ex.: `crossroads: ['name', 'nested.password']`
46+
4047
**Docs for steps**
4148

4249
| Props | Type | Description |
@@ -174,6 +181,7 @@ Progressive wizard
174181
- use `isDynamic` prop to enforce it
175182
- use `predictSteps` to allow navigation to show future steps
176183
- 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.
184+
- you can use `crossroads` to define, which fields the wizzard will listen to and change the navigation according to changes of the defined values
177185

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

0 commit comments

Comments
 (0)