Browse Source

Document zoomToContentSize

Kevin Sawicki 8 years ago
parent
commit
7896ee23a2
1 changed files with 6 additions and 0 deletions
  1. 6 0
      docs/api/browser-window.md

+ 6 - 0
docs/api/browser-window.md

@@ -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