Mention preferred size

This commit is contained in:
Kevin Sawicki 2016-11-17 13:12:52 -08:00
parent 2fc46f638f
commit ea6b53578f

View file

@ -205,12 +205,12 @@ It creates a new `BrowserWindow` with native properties as set by the `options`.
* `vibrancy` String - Add a type of vibrancy effect to the window, only on * `vibrancy` String - Add a type of vibrancy effect to the window, only on
macOS. Can be `appearance-based`, `light`, `dark`, `titlebar`, `selection`, macOS. Can be `appearance-based`, `light`, `dark`, `titlebar`, `selection`,
`menu`, `popover`, `sidebar`, `medium-light` or `ultra-dark`. `menu`, `popover`, `sidebar`, `medium-light` or `ultra-dark`.
* `zoomToPageWidth` Boolean - The zoom behavior on macOS, accessible by * `zoomToPageWidth` Boolean - Controls the behavior on macOS when
option-clicking the green stoplight button on the toolbar or running the option-clicking the green stoplight button on the toolbar or by clicking the
Window > Zoom menu item. If `true`, the window will grow to the width of the Window > Zoom menu item. If `true`, the window will grow to the preferred
web page, `false` will cause it to zoom to the width of the screen. This width of the web page when zoomed, `false` will cause it to zoom to the
will also affect the behavior when calling `maximize()` directly. Default is width of the screen. This will also affect the behavior when calling
`false`. `maximize()` directly. Default is `false`.
* `webPreferences` Object (optional) - Settings of web page's features. * `webPreferences` Object (optional) - Settings of web page's features.
* `devTools` Boolean (optional) - Whether to enable DevTools. If it is set to `false`, can not use `BrowserWindow.webContents.openDevTools()` to open DevTools. Default is `true`. * `devTools` Boolean (optional) - Whether to enable DevTools. If it is set to `false`, can not use `BrowserWindow.webContents.openDevTools()` to open DevTools. Default is `true`.
* `nodeIntegration` Boolean (optional) - Whether node integration is enabled. Default * `nodeIntegration` Boolean (optional) - Whether node integration is enabled. Default