Quartz Headless docs/ToggleGroupDirective

Search documentation

Type to search the documentation.

API: Primitives

ToggleGroupDirective

Directive reference for ToggleGroupDirective with the selector [qzToggleGroup].

Overview

Selector

[qzToggleGroup]

Inputs

Input Type Default Required Description
type ToggleGroupType DEFAULT_TOGGLE_GROUP_CONFIG.type
disabled unknown false Transform booleanAttribute; reads as boolean.
orientation ToggleGroupOrientation DEFAULT_TOGGLE_GROUP_CONFIG.orientation
loop unknown DEFAULT_TOGGLE_GROUP_CONFIG.loop 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 | readonly T[] | null null valueChange

Properties

Name Type Description
readonly activeId Signal<string>
readonly activeItem Signal<ToggleItemDirective<T> & CollectionItem>

Public methods

register

register(item: ToggleItemDirective<T>): void
Parameter Type Optional Description
item ToggleItemDirective<T>

unregister

unregister(item: ToggleItemDirective<T>): void
Parameter Type Optional Description
item ToggleItemDirective<T>

toggle

toggle(item: ToggleItemDirective<T>, options?: { focus?: boolean; }): void
Parameter Type Optional Description
item ToggleItemDirective<T>
options { focus?: boolean } Yes

setActive

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

activeTabIndex

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

isPressed

isPressed(item: ToggleItemDirective<T>): boolean
Parameter Type Optional Description
item ToggleItemDirective<T>

onKeydown

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