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 per‐
36       formed.
37
38       sort-by-number:
39            typeof: bool
40            default: false
41            If set to true, workspace names will be sorted numerically. Takes
42       presedence over any other sort-by option.
43
44       all-outputs:
45            typeof: bool
46            default: false
47            If set to false workspaces group will be shown only in assigned
48       output. Otherwise all workspace groups are shown.
49
50       active-only:
51            typeof: bool
52            default: false
53            If set to true only active or urgent workspaces will be shown.
54

FORMAT REPLACEMENTS

56       {name}: Name of workspace assigned by compositor
57
58       {icon}: Icon, as defined in format-icons.
59

CLICK ACTIONS

61       activate: Switch to workspace.
62
63       close: Close the workspace.
64

ICONS

66       Additional to workspace name matching, the following format-icons can
67       be set.
68
69       •   default: Will be shown, when no string match is found.
70       •   active: Will be shown, when workspace is active
71
72

EXAMPLES

74           "wlr/workspaces": {
75                "format": "{name}: {icon}",
76                "format-icons": {
77                     "1": "",
78                     "2": "",
79                     "3": "",
80                     "4": "",
81                     "5": "",
82                     "active": "",
83                     "default": ""
84                },
85                "sort-by-number": true
86           }
87

Style

89       •   #workspaces
90       •   #workspaces button
91       •   #workspaces button.active
92       •   #workspaces button.urgent
93       •   #workspaces button.hidden
94
95
96
97                                  2023-08-16          waybar-wlr-workspaces(5)
Impressum