类：菜单

创建原生的应用菜单和 context 菜单。

进程：Main

new Menu()

创建一个新的菜单。

静态方法

菜单类有如下静态方法：

Menu.setApplicationMenu(menu)

• menuMenu

在 macOS 上设置应用菜单menu。 在 windows 和 linux，是为每个窗口都在其顶部设置菜单menu。

设置为null时，将在 Windows 和 Linux 上删除菜单条，但在 macOS 系统中无效。

注意：这个API必须在app模块的ready事件后调用。

Menu.getApplicationMenu()

返回Menu- 应用程序菜单，设置、null、或未设置。

Menu.sendActionToFirstResponder(action)macOS

• actionString

发送action给应用的第一个响应器.这个用来模仿 Cocoa 菜单的默认行为，通常你只需要使用MenuItem的属性role.

查看更多 macOS 的原生 actionmacOS Cocoa Event Handling Guide.

Menu.buildFromTemplate(template)

• templateMenuItemConstructorOptions[]

返回Menu

一般来说，template只是用来创建MenuItem的数组参数。

你也可以向template元素添加其它东西，并且他们会变成已经有的菜单项的属性。

实例方法

menu对象有如下实例方法

menu.popup([browserWindow, options])

• browserWindowBrowserWindow (可选) - 默认为当前激活的窗口.
• optionsObject (可选)
  • xNumber (可选) - 默认为当前光标所在的位置.
  • yNumber (必须如果x设置了) - 默认为当前光标所在的位置.
  • asyncBoolean (可选) - 设置为true时，调用这个方法会立即返回。设置为false时，当菜单被选择或者被关闭时才会返回。默认为false。
  • positioningItemNumber (可选)macOS- 指定坐标鼠标位置下面的菜单项的索引. 默认为 -1.

在browserWindow中弹出菜单.

menu.closePopup([browserWindow])

• browserWindowBrowserWindow (可选) - 默认为当前激活的窗口.

在browserWindow关闭菜单.

menu.append(menuItem)

• menuItemMenuItem

添加菜单项。

menu.insert(pos, menuItem)

• posInteger
• menuItemMenuItem

在指定位置添加菜单项。

实例属性

menu对象拥有以下属性：

menu.items()

获取一个菜单项数组。

例子

Menu类只能在主进程中使用，但你也可以 在渲染过程中通过remote模块使用它。

主进程

在主进程中创建应用程序菜单的示例 简单模板API：

const {app, Menu} = require('electron')

const template = [
  {
    label: 'Edit',
    submenu: [
      {role: 'undo'},
      {role: 'redo'},
      {type: 'separator'},
      {role: 'cut'},
      {role: 'copy'},
      {role: 'paste'},
      {role: 'pasteandmatchstyle'},
      {role: 'delete'},
      {role: 'selectall'}
    ]
  },
  {
    label: 'View',
    submenu: [
      {role: 'reload'},
      {role: 'forcereload'},
      {role: 'toggledevtools'},
      {type: 'separator'},
      {role: 'resetzoom'},
      {role: 'zoomin'},
      {role: 'zoomout'},
      {type: 'separator'},
      {role: 'togglefullscreen'}
    ]
  },
  {
    role: 'window',
    submenu: [
      {role: 'minimize'},
      {role: 'close'}
    ]
  },
  {
    role: 'help',
    submenu: [
      {
        label: 'Learn More',
        click () { require('electron').shell.openExternal('https://electron.atom.io') }
      }
    ]
  }
]

if (process.platform === 'darwin') {
  template.unshift({
    label: app.getName(),
    submenu: [
      {role: 'about'},
      {type: 'separator'},
      {role: 'services', submenu: []},
      {type: 'separator'},
      {role: 'hide'},
      {role: 'hideothers'},
      {role: 'unhide'},
      {type: 'separator'},
      {role: 'quit'}
    ]
  })

  // Edit menu
  template[1].submenu.push(
    {type: 'separator'},
    {
      label: 'Speech',
      submenu: [
        {role: 'startspeaking'},
        {role: 'stopspeaking'}
      ]
    }
  )

  // Window menu
  template[3].submenu = [
    {role: 'close'},
    {role: 'minimize'},
    {role: 'zoom'},
    {type: 'separator'},
    {role: 'front'}
  ]
}

const menu = Menu.buildFromTemplate(template)
Menu.setApplicationMenu(menu)

渲染进程

以下是通过使用remote模块在网页（渲染进程）中动态创建菜单的示例 ，并在用户点击右键时显示：

<!-- index.html -->
<script>
const {remote} = require('electron')
const {Menu, MenuItem} = remote

const menu = new Menu()
menu.append(new MenuItem({label: 'MenuItem1', click() { console.log('item 1 clicked') }}))
menu.append(new MenuItem({type: 'separator'}))
menu.append(new MenuItem({label: 'MenuItem2', type: 'checkbox', checked: true}))

window.addEventListener('contextmenu', (e) => {
  e.preventDefault()
  menu.popup(remote.getCurrentWindow())
}, false)
</script>

macOS Application 上的菜单的注意事项

相对于 windows 和 linux, macOS 上的应用菜单是完全不同的 style，这里是一些注意事项，来让你的菜单项更原生化。

标准菜单

在 macOS 上，有很多系统定义的标准菜单，例如ServicesandWindows菜单.为了让你的应用更标准化，你可以为你的菜单的role设置值，然后 Electron 将会识别他们并且让你的菜单更标准：

• window
• help
• services

标准菜单项行为

macOS 为一些菜单项提供了标准的行为方法，例如About xxx，Hide xxx,和Hide Others. 为了让你的菜单项的行为更标准化，你应该为菜单项设置role属性。

主菜单名

在 macOS ，无论你设置的什么标签，应用菜单的第一个菜单项的标签始终未你的应用名字。想要改变它的话，你必须通过修改应用绑定的Info.plist文件来修改应用名字，更多信息参考About Information Property List Files。

为制定浏览器窗口设置菜单 (LinuxWindows)

浏览器窗口的setMenu方法能够设置菜单为特定浏览器窗口的类型。

菜单项位置

当通过Menu.buildFromTemplate创建菜单的时候，你可以使用positionandid来放置菜单项。

MenuItem的属性position格式为[placement]=[id]，placement取值为before,after, 或endof和id，id是菜单已经存在的菜单项的唯一 ID：

• before- 在对应引用id菜单项之前插入。如果引用的菜单项不存在，则将其插在菜单末尾。
• after- 在对应引用id菜单项之后插入。如果引用的菜单项不存在，则将其插在菜单末尾。
• endof- 在逻辑上包含对应引用id菜单项的集合末尾插入。如果引用的菜单项不存在, 则将使用给定的id创建一个新的集合，并且这个菜单项将插入。

当一个菜档项插入成功了，所有的没有插入的菜单项将一个接一个地在后面插入。所以如果你想在同一个位置插入一组菜单项，只需要为这组菜单项的第一个指定位置。

例子

模板:

[
  {label: '4', id: '4'},
  {label: '5', id: '5'},
  {label: '1', id: '1', position: 'before=4'},
  {label: '2', id: '2'},
  {label: '3', id: '3'}
]

菜单:

- 1
- 2
- 3
- 4
- 5

模板:

[
  {label: 'a', position: 'endof=letters'},
  {label: '1', position: 'endof=numbers'},
  {label: 'b', position: 'endof=letters'},
  {label: '2', position: 'endof=numbers'},
  {label: 'c', position: 'endof=letters'},
  {label: '3', position: 'endof=numbers'}
]

菜单:

- ---
- a
- b
- c
- ---
- 1
- 2
- 3