Add items to native application menus and context menus.
Process: Main
See Menu
for examples.
new MenuItem(options)
options
Object
click
Function (optional) - Will be called with click(menuItem, browserWindow, event)
when the menu item is clicked.
menuItem
MenuItembrowserWindow
BrowserWindowevent
Eventrole
String (optional) - 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.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.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.position
String (optional) - This field allows fine-grained definition of the specific location within a given menu.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.
The role
property can have following values:
undo
redo
cut
copy
paste
pasteandmatchstyle
selectall
delete
minimize
- Minimize current windowclose
- Close current windowquit
- Quit the applicationreload
- Reload the current windowforcereload
- Reload the current window ignoring the cache.toggledevtools
- Toggle developer tools in the current windowtogglefullscreen
- Toggle full screen mode on the current windowresetzoom
- Reset the focused page’s zoom level to the original sizezoomin
- Zoom in the focused page by 10%zoomout
- Zoom out the focused page by 10%editMenu
- Whole default “Edit” menu (Undo, Copy, etc.)windowMenu
- Whole default “Window” menu (Minimize, Close, etc.)The following additional roles are available on macOS:
about
- Map to the orderFrontStandardAboutPanel
actionhide
- Map to the hide
actionhideothers
- Map to the hideOtherApplications
actionunhide
- Map to the unhideAllApplications
actionstartspeaking
- Map to the startSpeaking
actionstopspeaking
- Map to the stopSpeaking
actionfront
- Map to the arrangeInFront
actionzoom
- Map to the performZoom
actionwindow
- The submenu is a “Window” menuhelp
- The submenu is a “Help” menuservices
- The submenu is a “Services” menuWhen specifying a role
on macOS, label
and accelerator
are the only options that will affect the menu item. All other options will be ignored.
The following properties are available on instances of MenuItem
:
menuItem.enabled
A Boolean
indicating whether the item is enabled, this property can be dynamically changed.
menuItem.visible
A Boolean
indicating whether the item is visible, this property can be dynamically changed.
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.label
A String
representing the menu items visible label
menuItem.click
A Function
that is fired when the MenuItem receives a click event