Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: mark skipTaskbar as unsupported on Linux #33226

Merged
merged 1 commit into from Mar 22, 2022
Merged

docs: mark skipTaskbar as unsupported on Linux #33226

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/api/browser-window.md
View file
Open in desktop
Expand Up @@ -174,8 +174,8 @@ It creates a new `BrowserWindow` with native properties as set by the `options`.
mode. On macOS, also whether the maximize/zoom button should toggle full
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
`false`.
* `skipTaskbar` boolean (optional) _macOS_ _Windows_ - Whether to show the window in taskbar.
Default is `false`.
* `kiosk` boolean (optional) - Whether the window is in kiosk mode. Default is `false`.
* `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.
* `icon` ([NativeImage](native-image.md) | string) (optional) - The window icon. On Windows it is
Expand Down
13 changes: 12 additions & 1 deletion docs/breaking-changes.md
View file
Open in desktop
Expand Up @@ -27,9 +27,20 @@ preload scripts _do_ depend on Node, either refactor them to remove Node usage
from the renderer, or explicitly specify `sandbox: false` for the relevant
renderers.

### Removed: `skipTaskbar` on Linux

See `skipTaskbar` discussion in 19.0 below. This feature is not available on
Wayland. Since most modern Linux desktops are transitioning to Wayland, this
feature will be removed for Linux.

## Planned Breaking API Changes (19.0)

*None (yet)*
### Unsupported: `skipTaskbar` on Linux
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I missed this, but all breaking changes in this document should use one of the types described at the top of the document (API Changed / Behavior Changed / Default Changed / Deprecated / Removed).

What does Unsupported mean?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Followup in #33479


On X11, `skipTaskbar` sends a `_NET_WM_STATE_SKIP_TASKBAR` message to the X11
window manager. There is not a direct equivalent for Wayland, and the known
workarounds have unacceptable tradeoffs (e.g. Window.is_skip_taskbar in GNOME
requires unsafe mode), so Electron is unable to support this feature on Linux.

## Planned Breaking API Changes (18.0)

Expand Down
1 change: 1 addition & 0 deletions shell/browser/native_window_views.cc
View file
Open in desktop
Expand Up @@ -291,6 +291,7 @@ NativeWindowViews::NativeWindowViews(const gin_helper::Dictionary& options,
#endif

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