Interface ListboxController

Headless Listbox controller using active-descendant focus.

interface ListboxController {
    destroy(): void;
    getSnapshot(): Readonly<TSnapshot>;
    handleKeyDown(event: KeyboardEvent): void;
    off<TKey extends keyof ListboxEvents>(
        type: TKey,
        listener: RuntimeEventListener<ListboxEvents[TKey]>,
    ): void;
    on<TKey extends keyof ListboxEvents>(
        type: TKey,
        listener: RuntimeEventListener<ListboxEvents[TKey]>,
    ): Unsubscribe;
    once<TKey extends keyof ListboxEvents>(
        type: TKey,
        listener: RuntimeEventListener<ListboxEvents[TKey]>,
    ): Unsubscribe;
    registerOption(option: ListboxOption): () => void;
    select(id: string, details?: ChangeDetails<ListboxChangeReason>): void;
    setActive(id: string | null): void;
    subscribe(listener: SnapshotListener<ListboxSnapshot>): Unsubscribe;
}

Hierarchy (View Summary)

RuntimeController<ListboxSnapshot>
RuntimeEventSource<ListboxEvents>
- ListboxController

Index

Methods

destroy getSnapshot handleKeyDown off on once registerOption select setActive subscribe

Methods

destroy

destroy(): void
Releases owned listeners, timers, observers, focus scopes, and subscriptions.

Returns void
Inherited from RuntimeController.destroy
- Defined in core/types.ts:21

getSnapshot

getSnapshot(): Readonly<TSnapshot>
Returns the current immutable snapshot, including after destruction.

Returns Readonly<TSnapshot>
Inherited from RuntimeController.getSnapshot
- Defined in core/types.ts:17

handleKeyDown

handleKeyDown(event: KeyboardEvent): void
Handles Arrow keys, Home/End, typeahead, Enter, and Space.
Parameters
- event: KeyboardEvent
Returns void
- Defined in components/listbox.ts:105

off

off<TKey extends keyof ListboxEvents>(
type: TKey,
listener: RuntimeEventListener<ListboxEvents[TKey]>,
): void
Removes a previously registered listener.
Type Parameters
- TKey extends keyof ListboxEvents
Parameters
- type: TKey
- listener: RuntimeEventListener<ListboxEvents[TKey]>
Returns void
Inherited from RuntimeEventSource.off
- Defined in core/types.ts:65

on

on<TKey extends keyof ListboxEvents>(
type: TKey,
listener: RuntimeEventListener<ListboxEvents[TKey]>,
): Unsubscribe
Registers a listener and returns an idempotent unsubscribe function.
Type Parameters
- TKey extends keyof ListboxEvents
Parameters
- type: TKey
- listener: RuntimeEventListener<ListboxEvents[TKey]>
Returns Unsubscribe
Inherited from RuntimeEventSource.on
- Defined in core/types.ts:60

once

once<TKey extends keyof ListboxEvents>(
type: TKey,
listener: RuntimeEventListener<ListboxEvents[TKey]>,
): Unsubscribe
Registers a listener that is automatically removed after its first call.
Type Parameters
- TKey extends keyof ListboxEvents
Parameters
- type: TKey
- listener: RuntimeEventListener<ListboxEvents[TKey]>
Returns Unsubscribe
Inherited from RuntimeEventSource.once
- Defined in core/types.ts:67

registerOption

registerOption(option: ListboxOption): () => void
Registers a dynamic option and returns cleanup scoped to that registration.
Parameters
- option: ListboxOption
Returns () => void
- Defined in components/listbox.ts:99

select

select(id: string, details?: ChangeDetails<ListboxChangeReason>): void
Selects or toggles an enabled option.
Parameters
- id: string
- Optionaldetails: ChangeDetails<ListboxChangeReason>
Returns void
- Defined in components/listbox.ts:103

setActive

setActive(id: string | null): void
Sets the keyboard-active enabled option.
Parameters
- id: string | null
Returns void
- Defined in components/listbox.ts:101

subscribe(listener: SnapshotListener<ListboxSnapshot>): Unsubscribe
Subscribes to future distinct snapshots without synchronously invoking the listener.
Parameters
- listener: SnapshotListener<ListboxSnapshot>
Returns Unsubscribe
Inherited from RuntimeController.subscribe
- Defined in core/types.ts:19