Class ShortcutManager

constructor

• new ShortcutManager(): ShortcutManager

  Returns ShortcutManager

generalShortcuts

shortcutsEnabled

pressedKeys

• get pressedKeys(): {
      alt: boolean;
      cmd: boolean;
      ctrl: boolean;
      other: number;
      shift: boolean;
  }

  Returns { alt: boolean; cmd: boolean; ctrl: boolean; other: number; shift: boolean }

shortcuts

• get shortcuts(): ShortcutGroup[]

  Returns ShortcutGroup[]

checkKeyEvent

• checkKeyEvent(
      event: KeyboardEvent,
      timestamp: number,
      checkPressKey?: boolean,
  ): undefined | ShortcutEvent

  Parameters

  • event: KeyboardEvent
  • timestamp: number
  • checkPressKey: boolean = true

  Returns undefined | ShortcutEvent

clearShortcuts

• clearShortcuts(): void

  Returns void

disableShortcutGroup

• disableShortcutGroup(name: string): void

  Parameters

  • name: string

  Returns void

enableShortcutGroup

• enableShortcutGroup(name: string): void

  Parameters

  • name: string

  Returns void

getCommandByEvent

• getCommandByEvent(
      event: KeyboardEvent,
  ): undefined | { groupName: string; shortcut: Shortcut }

  Parameters

  • event: KeyboardEvent

  Returns undefined | { groupName: string; shortcut: Shortcut }

getShorcutCombination

• getShorcutCombination(event: KeyboardEvent): string

  Parameters

  • event: KeyboardEvent

  Returns string

getShortcutGroup

• getShortcutGroup(name: string): undefined | ShortcutGroup

  Parameters

  • name: string

  Returns undefined | ShortcutGroup

registerShortcutGroup

• registerShortcutGroup(shortcutGroup: ShortcutGroup): void

  Parameters

  • shortcutGroup: ShortcutGroup

  Returns void

resetPressedKeys

• resetPressedKeys(): void

  Returns void

unregisterItemFromGroup

• unregisterItemFromGroup(groupName: string, itemName: string): void

  Parameters

  • groupName: string
  • itemName: string

  Returns void

unregisterShortcutGroup

• unregisterShortcutGroup(groupName: string): void

  Parameters

  • groupName: string

  Returns void