mirrors/electron
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Merge pull request #4962 from erkyrath/doc-issue-4884

Browse source 
Added information about the enabled, visible, and checked properties
This commit is contained in:
Kevin Sawicki 2016-03-31 15:43:22 -07:00
commit f87e417f7f
1 changed files with 30 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

41
docs/api/menu-item.md
View file

@ -14,7 +14,7 @@ Create a new `MenuItem` with the following method:
* `options` Object * `options` Object
* `click` Function - Will be called with `click(menuItem, browserWindow)` when * `click` Function - Will be called with `click(menuItem, browserWindow)` when
the menu item is clicked the menu item is clicked
* `role` String - Define the action of the menu item, when specified the * `role` String - Define the action of the menu item; when specified the
`click` property will be ignored `click` property will be ignored
* `type` String - Can be `normal`, `separator`, `submenu`, `checkbox` or * `type` String - Can be `normal`, `separator`, `submenu`, `checkbox` or
`radio` `radio`
@ -22,21 +22,22 @@ Create a new `MenuItem` with the following method:
* `sublabel` String * `sublabel` String
* `accelerator` [Accelerator](accelerator.md) * `accelerator` [Accelerator](accelerator.md)
* `icon` [NativeImage](native-image.md) * `icon` [NativeImage](native-image.md)
* `enabled` Boolean * `enabled` Boolean - If false, the menu item will be greyed out and unclickable.
* `visible` Boolean * `visible` Boolean - If false, the menu item will be entirely hidden.
* `checked` Boolean * `checked` Boolean - Should only be specified for `checkbox` or `radio` type
* `submenu` Menu - Should be specified for `submenu` type menu item, when menu items.
it's specified the `type: 'submenu'` can be omitted for the menu item. * `submenu` Menu - Should be specified for `submenu` type menu items. If
If the value is not a `Menu` then it will be automatically converted to one `submenu` is specified, the `type: 'submenu'` can be omitted. If the value
using `Menu.buildFromTemplate`. is not a `Menu` then it will be automatically converted to one using
`Menu.buildFromTemplate`.
* `id` String - Unique within a single menu. If defined then it can be used * `id` String - Unique within a single menu. If defined then it can be used
as a reference to this item by the position attribute. as a reference to this item by the position attribute.
* `position` String - This field allows fine-grained definition of the * `position` String - This field allows fine-grained definition of the
specific location within a given menu. specific location within a given menu.
When creating menu items, it is recommended to specify `role` instead of It is best to specify `role` for any menu item that matches a standard role,
manually implementing the behavior if there is matching action, so menu can have rather than trying to manually implement the behavior in a `click` function.
best native experience. The built-in `role` behavior will give the best native experience.
The `role` property can have following values: The `role` property can have following values:
@ -59,3 +60,21 @@ On OS X `role` can also have following additional values:
* `window` - The submenu is a "Window" menu * `window` - The submenu is a "Window" menu
* `help` - The submenu is a "Help" menu * `help` - The submenu is a "Help" menu
* `services` - The submenu is a "Services" menu * `services` - The submenu is a "Services" menu
## Instance Properties
The following properties (and no others) can be updated on an existing `MenuItem`:
* `enabled` Boolean
* `visible` Boolean
* `checked` Boolean
Their meanings are as described above.
A `checkbox` menu item will toggle its `checked` property on and off when
selected. You can add a `click` function to do additional work.
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. Again,
you can add a `click` function for additional behavior.