Skip to content

WizardProviderProps

Defined in: packages/react/src/v1/index.tsx:72

Props for WizardProvider: the createWizard options, all optional here, or wizard for an engine built elsewhere. Passing wizard together with any option throws provider-wizard-and-options.

optional children: ReactNode

Defined in: packages/react/src/v1/index.tsx:75


optional ctx: Record<string, unknown>

Defined in: packages/core/dist/index.d.ts:324

The initial ctx, which expressions read under ctx. Ignored when state is given.

WizardOptions.ctx


optional data: Record<string, unknown>

Defined in: packages/core/dist/index.d.ts:322

The initial data. Ignored when state is given.

WizardOptions.data


optional flow: FlowDefinition

Defined in: packages/core/dist/index.d.ts:316

Partial.flow


optional groups: Traversal

Defined in: packages/core/dist/index.d.ts:332

Group and repeat traversal, from @wizzard-packages/core/groups. Required by any flow containing a GroupStep, and carried by no flow without one - which is the whole reason it is passed in rather than imported.

WizardOptions.groups


optional plugins: readonly Hooks[]

Defined in: packages/core/dist/index.d.ts:320

Plugins, called in this order.

WizardOptions.plugins


optional registry: Readonly<Record<string, AsyncResolver>>

Defined in: packages/core/dist/index.d.ts:318

Named resolvers for everything a flow cannot serialize.

WizardOptions.registry


optional state: WizardState

Defined in: packages/core/dist/index.d.ts:326

A previously serialized state, for resuming a session.

WizardOptions.state


optional subFlows: Readonly<Record<string, FlowDefinition>>

Defined in: packages/core/dist/index.d.ts:334

Sub-flow definitions a string GroupStep.flow names.

WizardOptions.subFlows


optional wizard: Wizard<FlowDefinition>

Defined in: packages/react/src/v1/index.tsx:74

An existing engine. Supply this or flow, not both.