globalShortcut

    Process: Main

    The globalShortcut module can register/unregister a global keyboard shortcut with the operating system so that you can customize the operations for various shortcuts.

    Note: The shortcut is global; it will work even if the app does not have the keyboard focus. This module cannot be used before the ready event of the app module is emitted.

    The globalShortcut module has the following methods:

    • callback Function

    Registers a global shortcut of accelerator. The callback is called when the registered shortcut is pressed by the user.

    When the accelerator is already taken by other applications, this call will silently fail. This behavior is intended by operating systems, since they don’t want applications to fight for global shortcuts.

    The following accelerators will not be registered successfully on macOS 10.14 Mojave unless the app has been authorized as a :

    • “Media Play/Pause”
    • “Media Next Track”
    • “Media Previous Track”
    • “Media Stop”
    • accelerators string[] - an array of s.

    Registers a global shortcut of all accelerator items in . The callback is called when any of the registered shortcuts are pressed by the user.

    The following accelerators will not be registered successfully on macOS 10.14 Mojave unless the app has been authorized as a trusted accessibility client:

    • “Media Play/Pause”
    • “Media Next Track”
    • “Media Previous Track”
    • “Media Stop”

    Returns boolean - Whether this application has registered accelerator.

    When the accelerator is already taken by other applications, this call will still return false. This behavior is intended by operating systems, since they don’t want applications to fight for global shortcuts.

    Unregisters the global shortcut of .