electron/docs/api/menu-item.md

33 lines
1.1 KiB
Markdown
Raw Normal View History

2015-08-28 23:35:22 +00:00
# MenuItem
2015-08-28 23:19:28 +00:00
The `menu-item` module allows you to add items to an application or content
[`menu`](menu.md).
See [`menu`](menu.md) for examples.
2013-09-09 07:35:57 +00:00
2013-08-14 22:43:35 +00:00
## Class: MenuItem
2015-08-28 23:19:28 +00:00
Create a new `MenuItem` with the following method:
2013-08-14 22:43:35 +00:00
### new MenuItem(options)
* `options` Object
* `click` Function - Callback when the menu item is clicked
* `selector` String - Call the selector of first responder when clicked (OS
X only)
* `type` String - Can be `normal`, `separator`, `submenu`, `checkbox` or
`radio`
2013-08-14 22:43:35 +00:00
* `label` String
* `sublabel` String
* `accelerator` [Accelerator](accelerator.md)
2015-02-13 04:12:40 +00:00
* `icon` [NativeImage](native-image.md)
2013-08-14 22:43:35 +00:00
* `enabled` Boolean
* `visible` Boolean
* `checked` Boolean
* `submenu` Menu - Should be specified for `submenu` type menu item, when
it's specified the `type: 'submenu'` can be omitted for the menu item
* `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.