Skip to content

Commit 1a754e5

Browse files
aripollakbbhtt
authored andcommitted
Clarify a couple of Electron instructions
* Add note that WaylandWindowDecorations is not needed after Electron 27 (electron/electron@33000c4) * Clarify where the correct desktop filename is needed for setProgressBar/setBadgeCount
1 parent 267584f commit 1a754e5

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

docs/electron.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -141,8 +141,8 @@ should be used in manifest and Wayland can be tested with::
141141
To make native wayland the `default` for users ``--socket=fallback-x11``
142142
and ``--socket=wayland`` must be used in the manifest.
143143

144-
Client-side window decorations in native wayland can be enabled by
145-
passing ``--enable-features=WaylandWindowDecorations`` (Electron>=17).
144+
For Electron versions between 17 and 27, client-side window decorations in native wayland can be enabled by
145+
passing ``--enable-features=WaylandWindowDecorations``.
146146

147147
Electron uses ``libnotify`` on Linux to provide desktop notifications.
148148
libnotify `since 0.8.0 <https://gitlab.gnome.org/GNOME/libnotify/-/merge_requests/27>`_
@@ -308,4 +308,4 @@ Make setProgressBar and setBadgeCount work
308308
The `setProgressBar <https://www.electronjs.org/docs/latest/api/browser-window#winsetprogressbarprogress-options>`_ and `setBadgeCount <https://www.electronjs.org/docs/latest/api/app#appsetbadgecountcount-linux-macos>`_ functions allow showing a progress bar and a badge count in the window icon. It is implemented under Linux using the `UnityLauncherAPI <https://wiki.ubuntu.com/Unity/LauncherAPI>`_. This API is not implemented on every desktop environment. A known desktop environment which implements this is KDE.
309309
It is also implemented by the popular `Dash to Dock <https://micheleg.github.io/dash-to-dock>`_ GNOME extension and `Plank <https://launchpad.net/plank>`_.
310310

311-
To make it work in Flatpak, the app needs to :ref:`use the correct desktop filename <use-correct-desktop-filename>`. The Flatpak also needs the ``--talk-name=com.canonical.Unity`` permission. Electron versions earlier than v32 checks `checks if it's running on Unity or KDE <https://github.com/electron/electron/blob/fb88375ab4d2161dbf7e958a2a94c7c6d97dc84c/shell/browser/linux/unity_service.cc#L64>`_ before using the UnityLauncherAPI.
311+
To make it work in Flatpak, the app needs to :ref:`use the correct desktop filename <use-correct-desktop-filename>` in its embedded `package.json` file. The Flatpak also needs the ``--talk-name=com.canonical.Unity`` permission. Electron versions earlier than v32 checks `checks if it's running on Unity or KDE <https://github.com/electron/electron/blob/fb88375ab4d2161dbf7e958a2a94c7c6d97dc84c/shell/browser/linux/unity_service.cc#L64>`_ before using the UnityLauncherAPI.

0 commit comments

Comments
 (0)