Composite

Import

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

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 Composite from "./Composite.js";

Members

• Composite.ActiveIdState

  Public Composite.ActiveIdState behavioral model.

• Composite.InitialState

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

• Composite.KeyboardEventLike

  Public Composite.KeyboardEventLike behavioral model.

• Composite.Move

  Logical movement operations independent of physical key names.

• Composite.MoveOptions

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

• Composite.Orientation

  Supported composite movement axes.

• Composite.State

  Complete renderer-independent state for Composite.

• Composite.StateSchema

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

• Composite.TypeaheadBuffer

  Public Composite.TypeaheadBuffer behavioral model.

• Composite.activeDescendant

  Derives activeId only under virtual focus, otherwise undefined.

• Composite.focusActive

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

• Composite.focusElement

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

• Composite.keyMove

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

• Composite.makeState

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

• Composite.move

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

• Composite.moveActiveId

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

• Composite.moveActiveItem

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

• Composite.moveAndFocus

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

• Composite.moveByKey

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

• Composite.orderedEnabledItems

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

• Composite.rootTabIndex

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

• Composite.scrollActive

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

• Composite.tabIndex

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

• Composite.typeahead

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

• Composite.typeaheadFrom

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

• Composite.typeaheadKey

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

• Composite.updateTypeaheadBuffer

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

Other public imports

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

• Composite from @typed/ui

Source

• packages/ui/src/Composite.ts:15