Options
All
  • Public
  • Public/Protected
  • All
Menu

Class WizardStepComponent

Wizard step component. Each step can stand alone or have substeps.

Note: This component is expected to be a child of wizard.

Hierarchy

Implements

Index

Constructors

constructor

Properties

config

The wizard step config containing component properties

onShow

onShow: EventEmitter<Object> = new EventEmitter()

The event emitted when this wizard step is shown

reviewTemplate

reviewTemplate: TemplateRef<any>

The wizard step template used for the review details screen

Accessors

hasSubsteps

  • get hasSubsteps(): boolean

nextEnabled

  • get nextEnabled(): boolean

previousEnabled

  • get previousEnabled(): boolean

selected

  • get selected(): boolean
  • set selected(selected: boolean): void
  • Indicates that this wizard step is selected

    Returns boolean

    True if this wizard step is selected

  • Sets a flag indicating that this wizard step is selected

    Parameters

    • selected: boolean

      True if this wizard step is selected

    Returns void

    True if this wizard step is selected

selectedStep

selectedStepIndex

  • get selectedStepIndex(): number

steps

Methods

addStep

getDisplayNumber

  • Returns the step number to be displayed for the given wizard step or substep

    Parameters

    Returns string

    The step number to be displayed

Protected getEnabledSteps

getReviewSteps

getStepIndex

goToFirstStep

  • goToFirstStep(): void

goToLastStep

  • goToLastStep(): void

goToNextStep

  • goToNextStep(): void

goToPreviousStep

  • goToPreviousStep(): void

next

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

    Parameters

    • emitEvent: boolean

      True to emit the wizard's onNext event

    Returns boolean

ngDoCheck

  • ngDoCheck(): void

ngOnInit

  • ngOnInit(): void

previous

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

    Parameters

    • emitEvent: boolean

      True to emit the wizard's onPrevious event

    Returns boolean

Protected setupConfig

  • setupConfig(): void

show

  • show(index: number): void

Protected stepByTitle

Protected stepIndex

Protected unselectAll

  • unselectAll(): void

Generated using TypeDoc