Interface ComboboxController

Headless editable Combobox controller.

interface ComboboxController {
    bind(elements: OverlayElements): () => void;
    destroy(): void;
    getSnapshot(): Readonly<TSnapshot>;
    handleCompositionEnd(event: CompositionEvent): void;
    handleCompositionStart(): void;
    handleInput(event: InputEvent): void;
    handleKeyDown(event: KeyboardEvent): void;
    off<TKey extends keyof ComboboxEvents>(
        type: TKey,
        listener: RuntimeEventListener<ComboboxEvents[TKey]>,
    ): void;
    on<TKey extends keyof ComboboxEvents>(
        type: TKey,
        listener: RuntimeEventListener<ComboboxEvents[TKey]>,
    ): Unsubscribe;
    once<TKey extends keyof ComboboxEvents>(
        type: TKey,
        listener: RuntimeEventListener<ComboboxEvents[TKey]>,
    ): Unsubscribe;
    refresh(): Promise<void>;
    registerOption(option: ComboboxOption): () => void;
    select(id: string, details?: ChangeDetails<ComboboxSelectReason>): void;
    setInputValue(
        value: string,
        details?: ChangeDetails<ComboboxInputReason>,
    ): void;
    subscribe(listener: SnapshotListener<ComboboxSnapshot>): Unsubscribe;
}

Hierarchy (View Summary)

RuntimeController<ComboboxSnapshot>
RuntimeEventSource<ComboboxEvents>
- ComboboxController

Index

Methods

bind destroy getSnapshot handleCompositionEnd handleCompositionStart handleInput handleKeyDown off on once refresh registerOption select setInputValue subscribe

Methods

bind

bind(elements: OverlayElements): () => void
Binds input/popup DOM through the shared overlay layer.
Parameters
- elements: OverlayElements
Returns () => void
- Defined in components/combobox.ts:137

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

handleCompositionEnd

handleCompositionEnd(event: CompositionEvent): void
Commits the final IME value and resumes filtering.
Parameters
- event: CompositionEvent
Returns void
- Defined in components/combobox.ts:147

handleCompositionStart

handleCompositionStart(): void
Marks the start of an IME composition transaction.

Returns void
- Defined in components/combobox.ts:145

handleInput

handleInput(event: InputEvent): void
Handles a native input event without reading during module evaluation.
Parameters
- event: InputEvent
Returns void
- Defined in components/combobox.ts:141

handleKeyDown

handleKeyDown(event: KeyboardEvent): void
Handles popup navigation, selection, and Escape.
Parameters
- event: KeyboardEvent
Returns void
- Defined in components/combobox.ts:143

off

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

on

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

once

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

refresh

refresh(): Promise<void>
Re-runs async suggestions for the current query.

Returns Promise<void>
- Defined in components/combobox.ts:151

registerOption

registerOption(option: ComboboxOption): () => void
Registers a local option and returns cleanup scoped to that option.
Parameters
- option: ComboboxOption
Returns () => void
- Defined in components/combobox.ts:135

select

select(id: string, details?: ChangeDetails<ComboboxSelectReason>): void
Selects a visible enabled option.
Parameters
- id: string
- Optionaldetails: ChangeDetails<ComboboxSelectReason>
Returns void
- Defined in components/combobox.ts:149

setInputValue

setInputValue(value: string, details?: ChangeDetails<ComboboxInputReason>): void
Updates editable text, filtering and async suggestions.
Parameters
- value: string
- Optionaldetails: ChangeDetails<ComboboxInputReason>
Returns void
- Defined in components/combobox.ts:139

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

Interface ComboboxController

Hierarchy (View Summary)

Index

Methods

Methods

bind

Parameters

Returns () => void

destroy

Returns void

getSnapshot

Returns Readonly<TSnapshot>

handleCompositionEnd

Parameters

Returns void

handleCompositionStart

Returns void

handleInput

Parameters

Returns void

handleKeyDown

Parameters

Returns void

off

Type Parameters

Parameters

Returns void

on

Type Parameters

Parameters

Returns Unsubscribe

once

Type Parameters

Parameters

Returns Unsubscribe

refresh

Returns Promise<void>

registerOption

Parameters

Returns () => void

select

Parameters

Returns void

setInputValue

Parameters

Returns void

subscribe

Parameters

Returns Unsubscribe

Settings

On This Page