1waybar-sway-workspaces(5) File Formats Manual waybar-sway-workspaces(5)
2
6 waybar - sway workspaces module
7
9 The workspaces module displays the currently used workspaces in Sway.
10
12 Addressed by sway/workspaces
13 all-outputs:
15 typeof: bool
16 default: false
17 If set to false, workspaces will only be shown on the output they
18 are on. If set to true all workspaces will be shown on every output.
19 format:
21 typeof: string
22 default: {value}
23 The format, how information should be displayed.
24 format-icons:
26 typeof: array
27 Based on the workspace name and state, the corresponding icon gets
28 selected. See icons.
29 disable-scroll:
31 typeof: bool
32 default: false
33 If set to false, you can scroll to cycle through workspaces. If set
34 to true this behaviour is disabled.
35 smooth-scrolling-threshold:
37 typeof: double
38 Threshold to be used when scrolling.
39 disable-scroll-wraparound:
41 typeof: bool
42 default: false
43 If set to false, scrolling on the workspace indicator will wrap
44 around to the first workspace when reading the end, and vice versa. If
45 set to true this behavior is disabled.
46 enable-bar-scroll:
48 typeof: bool
49 default: false
50 If set to false, you can't scroll to cycle throughout workspaces
51 from the entire bar. If set to true this behaviour is enabled.
52 disable-markup:
54 typeof: bool
55 default: false
56 If set to true, button label will escape pango markup.
57 current-only:
59 typeof: bool
60 default: false
61 If set to true. Only focused workspaces will be shown.
62 persistent_workspaces:
64 typeof: json (see below)
65 default: empty
66 Lists workspaces that should always be shown, even when non exis‐
67 tent
68
70 {value}: Name of the workspace, as defined by sway.
71 {name}: Number stripped from workspace value.
73 {icon}: Icon, as defined in format-icons.
75 {index}: Index of the workspace.
77
79 Additional to workspace name matching, the following format-icons can
80 be set.
81 · default: Will be shown, when no string matches is found.
83 · urgent: Will be shown, when workspace is flagged as urgent
84 · focused: Will be shown, when workspace is focused
85 · persistent: Will be shown, when workspace is persistent one.
86
89 Each entry of persistent_workspace names a workspace that should always
90 be shown. Associated with that value is a list of outputs indicating
91 where the workspace should be shown, an empty list denoting all out‐
92 puts.
93 "sway/workspaces": {
95 "persistent_workspaces": {
96 "3": [], // Always show a workspace with name '3', on all outputs if it does not exists
97 "4": ["eDP-1"], // Always show a workspace with name '4', on output 'eDP-1' if it does not exists
98 "5": ["eDP-1", "DP-2"] // Always show a workspace with name '5', on outputs 'eDP-1' and 'DP-2' if it does not exists
99 }
100 }
101 n.b.: the list of outputs can be obtained from command line using
103 swaymsg -t get_outputs
104
106 "sway/workspaces": {
107 "disable-scroll": true,
108 "all-outputs": true,
109 "format": "{name}: {icon}",
110 "format-icons": {
111 "1": "",
112 "2": "",
113 "3": "",
114 "4": "",
115 "5": "",
116 "urgent": "",
117 "focused": "",
118 "default": ""
119 }
120 }
121
123 · #workspaces button
124 · #workspaces button.visible
125 · #workspaces button.focused
126 · #workspaces button.urgent
127 · #workspaces button.persistent
128 2020-04-11 waybar-sway-workspaces(5)