Skip to content

Commit 8ede654

Browse files
committed
Config object explained in Readme
1 parent 57d663c commit 8ede654

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -106,6 +106,8 @@ The React component that is passed to each `Step` wrapper component will be inje
106106
| `props.getState` | `function<key, defaultValue>` | Function to retrieve a state value by key |
107107
| `props.handleChange` | `function<event>` | `onChange` event handler for form elements |
108108

109+
<br />
110+
109111
## Navigation Component `props`
110112

111113
| Property | Type | Description |
@@ -122,6 +124,17 @@ The React component that is passed to each `Step` wrapper component will be inje
122124
| `props.getState` | `function<key, defaultValue>` | Function to retrieve a state value by key |
123125
| `props.handleChange` | `function<event>` | `onChange` event handler for form elements |
124126

127+
<br />
128+
129+
## Config Object
130+
131+
### `navigation`
132+
133+
| Property | Type | Description |
134+
| --------------------- | ----------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
135+
| `component` | `() => JSX.Element` | This component's `props` object is automatically populated with the `Steps` component's state (see: [NavigationComponentProps](#component-type-of-example-navigation-component)). |
136+
| `location` (optional) | "`before`" or "`after`" | Location of the navigation component. |
137+
125138
<br />
126139
<hr />
127140
<br />

0 commit comments

Comments
 (0)