菜单项

菜单项

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

进程：主进程

有关示例, 请参见 Menu。

Class: MenuItem

Add items to native application menus and context menus.

Process: Main

See Menu for examples.

new MenuItem(可选)

• 参数 Object

  • click Function (可选) - 当菜单项被点击后，将会调用 click(menuItem, browserWindow, event) 。

    • 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, close, minimize, zoom, front, appMenu, fileMenu, editMenu, viewMenu, recentDocuments, toggleTabBar, selectNextTab, selectPreviousTab, mergeAllWindows, clearRecentDocuments, moveTabToNewWindow or windowMenu - Define the action of the menu item, when specified the click property will be ignored. See roles.
  • typeString (可选)-可以是 normal、separator、submenu、checkbox 或 radio。
  • label String (可选)
  • sublabel String (可选)
  • accelerator Accelerator (可选)
  • icon (NativeImage | String) (可选)
  • enabled Boolean (可选) - 如果为 false，该菜单项将会置灰且不可点击。
  • acceleratorWorksWhenHidden Boolean (optional) - default is true, and when false will prevent the accelerator from triggering the item if the item is not visible`. macOS
  • visibleBoolean (可选)-如果为 false, 该菜单项将完全隐藏。
  • checkedBoolean (可选)-只应为 checkbox 或 radio 类型菜单项指定。
  • registerAccelerator Boolean (可选) - 如果为 false, accelerator 不会被系统注册, 但仍然会被显示. 默认值为 true。
  • submenu (MenuItemConstructorOptions[] | Menu) (optional) - Should be specified for submenu type menu items. If submenu is specified, the type: 'submenu' can be omitted. If the value is not a Menu then it will be automatically converted to one using Menu.buildFromTemplate.
  • idString (可选)-在单个菜单中是唯一的。如果定义, 则可以通过它来引用该项。
  • before String - Inserts this item before the item with the specified label. If the referenced item doesn't exist the item will be inserted at the end of the menu. Also implies that the menu item in question should be placed in the same “group” as the item.
  • after String - Inserts this item after the item with the specified label. If the referenced item doesn't exist the item will be inserted at the end of the menu.
  • 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.

Note: acceleratorWorksWhenHidden is specified as being macOS-only because accelerators always work when items are hidden on Windows and Linux. The option is exposed to users to give them the option to turn it off, as this is possible in native macOS development. This property is only usable on macOS High Sierra 10.13 or newer.

new MenuItem(options)

• options Object

  • click Function (optional) - Will be called with click(menuItem, browserWindow, event) when the menu item is clicked.

    • 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, close, minimize, zoom, front, appMenu, fileMenu, editMenu, viewMenu, recentDocuments, toggleTabBar, selectNextTab, selectPreviousTab, mergeAllWindows, clearRecentDocuments, moveTabToNewWindow or windowMenu - Define the action of the menu item, when specified the click property will be ignored. See roles.
  • type String (optional) - Can be normal, separator, submenu, checkbox or radio.
  • label String (optional)
  • sublabel String (optional)
  • accelerator Accelerator (optional)
  • icon (NativeImage | String) (optional)
  • enabled Boolean (optional) - If false, the menu item will be greyed out and unclickable.
  • acceleratorWorksWhenHidden Boolean (optional) - default is true, and when false will prevent the accelerator from triggering the item if the item is not visible`. macOS
  • visible Boolean (optional) - If false, the menu item will be entirely hidden.
  • checked Boolean (optional) - Should only be specified for checkbox or radio type menu items.
  • registerAccelerator Boolean (optional) - If false, the accelerator won't be registered with the system, but it will still be displayed. Defaults to true.
  • submenu (MenuItemConstructorOptions[] | Menu) (optional) - Should be specified for submenu type menu items. If submenu is specified, the type: 'submenu' can be omitted. If the value is not a Menu then it will be automatically converted to one using 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. If the referenced item doesn't exist the item will be inserted at the end of the menu. Also implies that the menu item in question should be placed in the same “group” as the item.
  • after String - Inserts this item after the item with the specified label. If the referenced item doesn't exist the item will be inserted at the end of the menu.
  • 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.

Note: acceleratorWorksWhenHidden is specified as being macOS-only because accelerators always work when items are hidden on Windows and Linux. The option is exposed to users to give them the option to turn it off, as this is possible in native macOS development. This property is only usable on macOS High Sierra 10.13 or newer.

角色

可以通过角色来为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 属性可以具有以下值:

• 撤消
• 重做
• cut
• copy
• paste
• pasteAndMatchStyle
• selectAll
• delete
• minimize - 最小化当前窗口。
• close - 关闭当前窗口.
• quit - Quit the application.
• reload - 重新加载当前窗口。
• forcereload - 忽略缓存，重新加载当前窗口。
• toggledevtools - 在当前窗口中隐藏/显示开发者工具。
• togglefullscreen - Toggle full screen mode on the current window.
• resetzoom - 将主页的缩放级别重置为初始大小.
• zoomin - 主页面放大 10%.
• zoomout -主页面缩小 10%.
• fileMenu - Whole default "File" menu (Close / Quit)
• editMenu-默认的 "编辑" 菜单 (包括撤消、复制等)
• viewMenu - Whole default "View" menu (Reload, Toggle Developer Tools, etc.)
• windowMenu - Whole default "Window" menu (Minimize, Zoom, etc.).

以下为macOS 中提供的角色:

• appMenu - Whole default "App" menu (About, Services, etc.)
• about-映射到 orderFrontStandardAboutPanel 操作.
• 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 操作.

在 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.

Roles

Roles allow menu items to have predefined behaviors.

It is best to specify role for any menu item that matches a standard role, rather than trying to manually implement the behavior in a click function. The built-in role behavior will give the best native experience.

The label and accelerator values are optional when using a role and will default to appropriate values for each platform.

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

The role property can have following values:

• undo
• redo
• cut
• copy
• paste
• pasteAndMatchStyle
• selectAll
• delete
• minimize - Minimize current window.
• close - Close current window.
• quit - Quit the application.
• reload - Reload the current window.
• forceReload - Reload the current window ignoring the cache.
• toggleDevTools - Toggle developer tools in the current window.
• togglefullscreen - Toggle full screen mode on the current window.
• resetZoom - Reset the focused page's zoom level to the original size.
• zoomIn - Zoom in the focused page by 10%.
• zoomOut - Zoom out the focused page by 10%.
• fileMenu - Whole default "File" menu (Close / Quit)
• editMenu - Whole default "Edit" menu (Undo, Copy, etc.).
• viewMenu - Whole default "View" menu (Reload, Toggle Developer Tools, etc.)
• windowMenu - Whole default "Window" menu (Minimize, Zoom, etc.).

The following additional roles are available on macOS:

• appMenu - Whole default "App" menu (About, Services, etc.)
• about - Map to the orderFrontStandardAboutPanel action.
• hide - Map to the hide action.
• hideOthers - Map to the hideOtherApplications action.
• unhide - Map to the unhideAllApplications action.
• startSpeaking - Map to the startSpeaking action.
• stopSpeaking - Map to the stopSpeaking action.
• front - Map to the arrangeInFront action.
• zoom - Map to the performZoom action.
• toggleTabBar - Map to the toggleTabBar action.
• selectNextTab - Map to the selectNextTab action.
• selectPreviousTab - Map to the selectPreviousTab action.
• mergeAllWindows - Map to the mergeAllWindows action.
• moveTabToNewWindow - Map to the moveTabToNewWindow action.
• window - The submenu is a "Window" menu.
• help - The submenu is a "Help" menu.
• 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 - The submenu is an "Open Recent" menu.
• clearRecentDocuments - Map to the clearRecentDocuments action.

When specifying a role on macOS, label and accelerator are the only options that will affect the menu item. All other options will be ignored. Lowercase role, e.g. toggledevtools, is still supported.

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

实例属性

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

Instance Properties

The following properties are available on instances of MenuItem:

menuItem.id

A String indicating the item's unique id, this property can be dynamically changed.

menuItem.id

A String indicating the item's unique id, this property can be dynamically changed.

menuItem.label

A String indicating the item's visible label, this property can be dynamically changed.

menuItem.label

A String indicating the item's visible label, this property can be dynamically changed.

menuItem.click

A Function that is fired when the MenuItem receives a click event. It can be called with menuItem.click(event, focusedWindow, focusedWebContents).

• event KeyboardEvent
• focusedWindow BrowserWindow
• focusedWebContents WebContents

menuItem.click

A Function that is fired when the MenuItem receives a click event. 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.submenu

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

menuItem.type

A String indicating the type of the item.

menuItem.type

A String indicating the type of the item.

menuItem.role

A String (optional) indicating the item's role, if set. 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, close, minimize, zoom, front, appMenu, fileMenu, editMenu, viewMenu, recentDocuments, toggleTabBar, selectNextTab, selectPreviousTab, mergeAllWindows, clearRecentDocuments, moveTabToNewWindow or windowMenu

menuItem.role

A String (optional) indicating the item's role, if set. 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, close, minimize, zoom, front, appMenu, fileMenu, editMenu, viewMenu, recentDocuments, toggleTabBar, selectNextTab, selectPreviousTab, mergeAllWindows, clearRecentDocuments, moveTabToNewWindow or windowMenu

menuItem.accelerator

A String (optional) indicating the item's accelerator, if set.

menuItem.accelerator

A String (optional) indicating the item's accelerator, if set.

menuItem.icon

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

menuItem.icon

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

menuItem.sublabel

A String indicating the item's sublabel, this property can be dynamically changed.

menuItem.sublabel

A String indicating the item's sublabel, this property can be dynamically changed.

menuItem.enabled

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

menuItem.enabled

A Boolean indicating whether the item is enabled, this property can be dynamically changed.

menuItem.visible

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

menuItem.visible

A Boolean indicating whether the item is visible, this property can be dynamically changed.

menuItem.checked

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

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

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

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

menuItem.checked

A Boolean indicating whether the item is checked, this property can be dynamically changed.

A checkbox menu item will toggle the checked property on and off when selected.

A radio menu item will turn on its checked property when clicked, and will turn off that property for all adjacent items in the same menu.

You can add a click function for additional behavior.

menuItem.registerAccelerator

A Boolean indicating if the accelerator should be registered with the system or just displayed, this property can be dynamically changed.

menuItem.registerAccelerator

A Boolean indicating if the accelerator should be registered with the system or just displayed, this property can be dynamically changed.

menuItem.commandId

A Number indicating an item's sequential unique id.

menuItem.commandId

A Number indicating an item's sequential unique id.

menuItem.menu

A Menu that the item is a part of.

menuItem.menu

A Menu that the item is a part of.