useWizard

Hook that manages a wizard

state

medium

test coverage

Last changed: 3 months ago

Installation

Library

CLI

Manual

import { useWizard } from '@siberiacancode/reactuse';

Usage

const { currentStepId, set, reset, back, next, history } = useWizard([ { id: 'step1', nodes: ['step2', 'step3'] }, { id: 'step2', nodes: ['step3'] }, { id: 'step3', nodes: [] }, ])

Demo

source

Api

Parameters

Name	Type	Default	Note
map	WizardItem<WizardStepId>[]	-	The map of the wizard
initialStepId?	WizardStepId	-	The initial step id

Returns

UseWizardReturn<WizardStepId>

Type declaration

export interface WizardItem<WizardStepId> {
  id: WizardStepId;
  nodes?: WizardStepId[];
}

Source

Source • Demo

Contributors

D

debabin

H

hywax