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.

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

docs: mark skipTaskbar as unsupported on Linux #33226

Merged
merged 1 commit into from Mar 22, 2022

Conversation

ckerr
Copy link
Member

@ckerr ckerr commented Mar 10, 2022

BREAKING CHANGE

Description of Change

Closes #33124.

skipTaskbar has no effect on Wayland. Currently Electron uses _NET_WM_STATE_SKIP_TASKBAR to tell the WM to hide an app from the taskbar, and this works fine on X11 but there's no equivalent mechanism in Wayland. There are some workarounds available on different systems, e.g. GNOME and KWin, but they some unacceptable tradeoffs, e.g. Window.is_skip_taskbar requires unsafe mode.

tl;dr I don't see a way to support this feature on Linux anymore.

This PR updates the documentation to reflect that it's only supported on macOS / Windows and makes an announcement in "breaking changes" (it's broken already, but better to document it here for visibility).

Checklist

Release Notes

Notes: Marked .skipTaskbar as unsupported on Linux.

@electron-cation electron-cation bot added documentation 📓 semver/patch backwards-compatible bug fixes new-pr 🌱 PR opened in the last 24 hours and removed new-pr 🌱 PR opened in the last 24 hours labels Mar 10, 2022
@zcbenz zcbenz requested a review from a team March 21, 2022 23:43
Copy link
Contributor

@jkleinsc jkleinsc left a comment

Choose a reason for hiding this comment

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

Looks good to me.

@zcbenz zcbenz merged commit 0af2b8d into main Mar 22, 2022
@zcbenz zcbenz deleted the docs/mark-skipTaaskbar-as-unsupported-on-Linux branch March 22, 2022 06:12
@release-clerk
Copy link

release-clerk bot commented Mar 22, 2022

Release Notes Persisted

Marked .skipTaskbar as unsupported on 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

bavulapati pushed a commit to bavulapati/electron that referenced this pull request Apr 29, 2022
ckerr added a commit that referenced this pull request Jul 29, 2022
Marked as unsupported in e19, now removed in e20.

See #33226 for more information
trop bot pushed a commit that referenced this pull request Aug 1, 2022
Marked as unsupported in e19, now removed in e20.

See #33226 for more information
VerteDinde added a commit that referenced this pull request Aug 1, 2022
* fix: remove skip-taskbar feature on Linux.

Marked as unsupported in e19, now removed in e20.

See #33226 for more information

* docs: remove skipTaskbar note in browserWindow

Co-authored-by: Charles Kerr <charles@charleskerr.com>
Co-authored-by: Keeley Hammond <khammond@slack-corp.com>
@freddy-daniel
Copy link

Will this affect browserWindow.setSkipTaskbar?

khalwa pushed a commit to solarwindscloud/electron that referenced this pull request Feb 22, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Bug]: skipTaskbar: true ignored
7 participants