MenuItem
The menu-item
module allows you to add items to an application or context
menu
.
See menu
for examples.
Class: MenuItem
Create a new MenuItem
with the following method:
new MenuItem(options)
options
Objectclick
Function - Will be called withclick(menuItem, browserWindow)
when the menu item is clickedrole
String - Define the action of the menu item, when specified theclick
property will be ignoredtype
String - Can benormal
,separator
,submenu
,checkbox
orradio
label
Stringsublabel
Stringaccelerator
Acceleratoricon
NativeImageenabled
Booleanvisible
Booleanchecked
Booleansubmenu
Menu - Should be specified forsubmenu
type menu item, when it's specified thetype: 'submenu'
can be omitted for the menu item. If the value is not aMenu
then it will be automatically converted to one usingMenu.buildFromTemplate
.id
String - Unique within a single menu. If defined then it can be used as a reference to this item by the position attribute.position
String - This field allows fine-grained definition of the specific location within a given menu.
When creating menu items, it is recommended to specify role
instead of
manually implementing the behavior if there is matching action, so menu can have
best native experience.
The role
property can have following values:
undo
redo
cut
copy
paste
selectall
minimize
- Minimize current windowclose
- Close current window
On OS X role
can also have following additional values:
about
- Map to theorderFrontStandardAboutPanel
actionhide
- Map to thehide
actionhideothers
- Map to thehideOtherApplications
actionunhide
- Map to theunhideAllApplications
actionfront
- Map to thearrangeInFront
actionwindow
- The submenu is a "Window" menuhelp
- The submenu is a "Help" menuservices
- The submenu is a "Services" menu