electron/docs/api/accelerator.md
Jeffrey Morgan 4de4ef1ccc Remove change to "mapped onto" in accelerator.md
Remove the change to “mapped onto” in `accelerator.md` after feedback
from @OlsonDev.
2015-07-24 07:19:43 +01:00

1.1 KiB

Accelerator

An accelerator is a string that represents a keyboard shortcut. It can contain multiple modifiers and key codes, combined by the + character.

Examples:

  • Command+A
  • Ctrl+Shift+Z

Platform notice

On Linux and Windows, the Command key does not have any effect so use CommandOrControl which represents Command on OS X and Control on Linux and Windows to define some accelerators.

The Super key is mapped to the Windows key on Windows and Linux and Cmd on OS X.

Available modifiers

  • Command (or Cmd for short)
  • Control (or Ctrl for short)
  • CommandOrControl (or CmdOrCtrl for short)
  • Alt
  • Shift
  • Super

Available key codes

  • 0 to 9
  • A to Z
  • F1 to F24
  • Punctuations like ~, !, @, #, $, etc.
  • Plus
  • Space
  • Backspace
  • Delete
  • Insert
  • Return (or Enter as alias)
  • Up, Down, Left and Right
  • Home and End
  • PageUp and PageDown
  • Escape (or Esc for short)
  • VolumeUp, VolumeDown and VolumeMute
  • MediaNextTrack, MediaPreviousTrack, MediaStop and MediaPlayPause