Module / v1.0.0-beta.13

@typed/ui/index

512 unique exports available through this public import path, including their members and aliases.

Learn this UI primitive →

import * as index from "@typed/ui/index";

Active item state

  • Composite.ActiveIdState

    interface · Re-export

    Public Composite.ActiveIdState behavioral model.

  • Composite.InitialState

    interface · Re-export

    Initial Composite values. activeId defaults to null, orientation to horizontal, loop to true, RTL and virtual focus to false.

  • Composite.State

    interface · Re-export

    Complete renderer-independent state for Composite.

  • Composite.StateSchema

    variable · Re-export

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

  • Composite.makeState

    function · Re-export

    Creates hydrated Composite state. activeId defaults to null, orientation to horizontal, loop to true, RTL and virtual focus to false.

Aliases

Bounded resizing

Browser form data

  • Form.FormDataRecord

    type-alias · Re-export

    Object representation of native FormData, preserving repeated names as arrays.

  • Form.FormDataValue

    type-alias · Re-export

    Native value emitted by FormData.

  • Form.decodeFormData

    function · Re-export

    Decodes native FormData through an Effect Schema codec.

  • Form.formDataToRecord

    function · Re-export

    Converts native form data to a record, preserving repeated names as arrays.

Buffered server rendering

  • ssrForHttp

    variable

    Registers buffered, GET-only HTML routes for a matcher.

    Path captures take precedence over same-named query parameters. Rendering completes before the response is created; this adapter does not stream.

Cancelable dismissal

  • Dialog.RequestClose

    function · Re-export

    Renders a button that starts the cancelable native close-request lifecycle.

  • Dialog.requestClose

    function · Re-export

    Requests the native dialog close lifecycle, including its cancel event.

Cell focus

  • Grid.InitialState

    interface · Re-export

    Initial Grid values. activeId defaults to null.

  • Grid.State

    interface · Re-export

    The cell ID exposed by the root through aria-activedescendant. Native focus stays on the root; selected cells and editing state are not stored here.

  • Grid.StateSchema

    variable · Re-export

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

  • Grid.activate

    function · Re-export

    Sets activeId, including null to clear virtual focus.

  • Grid.makeState

    function · Re-export

    Creates hydrated Grid state. activeId defaults to null.

Cell registration

Cells and headers

  • Grid.Cell

    function · Re-export

    Renders and optionally registers a gridcell with row and column coordinates.

  • Grid.CellOptions

    interface · Re-export

    Inputs accepted by Grid.Cell in addition to the shared DOM host options.

  • Grid.ColumnHeader

    function · Re-export

    Renders the Cell contract with the columnheader role.

  • Grid.RowHeader

    function · Re-export

    Renders the Cell contract with the rowheader role.

Checked commands

  • Menu.CheckboxItem

    function · Re-export

    Renders Item with menuitemcheckbox semantics and caller-supplied checked state.

  • Menu.CheckboxItemOptions

    interface · Re-export

    Inputs accepted by Menu.CheckboxItem in addition to the shared DOM host options.

  • Menu.RadioItem

    function · Re-export

    Renders Item with menuitemradio semantics and caller-supplied checked state.

  • Menu.RadioItemOptions

    interface · Re-export

    Inputs accepted by Menu.RadioItem in addition to the shared DOM host options.

Child row visibility

  • TreeGrid.Group

    function · Re-export

    Renders a rowgroup and hides it while its parent row is collapsed.

  • TreeGrid.GroupOptions

    interface · Re-export

    Inputs accepted by TreeGrid.Group in addition to the shared DOM host options.

Child visibility

  • Tree.Group

    function · Re-export

    Renders a child group and hides it while its parent id is not expanded.

  • Tree.GroupOptions

    interface · Re-export

    Inputs accepted by Tree.Group in addition to the shared DOM host options.

Collapse and restore

Collection ordering

  • Collection.byDomOrder

    function · Re-export

    Returns a sorted copy using compareDocumentPosition; items without comparable mounted elements retain an equivalent ordering position.

  • Collection.enabledItems

    function · Re-export

    Returns a new array excluding only items whose disabled flag is exactly true.

Collection state

  • Collection.State

    type-alias · Re-export

    Complete renderer-independent state for Collection.

  • Collection.makeState

    function · Re-export

    Creates hydrated Collection state. The collection starts with the supplied immutable item array, or empty.

Command focus

  • Menubar.InitialState

    type-alias · Re-export

    Initial Menubar values. Uses Composite defaults unless overridden.

  • Menubar.State

    interface · Re-export

    The active top-level command and horizontal navigation policy. Child menu visibility belongs to the separate Menu state connected by its submenu trigger.

  • Menubar.StateSchema

    variable · Re-export

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

  • Menubar.makeState

    function · Re-export

    Creates hydrated Menubar state. Uses Composite defaults unless overridden.

  • Toolbar.InitialState

    type-alias · Re-export

    Initial Toolbar values. Uses Composite defaults unless overridden.

  • Toolbar.State

    interface · Re-export

    The active command and arrow-navigation policy. Formatting preferences such as bold or italic are separate application state.

  • Toolbar.StateSchema

    variable · Re-export

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

  • Toolbar.makeState

    function · Re-export

    Creates hydrated Toolbar state. Uses Composite defaults unless overridden.

Command grouping

  • Menu.Group

    function · Re-export

    Renders a labelled ARIA group inside menu content.

  • Menu.GroupOptions

    interface · Re-export

    Inputs accepted by Menu.Group in addition to the shared DOM host options.

  • Menu.Separator

    function · Re-export

    Renders a separator with explicit horizontal or vertical orientation.

  • Menu.SeparatorOptions

    interface · Re-export

    Inputs accepted by Menu.Separator in addition to the shared DOM host options.

Command registration

Commands

  • Menu.Dismiss

    variable · Re-export

    Consumer-facing alias of the canonical Menu component with identical behavior and lifetime.

  • Menu.Item

    function · Re-export

    Renders and optionally registers a menu item; disabled items remain announced but do not activate.

  • Menu.ItemOptions

    interface · Re-export

    Inputs accepted by Menu.Item in addition to the shared DOM host options.

Component options

Controls

  • Alert.Alert

    function · Re-export

    Renders an assertive alert region without moving focus.

  • Group.Label

    function · Re-export

    Renders visible group-label text in a span.

  • Meter.Meter

    function · Re-export

    Renders a native meter for a measurement within a known range.

  • Select.Content

    function · Re-export

    Renders the manual-popover listbox and coordinates registered keyboard movement.

  • Select.Option

    function · Re-export

    Renders a selectable listbox option with distinct active and selected state.

  • Select.Select

    variable · Re-export

    Alias of Trigger.

  • Select.Trigger

    function · Re-export

    Renders the native button that toggles the select listbox popover.

DOM focus and scrolling

  • Composite.focusActive

    function · Re-export

    Focuses the registered active element unless state uses virtual focus or has no active id.

  • Composite.focusElement

    function · Re-export

    Calls an existing platform focus method inside Effect.sync and otherwise does nothing.

  • Composite.moveAndFocus

    function · Re-export

    Moves active state, then focuses and scrolls the mounted active item when virtual focus is disabled.

  • Composite.scrollActive

    function · Re-export

    Calls scrollIntoView with nearest block/inline alignment for the mounted active item.

Dialog naming and description

Direct dismissal

  • Dialog.Close

    function · Re-export

    Renders a button that closes a dialog without a cancel request.

  • Dialog.CloseOptions

    interface · Re-export

    Options for dialog close and close-request buttons.

  • Dialog.Dismiss

    variable · Re-export

    Alias for direct Close behavior.

  • Dialog.close

    function · Re-export

    Marks dialog state closed without requesting native cancellation.

Directional movement

  • Composite.Move

    type-alias · Re-export

    Logical movement operations independent of physical key names.

  • Composite.MoveOptions

    interface · Re-export

    State, collection, and disabled-item policy consumed by Composite movement helpers.

  • Composite.Orientation

    type-alias · Re-export

    Supported composite movement axes.

  • Composite.move

    function · Re-export

    Computes the next active id and updates state; collection and state failures/services are preserved in the returned Effect.

  • Composite.moveActiveId

    function · Re-export

    Returns the id reached by first/last/next/previous with optional disabled inclusion and loop policy.

  • Composite.moveActiveItem

    function · Re-export

    Returns the full item selected by moveActiveId, or undefined when no item is reachable.

  • Composite.orderedEnabledItems

    function · Re-export

    Sorts a copy by mounted DOM order and then removes disabled items.

Editable input

  • Combobox.Input

    function · Re-export

    Renders the native combobox input, keeps its value property synchronized, opens on focus, and handles Arrow, Enter, and Escape when a collection is supplied.

  • Combobox.InputOptions

    interface · Re-export

    Inputs accepted by Combobox.Input in addition to the shared DOM host options.

Element ref types

  • Dom.ElementRef

    type-alias · Re-export

    Optional ref contract shared by DOM-backed component options.

  • Dom.ElementRefCallback

    type-alias · Re-export

    Callback invoked with the exact mounted DOM element.

Event composition

  • Dom.chainEvent

    function · Re-export

    Combines a user handler with component-required behavior for one native event.

Event input types

Event inspection

  • Dom.currentTarget

    function · Re-export

    Reads a native event’s non-null current target during handler execution.

  • Dom.toggleState

    function · Re-export

    Reads the standards-based ToggleEvent.newState value when present.

Expansion

  • Tree.collapse

    function · Re-export

    Removes an id from expandedIds.

  • Tree.expand

    function · Re-export

    Adds an id once to expandedIds.

  • Tree.isExpanded

    function · Re-export

    Tests membership in expandedIds without touching the DOM.

Field relationships

  • Form.Description

    function · Re-export

    Renders visible explanatory content in a neutral div.

  • Form.DescriptionOptions

    interface · Re-export

    Options for descriptive form content.

  • Form.Error

    function · Re-export

    Renders the named field message with a generated ID and alert role.

  • Form.ErrorOptions

    interface · Re-export

    Options for a field validation alert.

  • Form.Group

    function · Re-export

    Renders an ARIA group with an optional accessible name.

  • Form.GroupOptions

    interface · Re-export

    Options for an accessible group of form controls.

  • Form.Label

    function · Re-export

    Renders a native label with an explicit control relationship.

  • Form.LabelOptions

    interface · Re-export

    Options for a native form label.

Field types

  • Form.FieldNameFor

    type-alias · Re-export

    Field names whose decoded value is assignable to Value.

  • Form.SchemaFieldNameFor

    type-alias · Re-export

    Struct field names matching both decoded and encoded control value types.

Form actions

  • Form.Push

    function · Re-export

    Renders a button that appends one item to an array field.

  • Form.Remove

    function · Re-export

    Renders a button that removes one array item by index.

  • Form.Reset

    function · Re-export

    Renders a native reset button that restores Typed form defaults.

  • Form.Submit

    function · Re-export

    Renders a native type=submit button.

Form context

  • Form.CurrentForm

    variable · Re-export

    Effect context service used by schema-bound form controls.

  • Form.FormService

    interface · Re-export

    Context service exposed to schema-bound descendant controls.

Form roots

  • Form.BoundFormOptions

    interface · Re-export

    Options accepted by a schema-bound form root.

  • Form.Form

    function · Re-export

    Renders a native form and provides its state to bound descendants.

  • Form.FormOptions

    interface · Re-export

    Options for the state-explicit form root.

  • Form.ValidSubmitHandler

    type-alias · Re-export

    Handler invoked only after whole-form Schema validation succeeds.

Grid surface

  • Grid.Root

    function · Re-export

    Renders the focus-owning grid root and initializes the active cell from DOM order on first focus.

  • Grid.RootOptions

    interface · Re-export

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

HTTP error responses

  • handleHttpServerError

    function

    Converts Effect HTTP server errors into empty 400, 404, or 500 responses. Other failures remain in the global error channel.

Hierarchical rows

  • TreeGrid.Row

    function · Re-export

    Renders a hierarchical row with level and optional expanded state.

  • TreeGrid.RowOptions

    interface · Re-export

    Inputs accepted by TreeGrid.Row in addition to the shared DOM host options.

Hierarchy and cell focus

  • TreeGrid.InitialState

    type-alias · Re-export

    Initial TreeGrid values. Uses Tree state and defaults.

  • TreeGrid.State

    type-alias · Re-export

    Tree expansion state reused for a grid whose active ID names a cell. expandedIds names parent rows, while activeId names the active cell within a row.

  • TreeGrid.StateSchema

    variable · Re-export

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

  • TreeGrid.activate

    variable · Re-export

    Sets the active TreeGrid row or cell id without changing expansion.

  • TreeGrid.makeState

    variable · Re-export

    Creates hydrated TreeGrid state. Uses Tree state and defaults.

Hierarchy state

  • Tree.InitialState

    interface · Re-export

    Initial Tree values. activeId defaults null and expandedIds defaults empty.

  • Tree.State

    interface · Re-export

    The focused node and expanded parent identities. Expansion controls visible traversal; file selection or opening is a separate application action.

  • Tree.StateSchema

    variable · Re-export

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

  • Tree.makeState

    function · Re-export

    Creates hydrated Tree state. activeId defaults null and expandedIds defaults empty.

Host input types

Host rendering

  • Dom.renderDivHost

    function · Re-export

    Renders a native div host from supplied props and content.

  • Dom.renderHost

    function · Re-export

    Creates the host-rendering boundary for a particular DOM element type.

Host rendering types

  • Dom.HostOverride

    type-alias · Re-export

    Component-local replacement for its default host element.

  • Dom.HostRenderer

    type-alias · Re-export

    Function signature for rendering an arbitrary DOM host.

  • Dom.HostRendererForTag

    type-alias · Re-export

    Renderer signature specialized to a native tag name.

Hydration schemas

  • Form.StateSchema

    function · Re-export

    Builds the serializable schema for a form’s hydrated state.

  • RadioGroup.StateSchema

    variable · Re-export

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

  • Select.StateSchema

    variable · Re-export

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

Input codecs

  • Form.MaskPart

    type-alias · Re-export

    Literal or decoded segment of a mask.

  • Form.MaskSlot

    interface · Re-export

    Named decoded segment in a bidirectional text mask.

  • Form.MaskedInput

    function · Re-export

    Binds a native text input to a structured mask value.

  • Form.MaskedInputOptions

    interface · Re-export

    Options for an input decoded through a structured mask codec.

  • Form.mask

    function · Re-export

    Builds a bidirectional Schema codec from literal text and named slots.

  • Form.slot

    function · Re-export

    Creates a named, Schema-decoded mask slot.

Internal prop defaults

Item metadata

  • Collection.Item

    interface · Re-export

    Public Collection.Item behavioral model.

Item registration

  • Collection.ref

    function · Re-export

    Registers a mounted element and removes it automatically with the Scope in which the returned Effect is run.

  • Collection.register

    function · Re-export

    Upserts an item immediately and installs a finalizer in the Scope that runs this Effect; the finalizer removes only that exact registration.

  • Collection.unregister

    function · Re-export

    Removes every registered item with the supplied id and retains the remaining order.

Keyboard focus

  • Composite.activeDescendant

    function · Re-export

    Derives activeId only under virtual focus, otherwise undefined.

  • Composite.rootTabIndex

    function · Re-export

    Derives 0 when the root owns focus and -1 once a roving-focus item is active.

  • Composite.tabIndex

    function · Re-export

    Derives 0 only for the active item under roving focus; virtual-focus items always receive -1.

  • Focusable.Focusable

    function · Re-export

    Renders a keyboard-focusable host without inventing widget semantics.

  • Focusable.FocusableOptions

    interface · Re-export

    Options for a generic focusable host.

Keyboard navigation

  • Composite.KeyboardEventLike

    interface · Re-export

    Public Composite.KeyboardEventLike behavioral model.

  • Composite.keyMove

    function · Re-export

    Maps Home/End and orientation-aware Arrow keys to movement, reversing horizontal arrows for RTL.

  • Composite.moveByKey

    function · Re-export

    Prevents the native key default only when keyMove recognizes the key, then updates active state.

  • Separator.SeparatorOptions

    interface · Re-export

    Separator orientation, defaulting to horizontal.

Listbox surface

  • Listbox.Root

    function · Re-export

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

  • Listbox.RootOptions

    interface · Re-export

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

Menu surface

  • Menu.Content

    function · Re-export

    Renders manual-popover menu content and coordinates focus, typeahead, Escape, and nested-menu traversal.

  • Menu.ContentOptions

    interface · Re-export

    Inputs accepted by Menu.Content in addition to the shared DOM host options.

  • Menu.Menu

    variable · Re-export

    Consumer-facing alias of the canonical Menu component with identical behavior and lifetime.

Menubar surface

  • Menubar.Menubar

    variable · Re-export

    Consumer-facing alias of the canonical Menubar component with identical behavior and lifetime.

  • Menubar.Root

    function · Re-export

    Renders the persistent menubar root with roving focus, orientation-aware keys, and typeahead.

  • Menubar.RootOptions

    interface · Re-export

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

Native content host

Native controls

  • Button.Button

    function · Re-export

    Renders a semantic native button with cooperative host customization.

  • Checkbox.Checkbox

    variable · Re-export

    Canonical component alias for Input.

  • Checkbox.Input

    function · Re-export

    Renders a native checkbox input synchronized with hydrated state.

  • Form.Checkbox

    function · Re-export

    Binds a native checkbox to a boolean form field.

  • Form.ColorInput

    variable · Re-export

    Binds a native color input to a string field.

  • Form.DateInput

    variable · Re-export

    Binds a native date input to a Date field.

  • Form.DateTimeLocalInput

    variable · Re-export

    Binds a native local date-time input to a string field.

  • Form.EmailInput

    variable · Re-export

    Binds a native email input to a string field.

  • Form.HiddenInput

    variable · Re-export

    Binds a native hidden input to a string field.

  • Form.InputComponent

    type-alias · Re-export

    Public component contract shared by state-explicit native input factories.

  • Form.MonthInput

    variable · Re-export

    Binds a native month input to a string field.

  • Form.NumberInput

    variable · Re-export

    Binds a native number input to a finite number field.

  • Form.PasswordInput

    variable · Re-export

    Binds a native password input to a string field.

  • Form.RangeInput

    variable · Re-export

    Binds a native range input to a finite number field.

  • Form.SearchInput

    variable · Re-export

    Binds a native search input to a string field.

  • Form.Select

    function · Re-export

    Binds a native select element to a string form field.

  • Form.TelInput

    variable · Re-export

    Binds a native telephone input to a string field.

  • Form.TextInput

    variable · Re-export

    Binds a native input[type=text] to a string field.

  • Form.TimeInput

    variable · Re-export

    Binds a native time input to a string field.

  • Form.UrlInput

    variable · Re-export

    Binds a native URL input to a string field.

  • Form.WeekInput

    variable · Re-export

    Binds a native week input to a string field.

  • Link

    function

    Renders a native anchor with safe, eligible same-origin SPA navigation.

    Modified clicks, downloads, external URLs, non-HTTP(S) destinations, and non-self targets retain browser behavior. Unsafe executable schemes are rendered as about:blank and their clicks are canceled. A user click handler runs first through DOM host event chaining; preventDefault() prevents the internal navigation decision.

  • RadioGroup.Item

    function · Re-export

    Renders one native radio input and optionally registers it for group navigation.

  • RadioGroup.RadioGroup

    variable · Re-export

    Alias of Root.

  • RadioGroup.Root

    function · Re-export

    Renders a named radiogroup around native radio items.

  • Slider.Slider

    function · Re-export

    Renders a native range input whose input events update numeric state.

  • SpinButton.SpinButton

    function · Re-export

    Renders a native number input that writes valueAsNumber on change.

  • Switch.Switch

    function · Re-export

    Renders a button-backed ARIA switch.

Navigable cells

  • TreeGrid.Cell

    function · Re-export

    Renders and optionally registers one gridcell with row and column coordinates.

  • TreeGrid.CellOptions

    interface · Re-export

    Inputs accepted by TreeGrid.Cell in addition to the shared DOM host options.

Nested menus

  • Menu.ParentMenu

    interface · Re-export

    Public Menu.ParentMenu behavioral model.

  • Menu.SubmenuTrigger

    function · Re-export

    Renders a menuitem that targets nested popover content and coordinates parent/child directional focus.

  • Menu.SubmenuTriggerOptions

    interface · Re-export

    Inputs accepted by Menu.SubmenuTrigger in addition to the shared DOM host options.

Node focus

  • Tree.activate

    function · Re-export

    Sets the active tree item id without changing expansion.

Node registration

  • Tree.ItemValue

    interface · Re-export

    Tree collection value recording an item’s parent relationship.

  • Tree.makeCollection

    variable · Re-export

    Creates a scoped Collection for Tree items.

Numeric bounds

Open state

Opening a menu

  • Menu.Button

    variable · Re-export

    Consumer-facing alias of the canonical Menu component with identical behavior and lifetime.

  • Menu.Trigger

    function · Re-export

    Renders a native button targeting menu popover content and opens the menu on ArrowDown.

  • Menu.TriggerOptions

    interface · Re-export

    Inputs accepted by Menu.Trigger in addition to the shared DOM host options.

Opening controls

Option registration

Pane sizing state

Panel activation

  • Tab.select

    function · Re-export

    Selects a tab and makes it the active roving-focus item.

  • Tabs.select

    function · Re-export

    Selects a tab and makes it the active roving-focus item.

Panel activation policy

Panel visibility

  • Tab.Panel

    function · Re-export

    Renders a labelled tabpanel and hides it reactively when its tab is not selected.

  • Tab.PanelOptions

    interface · Re-export

    Inputs accepted by Tabs.Panel in addition to the shared DOM host options.

  • Tabs.Panel

    function · Re-export

    Renders a labelled tabpanel and hides it reactively when its tab is not selected.

  • Tabs.PanelOptions

    interface · Re-export

    Inputs accepted by Tabs.Panel in addition to the shared DOM host options.

Pointer and focus anchors

  • Hovercard.Anchor

    function · Re-export

    Renders an anchor coordinating pointer and optional host-focus behavior.

  • Hovercard.AnchorOptions

    interface · Re-export

    Options for a hovercard anchor host.

  • Tooltip.Anchor

    function · Re-export

    Renders a tooltip anchor with pointer and optional host-focus behavior.

  • Tooltip.AnchorOptions

    interface · Re-export

    Options for a tooltip anchor host.

Popup state

  • Menu.InitialState

    interface · Re-export

    Initial Menu values. The caller supplies id; open defaults false, activeId null, loop true, and orientation vertical.

  • Menu.State

    interface · Re-export

    Popup identity, visibility, and active command focus. Checked preferences and command results belong to the application, not this state.

  • Menu.StateSchema

    variable · Re-export

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

  • Menu.makeState

    function · Re-export

    Creates hydrated Menu state. The caller supplies id; open defaults false, activeId null, loop true, and orientation vertical.

  • Menu.setOpen

    function · Re-export

    Updates only the menu’s explicit open state.

Prop composition

  • Dom.MergedHostProps

    type-alias · Re-export

    Type-level result of merging user and component-owned host props.

  • Dom.RenderHostProps

    type-alias · Re-export

    Final props delivered to a default or custom host renderer.

  • Dom.mergeProps

    function · Re-export

    Merges user host props with component-required internal props.

Property type utilities

  • Dom.IfEquals

    type-alias · Re-export

    Produces Output only when two types are mutually assignable.

  • Dom.NonNullish

    type-alias · Re-export

    Removes nullish values from a type.

  • Dom.Nullish

    type-alias · Re-export

    JavaScript’s two absent-value types.

  • Dom.Property

    type-alias · Re-export

    Safely selects a property type, yielding undefined for non-objects or absent keys.

  • Dom.WritableKeys

    type-alias · Re-export

    Selects writable keys from a structural type.

Query and popup state

  • Combobox.InitialState

    interface · Re-export

    Initial Combobox values. value defaults to an empty string, open to false, activeId to null, loop to true, and virtual focus is enabled.

  • Combobox.State

    interface · Re-export

    Editable query text, popup visibility, and the active suggestion identity. value can contain unmatched text; active suggestion focus does not validate a domain choice.

  • Combobox.StateSchema

    variable · Re-export

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

  • Combobox.makeState

    function · Re-export

    Creates hydrated Combobox state. value defaults to an empty string, open to false, activeId to null, loop to true, and virtual focus is enabled.

  • Combobox.setValue

    function · Re-export

    Stores the input value, clears activeId, and opens the popup in one state update.

Ref composition

Rendered content

Resize axis

Resize separator

Rotation policy

Row expansion

  • TreeGrid.collapse

    variable · Re-export

    Removes a row id from expandedIds using the Tree state transition.

  • TreeGrid.expand

    variable · Re-export

    Adds a row id once to expandedIds using the Tree state transition.

  • TreeGrid.isExpanded

    variable · Re-export

    Tests membership in expandedIds without touching the DOM; this is the Tree helper exposed from the TreeGrid entrypoint.

Rows

  • Grid.Row

    function · Re-export

    Renders an ARIA row and forwards an optional one-based aria-rowindex.

  • Grid.RowOptions

    interface · Re-export

    Inputs accepted by Grid.Row in addition to the shared DOM host options.

Schema-bound components

Selectable options

  • Listbox.Option

    function · Re-export

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

  • Listbox.OptionOptions

    interface · Re-export

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

Selection and focus

  • Listbox.InitialState

    interface · Re-export

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

  • Listbox.State

    interface · Re-export

    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

    variable · Re-export

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

  • Listbox.makeState

    function · Re-export

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

  • Listbox.move

    function · Re-export

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

  • Listbox.select

    function · Re-export

    Sets both activeId and selected value in one update.

  • Tab.InitialState

    interface · Re-export

    Initial Tabs values. The caller supplies value; activeId defaults to value, activation is automatic, orientation horizontal, and loop true.

  • Tab.State

    interface · Re-export

    The visible panel selection, focused tab identity, and activation policy. Manual activation allows activeId to differ from selectedId until the user commits.

  • Tab.StateSchema

    variable · Re-export

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

  • Tab.makeState

    function · Re-export

    Creates hydrated Tabs state. The caller supplies value; activeId defaults to value, activation is automatic, orientation horizontal, and loop true.

  • Tabs.InitialState

    interface · Re-export

    Initial Tabs values. The caller supplies value; activeId defaults to value, activation is automatic, orientation horizontal, and loop true.

  • Tabs.State

    interface · Re-export

    The visible panel selection, focused tab identity, and activation policy. Manual activation allows activeId to differ from selectedId until the user commits.

  • Tabs.StateSchema

    variable · Re-export

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

  • Tabs.makeState

    function · Re-export

    Creates hydrated Tabs state. The caller supplies value; activeId defaults to value, activation is automatic, orientation horizontal, and loop true.

Semantic hosts

  • Role.Role

    function · Re-export

    Renders a generic element with caller-selected ARIA semantics.

  • Role.RoleOptions

    interface · Re-export

    Options for assigning explicit ARIA semantics to a generic host.

Slide and rotation state

  • Carousel.InitialState

    interface · Re-export

    Initial Carousel values. activeId is required and paused defaults to true.

  • Carousel.State

    interface · Re-export

    The visible slide identity and explicit paused flag. Changing paused does not start a timer; an application scheduler must honor the flag.

  • Carousel.StateSchema

    variable · Re-export

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

  • Carousel.makeState

    function · Re-export

    Creates hydrated Carousel state. activeId is required and paused defaults to true.

Slide content

  • Carousel.Slide

    function · Re-export

    Renders one labelled slide, registers it when a collection is supplied, and toggles hidden from activeId.

  • Carousel.SlideOptions

    interface · Re-export

    Inputs accepted by Carousel.Slide in addition to the shared DOM host options.

Slide controls

  • Carousel.ControlOptions

    interface · Re-export

    Inputs accepted by Carousel.Control in addition to the shared DOM host options.

  • Carousel.Next

    function · Re-export

    Renders a button whose native click selects the next registered slide with wrapping enabled.

  • Carousel.Previous

    function · Re-export

    Renders a button whose native click selects the previous registered slide with wrapping enabled.

Slide navigation

  • Carousel.move

    function · Re-export

    Selects the previous or next enabled registered slide; movement wraps and leaves state unchanged for an empty collection.

  • Carousel.select

    function · Re-export

    Sets activeId without changing paused state.

Slide registration

Spatial navigation

  • Grid.moveActiveId

    function · Re-export

    Maps grid keys to a cell id: horizontal movement stays in-row, vertical movement stays in-column, and Ctrl+Home/End reaches grid endpoints.

State connection

State construction

  • Checkbox.makeState

    function · Re-export

    Creates hydrated, renderer-independent checkbox state.

  • Form.makeState

    function · Re-export

    Creates a Scope-owned hydrated form RefSubject from a Struct codec.

  • Meter.makeState

    function · Re-export

    Creates hydrated meter state.

  • RadioGroup.makeCollection

    variable · Re-export

    Creates a scoped Collection for RadioGroup items.

  • RadioGroup.makeState

    function · Re-export

    Creates hydrated radio selection with a required value, null active ID, and looping enabled by default.

  • Select.makeCollection

    variable · Re-export

    Creates a scoped Collection for Select items.

  • Select.makeState

    function · Re-export

    Creates hydrated Select state. The caller supplies id; value and activeId default null, open false, and loop true.

  • Slider.makeState

    function · Re-export

    Creates hydrated slider state.

  • SpinButton.makeState

    function · Re-export

    Creates hydrated spin-button state.

  • Switch.makeState

    function · Re-export

    Creates hydrated switch state independent of rendering.

State models

  • Button.ButtonType

    type-alias · Re-export

    Native button submission behavior.

  • Checkbox.State

    interface · Re-export

    Current renderer-independent checkbox state.

  • Form.FieldMeta

    interface · Re-export

    Metadata updated after a successful field mutation.

  • Form.FormFields

    type-alias · Re-export

    Schema field map accepted by the schema-bound form factory.

  • Form.FormState

    type-alias · Re-export

    Hydrated RefSubject carrying form state plus runtime schema metadata.

  • Form.InitialState

    interface · Re-export

    Input used to construct a hydrated form state.

  • Form.State

    interface · Re-export

    Serializable renderer-independent state of a form.

  • RadioGroup.InitialState

    interface · Re-export

    Required selected value with optional initial active ID and wrap policy.

  • RadioGroup.State

    interface · Re-export

    Selected choice plus the active element used for keyboard movement.

  • Select.InitialState

    interface · Re-export

    Required popup ID with optional initial selection, visibility, focus, and wrap policy.

  • Select.State

    interface · Re-export

    Popup identity, committed value, visibility, and active option.

State transitions

  • Checkbox.setChecked

    function · Re-export

    Sets the checkbox state to a boolean or mixed value.

  • Checkbox.toggle

    function · Re-export

    Toggles checked state, treating the mixed state as unchecked.

  • Form.pushValue

    function · Re-export

    Appends one item to an array field and marks it dirty and touched.

  • Form.removeValue

    function · Re-export

    Removes one item by index from an array field and marks it dirty and touched.

  • Form.reset

    function · Re-export

    Restores default values and clears errors, metadata, and submitting.

  • Form.setValue

    function · Re-export

    Assigns one decoded field value and updates dirty/touched metadata.

  • Meter.setValue

    function · Re-export

    Assigns the displayed measurement without clamping it to the meter range.

  • RadioGroup.setValue

    function · Re-export

    Sets the selected value and optionally the active element ID.

  • Select.select

    function · Re-export

    Commits an option ID and value, then marks the popup closed.

  • Slider.setValue

    function · Re-export

    Assigns a range value without clamping or snapping it.

  • SpinButton.setValue

    function · Re-export

    Assigns a numeric value without bounds checks or draft filtering.

  • Switch.setChecked

    function · Re-export

    Sets the switch to the requested checked state.

  • Switch.toggle

    function · Re-export

    Toggles the switch between checked and unchecked.

Streaming server rendering

  • streamingSsrForHttp

    variable

    Registers streaming, GET-only HTML routes for a matcher.

    Path captures take precedence over same-named query parameters. HTML chunks are emitted as they are rendered via renderToHtml and HttpServerResponse.stream.

Structure and naming

  • Group.Group

    function · Re-export

    Renders a semantic group with an explicit accessible name.

  • Heading.Heading

    function · Re-export

    Renders a div with heading semantics and an explicit level.

  • Separator.Separator

    function · Re-export

    Renders a non-interactive semantic division.

  • VisuallyHidden.VisuallyHidden

    function · Re-export

    Clips text visually while retaining it for accessible naming and reading.

Suggestion popup

  • Combobox.Popover

    function · Re-export

    Renders manual-popover listbox content, mirrors native toggle events into open state, and scrolls the selected option when opened.

  • Combobox.PopoverOptions

    interface · Re-export

    Inputs accepted by Combobox.Popover in addition to the shared DOM host options.

Suggestion registration

Suggestions

  • Combobox.Item

    function · Re-export

    Renders and optionally registers one option; disabled options expose aria-disabled and do not select on click.

  • Combobox.ItemOptions

    interface · Re-export

    Inputs accepted by Combobox.Item in addition to the shared DOM host options.

Summary activation

Tab controls

  • Tab.Tab

    function · Re-export

    Renders and optionally registers a tab with stable aria-controls, selected state, and roving tabindex.

  • Tab.TabOptions

    interface · Re-export

    Inputs accepted by Tabs.Tab in addition to the shared DOM host options.

  • Tabs.Tab

    function · Re-export

    Renders and optionally registers a tab with stable aria-controls, selected state, and roving tabindex.

  • Tabs.TabOptions

    interface · Re-export

    Inputs accepted by Tabs.Tab in addition to the shared DOM host options.

Tab list

  • Tab.List

    function · Re-export

    Renders the tablist and applies orientation-aware movement plus Enter/Space activation in manual mode.

  • Tab.ListOptions

    interface · Re-export

    Inputs accepted by Tabs.List in addition to the shared DOM host options.

  • Tabs.List

    function · Re-export

    Renders the tablist and applies orientation-aware movement plus Enter/Space activation in manual mode.

  • Tabs.ListOptions

    interface · Re-export

    Inputs accepted by Tabs.List in addition to the shared DOM host options.

Tab navigation

  • Tab.Orientation

    type-alias · Re-export

    Supported composite movement axes.

  • Tab.move

    function · Re-export

    Moves activeId through registered tabs without selecting under manual activation.

  • Tabs.Orientation

    type-alias · Re-export

    Supported composite movement axes.

  • Tabs.move

    function · Re-export

    Moves activeId through registered tabs without selecting under manual activation.

Tab registration

Toolbar commands

  • Toolbar.Item

    function · Re-export

    Renders and optionally registers a toolbar button; focus activates it unless disabled.

  • Toolbar.ItemOptions

    interface · Re-export

    Inputs accepted by Toolbar.Item in addition to the shared DOM host options.

Toolbar surface

  • Toolbar.Root

    function · Re-export

    Renders the toolbar root and moves roving focus through registered items in DOM order.

  • Toolbar.RootOptions

    interface · Re-export

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

  • Toolbar.Toolbar

    variable · Re-export

    Consumer-facing alias of the canonical Toolbar component with identical behavior and lifetime.

Top-level commands

  • Menubar.Item

    function · Re-export

    Renders a registered menuitem and runs onActivate for native focus or click unless disabled.

  • Menubar.ItemOptions

    interface · Re-export

    Inputs accepted by Menubar.Item in addition to the shared DOM host options.

Tree nodes

  • Tree.Item

    function · Re-export

    Renders and optionally registers a treeitem with level, expanded, disabled, and roving-focus state.

  • Tree.ItemOptions

    interface · Re-export

    Inputs accepted by Tree.Item in addition to the shared DOM host options.

Tree surface

  • Tree.Root

    function · Re-export

    Renders the tree root and applies hierarchy-aware keyboard navigation to registered items.

  • Tree.RootOptions

    interface · Re-export

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

Treegrid surface

  • TreeGrid.Root

    function · Re-export

    Renders the focus-owning treegrid root and applies combined grid and expansion keys.

  • TreeGrid.RootOptions

    interface · Re-export

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

Typeahead

  • Composite.TypeaheadBuffer

    interface · Re-export

    Public Composite.TypeaheadBuffer behavioral model.

  • Composite.typeahead

    function · Re-export

    Returns the first enabled item id in DOM order whose textValue starts with the query.

  • Composite.typeaheadFrom

    function · Re-export

    Returns only the id selected by typeahead, or null when no item matches.

  • Composite.typeaheadKey

    function · Re-export

    Returns an unmodified one-character key exactly as provided; modified and multi-character keys return null.

  • Composite.updateTypeaheadBuffer

    function · Re-export

    Appends within the timeout window and starts a new query after the buffer expires.

Validation

  • Form.validate

    function · Re-export

    Checks retained decoded values against the form codec Type.

interface

  • Checkbox.InitialState

    interface · Re-export

    Public interface exposed as Checkbox.InitialState from @typed/ui/index.

  • Meter.InitialState

    interface · Re-export

    Public interface exposed as Meter.InitialState from @typed/ui/index.

  • Meter.State

    interface · Re-export

    Public interface exposed as Meter.State from @typed/ui/index.

  • Slider.InitialState

    interface · Re-export

    Public interface exposed as Slider.InitialState from @typed/ui/index.

  • Slider.State

    interface · Re-export

    Public interface exposed as Slider.State from @typed/ui/index.

  • SpinButton.InitialState

    interface · Re-export

    Public interface exposed as SpinButton.InitialState from @typed/ui/index.

  • SpinButton.State

    interface · Re-export

    Public interface exposed as SpinButton.State from @typed/ui/index.

  • Switch.InitialState

    interface · Re-export

    Public interface exposed as Switch.InitialState from @typed/ui/index.

  • Switch.State

    interface · Re-export

    Public interface exposed as Switch.State from @typed/ui/index.

namespace

  • Alert

    namespace · Re-export

    Public namespace exposed as Alert from @typed/ui/index.

  • Button

    namespace · Re-export

    Public namespace exposed as Button from @typed/ui/index.

  • Carousel

    namespace · Re-export

    Public namespace exposed as Carousel from @typed/ui/index.

  • Checkbox

    namespace · Re-export

    Public namespace exposed as Checkbox from @typed/ui/index.

  • Collection

    namespace · Re-export

    Public namespace exposed as Collection from @typed/ui/index.

  • Combobox

    namespace · Re-export

    Public namespace exposed as Combobox from @typed/ui/index.

  • Composite

    namespace · Re-export

    Public namespace exposed as Composite from @typed/ui/index.

  • Dialog

    namespace · Re-export

    Public namespace exposed as Dialog from @typed/ui/index.

  • Disclosure

    namespace · Re-export

    Public namespace exposed as Disclosure from @typed/ui/index.

  • Dom

    namespace · Re-export

    Public namespace exposed as Dom from @typed/ui/index.

  • Focusable

    namespace · Re-export

    Public namespace exposed as Focusable from @typed/ui/index.

  • Form

    namespace · Re-export

    Public namespace exposed as Form from @typed/ui/index.

  • Grid

    namespace · Re-export

    Public namespace exposed as Grid from @typed/ui/index.

  • Group

    namespace · Re-export

    Public namespace exposed as Group from @typed/ui/index.

  • Heading

    namespace · Re-export

    Public namespace exposed as Heading from @typed/ui/index.

  • Hovercard

    namespace · Re-export

    Public namespace exposed as Hovercard from @typed/ui/index.

  • Listbox

    namespace · Re-export

    Public namespace exposed as Listbox from @typed/ui/index.

  • Menu

    namespace · Re-export

    Public namespace exposed as Menu from @typed/ui/index.

  • Menubar

    namespace · Re-export

    Public namespace exposed as Menubar from @typed/ui/index.

  • Meter

    namespace · Re-export

    Public namespace exposed as Meter from @typed/ui/index.

  • Popover

    namespace · Re-export

    Public namespace exposed as Popover from @typed/ui/index.

  • RadioGroup

    namespace · Re-export

    Public namespace exposed as RadioGroup from @typed/ui/index.

  • Role

    namespace · Re-export

    Public namespace exposed as Role from @typed/ui/index.

  • Select

    namespace · Re-export

    Public namespace exposed as Select from @typed/ui/index.

  • Separator

    namespace · Re-export

    Public namespace exposed as Separator from @typed/ui/index.

  • Slider

    namespace · Re-export

    Public namespace exposed as Slider from @typed/ui/index.

  • SpinButton

    namespace · Re-export

    Public namespace exposed as SpinButton from @typed/ui/index.

  • Switch

    namespace · Re-export

    Public namespace exposed as Switch from @typed/ui/index.

  • Tab

    namespace · Re-export

    Public namespace exposed as Tab from @typed/ui/index.

  • Tabs

    namespace · Re-export

    Public namespace exposed as Tabs from @typed/ui/index.

  • Toolbar

    namespace · Re-export

    Public namespace exposed as Toolbar from @typed/ui/index.

  • Tooltip

    namespace · Re-export

    Public namespace exposed as Tooltip from @typed/ui/index.

  • Tree

    namespace · Re-export

    Public namespace exposed as Tree from @typed/ui/index.

  • TreeGrid

    namespace · Re-export

    Public namespace exposed as TreeGrid from @typed/ui/index.

  • VisuallyHidden

    namespace · Re-export

    Public namespace exposed as VisuallyHidden from @typed/ui/index.

  • WindowSplitter

    namespace · Re-export

    Public namespace exposed as WindowSplitter from @typed/ui/index.

type-alias

  • Checkbox.Checked

    type-alias · Re-export

    Public type-alias exposed as Checkbox.Checked from @typed/ui/index.

  • Form.ArrayFieldName

    type-alias · Re-export

    Public type-alias exposed as Form.ArrayFieldName from @typed/ui/index.

  • Form.ArrayFieldValue

    type-alias · Re-export

    Public type-alias exposed as Form.ArrayFieldValue from @typed/ui/index.

  • Form.BooleanFieldName

    type-alias · Re-export

    Public type-alias exposed as Form.BooleanFieldName from @typed/ui/index.

  • Form.MaskValue

    type-alias · Re-export

    Public type-alias exposed as Form.MaskValue from @typed/ui/index.

variable

  • Checkbox.StateSchema

    variable · Re-export

    Public variable exposed as Checkbox.StateSchema from @typed/ui/index.

  • Meter.StateSchema

    variable · Re-export

    Public variable exposed as Meter.StateSchema from @typed/ui/index.

  • Slider.StateSchema

    variable · Re-export

    Public variable exposed as Slider.StateSchema from @typed/ui/index.

  • SpinButton.StateSchema

    variable · Re-export

    Public variable exposed as SpinButton.StateSchema from @typed/ui/index.

  • Switch.StateSchema

    variable · Re-export

    Public variable exposed as Switch.StateSchema from @typed/ui/index.