Module: Tray

Note

This page is auto-generated from man/waybar-tray.5.scd on the master branch. Do not edit it here — changes will be overwritten on the next sync. To update it, edit the man page(s) and open a PR.

DESCRIPTION

WARNING tray is still in beta. There may be bugs. Breaking changes may occur.

CONFIGURATION

Addressed by tray

Option	Typeof	Default	Description
icon-size	integer		Defines the size of the tray icons.
show-passive-items	bool	false	Defines visibility of the tray icons with Passive status.
smooth-scrolling-threshold	double		Threshold to be used when scrolling.
spacing	integer		Defines the spacing between the tray icons.
reverse-direction	bool		Defines if new app icons should be added in a reverse order
on-update	string		Command to execute when the module is updated.
expand	bool	false	Enables this module to consume all left over space dynamically.
icons	object		Per-application icon customization. Keys are application IDs (e.g., "spotify", "blueman"). Values can be: - string: Custom icon name or path to icon file - false: Hide this application's tray icon completely
orders	object		Orders for items to be placed in tray. When not set, orders are controlled by DBus. Key: name of item. Value: integer, higher value means to place this item to the right.

Note: custom icons only work with actual image files, not font-based icons. They might not work for some Electron apps (see https://github.com/electron/electron/issues/40936).

Option	Typeof	Default	Description
ignore-list	array		List of strings used to hide matching tray items. An item is hidden when any string in the list is found (as a substring) in the item's bus name, category, icon name, id or title.

EXAMPLES

"tray": {
	"icon-size": 21,
	"spacing": 10,
	"icons": {
		"blueman": "bluetooth",
		"TelegramDesktop": "$HOME/.local/share/icons/hicolor/16x16/apps/telegram.png",
		"spotify": false
	},
	"orders": {
		"wechat": 99
	}
}

STYLE

• #tray

• #tray menu for the context menu

• #tray widget>image for icons

• #tray > .passive for icons with status Passive

• #tray > .active for icons with status Active

• #tray > .needs-attention for icons with status NeedsAttention

TRAY APPLETS

The following applets are known to work with the tray module:

• NetworkManager: install networkmanager, enable it with systemctl enable NetworkManager.service, and start the applet with nm-applet --indicator.

• Blueman: enable the Bluetooth daemon, install blueman, and start blueman-applet.

• Electron apps: apps like Slack, Telegram, Caprine and Discord should work out of the box.