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

Merge pull request #8156 from sindresorhus/remove-dock-window-level

Browse source 
🍎 Document that the `dock` window level is deprecated
This commit is contained in:
Kevin Sawicki 2016-12-12 09:39:08 -08:00 committed by GitHub
commit 2fa9ca1f6d
3 changed files with 3 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
atom/browser/native_window_mac.mm
View file

@ -1073,6 +1073,7 @@ void NativeWindowMac::SetAlwaysOnTop(bool top, const std::string& level) {
} else if (level == "screen-saver") { } else if (level == "screen-saver") {
windowLevel = NSScreenSaverWindowLevel; windowLevel = NSScreenSaverWindowLevel;
} else if (level == "dock") { } else if (level == "dock") {
// Deprecated by macOS, but kept for backwards compatibility
windowLevel = NSDockWindowLevel; windowLevel = NSDockWindowLevel;
} }
} }

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

@ -833,7 +833,7 @@ On Linux always returns `true`.
* `flag` Boolean * `flag` Boolean
* `level` String (optional) _macOS_ - Values include `normal`, `floating`, * `level` String (optional) _macOS_ - Values include `normal`, `floating`,
`torn-off-menu`, `modal-panel`, `main-menu`, `status`, `pop-up-menu`, `torn-off-menu`, `modal-panel`, `main-menu`, `status`, `pop-up-menu`,
`screen-saver`, and `dock`. The default is `floating`. See the `screen-saver`, and ~~`dock`~~ (Deprecated). The default is `floating`. See the
[macOS docs][window-levels] for more details. [macOS docs][window-levels] for more details.
Sets whether the window should show always on top of other windows. After Sets whether the window should show always on top of other windows. After

2
spec/api-browser-window-spec.js
View file

@ -494,7 +494,7 @@ describe('BrowserWindow module', function () {
describe('BrowserWindow.setAlwaysOnTop(flag, level)', function () { describe('BrowserWindow.setAlwaysOnTop(flag, level)', function () {
it('sets the window as always on top', function () { it('sets the window as always on top', function () {
assert.equal(w.isAlwaysOnTop(), false) assert.equal(w.isAlwaysOnTop(), false)
w.setAlwaysOnTop(true, 'dock') w.setAlwaysOnTop(true, 'screen-saver')
assert.equal(w.isAlwaysOnTop(), true) assert.equal(w.isAlwaysOnTop(), true)
w.setAlwaysOnTop(false) w.setAlwaysOnTop(false)
assert.equal(w.isAlwaysOnTop(), false) assert.equal(w.isAlwaysOnTop(), false)