electron/docs/api/menu-item.md

58 lines
1.9 KiB
Markdown
Raw Normal View History

2013-09-09 07:35:57 +00:00
# menu-item
2013-08-14 22:43:35 +00:00
## Class: MenuItem
### new MenuItem(options)
* `options` Object
2013-08-14 22:43:35 +00:00
* `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
2013-08-14 22:43:35 +00:00
* `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
2013-08-14 22:43:35 +00:00
* `visible` Boolean
2013-08-14 22:43:35 +00:00
* `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.
It has the form "[placement]=[id]" where placement is one of `before`,
`after`, or `endof` and `id` is the id of an existing item in the menu.
- `before` - Inserts this item before the id referenced item. If the
referenced item doesn't exist the item will be inserted at the end of
the menu.
- `after` - Inserts this item after id referenced item. If the referenced
item doesn't exist the item will be inserted at the end of the menu.
- `endof` - Inserts this item at the end of the logical group containing
the id referenced item. (Groups are created by separator items). If
the referenced item doesn't exist a new separator group is created with
the given id and this item is inserted after that separator.
When an item is positioned following unpositioned items are inserted after
it, until a new item is positioned. So if you want to position a group of
menu items in the same location you only need to specify a position for
the first item.