• Public
  • Public/Protected
  • All

Interface ResolvedKeybinding




args?: any

Optional arguments that will be passed to the command when it gets triggered via this keybinding. Needs to be specified when the triggered command expects arguments to be passed to the command handler.

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.

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.