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

📝 Document simple fullscreen functionality [ci skip]

Browse source
This commit is contained in:
Zachary Flower 2017-08-13 00:35:03 -06:00
parent ba5fa2c8b1
commit 8a2c35023f
1 changed files with 11 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

11
docs/api/browser-window.md
View file

@ -176,6 +176,7 @@ It creates a new `BrowserWindow` with native properties as set by the `options`.
* `fullscreenable` Boolean (optional) - Whether the window can be put into fullscreen * `fullscreenable` Boolean (optional) - Whether the window can be put into fullscreen
mode. On macOS, also whether the maximize/zoom button should toggle full mode. On macOS, also whether the maximize/zoom button should toggle full
screen mode or maximize window. Default is `true`. screen mode or maximize window. Default is `true`.
* `simpleFullscreen` Boolean (optional) - Use pre-Lion fullscreen on macOS. Default is `false`.
* `skipTaskbar` Boolean (optional) - Whether to show the window in taskbar. Default is * `skipTaskbar` Boolean (optional) - Whether to show the window in taskbar. Default is
`false`. `false`.
* `kiosk` Boolean (optional) - The kiosk mode. Default is `false`. * `kiosk` Boolean (optional) - The kiosk mode. Default is `false`.
@ -766,6 +767,16 @@ Sets whether the window should be in fullscreen mode.
Returns `Boolean` - Whether the window is in fullscreen mode. Returns `Boolean` - Whether the window is in fullscreen mode.
#### `win.setSimpleFullScreen(flag)` _macOS_
* `flag` Boolean
Sets whether the window should be in simple fullscreen mode.
#### `win.isSimpleFullScreen()` _macOS_
Returns `Boolean` - Whether the window is in simple fullscreen mode.
#### `win.setAspectRatio(aspectRatio[, extraSize])` _macOS_ #### `win.setAspectRatio(aspectRatio[, extraSize])` _macOS_
* `aspectRatio` Float - The aspect ratio to maintain for some portion of the * `aspectRatio` Float - The aspect ratio to maintain for some portion of the