Quartz Headless docs/ListboxDirective

Search documentation

Type to search the documentation.

API: Primitives

ListboxDirective

Directive reference for ListboxDirective with the selector [qzListbox].

Overview

Selector

[qzListbox]

Inputs

Input Type Default Required Description
multiple unknown false Transform booleanAttribute; reads as boolean.
orientation ListboxOrientation 'vertical'
disabled unknown false Transform booleanAttribute; reads as boolean.
config Partial<ListboxConfig> {}
compareWith (a: T, b: T) => boolean Object.is Equality function for object values. Defaults to Object.is.

Models

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

Model Type Default Required Change output Description
value T | T[] | null null valueChange Selected value. Supports Angular two-way binding: [(value)]="selection".

Outputs

Output Payload Description
valueChangeCommitted T | T[] | null Fires once per user selection change; never for programmatic writes.

Properties

Name Type Description
readonly isDisabled Signal<boolean> Effective disabled state: the disabled input OR a disabled Angular Forms control.
readonly activeId Signal<string>
readonly activeOption Signal<ListboxOptionDirective<T> | null>

Public methods

register

register(option: ListboxOptionDirective<T>): void
Parameter Type Optional Description
option ListboxOptionDirective<T>

unregister

unregister(option: ListboxOptionDirective<T>): void
Parameter Type Optional Description
option ListboxOptionDirective<T>

setActive

setActive(option: ListboxOptionDirective<T>): void
Parameter Type Optional Description
option ListboxOptionDirective<T>

isSelected

isSelected(option: ListboxOptionDirective<T>): boolean
Parameter Type Optional Description
option ListboxOptionDirective<T>

setFormDisabled

setFormDisabled(disabled: boolean): void

Adapter hook for @quartz-headless/primitives/forms (setDisabledState).

Parameter Type Optional Description
disabled boolean

select

select(option: ListboxOptionDirective<T>): void
Parameter Type Optional Description
option ListboxOptionDirective<T>

onKeydown

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