BwWizard | bw-wizard

Overview

The wizard component is used for multi-step forms. You can have optional and required steps. It has methods to navigate between steps and a method to check if the current step can be skipped. The mode property can be set to make the wizard horizontal (default) or vertical.

Rather than using the wizard component directly, you should use bw-view-manager to build advanced multi step layouts. Read the wizard tutorial for examples.

Properties

Property	Attribute	Description	Type	Default
`mode`	`mode`	Display mode: 'horizontal' (default) or 'vertical'.	`"horizontal" \| "vertical"`	`'horizontal'`
`steps`	`steps`	The steps of the wizard.	`WizardStep[]`	`[]`

Events

Event	Description	Type
`finish`	Emitted when the wizard is finished.	`CustomEvent<void>`
`stepChange`	Emitted when the current step changes.	`CustomEvent<number>`

Methods

`canSkip() => Promise<boolean>`

Checks if the current step can be skipped.

Returns

Type: Promise<boolean>

`next() => Promise<void>`

Goes to the next step.

Returns

Type: Promise<void>

`previous() => Promise<void>`

Goes to the previous step.

Returns

Type: Promise<void>

`reset() => Promise<void>`

Resets the wizard.

Returns

Type: Promise<void>

`skip() => Promise<void>`

Skips the current step.

Returns

Type: Promise<void>

Shadow Parts

Part	Description
`"container"`	inner flex container that wraps the whole wizard

Dependencies

Used by

bw-view

Overview​

Properties​

Events​

Methods​

canSkip() => Promise<boolean>​

Returns​

next() => Promise<void>​

Returns​

previous() => Promise<void>​

Returns​

reset() => Promise<void>​

Returns​

skip() => Promise<void>​

Returns​

Shadow Parts​

Dependencies​

Used by​

Graph​

Overview

Properties

Events

Methods

`canSkip() => Promise<boolean>`

Returns

`next() => Promise<void>`

Returns

`previous() => Promise<void>`

Returns

`reset() => Promise<void>`

Returns

`skip() => Promise<void>`

Returns

Shadow Parts

Dependencies

Used by

Graph