Luxar Viewer API Documentation - v2026.9.22
    Preparing search index...

    Interface KeyBinding

    Key binding configuration

    interface KeyBinding {
        actionId: string;
        actionParameter?: string | number;
        key: string;
        modifiers?: {
            ctrl?: boolean;
            shift?: boolean;
            alt?: boolean;
            meta?: boolean;
        };
        handler: (event: KeyboardEvent) => boolean | void | Promise<void>;
        keyupHandler?: (event: KeyboardEvent) => boolean | void | Promise<void>;
        preventDefault?: boolean;
        description: string;
        help: false | ShortcutHelpMetadata;
    }
    Index
    actionId actionParameter? key modifiers? handler keyupHandler? preventDefault? description help
    actionId: string

    Stable action identity, independent of the registered chord.

    actionParameter?: string | number

    Optional discriminator for parameterized actions sharing one identity.

    key: string
    modifiers?: { ctrl?: boolean; shift?: boolean; alt?: boolean; meta?: boolean }
    handler: (event: KeyboardEvent) => boolean | void | Promise<void>

    Return false synchronously to leave the event available to lower-priority contexts.

    keyupHandler?: (event: KeyboardEvent) => boolean | void | Promise<void>

    Modifier-aware bindings match keyup only while those modifiers remain held. Async handlers are always handled; only a synchronous false can decline.

    preventDefault?: boolean
    description: string
    help: false | ShortcutHelpMetadata

    Shortcut-overlay metadata, or an explicit opt-out.

    Settings
    Member Visibility

    On This Page
    Properties