Options
All
  • Public
  • Public/Protected
  • All
Menu

Class WizardComponent

Wizard component

Hierarchy

Implements

  • DoCheck
  • OnInit

Index

Constructors

constructor

Properties

config

config: WizardConfig

The wizard config containing component properties

onCancel

onCancel: EventEmitter<Object> = new EventEmitter()

The event emitted when the cancel button has been selected

onFinish

onFinish: EventEmitter<Object> = new EventEmitter()

The event emitted when all wizard steps and substeps have finished

onNext

onNext: EventEmitter<Object> = new EventEmitter()

The event emitted when the next button has been selected

onPrevious

onPrevious: EventEmitter<Object> = new EventEmitter()

The event emitted when the back button has been selected

onStepChange

onStepChange: EventEmitter<Object> = new EventEmitter()

The event emitted when a step has changed

Accessors

firstStep

  • get firstStep(): boolean
  • set firstStep(firstStep: boolean): void
  • Indicates that the selected step is also the first wizard step or substep

    Returns boolean

    True if the selected step is the first wizard step or substep

  • Set a flag indicating that the selected step is also the first wizard step or substep

    Parameters

    • firstStep: boolean

      True if the selected step is the first wizard step or substep

    Returns void

    True if the selected step is the first wizard step or substep

selectedStep

selectedStepIndex

  • get selectedStepIndex(): number

steps

Methods

addStep

Protected getEnabledSteps

getReviewSteps

getStepIndex

goToNextStep

  • goToNextStep(): void

goToPreviousStep

  • goToPreviousStep(): void

goToStep

  • goToStep(stepIndex: number, resetStepNav: boolean): void
  • Navigate to the given wizard step index

    Parameters

    • stepIndex: number

      The step number to navigate to

    • resetStepNav: boolean

      True if the first substep (if exists) should be selected

    Returns void

next

  • next(emitEvent: boolean): void

ngDoCheck

  • ngDoCheck(): void

ngOnInit

  • ngOnInit(): void

previous

  • previous(emitEvent: boolean): void
  • Called when the previous button has been selected.

    Parameters

    • emitEvent: boolean

      True to emit the onNext event

    Returns void

Protected setupConfig

  • setupConfig(): void

Protected stepByTitle

stepChanged

  • stepChanged(step: WizardStep, index: number): void
  • Emits an event when the wizard step or substep has changed

    Parameters

    • step: WizardStep

      The wizard step or substep

    • index: number

      The order of the wizard step of substep within its parent

    Returns void

Protected stepIndex

Protected unselectAll

  • unselectAll(): void

updateStepIndex

  • updateStepIndex(stepIndex: number): void
  • Set a flag indicating that the selected step is also the first wizard step or substep

    Parameters

    • stepIndex: number

      The step index

    Returns void

Generated using TypeDoc