mirrors/electron
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
electron/docs/api/accelerator.md
Cheng Zhao a9ea8b92f0 Merge pull request #4988 from atom/accelerator-docs 
use example accelerators that align with best practices
2016-04-03 14:03:32 +09:00

1.3 KiB
Raw Blame History

Accelerator

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

Examples:

  • CommandOrControl+A
  • CommandOrControl+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.

Use Alt instead of Option. The Option key only exists on OS X, whereas the Alt key is available on all platforms.

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
  • Option
  • AltGr
  • 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
  • PrintScreen