Interface: WizardProps

Defined in: composites/Wizard/Wizard.tsx:217

Props for Wizard.

The Wizard root carries no evaluation prop: under the evidence rule (CONTRIBUTING §2.3) a dimension only appears on a component if a runtime dispatches on it. The Wizard root renders a transparent <section> — no color tokens are read here — so adding evaluation would reserve API surface for a speculative future consumer. Re-introduce it the day a real consumer (e.g. wizard frame chrome) needs it.

The composite owns its layout; the root does not accept style or className. Pass them on a wrapping element instead. See CONTRIBUTING §4.

Properties

announceStep?

optional announceStep?: (state) => string

Defined in: composites/Wizard/Wizard.tsx:246

Builds the text announced by the wizard's visually-hidden aria-live=polite region whenever the active step changes. The default is an English fallback ("Step 2 of 3" / "Complete") — localized hosts supply their own copy here (CONTRIBUTING §6).

Parameters

Parameter	Type
state	{ currentStep: number; isComplete: boolean; totalSteps: number; }
state.currentStep	number
state.isComplete	boolean
state.totalSteps	number

Returns

string

---

aria-label?

optional aria-label?: string

Defined in: composites/Wizard/Wizard.tsx:239

Accessible name for the wizard region (rendered as aria-label). Always provide one (or aria-labelledby) — the wizard renders a <section> landmark and screen-reader users navigate by its name.

---

children?

optional children?: any

Defined in: composites/Wizard/Wizard.tsx:256

Expected children: any number of WizardStep (in order), an optional WizardSummary, and an optional WizardNavigation. Children are dispatched on their fixed composition identity.

---

currentStep?

optional currentStep?: number

Defined in: composites/Wizard/Wizard.tsx:224

Controlled current step index (0-based). When the user has advanced past the last step, currentStep === numberOfSteps — this is the terminal state that renders the WizardSummary sub-part (if provided). Pair with WizardProps.onStepChange.

---

defaultStep?

optional defaultStep?: number

Defined in: composites/Wizard/Wizard.tsx:229

Initial step index when rendering uncontrolled.

Default

0

---

onStepChange?

optional onStepChange?: (step) => void

Defined in: composites/Wizard/Wizard.tsx:233

Fires whenever the active step changes — controlled or uncontrolled.

Parameters

Parameter	Type
step	number

Returns

void