Interface Wizard

interface Wizard {
    back(): void;
    cancel(): void;
    finish(): void;
    next<T>(stepId: string, properties?: T): void;
    setTitle(title: string): void;
}

Index

Methods

back cancel finish next setTitle

Methods

back

back(): void
Renders the previous wizard step.

Returns void

cancel

cancel(): void
Cancels the wizard.

Returns void

finish

finish(): void
Finishes the wizard.

Returns void

next

next<T>(stepId, properties?): void
Renders the next wizard step.
Type Parameters
- T extends Record<string, any>
Parameters
- stepId: string
  The step element ID to render.
- Optionalproperties: T
  The properties to set on the step element.
Returns void

setTitle

setTitle(title): void
Sets the title of the wizard header.
Parameters
- title: string
  The title.
Returns void