interface / @typed/ui

Listbox.OptionOptions

Inputs accepted by Listbox.Option in addition to the shared DOM host options.

Learn this UI primitive →

Package version
1.0.0-beta.13
Category
Selectable options
Since
1.0.0
Member of
Listbox

Import

import { Listbox } from "@typed/ui";

Access Listbox.OptionOptions through the imported Listbox export. Its declaration below describes the member.

This public exposure is a re-export. Its import path is supported; declaration documentation is shared with the other public exposures below.

Signatures

export interface OptionOptions extends Dom.HostOptions<HTMLDivElement> {
    readonly state: RefSubject.HydratedRefSubject<State, Schema.SchemaError>;
    readonly collection?: RefSubject.RefSubject<Collection.State<string>>;
    readonly id: string;
    readonly value: string;
    readonly content: Renderable.Any;
    readonly textValue?: string;
    readonly disabled?: boolean;
}

Property: collection

Item registry used for collection-driven keyboard behavior and mounted ordering.

Property: content

Renderable child content for the component host.

Property: disabled

Flag used by collection movement and widget handlers to skip activation by default.

Property: id

Stable id used for collection identity and ARIA relationships.

Property: state

Renderer-independent RefSubject state consumed by this component or operation.

Property: textValue

Search text used by typeahead independently of rendered markup.

Property: value

Current semantic value selected or edited by the widget.

Other public imports

These import paths expose the same declaration. Each page retains its own public name and signature.

Source