waybar/man/waybar-hyprland-workspaces.5.scd

79 lines
1.7 KiB
Plaintext
Raw Normal View History

waybar-hyprland-workspaces(5)
2023-07-01 01:13:36 +02:00
# NAME
waybar - hyprland workspaces module
# DESCRIPTION
The *workspaces* module displays the currently used workspaces in hyprland compositor.
# CONFIGURATION
Addressed by *hyprland/workspaces*
*format*: ++
typeof: string ++
default: {id} ++
The format, how information should be displayed.
*format-icons*: ++
typeof: array ++
Based on the workspace id and state, the corresponding icon gets selected. See *icons*.
2023-07-16 03:02:39 +02:00
*show-special*: ++
typeof: bool ++
default: false ++
If set to true special workspaces will be shown.
*all-outputs*: ++
typeof: bool ++
default: false ++
If set to false workspaces group will be shown only in assigned output. Otherwise all workspace groups are shown.
2023-07-01 01:13:36 +02:00
# FORMAT REPLACEMENTS
*{id}*: id of workspace assigned by compositor
*{name}*: workspace name assigned by compositor
2023-07-01 01:13:36 +02:00
*{icon}*: Icon, as defined in *format-icons*.
# ICONS
Additional to workspace name matching, the following *format-icons* can be set.
- *default*: Will be shown, when no string match is found.
- *active*: Will be shown, when workspace is active
2023-08-14 11:17:49 +02:00
- *special*: Will be shown on non-active special workspaces
- *persistent*: Will be shown on non-active persistent workspaces
2023-07-01 01:13:36 +02:00
# EXAMPLES
```
2023-08-14 11:17:49 +02:00
"hyprland/workspaces": {
2023-07-01 01:13:36 +02:00
"format": "{name}: {icon}",
"format-icons": {
"1": "",
"2": "",
"3": "",
"4": "",
"5": "",
"active": "",
"default": ""
},
2023-08-14 11:17:49 +02:00
"persistent_workspaces": {
"*": 5, // 5 workspaces by default on every monitor
"HDMI-A-1": 3 // but only three on HDMI-A-1
}
2023-07-01 01:13:36 +02:00
}
```
# Style
- *#workspaces*
- *#workspaces button*
- *#workspaces button.active*
2023-08-14 11:17:49 +02:00
- *#workspaces button.persistent*
- *#workspaces button.special*