Document zoomToContentSize
authorKevin Sawicki <kevinsawicki@gmail.com>
Thu, 27 Oct 2016 18:17:24 +0000 (11:17 -0700)
committerKevin Sawicki <kevinsawicki@gmail.com>
Mon, 21 Nov 2016 16:45:46 +0000 (08:45 -0800)
docs/api/browser-window.md

index 5ff2380a5813a227365af304e2b18be7835ef306..32f991f36b8789cfce7bcf468c3451ff109c66d2 100644 (file)
@@ -205,6 +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
     macOS. Can be `appearance-based`, `light`, `dark`, `titlebar`, `selection`,
     `menu`, `popover`, `sidebar`, `medium-light` or `ultra-dark`.
+  * `zoomToContentSize` Boolean - The zoom behavior on macOS, accessible by
+    option-clicking the green stoplight button on the toolbar or running the
+    Window > Zoom menu item. If `true`, the window will grow to the width of the
+    web page, `false` will cause it to zoom to the width of the screen. This
+    will also affect the behavior when calling `maximize()` directly. Default is
+    `false`.
   * `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`.
     * `nodeIntegration` Boolean (optional) - Whether node integration is enabled. Default