@theredhead — Frontend Library - v1.0.0
    Preparing search index...

    Class UIWizard

    A multi-step workflow shell with a step indicator, navigation buttons, and optional validation gates.

    Steps are defined by projecting <ui-wizard-step> children. The wizard discovers them via content queries and renders only the active step.

    <ui-wizard (complete)="onFinish()">
      <ui-wizard-step label="Account">…</ui-wizard-step>
      <ui-wizard-step label="Profile">…</ui-wizard-step>
      <ui-wizard-step label="Confirm">…</ui-wizard-step>
    </ui-wizard>

    <ui-wizard linear>
      <ui-wizard-step label="Details" [canAdvance]="formValid()">
        …
      </ui-wizard-step>
      <ui-wizard-step label="Review">…</ui-wizard-step>
    </ui-wizard>
    Index

    Constructors

    constructor

    Properties

    activeIndex ariaLabel backLabel complete finishLabel linear nextLabel showStepIndicator stepChange

    Methods

    finish goToStep next previous

    Constructors

    Properties

    activeIndex: ModelSignal<number> = ...

    Zero-based index of the active step (two-way bindable).

    ariaLabel: InputSignal<string> = ...

    Accessible label for the wizard.

    backLabel: InputSignal<string> = ...

    Label for the Back button.

    complete: OutputEmitterRef<void> = ...

    Emitted when the user clicks Finish on the last step.

    finishLabel: InputSignal<string> = ...

    Label for the Finish button (shown on the last step).

    linear: InputSignal<boolean> = ...

    When true, the user must complete steps in order and cannot click ahead on the step indicator.

    nextLabel: InputSignal<string> = ...

    Label for the Next button.

    showStepIndicator: InputSignal<boolean> = ...

    Whether to show the step indicator bar.

    stepChange: OutputEmitterRef<StepChangeEvent> = ...

    Emitted when the active step changes.

    Methods

    • Complete the wizard (only works on the last step).

      Returns void

    • Navigate to a specific step by index.

      Parameters

      • index: number

      Returns void

    • Advance to the next step (respects validation).

      Returns void

    • Go back to the previous step.

      Returns void

    Settings

    Member Visibility

    On This Page

    Basic usageWith validation gates
    Constructors
    Properties
    Methods