Protected ReadonlycommandProtected ReadonlycontextProtected ReadonlycontextsProtected ReadonlycontributionsProtected ReadonlycoreProtectedkeybindingsProtectedkeybindingProtected ReadonlykeyboardProtected ReadonlykeymapsProtectedkeyProtected ReadonlyloggerProtected ReadonlystatusProtected ReadonlytoProtected ReadonlywhenStatic ReadonlyPASSTHROUGH_Event that is fired when the resolved keybindings change due to a different keyboard layout or when a new keymap is being set
Get a user visible representation of a common.Keybinding.
the keybinding
the separator to be used to stringify KeyCodes that are part of the KeySequence
an array of strings representing all elements of the KeySequence defined by the common.Keybinding
if true, no special characters will be substituted into the string returned. Ensures correct keyboard shortcuts in Electron menus.
Return a user visible representation of a single key.
Get a user visible representation of a key code (a key with modifiers).
the keycode
the separator used to separate keys (key and modifiers) in the returning string
if true, no special characters will be substituted into the string returned. Ensures correct keyboard shortcuts in Electron menus.
a string representing the KeyCode
Get a user visible representation of a KeySequence.
the keysequence
the separator to be used to stringify KeyCodes that are part of the KeySequence
an array of strings representing all elements of the KeySequence
ProtectedasProtectedbuildBuilds a ternary search tree from all registered keybindings for efficient lookup. Bindings are indexed by their resolved key sequence. Bindings are stored in the order they should be checked: highest scope first, and within the same scope, in the order they appear in keymaps (later-registered first).
ProtectedclearClear all resolved properties of registered keybindings so the KeyboardLayoutService is called
again to resolve them. This is necessary when the user's keyboard layout has changed.
Checks whether a colliding common.Keybinding exists in a specific scope.
the keybinding to check
the keybinding scope to check
true if there is a colliding keybinding
Optionaltarget: EventTargetProtecteddoProtecteddoProtectedexecuteTries to execute a keybinding.
to execute
keyboard event.
Get all common.Keybindings for a KeybindingScope.
the keybinding scope to retrieve the common.Keybindings for.
an array of common.ScopedKeybinding
Get all keybindings associated to a commandId.
The ID of the command for which we are looking for keybindings.
an array of ScopedKeybinding
ProtectedgetGets or builds the keybinding tree for efficient lookup. The tree maps resolved key sequences to arrays of bindings sorted by scope (highest first).
ProtectedgetFinds collisions for a key sequence inside a list of bindings (error-free)
the reference bindings
the sequence to match
ProtectedgetReturn a new filtered array containing only the usable bindings among the input bindings
Bindings to filter
ProtectedinsertEnsures that keybindings are inserted in order of increasing length of binding to ensure that if a user triggers a short keybinding (e.g. ctrl+k), the UI won't wait for a longer one (e.g. ctrl+k enter)
ProtectedinvalidateInvalidates the keybinding tree, causing it to be rebuilt on next access.
ProtectedisProtectedisOnly execute if it has no context (global context) or if we're in that context.
Return true of string a pseudo-command id, in other words a command id that has a special meaning and that we won't find in the command registry.
commandId to test
ProtectedisReturns true if the binding is usable
Binding to be checked
Match first binding in the current context. Keybindings ordered by a scope and by a registration order within the scope.
Uses a ternary search tree for efficient O(log n) lookup instead of O(n) iteration. The tree is lazily built and invalidated when keybindings change.
When multiple bindings match, bindings that use context keys local to the focused element are given priority over bindings that only use global context keys.
Optionalevent: KeyboardEventProtectedregisterRegisters the keybinding context arguments into the application. Fails when an already registered context is being registered.
the keybinding contexts to register into the application.
Register a default keybinding to the registry.
Keybindings registered later have higher priority during evaluation.
the keybinding to be registered
Register multiple default keybindings to the registry
An array of keybinding to be registered
Reset keybindings for all scopes(only leaves the default keybindings mapped)
Reset keybindings for a specific scope
scope to reset the keybindings for
Ensure that the resolved property of the given binding is set by calling the KeyboardLayoutService.
Run the command matching to the given keyboard event.
ProtectedselectSelects the most appropriate binding from a list of enabled bindings.
Prioritizes bindings whose when clause uses context keys that are locally
defined at the focused element, as these are more specific to the user's
current focus context.
Array of enabled bindings to choose from (must not be empty)
Optionalevent: KeyboardEventOptional keyboard event to get the focused element from
The selected binding
Sets a new keymap replacing all existing common.Keybindings in the given scope.
the keybinding scope
an array containing the new common.Keybindings
Unregister all keybindings from the registry that are bound to the key of the given keybinding
a keybinding specifying the key to be unregistered
Unregister all keybindings with the given key from the registry
a key to be unregistered
Unregister all existing keybindings for the given command
the command to unregister all keybindings for
Ternary search tree for efficient keybinding lookup. Maps resolved key sequences to arrays of bindings sorted by scope (highest first).