App Options
Customizing your app
Javascript API
Recipes
⌨
Global Shortcuts
We allow you to register global keyboard shortcuts that work when your app doesn't have keyboard focus.
Accelerators
todesktop.shortcut.isRegistered(accelerator)
Promise<Boolean> - Whether your application has registered the accelerator (shortcut).
Note if another application has taken the accelerator this will still return
false1
await todesktop.shortcut.isRegistered("Command+G")
Copied!
todesktop.shortcut.register(accelerator, callback)
Promise<Boolean> - Whether the shortcut was registered successfully.
Registers the global shortcut of
accelerator. The callback is called when the user presses the shortcut. Note when the accelerator is already taken by other applications, this call will silently fail.
1
todesktop.shortcut.register("Command+G", () => {
2
console.log("The shortcut was pressed");
3
});
Copied!
todesktop.shortcut.unregister(accelerator)
Promise<Boolean> - Whether the shortcut was successfully unregistered
Unregisters the global shortcut of
accelerator.1
todesktop.shortcut.unregister("Command+G");
Copied!
todesktop.shortcut.unregisterAll()
Promise<Boolean> - Whether all shortcuts were successfully removed
1
todesktop.shortcut.unregisterAll();
Copied!
Last modified 3mo ago