Waybar/man/waybar-sway-workspaces.5.scd

189 lines
5.6 KiB
Plaintext
Raw Normal View History

2019-08-26 17:08:06 +00:00
waybar-sway-workspaces(5)
# NAME
waybar - sway workspaces module
# DESCRIPTION
The *workspaces* module displays the currently used workspaces in Sway.
# CONFIGURATION
Addressed by *sway/workspaces*
*all-outputs*: ++
typeof: bool ++
default: false ++
If set to false, workspaces will only be shown on the output they are on. If set to true all workspaces will be shown on every output.
2019-08-26 17:08:06 +00:00
*format*: ++
typeof: string ++
default: {value} ++
The format, how information should be displayed.
2019-08-26 17:08:06 +00:00
*format-icons*: ++
typeof: array ++
Based on the workspace name and state, the corresponding icon gets selected. See *icons*.
2019-08-26 17:08:06 +00:00
*disable-scroll*: ++
typeof: bool ++
default: false ++
If set to false, you can scroll to cycle through workspaces. If set to true this behaviour is disabled.
2019-08-26 17:08:06 +00:00
*disable-click*: ++
typeof: bool ++
default: false ++
If set to false, you can click to change workspace. If set to true this behaviour is disabled.
2019-08-26 17:08:06 +00:00
*smooth-scrolling-threshold*: ++
typeof: double ++
Threshold to be used when scrolling.
2019-08-26 17:08:06 +00:00
*disable-scroll-wraparound*: ++
typeof: bool ++
default: false ++
If set to false, scrolling on the workspace indicator will wrap around to the first workspace when reading the end, and vice versa. If set to true this behavior is disabled.
2019-08-26 17:08:06 +00:00
*enable-bar-scroll*: ++
typeof: bool ++
default: false ++
If set to false, you can't scroll to cycle throughout workspaces from the entire bar. If set to true this behaviour is enabled.
2019-08-26 17:08:06 +00:00
*disable-markup*: ++
typeof: bool ++
default: false ++
If set to true, button label will escape pango markup.
2019-08-26 17:08:06 +00:00
*current-only*: ++
typeof: bool ++
default: false ++
If set to true. Only focused workspaces will be shown.
2019-08-26 17:08:06 +00:00
*persistent-workspaces*: ++
typeof: json (see below) ++
default: empty ++
Lists workspaces that should always be shown, even when non-existent
2019-08-26 17:08:06 +00:00
2020-04-12 16:35:41 +00:00
*on-update*: ++
typeof: string ++
Command to execute when the module is updated.
2020-04-12 16:35:41 +00:00
*disable-auto-back-and-forth*: ++
typeof: bool ++
Whether to disable *workspace_auto_back_and_forth* when clicking on workspaces. If this is set to *true*, clicking on a workspace you are already on won't do anything, even if *workspace_auto_back_and_forth* is enabled in the Sway configuration.
*alphabetical_sort*: ++
typeof: bool ++
Whether to sort workspaces alphabetically. Please note this can make "swaymsg workspace prev/next" move to workspaces inconsistent with the ordering shown in Waybar.
2023-06-07 13:25:59 +00:00
warp-on-scroll: ++
typeof: bool ++
default: true ++
If set to false, you can scroll to cycle through workspaces without mouse warping being enabled. If set to true this behaviour is disabled.
2023-06-07 13:25:59 +00:00
*window-rewrite*: ++
typeof: object ++
Regex rules to map window class to an icon or preferred method of representation for a workspace's window.
Keys are the rules, while the values are the methods of representation.
Rules may specify `class<...>`, `title<...>`, or both in order to fine-tune the matching.
*window-rewrite-default*:
typeof: string ++
default: "?" ++
The default method of representation for a workspace's window. This will be used for windows whose classes do not match any of the rules in *window-rewrite*.
*format-window-separator*: ++
typeof: string ++
default: " " ++
The separator to be used between windows in a workspace.
2019-08-26 17:08:06 +00:00
# FORMAT REPLACEMENTS
*{value}*: Name of the workspace, as defined by sway.
*{name}*: Number stripped from workspace value.
2019-08-26 17:08:06 +00:00
*{icon}*: Icon, as defined in *format-icons*.
*{index}*: Index of the workspace.
*{output}*: Output where the workspace is located.
*{windows}*: Result from window-rewrite
2019-08-26 17:08:06 +00:00
# ICONS
Additional to workspace name matching, the following *format-icons* can be set.
- *default*: Will be shown, when no string matches are found.
2019-08-26 17:08:06 +00:00
- *urgent*: Will be shown, when workspace is flagged as urgent
- *focused*: Will be shown, when workspace is focused
- *persistent*: Will be shown, when workspace is persistent.
- *high-priority-named*: Icons by names will be shown always for those workspaces, independent by state.
2019-08-26 17:08:06 +00:00
2019-08-31 17:57:44 +00:00
# PERSISTENT WORKSPACES
2019-08-26 17:08:06 +00:00
2019-08-31 17:57:44 +00:00
Each entry of *persistent_workspace* names a workspace that should always be shown.
2019-08-26 17:08:06 +00:00
Associated with that value is a list of outputs indicating *where* the workspace should be shown,
an empty list denoting all outputs.
```
"sway/workspaces": {
"persistent-workspaces": {
"3": [], // Always show a workspace with name '3', on all outputs if it does not exist
"4": ["eDP-1"], // Always show a workspace with name '4', on output 'eDP-1' if it does not exist
"5": ["eDP-1", "DP-2"] // Always show a workspace with name '5', on outputs 'eDP-1' and 'DP-2' if it does not exist
}
2019-08-26 17:08:06 +00:00
}
```
n.b.: the list of outputs can be obtained from command line using *swaymsg -t get_outputs*
# EXAMPLES
```
"sway/workspaces": {
"disable-scroll": true,
"all-outputs": true,
"format": "{name}: {icon}",
"format-icons": {
"1": "",
"2": "",
"3": "",
"4": "",
"5": "",
2023-07-20 19:56:15 +00:00
"high-priority-named": [ "1", "2" ],
"urgent": "",
"focused": "",
"default": ""
}
2019-08-26 17:08:06 +00:00
}
```
```
"sway/workspaces": {
"format": "<span size='larger'>{name}</span> {windows}",
"format-window-separator": " | ",
"window-rewrite-default": "{name}",
"window-format": "<span color='#e0e0e0'>{name}</span>",
"window-rewrite": {
"class<firefox>": "",
"class<kitty>": "k",
2024-06-05 18:16:30 +00:00
"title<.* - (.*) - VSCodium>": "codium $1" // captures part of the window title and formats it into output
}
}
```
2019-08-26 17:08:06 +00:00
# Style
- *#workspaces button*
- *#workspaces button.visible*
- *#workspaces button.focused*
- *#workspaces button.urgent*
2019-08-31 17:57:44 +00:00
- *#workspaces button.persistent*
2024-03-20 02:56:19 +00:00
- *#workspaces button.empty*
- *#workspaces button.current_output*
2020-08-13 19:11:55 +00:00
- *#workspaces button#sway-workspace-${name}*