菜单项

添加菜单项到应用程序菜单和上下文菜单中

进程：主进程

有关示例, 请参见 Menu。

new MenuItem(options)

• 选项 对象
  • click 函数(可选) - 单击菜单项时，将用 click(menuItem, browserWindow, event) 调用。
    • menuItem MenuItem
    • browserWindow BrowserWindow |未定义 - 如果没有打开窗口，则无法定义此定义。
    • event KeyboardEvent
  • role String (optional) - Can be undo, redo, cut, copy, paste, pasteAndMatchStyle, delete, selectAll, reload, forceReload, toggleDevTools, resetZoom, zoomIn, zoomOut, togglefullscreen, window, minimize, close, help, about, services, hide, hideOthers, unhide, quit, startSpeaking, stopSpeaking, zoom, front, appMenu, fileMenu, editMenu, viewMenu, shareMenu, recentDocuments, toggleTabBar, selectNextTab, selectPreviousTab, mergeAllWindows, clearRecentDocuments, moveTabToNewWindow or windowMenu - Define the action of the menu item, when specified the click property will be ignored. 参见 roles
  • typeString (可选)-可以是 normal、separator、submenu、checkbox 或 radio。
  • label String (可选)
  • sublabel String (可选)
  • toolTip String (optional) macOS - Hover text for this menu item.
  • accelerator Accelerator (可选)
  • icon (NativeImage | String) (可选)
  • enabled Boolean (可选) - 如果为 false，该菜单项将会置灰且不可点击。
  • acceleratorWorksWhenHidden Boolean (optional) macOS - default is true, and when false will prevent the accelerator from triggering the item if the item is not visible`.
  • visibleBoolean (可选)-如果为 false, 该菜单项将完全隐藏。
  • checkedBoolean (可选)-只应为 checkbox 或 radio 类型菜单项指定。
  • registerAccelerator Boolean (optional) Linux Windows - If false, the accelerator won’t be registered with the system, but it will still be displayed. 默认值为 true。
  • sharingItem SharingItem (optional) macOS - The item to share when the role is shareMenu.
  • submenu (MenuItemConstructorOptions[] | Menu) (optional) - Should be specified for submenu type menu items. If submenu is specified, the type: 'submenu' can be omitted. 如果该值不属于Menu，它将被函数Menu.buildFromTemplate自动转换。
  • id String (optional) - Unique within a single menu. If defined then it can be used as a reference to this item by the position attribute.
  • before String - Inserts this item before the item with the specified label. 如果引用值不存在，那么该菜单项会插在这个菜单的尾部。 这还意味着，菜单项应该被放置在与引用项相同的组中。
  • after String - 在指定的标签之后插入菜单项。 如果引用值不存在，那么该菜单项会插在这个菜单的尾部。
  • beforeGroupContaining String - Provides a means for a single context menu to declare the placement of their containing group before the containing group of the item with the specified label.
  • afterGroupContaining String - Provides a means for a single context menu to declare the placement of their containing group after the containing group of the item with the specified label.

注意: acceleratorWorksWhenHidden只在MacOS中生效，因为在Windows和Linux中快捷键不会随着隐藏菜单项而失效。 该选项让用户可以选择关闭，因为这是本地 macOS 开发中的可能。 此属性只能在macOS High Sierra 10.13或以上中使用。

角色

可以通过角色来为menu添加预定义行为。

最好给任何一个菜单指定 role去匹配一个标准角色, 而不是尝试在 click 函数中手动实现该行为。 内置的 role 行为将提供最佳的原生体验。

使用 role 时, label 和 accelerator 值是可选的, 并为每个平台，将默认为适当值。

Every menu item must have either a role, label, or in the case of a separator a type.

role 属性可以具有以下值:

• undo - 撤销。
• about - Trigger a native about panel (custom message box on Window, which does not provide its own).
• redo
• cut - 剪切。
• copy - 复制。
• paste - 粘贴。
• pasteAndMatchStyle
• selectAll - 全选。
• delete -删除
• minimize - 最小化当前窗口。
• close - 关闭当前窗口.
• quit - 退出程序
• reload - 重新加载当前窗口。
• forcereload - 忽略缓存，重新加载当前窗口。
• toggledevtools - 在当前窗口中隐藏/显示开发者工具。
• togglefullscreen - 将当前窗口切换至全屏模式。
• resetzoom - 将主页的缩放级别重置为初始大小.
• zoomin - 主页面放大 10%.
• zoomout -主页面缩小 10%.
• toggleSpellChecker - 启用/禁用内置拼写检查器。
• fileMenu - 默认的“文件”菜单（关闭/退出）
• editMenu-默认的 “编辑” 菜单 (包括撤消、复制等)
• viewMenu - 默认的“视图”菜单（包括重新加载、开发者工具等）
• windowMenu - 默认的“窗口”菜单（包括最小化、缩放等）

The following additional roles are available on macOS:

• appMenu - Whole default “App” menu (About, Services, etc.)
• hide-映射到 hide 操作.
• hideOthers-映射到 hideOtherApplications 操作.
• unhide-映射到 unhideAllApplications 操作.
• startSpeaking-映射到 startSpeaking 操作.
• stopSpeaking-映射到 stopSpeaking 操作.
• front-映射到 arrangeInFront 操作.
• zoom-映射到 performZoom 操作.
• toggleTabBar-映射到 toggleTabBar 操作.
• selectNextTab - 映射到 selectNextTab 操作.
• selectPreviousTab - 映射到 selectPreviousTab 操作.
• mergeAllWindows - 映射到 mergeAllWindows 操作.
• moveTabToNewWindow - 映射到 moveTabToNewWindow 操作.
• window - 这个子菜单是”Window” 菜单.
• help-这个子菜单是 “Help” 菜单.
• services - The submenu is a “Services” menu. This is only intended for use in the Application Menu and is not the same as the “Services” submenu used in context menus in macOS apps, which is not implemented in Electron.
• recentDocuments-这个子菜单是 “Open Recent” 菜单.
• clearRecentDocuments -映射到 clearRecentDocuments 操作.
• shareMenu - The submenu is share menu. The sharingItem property must also be set to indicate the item to share.

在 macOS 上指定 role 时, label 和 accelerator 是影响菜单项的唯一选项。 所有其它选项都将被忽略。 不过，仍然支持小写的role，如toggledevtools。

Nota Bene: The enabled and visibility properties are not available for top-level menu items in the tray on macOS.

实例属性

以下为 MenuItem 实例的可用属性:

menuItem.id

String 指定了该选项唯一的id，此属性可被动态更改。

menuItem.label

A String indicating the item’s visible label.

menuItem.click

当 MenuItem 接收到 click 事件时激发的Function. It can be called with menuItem.click(event, focusedWindow, focusedWebContents).

• event KeyboardEvent
• focusedWindow BrowserWindow
• focusedWebContents WebContents

menuItem.submenu

A Menu (optional) containing the menu item’s submenu, if present.

menuItem.type

String 表示菜单项的类型 Can be normal, separator, submenu, checkbox or radio.

menuItem.role

String（可选） 指出菜单项的角色 可为 undo, redo, cut, copy, paste, pasteAndMatchStyle, delete, selectAll, reload, forceReload, toggleDevTools, resetZoom, zoomIn, zoomOut, togglefullscreen, window, minimize, close, help, about, services, hide, hideOthers, unhide, quit, startSpeaking, stopSpeaking, zoom, front, appMenu, fileMenu, editMenu, viewMenu, recentDocuments, toggleTabBar, selectNextTab, selectPreviousTab, mergeAllWindows, clearRecentDocuments, moveTabToNewWindow 或 windowMenu

menuItem.accelerator

A Accelerator (optional) indicating the item’s accelerator, if set.

menuItem.icon

A NativeImage | String (optional) indicating the item’s icon, if set.

menuItem.sublabel

A String indicating the item’s sublabel.

menuItem.toolTip macOS

A String indicating the item’s hover text.

menuItem.enabled

一个 Boolean 类型的值, 指示是否启用该项, 该属性可以动态改变

menuItem.visible

一个 Boolean 类型的值, 指示该项是否可见, 该属性可以动态改变。

menuItem.checked

一个 Boolean 类型的值, 指示是否选中该项, 该属性可以动态改变。

checkbox 菜单项将在选中时切换 checked 的开关属性。

单选菜单项 将返回单击时checked属性, 并将关闭同一菜单中所有相邻项的属性。

你可以为其他行为添加click函数。

menuItem.registerAccelerator

A Boolean indicating if the accelerator should be registered with the system or just displayed.

This property can be dynamically changed.

menuItem.sharingItem macOS

A SharingItem indicating the item to share when the role is shareMenu.

This property can be dynamically changed.

menuItem.commandId

A Number indicating an item’s sequential unique id.

menuItem.menu

A Menu that the item is a part of.