Skip to content

Commit 0af2b8d

Browse files
authored
docs: mark skipTaskbar as unsupported on Linux (electron#33226)
Fixes electron#33124.
1 parent f511263 commit 0af2b8d

File tree

3 files changed

+15
-3
lines changed

3 files changed

+15
-3
lines changed

docs/api/browser-window.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -186,8 +186,8 @@ It creates a new `BrowserWindow` with native properties as set by the `options`.
186186
mode. On macOS, also whether the maximize/zoom button should toggle full
187187
screen mode or maximize window. Default is `true`.
188188
* `simpleFullscreen` boolean (optional) - Use pre-Lion fullscreen on macOS. Default is `false`.
189-
* `skipTaskbar` boolean (optional) - Whether to show the window in taskbar. Default is
190-
`false`.
189+
* `skipTaskbar` boolean (optional) _macOS_ _Windows_ - Whether to show the window in taskbar.
190+
Default is `false`.
191191
* `kiosk` boolean (optional) - Whether the window is in kiosk mode. Default is `false`.
192192
* `title` string (optional) - Default window title. Default is `"Electron"`. If the HTML tag `<title>` is defined in the HTML file loaded by `loadURL()`, this property will be ignored.
193193
* `icon` ([NativeImage](native-image.md) | string) (optional) - The window icon. On Windows it is

docs/breaking-changes.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,9 +27,20 @@ preload scripts _do_ depend on Node, either refactor them to remove Node usage
2727
from the renderer, or explicitly specify `sandbox: false` for the relevant
2828
renderers.
2929

30+
### Removed: `skipTaskbar` on Linux
31+
32+
See `skipTaskbar` discussion in 19.0 below. This feature is not available on
33+
Wayland. Since most modern Linux desktops are transitioning to Wayland, this
34+
feature will be removed for Linux.
35+
3036
## Planned Breaking API Changes (19.0)
3137

32-
*None (yet)*
38+
### Unsupported: `skipTaskbar` on Linux
39+
40+
On X11, `skipTaskbar` sends a `_NET_WM_STATE_SKIP_TASKBAR` message to the X11
41+
window manager. There is not a direct equivalent for Wayland, and the known
42+
workarounds have unacceptable tradeoffs (e.g. Window.is_skip_taskbar in GNOME
43+
requires unsafe mode), so Electron is unable to support this feature on Linux.
3344

3445
## Planned Breaking API Changes (18.0)
3546

shell/browser/native_window_views.cc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -291,6 +291,7 @@ NativeWindowViews::NativeWindowViews(const gin_helper::Dictionary& options,
291291
#endif
292292

293293
#if defined(USE_X11)
294+
// TODO(ckerr): remove in Electron v20.0.0
294295
// Before the window is mapped the SetWMSpecState can not work, so we have
295296
// to manually set the _NET_WM_STATE.
296297
std::vector<x11::Atom> state_atom_list;

0 commit comments

Comments
 (0)