Class KeyboardShortcutAbstract

constructor

• new KeyboardShortcut(
      keys: Set<string>,
      modifiers?: Partial<KeyboardShortcutModifiers>,
      _shortcutEquivalences?: Partial<
          Record<"unknown" | "azerty" | "qwerty", Set<string>>,
      >,
      enabled?: boolean,
  ): KeyboardShortcut

  Constructs a new Keyboard Shortcut

  Parameters

  • keys: Set<string>

    Main keys supported by the shortcut
  • modifiers: Partial<KeyboardShortcutModifiers> = {}

    Shortcut key modifiers
  • _shortcutEquivalences: Partial<Record<"unknown" | "azerty" | "qwerty", Set<string>>> = {}
  • enabled: boolean = true

  Returns KeyboardShortcut

enabled

ReadonlyisToggable

Readonlykeys

Readonlymodifiers

Abstract Readonlyname

Abstracttranslation

• get translation(): 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(keyboardType: "unknown" | "azerty" | "qwerty"): string

  Get the shortcut in string format to display it

  Parameters

  • keyboardType: "unknown" | "azerty" | "qwerty"

  Returns string

matchEvent

• matchEvent(
      event: KeyboardEvent,
      holdingKeys: Set<string>,
      holdingCodes: Set<string>,
  ): boolean

  Returns whether the shortcut matches the given input keyboard event state

  Parameters

  • event: KeyboardEvent
  • holdingKeys: Set<string>
  • holdingCodes: Set<string>

  Returns boolean