@cartridge-engine/keyboard-engine
    Preparing search index...

    Interface PageSequenceBinding

    A sequence binding registered on a page (screen) layer.

    Extends BaseSequenceBinding with page-only options.

    interface PageSequenceBinding {
        handler: KeyHandler;
        keys: string[];
        options?: PageSequenceOptions;
        timeout?: number;
        when?: string | (() => boolean);
    }

    Hierarchy (View Summary)

    Index
    handler keys options? timeout? when?
    handler: KeyHandler

    Callback to invoke when the full sequence is matched.

    keys: string[]

    Ordered key names making up the full sequence. Must have length ≥ 2 (the first key is the lookup key in the map).

    options?: PageSequenceOptions

    Binding options (exclusive mode, focusId, onlyThis, etc.).

    timeout?: number

    Per-binding timeout override (ms). Falls back to the global DEFAULT_SEQUENCE_TIMEOUT (500 ms) when omitted.

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

    Optional condition callback (extracted from options.when at registration). When provided, the sequence only starts and continues when this returns true.

    Settings
    Member Visibility

    On This Page
    Properties