Skip to content

Commit b184383

Browse files
committed
updated README
1 parent 1ee0abf commit b184383

File tree

1 file changed

+3
-6
lines changed

1 file changed

+3
-6
lines changed

README.md

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -115,16 +115,13 @@ export default props => {
115115

116116
Configurable for `Tour` only
117117

118-
All steps must be listed here. Each element in the array can either be a string representing the step name, a preconfigured step, or a step placeholder object.
118+
All steps must be listed here. Each element in the array can either be a string representing the step name, or a preconfigured step.
119119

120120
If it's a string, the step must be registered by the time the _previous_ step is displayed.
121121

122-
If it is an object, it can be a fully configured step and can contain any of the configuration options below, but it must not include a `fetch()` method.
122+
If it is an object, it can be a fully configured step and can contain any of the configuration options below. Optionally, it can contain a `fetch()` method that instructs the tour to assume that the step exists but has not yet loaded. Note that `fetch()` can only be used in `stepOrder`, not on a step configuration using `useStep()`.
123123

124-
Or, it can take the following options as a placeholder that instructs the tour to assume that the step exists but has not yet loaded:
125-
126-
- `name` - required, the name of the step
127-
- `fetch` - required, a function the returns a promise. Called when the step is to be displayed but is not yet registered. It can change the route, fetch data, or conduct any other action that enabled the step to load and register. When present, the tour will pause and will only resume once the step is registered. Life cycle events can be used to manage the UI when in the fetching state.
124+
`fetch() => Promise<void>` - Called when the step is to be displayed but is not yet registered. It can change the route, fetch data, or conduct any other action that enables the step to load and register. When present, the tour will pause and will only resume once the step is registered. Life cycle events can be used to manage the UI when in the fetching state.
128125

129126
### `name <string>` required
130127

0 commit comments

Comments
 (0)