Search documentation

Search by topic, API name, or import path.

GitHub ↗

variable / @typed/ui/index

Listbox.StateSchema

Effect Schema used by makeState to encode, decode, and hydrate Listbox state.

Learn this UI primitive →

Package version
1.0.0-beta.7
Category
Selection and focus
Since
1.0.0
Member of
Listbox

Import

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

Access Listbox.StateSchema 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 declare const StateSchema: Schema.Struct<{
    readonly value: Schema.NullOr<Schema.String>;
    readonly activeId: Schema.NullOr<Schema.String>;
    readonly orientation: Schema.Literals<readonly [
        "vertical"
    ]>;
    readonly loop: Schema.Boolean;
    readonly rtl: Schema.Boolean;
    readonly virtualFocus: Schema.Boolean;
}>;

Examples

import * as Schema from "effect/Schema";
import * as Listbox from "@typed/ui/Listbox";

const decodeState = Schema.decodeUnknownEffect(Listbox.StateSchema);

Other public imports

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

Source