doc/user/modules/tray.rst
.. include:: defs.rst
.. poly-setting:: type = internal/tray
.. versionadded:: 3.7.0
The tray module displays system tray application icons on the bar.
This module is a bit different from the other modules. The tray icons (also called clients) are individual windows managed by their respective application (e.g. the Dropbox tray icon is created and managed by the Dropbox application). Polybar is only responsible for embedding the windows in the bar and positioning them correctly.
.. attention::
Only a single instance of this module can be active at the same time (across all polybar instances in the same graphical session).
The way the system tray protocol <systray-spec_>_ works, at most one tray
can exist at any time.
Polybar will produce a warning if additional tray instances are created.
This also applies when another tray application (e.g. stalonetray) is
active.
For transparent background colors, the tray will use pseudo-transparency, true transparency is not possible for the tray icons.
The module only has a single format:
.. poly-setting:: format
:type: |type-format|
:tags: <tray>: Shows tray icons
:default: <tray>
.. poly-setting:: tray-spacing
Space added between tray icons
:type: |type-extent|, non-negative
:default: 0px
.. poly-setting:: tray-padding
Space added before and after each tray icon
:type: |type-extent|, non-negative
:default: 0px
.. poly-setting:: tray-size
Size of individual tray icons
:type: |type-pwo|, relative to bar height, non-negative :default: 66%
.. poly-setting:: tray-background
Background color of tray icons
.. note::
This only affects the color of the individual icons and not the space in
between, changing this setting to anything else than the bar background
will likely not look good unless the background color is also changed for
the rest of the tray module (e.g. with format-background).
:type: |type-color|
:default: ${root.background}
.. poly-setting:: tray-foreground
Tray icon color
This serves as a hint to the tray icon application for which color to use for the icon.
This is not guaranteed to have any effect (likely only in GTK3) because it
targets a non-standard part of the system tray protocol <systray-spec_>_ by
setting the _NET_SYSTEM_TRAY_COLORS atom on the tray window.
:type: |type-color|
:default: ${tray-foreground}
::
[module/tray] type = internal/tray
format-margin = 8px tray-spacing = 8px
.. include:: /migration/3.7/tray.rst
System Tray Protocol Specification <systray-spec_>_XEmbed Protocol Specification <xembed_>_.. _systray-spec: https://specifications.freedesktop.org/systemtray-spec/systemtray-spec-latest.html .. _xembed: https://specifications.freedesktop.org/xembed-spec/xembed-spec-latest.html