Class KeyboardShortcutAbstract

constructor

• new KeyboardShortcut(binding: KeyboardShortcutKeyBinding): KeyboardShortcut

  Constructs a new Keyboard Shortcut

  Parameters

  • binding: KeyboardShortcutKeyBinding

    The key and modifiers that trigger the shortcut

  Returns KeyboardShortcut

Abstract Readonlyaction

enabled

ReadonlyisToggable

Abstractlabel

• get label(): string

  Get translation

  Returns string

Abstractexecute

• execute(viewer: Viewer, isHolding: boolean): Promise<void>

  Executes the keyboard shortcuts

  Parameters

  • viewer: Viewer

    The viewer to interact with

  • isHolding: boolean

    Whether the user is holding the keyboard keys combination

    Note: isHolding true means this is at least the second time the function is called for one event loop (down => up)

  Returns Promise<void>

getKeyboardShortcutString

• getKeyboardShortcutString(): string

  Get the shortcut in string format to display it

  Returns string

matchEvent

• matchEvent(event: KeyboardEvent): boolean

  Returns whether the shortcut matches the given input keyboard event state

  Parameters

  • event: KeyboardEvent

  Returns boolean

resetDefaultBinding

• resetDefaultBinding(): void

  Returns void

setBinding

• setBinding(binding: KeyboardShortcutKeyBinding): void

  Parameters

  • binding: KeyboardShortcutKeyBinding

  Returns void