diff --git a/docs/api/accelerator.md b/docs/api/accelerator.md index 1f760b46361..f90e409043f 100644 --- a/docs/api/accelerator.md +++ b/docs/api/accelerator.md @@ -2,14 +2,30 @@ > Define keyboard shortcuts. -Accelerators can contain multiple modifiers and key codes, combined by -the `+` character. +Accelerators are Strings that can contain multiple modifiers and key codes, +combined by the `+` character, and are used to define keyboard shortcuts +throughout your application. Examples: * `CommandOrControl+A` * `CommandOrControl+Shift+Z` +Shortcuts are registered with the [`globalShortcut`](global-shortcut.md) module +using the [`register`](global-shortcut.md#globalshortcutregisteraccelerator-callback) +method, i.e. + +```javascript +const {app, globalShortcut} = require('electron') + +app.on('ready', () => { + // Register a 'CommandOrControl+Y' shortcut listener. + globalShortcut.register('CommandOrControl+Y', () => { + // Do stuff when Y and either Command/Control is pressed. + }) +}) +``` + ## Platform notice On Linux and Windows, the `Command` key does not have any effect so