function / @typed/ui/Composite

typeaheadKey

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

Learn this UI primitive →

Package version
1.0.0-beta.7
Category
Typeahead
Since
1.0.0

Import

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

Signatures

export declare function typeaheadKey(event: KeyboardEventLike): string | null;

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 key = Composite.typeaheadKey({ key: "A" });

Other public imports

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

Source