Theia API Documentation v1.77.0
    Preparing search index...

    Interface ResolvedKeybinding

    A Keybinding binds a specific key sequence (Keybinding#keybinding) to trigger a command (Keybinding#command). A Keybinding optionally may define a "when clause" (Keybinding#when) to specify in which context it becomes active.

    KeyBindingRegistry

    interface ResolvedKeybinding {
        args?: any;
        command: string;
        context?: string;
        displayFor?: string;
        inactive?: boolean;
        inactiveReason?: string;
        keybinding: string;
        resolved?: KeyCode[];
        when?: string;
    }

    Hierarchy (View Summary)

    Index
    args?: any

    eslint-disable-next-line @typescript-eslint/no-explicit-any

    command: string

    Unique command identifier of the command to be triggered by this keybinding.

    context?: string

    The optional keybinding context where this binding belongs to. If not specified, then this keybinding context belongs to the NOOP keybinding context.

    use when closure instead

    displayFor?: string

    Optional id of a command for which this keybinding is shown as the accelerator, e.g. in menus, although the keybinding doesn't execute that command itself. Use it for passthrough keybindings that let the browser handle a key natively on behalf of a command.

    inactive?: boolean
    inactiveReason?: string
    keybinding: string

    The key sequence for the keybinding as defined in packages/keymaps/README.md.

    resolved?: KeyCode[]

    The KeyboardLayoutService may transform the keybinding depending on the user's keyboard layout. This property holds the transformed keybinding that should be used in the UI. The value is undefined if the KeyboardLayoutService has not been called yet to resolve the keybinding.

    when?: string

    An optional clause defining the condition when the keybinding is active, e.g. based on the current focus. See https://code.visualstudio.com/docs/getstarted/keybindings#_when-clause-contexts for more details.