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

Merge pull request #4864 from miniak/fix-menu-api-doc

Browse source 
Fix Menu documentation
This commit is contained in:
Jessica Lord 2016-03-21 13:40:50 -07:00
commit b4f1a63f64
1 changed files with 12 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
docs/api/menu.md
View file

@ -240,7 +240,11 @@ Generally, the `template` is just an array of `options` for constructing a
You can also attach other fields to the element of the `template` and they You can also attach other fields to the element of the `template` and they
will become properties of the constructed menu items. will become properties of the constructed menu items.
### `Menu.popup([browserWindow, x, y, positioningItem])` ## Instance Methods
The `menu` object has the following instance methods:
### `menu.popup([browserWindow, x, y, positioningItem])`
* `browserWindow` BrowserWindow (optional) - Default is `null`. * `browserWindow` BrowserWindow (optional) - Default is `null`.
* `x` Number (optional) - Default is -1. * `x` Number (optional) - Default is -1.
@ -253,20 +257,24 @@ Pops up this menu as a context menu in the `browserWindow`. You can optionally
provide a `x, y` coordinate to place the menu at, otherwise it will be placed provide a `x, y` coordinate to place the menu at, otherwise it will be placed
at the current mouse cursor position. at the current mouse cursor position.
### `Menu.append(menuItem)` ### `menu.append(menuItem)`
* `menuItem` MenuItem * `menuItem` MenuItem
Appends the `menuItem` to the menu. Appends the `menuItem` to the menu.
### `Menu.insert(pos, menuItem)` ### `menu.insert(pos, menuItem)`
* `pos` Integer * `pos` Integer
* `menuItem` MenuItem * `menuItem` MenuItem
Inserts the `menuItem` to the `pos` position of the menu. Inserts the `menuItem` to the `pos` position of the menu.
### `Menu.items()` ## Instance Properties
`menu` objects also have the following properties:
### `menu.items`
Get an array containing the menu's items. Get an array containing the menu's items.