Hotkeys
5.1.0The Hotkeys API allows applications to register key combinations and receive notifications when a key combination is pressed by the user irrespective of whether the application is on focus or not. Hotkeys is useful for web applications that do not have access to system resources and cannot register global shortcuts.
See also the Hotkeys documentation for more details.
object
Description
Information about the hotkey.
Properties
hotkey:
The key or key combination that will be used as a hotkey.
description?:
Description of the hotkey.
object
Description
Hotkeys API.
(hotkey: string | HotkeyInfo, callback: HotkeyCallback) => Promise<void>
Description
Registers a hotkey. Note that the same hotkey can be registered just once.
Parameters
hotkey
string | HotkeyInfo
yes
The key or key combination (as a string or as a HotkeyInfo object) that will be registered.
callback
yes
Callback function that will be invoked when the hotkey is activated.
Returns
Promise<void>
(hotkey: string) => Promise<void>
Description
Unregisters a hotkey. Notifications will no longer be received about this hotkey.
Parameters
hotkey
string
yes
The hotkey to unregister.
Returns
Promise<void>
() => Promise<void>
Description
Unregister all hotkeys registered by the current application.
Returns
Promise<void>
(hotkey: string) => void
Description
Returns true if the current application has registered a hotkey.
Parameters
hotkey
string
yes
The hotkey you want to check for.
Returns
void
function
() => void
Description
Callback function that is invoked when the hotkey is activated.
Returns
void