Skip to content
wizzard
Examples
Inspector
Docs
GitHub
Search
Ctrl
K
Cancel
Documentation version
1.0.0
Select theme
Dark
Light
Auto
Menu
Examples
Inspector
Docs
GitHub
Start here
Getting started
Tutorial
Concepts and glossary
What you can build
Tasks
Block Next until valid
Restore after reload
Clear abandoned branch data
Render field errors
Guides
The flow
Groups, repeat and sub-flows
Expressions
Navigation
Hooks
API behaviour
Validation
Loading a step
Persistence
Writing a plugin
Testing a wizard
Inspecting a flow
Devtools
Server-driven flows
Errors
resolver-not-registered
resolver-is-async
expr-unknown-operator
expr-invalid-operand
when-threw
expr-too-deep
flow-invalid
flow-unreadable
flow-no-steps
order-unknown-step
step-not-in-order
order-duplicate
get-unknown-root
flow-not-serializable
target-unknown-step
clear-on-leave-invalid
when-with-next
repeat-without-when
repeat-without-version
session-flow-mismatch
session-no-frames
session-frame-corrupt
session-frames-reordered
session-unknown-flow
session-frame-mismatch
groups-not-installed
repeat-keys
provider-missing
provider-wizard-and-options
start-failed
plugin-disabled
before-navigate-invalid
after-navigate-threw
plugin-teardown-failed
listener-threw
nav-invalid
nav-blocked
nav-no-target
nav-not-reachable
nav-superseded
nav-aborted
devtools-no-wizard
devtools-no-plugin
devtools-render-failed
devtools-stopped
devtools-export-failed
devtools-bundle-unsupported
persist-unavailable
persist-not-restored
persist-write-failed
persist-on-restore-threw
inspector-paste
API reference
@wizzard-packages/core
Classes
WizardError
Interfaces
ActiveAt
AtomStep
Breadcrumb
Derived
FlowDefinition
Frame
GroupStep
Hooks
PluginHost
Scope
Slice
Traversal
Wizard
WizardOptions
WizardState
Type Aliases
AsyncRegistry
AsyncResolver
Attempt
AttemptPhase
BackTarget
DataOf
Expr
Json
NavDecision
NavigationPolicy
NavIntent
NavReason
NavResult
Registry
Resolver
SliceAt
Snapshot
StepDef
StepIdOf
StepStatus
SubFlows
Target
WizardStatus
Variables
END
Functions
allowedByPolicy
createSelector
createWizard
defineFlow
enterable
evaluate
evaluateAsync
getPath
group
isGroup
isSync
reachable
reachableOnPath
resolveBack
resolveNext
setPath
step
test
testAsync
unsetPath
@wizzard-packages/core/expr
Type Aliases
Path
Functions
and
empty
eq
get
gt
gte
isIn
lt
lte
ne
not
or
ref
@wizzard-packages/core/graph
Interfaces
FlowGraph
GraphEdge
GraphNode
GroupNode
Functions
buildGraph
@wizzard-packages/core/groups
Interfaces
Items
Level
Type Aliases
Move
Refusal
Variables
groups
Functions
here
itemsOf
step
walk
@wizzard-packages/core/session
Interfaces
RecordedSession
Type Aliases
FrameProblem
Functions
checkFrames
checkSession
isStackEntry
knownFlows
@wizzard-packages/core/snapshot
Interfaces
DecodeOptions
Snapshot
Type Aliases
RestoreReason
RestoreResult
Functions
decodeSnapshot
toSnapshot
@wizzard-packages/core/validate-flow
Interfaces
FlowProblem
Functions
assertFlow
validateFlow
@wizzard-packages/devtools
Interfaces
DevtoolsOptions
DevtoolsPlugin
FlowGraphViewProps
GraphView
LayoutInfo
Outcome
OutcomeError
Pending
Recorder
RecordOptions
SessionBundle
TakenEdge
WizardDevtoolsProps
Type Aliases
Tab
WizardLike
Variables
EDGE_DRAW_CAP
Functions
devtools
FlowGraphView
recordSession
WizardDevtools
@wizzard-packages/devtools/headless
Interfaces
BundleMeta
Change
LayoutOptions
Positioned
PositionedEdge
PositionedGraph
Type Aliases
Direction
Variables
NODE_H
NODE_W
REPEAT_H
Functions
diffState
formatExpr
layoutGraph
toOutcomeError
References
devtools
DevtoolsOptions
DevtoolsPlugin
Outcome
OutcomeError
Pending
Recorder
RecordOptions
recordSession
SessionBundle
WizardLike
@wizzard-packages/plugins/persist
Interfaces
PersistOptions
SyncStorage
Type Aliases
RestoreOutcome
Functions
persist
@wizzard-packages/react
Interfaces
Navigation
Wizard
WizardOptions
WizardProviderProps
Type Aliases
Snapshot
Functions
useErrors
useField
useNavigation
useOptionalWizard
useStep
useWizard
useWizardSelector
useWizardSnapshot
WizardProvider
@wizzard-packages/validate
Interfaces
StandardIssue
StandardSchemaV1
Type Aliases
FieldErrors
StandardResult
Functions
issuesToErrors
schema
@wizzard-packages/vue
Interfaces
Navigation
Functions
provideWizard
useErrors
useField
useNavigation
useOptionalWizard
useStep
useWizard
useWizardSelector
useWizardSnapshot
References
Snapshot
Wizard
WizardOptions
Select theme
Dark
Light
Auto
@wizzard-packages/core/groups
Sub-flows: the traversal a wizard is handed when its flow has a group step.
Interfaces
Section titled “Interfaces”
Items
Level
Type Aliases
Section titled “Type Aliases”
Move
Refusal
Variables
Section titled “Variables”
groups
Functions
Section titled “Functions”
here
itemsOf
step
walk