function / @typed/ui/index

Composite.moveByKey

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

Learn this UI primitive →

Package version
1.0.0-beta.7
Category
Keyboard navigation
Since
1.0.0
Member of
Composite

Import

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

Access Composite.moveByKey through the imported Composite 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 function moveByKey<Value, CompositeState extends State, E, R, E2, R2, Element extends object>(event: KeyboardEventLike, options: MoveOptions<Value, CompositeState, E, R, E2, R2, Element>): Effect.Effect<boolean, E | E2, R | R2>;

Why

The operation exposes Composite’s transition directly so callers can compose it in Effect programs and native event handlers.

Ownership and lifetime

The returned Effect performs the update or DOM side effect only when run, preserves the declared error and service channels, and retains no resources after completion.

Example

Import with import { moveByKey } from "@typed/ui/Composite"; Extend the Composite.makeState runnable setup. Inside the linked Effect program run yield* moveByKey({ key: "ArrowDown" }, { state, collection }), then read state to observe the active id selected by the current orientation and RTL policy.

Other public imports

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

Source