ink-cartridge
    Preparing search index...

    Interface MappingKeyEntry<TComponet>

    A registered mapping key: an external key sequence (keys) that triggers a target composition chain (target) when fully typed.

    interface MappingKeyEntry<TComponet> {
        affectOverlay?: boolean;
        category?: "*" | TComponet[];
        exclusive?: boolean;
        executeWhenNoOverlay?: boolean;
        KeyReleaseWhenChainInterrupted?: boolean;
        keys: string[];
        mode?: string;
        target: string[];
        timeout?: number;
        when?: string | (() => boolean);
    }

    Type Parameters

    • TComponet

    Hierarchy

    • PrimitiveTypeKeys<TComponet>
      • MappingKeyEntry
    Index
    affectOverlay?: boolean

    Which pipeline phase this entry fires in: true = layer phase (before the layer broadcast), false = page phase (after the layer broadcast, before the screen stack).

    category?: "*" | TComponet[]

    Top-component whitelist: "*" or omitted = all screens; [] = no screens (effectively disabled); [A, B] = only when the stack top is exactly A or B.

    exclusive?: boolean

    When true, keys that break the pending mapping sequence are silently consumed and the sequence keeps waiting.

    executeWhenNoOverlay?: boolean

    When true, an overlay-phase entry (affectOverlay: true) fires even while no layer is open. With the default false, the entry is skipped when no layers exist. Only relevant when affectOverlay is true.

    KeyReleaseWhenChainInterrupted?: boolean

    When true, if the target composition chain is interrupted (any target key fails to resolve / execute), the final key that broke the sequence is swallowed silently instead of being released to lower pipeline stages. Mirrors CompositioKey.KeyReleaseWhenChainInterrupted.

    keys: string[]

    External key sequence the user must type (e.g. ["g", "i"]).

    mode?: string

    Restrict the entry to a specific mode. When the active mode does not match, the entry is skipped. Omitted = fires in all modes.

    target: string[]

    Internal composition keys to execute in order.

    timeout?: number

    Timeout for the next key in the sequence, in milliseconds.

    when?: string | (() => boolean)

    The mapping is enabled only while this callback returns true.