1waybar-wlr-taskbar(5)         File Formats Manual        waybar-wlr-taskbar(5)
2
3
4

NAME

6       waybar - wlr taskbar module
7

DESCRIPTION

9       The taskbar module displays the currently open applications. This mod‐
10       ule requires a compositor that implements the foreign-toplevel-manager
11       interface.
12

CONFIGURATION

14       Addressed by wlr/taskbar
15
16       all-outputs:
17            typeof: bool
18            default: false
19            If set to false applications on the waybar's current output will
20       be shown. Otherwise all applications are shown.
21
22       format:
23            typeof: string
24            default: {icon}
25            The format, how information should be displayed.
26
27       icon-theme:
28            typeof: array|string
29            The names of the icon-themes that should be used to find an icon.
30       The list will be traversed from left to right. If omitted, the system
31       default will be used.
32
33       icon-size:
34            typeof: integer
35            default: 16
36            The size of the icon.
37
38       markup:
39            typeof: bool
40            default: false
41            If set to true, pango markup will be accepted in format and
42       tooltip-format.
43
44       tooltip:
45            typeof: bool
46            default: true
47            If set to false no tooltip will be shown.
48
49       tooltip-format:
50            typeof: string
51            default: {title}
52            The format, how information in the tooltip should be displayed.
53
54       active-first:
55            typeof: bool
56            default: false
57            If set to true, always reorder the tasks in the taskbar so that
58       the currently active one is first. Otherwise don't reorder.
59
60       sort-by-app-id:
61            typeof: bool
62            default: false
63            If set to true, group tasks by their app_id. Cannot be used with
64       'active-first'.
65
66       on-click:
67            typeof: string
68            The action which should be triggered when clicking on the applica‐
69       tion button with the left mouse button.
70
71       on-click-middle:
72            typeof: string
73            The action which should be triggered when clicking on the applica‐
74       tion button with the middle mouse button.
75
76       on-click-right:
77            typeof: string
78            The action which should be triggered when clicking on the applica‐
79       tion button with the right mouse button.
80
81       on-update:
82            typeof: string
83            Command to execute when the module is updated.
84
85       ignore-list:
86            typeof: array
87            List of app_id/titles to be invisible.
88
89       app_ids-mapping:
90            typeof: object
91            Dictionary of app_id to be replaced with
92
93       rewrite:
94            typeof: object
95            Rules to rewrite the module format output. See rewrite rules.
96

FORMAT REPLACEMENTS

98       {icon}: The icon of the application.
99
100       {name}: The application name as in desktop file if appropriate desktop
101       fils found, otherwise same as {app_id}
102
103       {title}: The title of the application.
104
105       {app_id}: The app_id (== application name) of the application.
106
107       {state}: The state (minimized, maximized, active, fullscreen) of the
108       application.
109
110       {short_state}: The state (minimize == m, maximized == M, active == A,
111       fullscreen == F) represented as one character of the application.
112

CLICK ACTIONS

114       activate: Bring the application into foreground.
115
116       minimize: Toggle application's minimized state.
117
118       minimize-raise: Bring the application into foreground or toggle its
119       minimized state.
120
121       maximize: Toggle application's maximized state.
122
123       fullscreen: Toggle application's fullscreen state.
124
125       close: Close the application.
126

REWRITE RULES

128       rewrite is an object where keys are regular expressions and values are
129       rewrite rules if the expression matches. Rules may contain references
130       to captures of the expression.
131
132       Regular expression and replacement follow ECMA-script rules.
133
134       If no expression matches, the format output is left unchanged.
135
136       Invalid expressions (e.g., mismatched parentheses) are skipped.
137

EXAMPLES

139           "wlr/taskbar": {
140                "format": "{icon}",
141                "icon-size": 14,
142                "icon-theme": "Numix-Circle",
143                "tooltip-format": "{title}",
144                "on-click": "activate",
145                "on-click-middle": "close",
146                "ignore-list": [
147                    "Alacritty"
148                ],
149                "app_ids-mapping": {
150                     "firefoxdeveloperedition": "firefox-developer-edition"
151                },
152                "rewrite": {
153                     "Firefox Web Browser": "Firefox",
154                     "Foot Server": "Terminal"
155                }
156           }
157

Style

159       •   #taskbar
160       •   #taskbar button
161       •   #taskbar button.maximized
162       •   #taskbar button.minimized
163       •   #taskbar button.active
164       •   #taskbar button.fullscreen
165
166
167
168                                  2023-08-16             waybar-wlr-taskbar(5)