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

    Interface Keybinding

    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 Keybinding {
        args?: any;
        command: string;
        context?: string;
        keybinding: string;
        when?: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    args? command context? keybinding when?

    Properties

    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

    keybinding: string

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

    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.

    Settings

    Member Visibility

    On This Page

    Properties