interface / @typed/ui/index

Composite.MoveOptions

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

Learn this UI primitive →

Package version
1.0.0-beta.7
Category
Directional movement
Since
1.0.0
Member of
Composite

Import

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

Access Composite.MoveOptions 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 interface MoveOptions<Value = unknown, CompositeState extends State = State, E = never, R = never, E2 = never, R2 = never, Element extends object = globalThis.Element> {
    readonly state: RefSubject.RefSubject<CompositeState, E, R>;
    readonly collection: RefSubject.RefSubject<Collection.State<Value, Element>, E2, R2>;
    readonly includeDisabled?: boolean;
}

Why

Keeping both RefSubjects and the disabled-item policy in one value preserves their independent error and service channels across movement, focus, and scrolling helpers.

Ownership and lifetime

This declaration is data or schema metadata and acquires no resources.

Example

Import with import type { MoveOptions } from "@typed/ui/Composite"; Extend the Composite.makeState runnable setup. Combine the only three inputs with const options: MoveOptions<string, State> = { state, collection, includeDisabled: false }.

Property: collection

Item registry used for collection-driven keyboard behavior and mounted ordering.

Property: includeDisabled

Whether movement may land on disabled collection items.

Property: state

Renderer-independent RefSubject state consumed by this component or operation.

Other public imports

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

Source