Skip to content

Commit 07045fb

Browse files
authored
Merge pull request #81 from devrnt/docs/remove-leftovers
Docs/remove leftovers
2 parents 8998de0 + 6826854 commit 07045fb

File tree

2 files changed

+3
-10
lines changed

2 files changed

+3
-10
lines changed

README.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -112,8 +112,6 @@ Used to retrieve all methods and properties related to your wizard. Make sure `W
112112

113113
`handleStep` is used to attach a handler to the step, can either be `async` or a `sync` function. This function will be invoked when calling `nextStep`.
114114

115-
Provide an optional `stepIndex` to either `nextStep` or `previousStep` to overwrite the default "step-flow" behaviour.
116-
117115
**Remark** - You can't use `useWizard` in the same component where `Wizard` is used.
118116

119117
#### Methods

src/types.ts

Lines changed: 3 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -12,16 +12,12 @@ export type WizardProps = {
1212
export type WizardValues = {
1313
/**
1414
* Go to the next step
15-
*
16-
* @param stepIndex Overwrite the default behaviour by providing a step index
1715
*/
18-
nextStep: (stepIndex?: number) => Promise<void>;
16+
nextStep: () => Promise<void>;
1917
/**
2018
* Go to the previous step
21-
*
22-
* @param stepIndex Overwrite the default behaviour by providing a step index
23-
* */
24-
previousStep: (stepIndex?: number) => void;
19+
*/
20+
previousStep: () => void;
2521
/**
2622
* Go to the given step index
2723
*
@@ -32,7 +28,6 @@ export type WizardValues = {
3228
* Attach a callback that will be called when calling `nextStep()`
3329
*
3430
* @param handler Can be either sync or async
35-
*
3631
*/
3732
handleStep: (handler: Handler) => void;
3833
/**

0 commit comments

Comments
 (0)