Class HSHotkeyModal

constructor

• new HSHotkeyModal(): HSHotkeyModal

  Returns HSHotkeyModal

isActive

onEnter

onExit

bind

• bind(
      mods: string[],
      key: string,
      onPressed: Function | null,
      onReleased?: Function | null,
      onRepeat?: Function | null,
  ): HSHotkeyModal

  Bind a hotkey to this modal. The hotkey is only enabled while the modal is active.

  Parameters

  • mods: string[]

    Modifier keys for the hotkey (e.g. ["cmd", "shift"])

  • key: string

    Key name for the hotkey (e.g. "h")

  • onPressed: Function | null

    Called when the hotkey is pressed, or null

  • OptionalonReleased: Function | null

    Called when the hotkey is released, or null/omitted

  • OptionalonRepeat: Function | null

    Called repeatedly while the hotkey is held down, or null/omitted

  Returns HSHotkeyModal

  This modal, for chaining

destroy

• destroy(): void

  Destroy the modal, along with its trigger and all hotkeys bound to it.

  Returns void

enter

• enter(): HSHotkeyModal

  Enter the modal: its trigger (if any) is disabled and its bound hotkeys are enabled.

  Returns HSHotkeyModal

  This modal, for chaining

exit

• exit(): HSHotkeyModal

  Exit the modal: its bound hotkeys are disabled and its trigger (if any) is re-enabled.

  Returns HSHotkeyModal

  This modal, for chaining