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

fix: make menu.popup options optional (#13977)

Browse source 
* add empty object as default param for options

* update docs

* add spec for optional options

* fix: add null check for options
This commit is contained in:
Dominic 2018-08-08 15:38:52 -07:00 committed by Charles Kerr
parent fc4499ebd4
commit a7052efaf4
3 changed files with 9 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
docs/api/menu.md
View file

@ -61,7 +61,7 @@ The `menu` object has the following instance methods:
#### `menu.popup(options)` #### `menu.popup(options)`
* `options` Object * `options` Object (optional)
* `window` [BrowserWindow](browser-window.md) (optional) - Default is the focused window. * `window` [BrowserWindow](browser-window.md) (optional) - Default is the focused window.
* `x` Number (optional) - Default is the current mouse cursor position. * `x` Number (optional) - Default is the current mouse cursor position.
Must be declared if `y` is declared. Must be declared if `y` is declared.

2
lib/browser/api/menu.js
View file

@ -47,7 +47,7 @@ Menu.prototype._init = function () {
this.delegate = delegate this.delegate = delegate
} }
Menu.prototype.popup = function (options) { Menu.prototype.popup = function (options = {}) {
if (options == null || typeof options !== 'object') { if (options == null || typeof options !== 'object') {
throw new TypeError('Options must be an object') throw new TypeError('Options must be an object')
} }

8
spec/api-menu-spec.js
View file

@ -633,10 +633,16 @@ describe('Menu module', () => {
it('throws an error if options is not an object', () => { it('throws an error if options is not an object', () => {
expect(() => { expect(() => {
menu.popup() menu.popup('this is a string, not an object')
}).to.throw(/Options must be an object/) }).to.throw(/Options must be an object/)
}) })
it('allows for options to be optional', () => {
expect(() => {
menu.popup({})
}).to.not.throw()
})
it('should emit menu-will-show event', (done) => { it('should emit menu-will-show event', (done) => {
menu.on('menu-will-show', () => { done() }) menu.on('menu-will-show', () => { done() })
menu.popup({window: w}) menu.popup({window: w})