Search documentation

Search by topic, API name, or import path.

GitHub ↗

function / @typed/ui/index

Composite.moveActiveItem

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

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.moveActiveItem 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 moveActiveItem<Item extends Collection.Item<unknown, object>>(items: readonly Item[], state: ActiveIdState, direction: Move, includeDisabled?: boolean): Item | undefined;

Why

Separating this deterministic policy from event wiring lets applications test it directly and reuse it in custom composites.

Ownership and lifetime

This is a synchronous calculation. It acquires no resources and does not mutate the input array, state, event, or DOM.

Examples

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

const item = Composite.moveActiveItem([{ id: "a" }, { id: "b" }], { activeId: "a", loop: true }, "next");

Other public imports

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

Source