maximizable, fullscreenable docs

This commit is contained in:
evgenyzinoviev 2016-01-22 23:31:59 +01:00
parent ef51e4e108
commit 3182504969

View file

@ -51,6 +51,8 @@ It creates a new `BrowserWindow` with native properties as set by the `options`.
on Linux. Default is `true`.
* `minimizable` Boolean - Whether window is minimizable. This is not
implemented on Linux. Default is `true`.
* `maximizable` Boolean - Whether window is maximizable. This is not
implemented on Linux. Default is `true`.
* `closable` Boolean - Whether window is closable. This is not implemented
on Linux. Default is `true`.
* `alwaysOnTop` Boolean - Whether the window should always stay on top of
@ -59,6 +61,8 @@ It creates a new `BrowserWindow` with native properties as set by the `options`.
explicity set to `false` the fullscreen button will be hidden or disabled
on OS X, or the maximize button will be disabled on Windows. Default is
`false`.
* `fullscreenable` Boolean - Whether the maximize/zoom button on OS X should
toggle full screen mode or maximize window. Default is `true`.
* `skipTaskbar` Boolean - Whether to show the window in taskbar. Default is
`false`.
* `kiosk` Boolean - The kiosk mode. Default is `false`.
@ -551,6 +555,30 @@ nothing.
Returns whether the window can be manually minimized by user. On Linux always
returns `true`.
### `win.setMaximizable(maximizable)` _OS X_ _Windows_
* `maximizable` Boolean
Sets whether the window can be manually maximized by user. On Linux does
nothing.
### `win.isMaximizable()` _OS X_ _Windows_
Returns whether the window can be manually maximized by user. On Linux always
returns `true`.
### `win.setFullscreenable(fullscreenable)` _OS X_
* `fullscreenable` Boolean
Sets whether the maximize/zoom window button toggles fullscreen mode or
maximizes the window. On Windows and Linux does nothing.
### `win.isFullscreenable()` _OS X_
Returns whether the maximize/zoom window button toggles fullscreen mode or
maximizes the window. On Windows and Linux always returns `true`.
### `win.setClosable(closable)` _OS X_ _Windows_
* `closable` Boolean