weasel API - v0.8.0
    Preparing search index...

    Interface ToolKeybinding

    Configurable activation-key descriptor for tools that expose their keybinding to the host (currently Lasso and Eyedropper). Captures only the fields meaningful to a caller-supplied tool-select key — dispatcher-internal fields (skipInEditable, enabled, preventDefault) live on KeyBinding in keyHelpers.ts and are not part of the configurable surface.

    interface ToolKeybinding {
        alt?: boolean;
        key: string | readonly string[];
        mod?: boolean;
        shift?: boolean | "optional";
    }
    Index

    Properties

    alt? key mod? shift?

    Properties

    alt?: boolean

    Require Alt. Default false.

    key: string | readonly string[]

    Key or list of keys to match (case-insensitive against event.key).

    mod?: boolean

    Require Cmd (mac) / Ctrl (others). Default false.

    shift?: boolean | "optional"

    Shift policy. undefined/false forbids shift, true requires shift, 'optional' allows either.

    Settings

    Member Visibility

    On This Page

    Properties