matchesHeldModifiers

function matchesHeldModifiers(
   hotkey, 
   heldKeys, 
   options): boolean;

Defined in: hint.ts:23

Returns whether held modifiers should reveal a shortcut hint. By default, any nonempty subset of the binding's modifiers qualifies; an unrelated modifier hides the hint. exact requires every binding modifier. Nonmodifier keys are ignored. This does not check registration or focus.

Parameters#

hotkey#

RegisterableHotkey

heldKeys#

readonly string[]

options#

HeldModifierOptions = {}

Returns#

boolean

Example#

matchesHeldModifiers('Alt+Shift+[KeyK]', ['Alt']) // true
matchesHeldModifiers('Alt+Shift+[KeyK]', ['Alt', 'Control']) // false