键盘快捷键

加速器​

加速器是可以在你的Electron中用来表示键盘快捷键的字符串。 这些字符串可以包含由 + 连接的多个修饰键和一个单一的键码。

[!NOTE] 加速器是 大小写不敏感 的。

可用的功能键​

• Command (缩写为Cmd)
• Control (缩写为Ctrl)
• CommandOrControl (缩写为 CmdOrCtrl)
• Alt
• Option
• AltGr
• Shift
• Super (别名为 Meta)

可用的普通按键​

• 0 到 9
• A 到 Z
• F1 到 F24
• 各种标点符号包括:), !, @, #, $, %, ^, &, *, (, :, ;, :, +, =, <, ,, _, -, >, ., ?, /, ~, `, {, ], [, |, \, }, "
• Plus
• Space
• Tab
• 大写锁定(Capslock)
• 数字锁定(Numlock)
• 滚动锁定
• Backspace
• 删除
• Insert
• Return (等同于 Enter)
• Up, Down, Left and Right
• Home 和 End
• PageUp 和 PageDown
• Escape (缩写为 Esc)
• VolumeUp, VolumeDown 和 VolumeMute
• MediaNextTrack、MediaPreviousTrack、MediaStop 和 MediaPlayPause
• PrintScreen
• 小键盘按键
  • num1-num9 -数字1-数字9
  • numdec - 小数点
  • numadd - 加号
  • numsub - 减号
  • nummult - 乘号
  • numdiv - 除号

跨平台功能键​

在不同的操作系统中,许多功能键加速器会映射到不同键。

示例​

以下是一些跨平台的 Electron 加速器通用编辑操作的例子:

• 复制: CommandOrControl+C
• 粘贴: CommandOrControl+V
• 撤销:CommandOrControl+Z
• 重做:CommandOrControl+Shift+Z

本地快捷键​

本地快捷键仅当应用获得焦点时才会触发。 这些快捷键映射到应用的主应用菜单中特定的菜单项。

如果要定义一个本地的键盘快捷键,你需要在创建一个 MenuItem 时配置 accelerator 属性。 然后,与该菜单项相关的 click 事件将在使用该加速器时触发。

const{ dialog,Menu,MenuItem}=require('electron/main')

const menu =newMenu()

// 在 macOS 中,第一个子菜单必须是应用菜单
if(process.platform==='darwin'){
const appMenu =newMenuItem({role:'appMenu'})
 menu.append(appMenu)
}

const submenu =Menu.buildFromTemplate([{
label:'Open a Dialog',
click:()=> dialog.showMessageBox({message:'Hello World!'}),
accelerator:'CommandOrControl+Alt+R'
}])
menu.append(newMenuItem({label:'Custom Menu', submenu }))

Menu.setApplicationMenu(menu)

在上述例子中,当在 macOS 上按下 ⌘ Cmd+⌥ Opt+R 或在其它平台按下 Ctrl+Alt+R 时,将打开一个原生的"Hello World"对话框。

[!TIP] 即使菜单项被隐藏,加速器也可以工作。 在 macOS 上,这个特性可以通过在构建 MenuItem 时,设置 acceleratorWorksWhenHidden: false 来禁用。

[!TIP] 在 Windows and Linux 上,把 MenuItem 的 registerAccelerator 属性设置为 false,可以使加速器在系统菜单中可见但不启用。

全局快捷键​

Global keyboard shortcuts work even when your app is out of focus. To configure a global keyboard shortcut, you can use the globalShortcut.register function to specify shortcuts.

const{ dialog, globalShortcut }=require('electron/main')

globalShortcut.register('CommandOrControl+Alt+R',()=>{
 dialog.showMessageBox({message:'Hello World!'})
})

To later unregister a shortcut, you can use the globalShortcut.unregisterAccelerator function.

const{ globalShortcut }=require('electron/main')

globalShortcut.unregister('CommandOrControl+Alt+R')

[!WARNING] On macOS, there's a long-standing bug with globalShortcut that prevents it from working with keyboard layouts other than QWERTY (electron/electron#19747).

Shortcuts within a window​

In the renderer process​

If you want to handle keyboard shortcuts within a BaseWindow, you can listen for the keyup and keydown DOM Events inside the renderer process using the addEventListener API.