Skip to content

Commit 70c817a

Browse files
authored
Merge pull request #164 from rvsia/fix-substeps
Fix PF4 Wizard doc substep > substepOf
2 parents 2685c14 + 1c558c8 commit 70c817a

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ You can rewrite only selection of them, e.g.
4343
| stepKey | string, number | For first step: 1, otherwise anything |
4444
| nextStep | object/stepKey of next step | See below |
4545
| fields | array | As usual |
46-
| substep | string | Substep title (steps are grouped by this title) |
46+
| substepOf | string | Substep title (steps are grouped by this title) |
4747
| title | string | Step title |
4848
| buttons | node, func | Custom buttons component|
4949
|showTitle|bool|If true, step titles will (not if false) be shown in the wizard body|
@@ -102,7 +102,7 @@ The components receives these props:
102102

103103
### How to do substeps
104104

105-
Field in Wizard fields should contain `substep` <`string`> which is title of the primary step. Steps with the same substep are grouped together by the title of primary step.
105+
Field in Wizard fields should contain `substepOf` <`string`> which is title of the primary step. Steps with the same substepOf are grouped together by the title of primary step.
106106

107107
#### Example
108108

@@ -128,20 +128,20 @@ Schema: [
128128
stepKey: 'security',
129129
title: 'Security',
130130
nextStep: 'credentials',
131-
substep: 'Configuration'
131+
substepOf: 'Configuration'
132132
},{
133133
stepKey: 'credentials',
134134
title: 'Credentials',
135135
nextStep: 'summary',
136-
substep: 'Configuration'
136+
substepOf: 'Configuration'
137137
},{
138138
stepKey: 'summary',
139139
title: 'Summary'
140140
},
141141
]
142142
```
143143

144-
Progressive Wizard works same way. It checks if previous step has the same \`substep\` value and if so, it grouped them together.
144+
Progressive Wizard works same way. It checks if previous step has the same \`substepOf\` value and if so, it grouped them together.
145145
If the value is different, a new primary step is created with the step as a substep.
146146

147147
### First step

0 commit comments

Comments
 (0)