Quartz Headless docs/ListboxService

Search documentation

Type to search the documentation.

API: Primitives

ListboxService

Container-scoped registry and active-descendant state for qzListbox.

Overview

Container-scoped registry and active-descendant state for qzListbox.

Properties

Name Type Description
readonly options Signal<ListboxOptionDirective<unknown>[]>
readonly enabledOptions Signal<ListboxOptionDirective<unknown>[]>
readonly activeId Signal<string>
readonly activeOption Signal<ListboxOptionDirective<unknown>>

Public methods

register

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

unregister

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

setActive

setActive(id: string | null): void
Parameter Type Optional Description
id string | null

configure

configure(options: { orientation: "vertical" | "horizontal"; typeaheadTimeoutMs: number; }): void
Parameter Type Optional Description
options { orientation: 'vertical' | 'horizontal'; typeaheadTimeoutMs: number }

first

first(): void

last

last(): void

next

next(): void

previous

previous(): void

typeahead

typeahead(character: string): void
Parameter Type Optional Description
character string

destroy

destroy(): void