Global Shortcuts

Overview 

The global keyboard shortcuts are triggered even if the application does not have the keyboard focus. You can use them to implement global hotkeys for your application.

To register the CommandOrControl+Shift+D global keyboard shortcut, you can use the following approach:

import { globalShortcut } from '@mobrowser/api';

const success = globalShortcut.register('CommandOrControl+Shift+D', () => {
  console.log('CommandOrControl+Shift+D has been pressed')
})

The function returns true if the shortcut has been registered successfully.

The shortcut registration may fail if the same global shortcut is already registered by this method or the given shortcut cannot be registered due to the operating system restrictions.

You can also check if a global keyboard shortcut is already registered:

if (globalShortcut.isRegistered('CommandOrControl+Shift+D')) {
  console.log('CommandOrControl+Shift+D is already registered')
}

To unregister a global keyboard shortcut, use the following approach:

globalShortcut.unregister('CommandOrControl+Shift+D')

When the application is closed, all registered global shortcuts are automatically unregistered.

Shortcut format 

The shortcut is a string in the format 'CommandOrControl+Shift+F'.

Tokens are separated by + and are case-insensitive. The last token must be a key code. All preceding tokens must be modifiers.

Modifiers 

Named key codes 

Single-character key codes 

Any single ASCII character can be used as a key code directly, e.g. A–Z, 0–9, and punctuation such as ,, -, ., /, ;, =, [, \, ], `, and '. Characters that require Shift (e.g. !, @, #, $, %, ^, &, *, (, ), +, :, <, >, ?, ", {, |, }, ~, _) implicitly add the Shift modifier.