summaryrefslogtreecommitdiff
path: root/qutebrowser/config/configdata.yml
diff options
context:
space:
mode:
authorFlorian Bruhin <me@the-compiler.org>2021-03-27 11:39:36 +0100
committerFlorian Bruhin <me@the-compiler.org>2021-03-27 15:35:25 +0100
commit12bcca9c479c7ea57f17bffb48bc71897e79a8e5 (patch)
tree9ad00aa2ffbe3f07606b659bf6c3b33b2e51fc35 /qutebrowser/config/configdata.yml
parentc7c9ed47e70020def51332130b9ca449dbad94cc (diff)
downloadqutebrowser-12bcca9c479c7ea57f17bffb48bc71897e79a8e5.tar.gz
qutebrowser-12bcca9c479c7ea57f17bffb48bc71897e79a8e5.zip
notifications: Update docs
Diffstat (limited to 'qutebrowser/config/configdata.yml')
-rw-r--r--qutebrowser/config/configdata.yml37
1 files changed, 24 insertions, 13 deletions
diff --git a/qutebrowser/config/configdata.yml b/qutebrowser/config/configdata.yml
index dc570a2ec..c417ffdd4 100644
--- a/qutebrowser/config/configdata.yml
+++ b/qutebrowser/config/configdata.yml
@@ -917,27 +917,38 @@ content.notifications.presenter:
type:
name: String
valid_values:
- - auto: Use a libnotify-compatible presenter if DBus is available, silently fall
- back to Qt's presenter otherwise.
- - qt: Use Qt's native notification presenter. Switching from or to this value
- requires a restart of qutebrowser.
- - libnotify: Use a libnotify-compatible presenter if DBus is available, show an
- error (and fall back to Qt's presenter) otherwise.
- - systray: Use a notification presenter based on a systray icon. This is a
+ - auto: Tries `libnotify`, `systray` and `messages`, uses the first one available
+ without showing error messages.
+ - qt: Use Qt's native notification presenter, based on a system tray icon.
+ Switching from or to this value requires a restart of qutebrowser.
+ Recommended over `systray` on PyQt 5.14.
+ - libnotify: Shows messages via DBus in a libnotify-compatible way. If DBus isn't
+ available, falls back to `systray` or `messages`, but shows an error
+ message.
+ - systray: Use a notification presenter based on a systray icon. Falls back to
+ `libnotify` or `messages` if not systray is available. This is a
reimplementation of the `qt` setting value, but with the possibility to
switch to it at runtime.
- - messages: Show notifications as qutebrowser messages. Most features (images,
- clicking/closing notifications) aren't available.
- - herbe: Show notifications using herbe (github.com/dudik/herbe)
+ - messages: Show notifications as qutebrowser messages. Most notification features
+ aren't available.
+ - herbe: (experimental!) Show notifications using herbe (github.com/dudik/herbe). Most
+ notification features aren't available.
backend:
QtWebEngine: Qt 5.14
QtWebKit: false
desc: >-
What notification presenter to use for web notifications.
- Note that with Qt 5.14, certain JavaScript features for notifications will not work
- with the libnotify notification presenter (the `click` and `close` events, as well
- as the `tag` option to replace existing notifications).
+ Note that not all implementations support all features of notifications:
+
+ - With PyQt 5.14, any setting other than `qt` does not support the `click` and
+ `close` events, as well as the `tag` option to replace existing notifications.
+ - The `qt` and `systray` options only support showing one notification at the time
+ and ignore the `tag` option to replace existing notifications.
+ - The `herbe` option only supports showing one notification at the time and doesn't
+ show icons.
+ - The `messages` option doesn't show icons and doesn't support the `click` and
+ `close` events.
content.pdfjs:
default: false