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

NAME

6       waybar - wlr workspaces module
7

DESCRIPTION

9       The workspaces module displays the currently used workspaces in wayland
10       compositor.
11

CONFIGURATION

13       Addressed by wlr/workspaces
14
15       format:
16            typeof: string
17            default: {name}
18            The format, how information should be displayed.
19
20       format-icons:
21            typeof: array
22            Based on the workspace name and state, the corresponding icon gets
23       selected. See icons.
24
25       sort-by-name:
26            typeof: bool
27            default: true
28            Should workspaces be sorted by name.
29
30       sort-by-coordinates:
31            typeof: bool
32            default: true
33            Should workspaces be sorted by coordinates.
34           Note that if both  sort-by-name and sort-by-coordinates are true
35           sort by name will be first. If both are false - sort by id will be
36           performed.
37
38       all-outputs:
39            typeof: bool
40            default: false
41            If set to false workspaces group will be shown only in assigned
42       output. Otherwise all workspace groups are shown.
43
44       active-only:
45            typeof: bool
46            default: false
47            If set to true only active or urgent workspaces will be shown.
48

FORMAT REPLACEMENTS

50       {name}: Name of workspace assigned by compositor
51
52       {icon}: Icon, as defined in format-icons.
53

CLICK ACTIONS

55       activate: Switch to workspace.
56
57       close: Close the workspace.
58

ICONS

60       Additional to workspace name matching, the following format-icons can
61       be set.
62
63       •   default: Will be shown, when no string match is found.
64       •   focused: Will be shown, when workspace is focused
65
66

EXAMPLES

68           "wlr/workspaces": {
69                "format": "{name}: {icon}",
70                "format-icons": {
71                     "1": "",
72                     "2": "",
73                     "3": "",
74                     "4": "",
75                     "5": "",
76                     "focused": "",
77                     "default": ""
78                }
79           }
80

Style

82       •   #workspaces
83       •   #workspaces button
84       •   #workspaces button.active
85       •   #workspaces button.urgent
86       •   #workspaces button.hidden
87
88
89
90                                  2022-05-23          waybar-wlr-workspaces(5)