ink-cartridge
    Preparing search index...

    Interface StopOptions

    Options for KeyboardEngine.stop when stopping keys within a specific focus target.

    interface StopOptions {
        elementId?: string;
        focusId?: string | FocusRef;
        stopAction?: boolean;
        when?: string | (() => boolean);
    }
    Index
    elementId? focusId? stopAction? when?
    elementId?: string

    ID of the element whose keyboard data the stop rule applies to.

    focusId?: string | FocusRef

    If provided, stops only within the named focus target.

    stopAction?: boolean

    When true, treats each entry in keys as a shortcut action ID and resolves it to the actual key names currently bound to that action (via the layer's or focus target's actionKeysMap).

    This keeps stopping logic decoupled from literal key names: if you later rebind the action to different keys, the stop still works.

    If an action ID has no bound keys (never registered or already unbound).

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

    Optional condition — function or registered condition id. When provided, the key is only stopped (propagation barrier) when this evaluates to true. When false, the stop rule is ignored and the key propagates normally.

    Settings
    Member Visibility

    On This Page
    Properties