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

Support the "desktop" window type on Mac OS X

Browse source 
Adds the desktop window type referenced in https://github.com/atom/electron/issues/2899 for compatiblity with the linux version. Note that on Mac OS X, the desktop window cannot receive input events (seems to be a limitation of being behind the desktop).

In this diff I also removed the `standardWindow` option from the docs, in favor of an additional `textured` value for window `type` on Mac OS X. The old `standardWindow` option continues to work, but seemed more confusing. If this seems like a bad idea, I can revert that change.
This commit is contained in:
Ben Gotow 2015-11-19 00:39:45 -08:00
parent 52e34ca0f9
commit d427ae1030
2 changed files with 43 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -66,11 +66,14 @@ It creates a new `BrowserWindow` with native properties as set by the `options`.
* `darkTheme` Boolean - Forces using dark theme for the window, only works on
some GTK+3 desktop environments.
* `transparent` Boolean - Makes the window [transparent](frameless-window.md).
* `type` String - Specifies the type of the window, possible types are
`desktop`, `dock`, `toolbar`, `splash`, `notification`. This only works on
Linux.
* `standardWindow` Boolean - Uses the OS X's standard window instead of the
textured window. Defaults to `true`.
* `type` String - Specifies the type of the window, which applies
additional platform-specific properties.
- On Linux, possible types are `desktop`, `dock`, `toolbar`, `splash`, `notification`.
- On Mac OS X:
- `textured`: Adds metal gradient appearance (NSTexturedBackgroundWindowMask)
- `desktop`: Places the window at the desktop background window level (kCGDesktopWindowLevel - 1).
Note that the window will not receive focus, keyboard or mouse events, but
you can use `globalShortcut` to receive input sparingly.
* `titleBarStyle` String, OS X - specifies the style of window title bar.
This option is supported on OS X 10.10 Yosemite and newer. There are three
possible values:
@ -86,11 +89,11 @@ It creates a new `BrowserWindow` with native properties as set by the `options`.
is `true`.
* `preload` String - Specifies a script that will be loaded before other
scripts run in the page. This script will always have access to node APIs
no matter whether node integration is turned on or off. The value should
no matter whether node integration is turned on or off. The value should
be the absolute file path to the script.
When node integration is turned off, the preload script can reintroduce
Node global symbols back to the global scope. See example
When node integration is turned off, the preload script can reintroduce
Node global symbols back to the global scope. See example
[here](process.md#event-loaded).
* `partition` String - Sets the session used by the page. If `partition`
starts with `persist:`, the page will use a persistent session available to