Quartz Headless docs/StepperDirective

Search documentation

Type to search the documentation.

API: Primitives

StepperDirective

Directive reference for StepperDirective with the selector [qzStepper].

Overview

Selector

[qzStepper]

Inputs

Input Type Default Required Description
orientation StepperOrientation DEFAULT_STEPPER_CONFIG.orientation
activationMode StepperActivationMode DEFAULT_STEPPER_CONFIG.activationMode
linear unknown DEFAULT_STEPPER_CONFIG.linear Transform booleanAttribute; reads as boolean.
disabled unknown false Transform booleanAttribute; reads as boolean.
compareWith (a: T, b: T) => boolean

Models

Two-way bindings: each model is an input and emits the matching change output.

Model Type Default Required Change output Description
value T | null null valueChange

Properties

Name Type Description
readonly activeTrigger Signal<StepTriggerDirective<T> & CollectionItem>

Public methods

registerStep

registerStep(step: StepDirective<T>): void
Parameter Type Optional Description
step StepDirective<T>

unregisterStep

unregisterStep(step: StepDirective<T>): void
Parameter Type Optional Description
step StepDirective<T>

registerTrigger

registerTrigger(trigger: StepTriggerDirective<T>): void
Parameter Type Optional Description
trigger StepTriggerDirective<T>

unregisterTrigger

unregisterTrigger(trigger: StepTriggerDirective<T>): void
Parameter Type Optional Description
trigger StepTriggerDirective<T>

registerPanel

registerPanel(panel: StepPanelDirective<T>): void
Parameter Type Optional Description
panel StepPanelDirective<T>

unregisterPanel

unregisterPanel(panel: StepPanelDirective<T>): void
Parameter Type Optional Description
panel StepPanelDirective<T>

goTo

goTo(value: T, options?: { focus?: boolean; }): boolean
Parameter Type Optional Description
value T
options { focus?: boolean } Yes

next

next(options?: { focus?: boolean; }): boolean
Parameter Type Optional Description
options { focus?: boolean } Yes

previous

previous(options?: { focus?: boolean; }): boolean
Parameter Type Optional Description
options { focus?: boolean } Yes

activate

activate(trigger: StepTriggerDirective<T>, options?: { focus?: boolean; }): void
Parameter Type Optional Description
trigger StepTriggerDirective<T>
options { focus?: boolean } Yes

setActive

setActive(trigger: StepTriggerDirective<T>, options?: { focus?: boolean; }): void
Parameter Type Optional Description
trigger StepTriggerDirective<T>
options { focus?: boolean } Yes

activeTabIndex

activeTabIndex(id: string): 0 | -1
Parameter Type Optional Description
id string

isActiveValue

isActiveValue(value: T): boolean
Parameter Type Optional Description
value T

isCompletedValue

isCompletedValue(value: T): boolean
Parameter Type Optional Description
value T

isDisabledValue

isDisabledValue(value: T): boolean
Parameter Type Optional Description
value T

panelIdFor

panelIdFor(trigger: StepTriggerDirective<T>): string
Parameter Type Optional Description
trigger StepTriggerDirective<T>

triggerIdFor

triggerIdFor(panel: StepPanelDirective<T>): string | null
Parameter Type Optional Description
panel StepPanelDirective<T>

handleKeydown

handleKeydown(event: KeyboardEvent): void
Parameter Type Optional Description
event KeyboardEvent