Search documentation

Search by topic, API name, or import path.

GitHub ↗

namespace / @typed/ui

Listbox

Public namespace exposed as Listbox from @typed/ui.

Learn this UI primitive →

Package version
1.0.0-beta.7
Category
namespace

Import

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

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

Signatures

export * as Listbox from "./Listbox.js";

Members

  • Listbox.InitialState

    Initial Listbox values. value and activeId default to null, loop defaults to true, and roving focus is used.

  • Listbox.Option

    Renders and optionally registers an option; focus or click selects it unless disabled.

  • Listbox.OptionOptions

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

  • Listbox.Root

    Renders the listbox root, initializes selection on focus, and handles vertical movement and typeahead in DOM order.

  • Listbox.RootOptions

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

  • Listbox.State

    The committed single value and the option currently owning keyboard focus. Normal option focus and movement update both values; the DOM ID and saved value may differ.

  • Listbox.StateSchema

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

  • Listbox.makeCollection

    Creates a scoped Collection for Listbox items.

  • Listbox.makeState

    Creates hydrated Listbox state. value and activeId default to null, loop defaults to true, and roving focus is used.

  • Listbox.move

    Moves through the registered options, synchronizes value when the target has one, then focuses and scrolls the active option.

  • Listbox.select

    Sets both activeId and selected value in one update.

Other public imports

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

Source