Class KeyBinding

Represents a key combination that can trigger a keyboard shortcut.

Implements

KeyCombination

Index

Constructors

Properties

altKey controlOrMeta ctrlKey key metaKey shiftKey

Methods

matchesEvent toString fromString

Constructors

constructor

new KeyBinding(trigger): KeyBinding
Parameters
- trigger: KeyCombination
Returns KeyBinding
- Defined in shortcuts/KeyBinding.ts:64

Properties

`Readonly` altKey

altKey: boolean

Inherit Doc

`Readonly` controlOrMeta

controlOrMeta: boolean

Inherit Doc

`Readonly` ctrlKey

ctrlKey: boolean

Inherit Doc

`Readonly` key

key: string

Inherit Doc

`Readonly` metaKey

metaKey: boolean

Inherit Doc

`Readonly` shiftKey

shiftKey: undefined | boolean

If undefined, the state of the shift key is ignored.

Methods

matchesEvent

matchesEvent(keyEvent): boolean
Returns true if and only if keyEvent should trigger this shortcut.
Parameters
- keyEvent: Partial<KeyCombination>
Returns boolean
- Defined in shortcuts/KeyBinding.ts:74

toString

toString(): string
Returns a string representation of this shortcut in the same format accepted by fromString.

Returns string
- Defined in shortcuts/KeyBinding.ts:127

`Static` fromString

fromString(shortcutStr): KeyBinding
Accepts a string in the form modifier1+modifier2+...+key (e.g. Ctrl+Shift+a) and returns the corresponding KeyboardShortcut.
Parameters
- shortcutStr: string
Returns KeyBinding
- Defined in shortcuts/KeyBinding.ts:154

Generated using TypeDoc

OpenSource licenses