A stepper component that provides a wizard-like workflow by dividing content into logical steps.
- Slots
-
default— Renders `igc-step` components inside the default slot.
Properties
Section titled "Properties"animationDuration
Section titled "animationDuration"The animation duration in either vertical or horizontal mode in milliseconds.
animationDuration: number contentTop
Section titled "contentTop"Whether the content is displayed above the steps.
contentTop: boolean horizontalAnimation
Section titled "horizontalAnimation"The animation type when in horizontal mode.
horizontalAnimation: HorizontalTransitionAnimation linear
Section titled "linear"Whether the stepper is linear.
linear: boolean orientation
Section titled "orientation"The orientation of the stepper.
orientation: StepperOrientation stepType
Section titled "stepType"The visual type of the steps.
stepType: StepperStepType titlePosition
Section titled "titlePosition"The position of the steps title.
titlePosition: StepperTitlePosition verticalAnimation
Section titled "verticalAnimation"The animation type when in vertical mode.
verticalAnimation: StepperVerticalAnimation Accessors
Section titled "Accessors"steps
Section titled "steps"Returns all of the stepper's steps.
get steps(): readonly IgrStepComponent[] Returns readonly IgrStepComponent[]
Methods
Section titled "Methods"navigateTo
Section titled "navigateTo"Activates the step at a given index.
navigateTo(index: number): void Parameters
- index:
number
Returns void
Activates the next enabled step.
next(): void Returns void
Activates the previous enabled step.
prev(): void Returns void
reset
Section titled "reset"Resets the stepper to its initial state i.e. activates the first step.
reset(): void Returns void
Events
Section titled "Events"onActiveStepChanged
Section titled "onActiveStepChanged"Emitted after the active step has changed.
onActiveStepChanged(args: CustomEvent<IgrActiveStepChangedEventArgs>): void Parameters
Returns void
onActiveStepChanging
Section titled "onActiveStepChanging"Emitted when the active step is about to change. Cancelable.
onActiveStepChanging(args: CustomEvent<IgrActiveStepChangingEventArgs>): void