Module renderer/core/keybinding

Index

Variables

Alt

Alt: "Alt" = 'Alt'

BracketLeft

BracketLeft: "BracketLeft" = 'BracketLeft'

BracketRight

BracketRight: "BracketRight" = 'BracketRight'

Cmd

Cmd: "Cmd" = 'Cmd'

Ctrl

Ctrl: "Ctrl" = 'Ctrl'

CtrlCmd

CtrlCmd: "CtrlCmd" = 'CtrlCmd'

Escape

Escape: "Escape" = 'Escape'

LeftClick

LeftClick: 0 = 0

Meta

Meta: "Meta" = 'Meta'

Shift

Shift: "Shift" = 'Shift'

Space

Space: "Space" = 'Space'

Tab

Tab: "Tab" = 'Tab'

Win

Win: "Win" = 'Win'

Functions

disableShortcuts

disableShortcuts(): void

- Defined in src/renderer/core/keybinding.ts:43
Disable shortcuts

Returns void

enableShortcuts

enableShortcuts(): void

- Defined in src/renderer/core/keybinding.ts:50
Enable shortcuts

Returns void

getKeyLabel

getKeyLabel(key: string | number): string

- Defined in src/renderer/core/keybinding.ts:76
Get key label.

Parameters
- key: string | number
Returns string

getKeysLabel

getKeysLabel(id: keyof BuildInActions): string
getKeysLabel(id: string): string
getKeysLabel(keys: (string | number)[]): string

- Defined in src/renderer/core/keybinding.ts:182
Get shortcuts label.

Parameters
- id: keyof BuildInActions
Returns string
- Defined in src/renderer/core/keybinding.ts:183
Parameters
- id: string
Returns string
- Defined in src/renderer/core/keybinding.ts:184
Parameters
- keys: (string | number)[]
Returns string

hasCtrlCmd

hasCtrlCmd(e: KeyboardEvent | MouseEvent): boolean

- Defined in src/renderer/core/keybinding.ts:67
Determine whether the user has pressed the Cmd key (macOS) or Ctrl key.

Parameters
- e: KeyboardEvent | MouseEvent
Returns boolean

isKeydown

isKeydown(key: string): boolean

- Defined in src/renderer/core/keybinding.ts:58
Determine whether the user has pressed the key

Parameters
- key: string
  
  upper case.
Returns boolean

keydownHandler

keydownHandler(e: KeyboardEvent): void

- Defined in src/renderer/core/keybinding.ts:202
Parameters
- e: KeyboardEvent
Returns void

keyupHandler

keyupHandler(e: KeyboardEvent): void

- Defined in src/renderer/core/keybinding.ts:227
Parameters
- e: KeyboardEvent
Returns void

matchKeys

matchKeys(e: KeyboardEvent | MouseEvent, keys: (string | number)[]): boolean

- Defined in src/renderer/core/keybinding.ts:109
Determine whether the event matches the shortcut key combination.

Parameters
- e: KeyboardEvent | MouseEvent
- keys: (string | number)[]
Returns boolean

Generated using TypeDoc