2019-08-26 17:00:46 +00:00
waybar-sway-window(5)
# NAME
waybar - sway window module
# DESCRIPTION
The *window* module displays the title of the currently focused window in Sway
# CONFIGURATION
Addressed by *sway/window*
*format*: ++
typeof: string ++
2022-08-10 20:24:48 +00:00
default: {title} ++
2022-08-11 06:41:10 +00:00
The format, how information should be displayed.
2019-08-26 17:00:46 +00:00
*rotate*: ++
typeof: integer ++
2024-09-08 11:33:52 +00:00
Positive value to rotate the text label (in 90 degree increments).
2019-08-26 17:00:46 +00:00
*max-length*: ++
typeof: integer ++
The maximum length in character the module should display.
2021-02-01 16:34:51 +00:00
*min-length*: ++
2023-07-30 15:33:02 +00:00
typeof: integer ++
2023-10-21 15:45:25 +00:00
The minimum length in characters the module should accept.
2021-02-01 16:34:51 +00:00
*align*: ++
2023-07-30 15:33:02 +00:00
typeof: float ++
2024-03-04 19:00:57 +00:00
The alignment of the label within the module, where 0 is left-aligned and 1 is right-aligned. If the module is rotated, it will follow the flow of the text.
*justify*: ++
typeof: string ++
The alignment of the text within the module's label, allowing options 'left', 'right', or 'center' to define the positioning.
2021-02-01 16:34:51 +00:00
2019-08-26 17:00:46 +00:00
*on-click*: ++
typeof: string ++
Command to execute when clicked on the module.
2019-12-29 04:22:53 +00:00
*on-click-middle*: ++
typeof: string ++
Command to execute when middle-clicked on the module using mousewheel.
2019-08-26 17:00:46 +00:00
*on-click-right*: ++
typeof: string ++
2023-10-21 15:45:25 +00:00
Command to execute when you right-click on the module.
2019-08-26 17:00:46 +00:00
2020-04-12 16:35:41 +00:00
*on-update*: ++
typeof: string ++
Command to execute when the module is updated.
2019-08-26 17:00:46 +00:00
*on-scroll-up*: ++
typeof: string ++
Command to execute when scrolling up on the module.
*on-scroll-down*: ++
typeof: string ++
Command to execute when scrolling down on the module.
*smooth-scrolling-threshold*: ++
typeof: double ++
Threshold to be used when scrolling.
*tooltip*: ++
typeof: bool ++
default: true ++
Option to disable tooltip on hover.
sway-window, Issue 1399: new style classes
Provides CSS classes empty, floating, tabbed, tiled, solo, stacked and
app_id.
Adds offscreen-css bool option (default false), only effective when
"all-outputs" is true. This adds styles on outputs without focused
node, according to its focused workspaces window situation.
Adds an "offscreen-css-text" string option (default empty), only
effective when "all-outputs" and "offscreen-style" are set. This
is shown as a text on outputs without a focused node.
Adds a "show-focused-workspace" bool option (default false) to indicate
the workspace name if the whole workspace is focused when nodes are
also present. If not set, empty text is shown, but css classes
according to nodes in the workspace are still applied.
Limitation:
When the top level layout changes, there is no sway event so the
module cannot react. Perhaps in the future recurring polling can
be added to go around this limitation.
2022-04-17 05:13:35 +00:00
*all-outputs*: ++
typeof: bool ++
default: false ++
Option to show the focused window along with its workspace styles on all outputs.
*offscreen-css*: ++
typeof: bool ++
default: false ++
Only effective when all-outputs is true. Adds style according to present windows on unfocused outputs instead of showing the focused window and style.
*offscreen-css-text*: ++
typeof: string ++
2023-10-21 15:45:25 +00:00
Only effective when both all-outputs and offscreen-style are true. On screens currently not focused, show the given text along with that workspace styles.
sway-window, Issue 1399: new style classes
Provides CSS classes empty, floating, tabbed, tiled, solo, stacked and
app_id.
Adds offscreen-css bool option (default false), only effective when
"all-outputs" is true. This adds styles on outputs without focused
node, according to its focused workspaces window situation.
Adds an "offscreen-css-text" string option (default empty), only
effective when "all-outputs" and "offscreen-style" are set. This
is shown as a text on outputs without a focused node.
Adds a "show-focused-workspace" bool option (default false) to indicate
the workspace name if the whole workspace is focused when nodes are
also present. If not set, empty text is shown, but css classes
according to nodes in the workspace are still applied.
Limitation:
When the top level layout changes, there is no sway event so the
module cannot react. Perhaps in the future recurring polling can
be added to go around this limitation.
2022-04-17 05:13:35 +00:00
*show-focused-workspace-name*: ++
typeof: bool ++
default: false ++
If the workspace itself is focused and the workspace contains nodes or floating_nodes, show the workspace name. If not set, text remains empty but styles according to nodes in the workspace are still applied.
2023-07-05 00:15:59 +00:00
2021-04-21 10:18:33 +00:00
*rewrite*: ++
typeof: object ++
2023-03-25 16:41:09 +00:00
Rules to rewrite the module format output. See *rewrite rules*.
2021-04-21 10:18:33 +00:00
2022-03-07 13:53:53 +00:00
*icon*: ++
typeof: bool ++
2022-03-10 08:49:14 +00:00
default: false ++
2022-03-07 13:53:53 +00:00
Option to hide the application icon.
2022-04-17 21:54:27 +00:00
*icon-size*: ++
typeof: integer ++
default: 24 ++
Option to change the size of the application icon.
2022-08-10 20:24:48 +00:00
# FORMAT REPLACEMENTS
*{title}*: The title of the focused window.
*{app_id}*: The app_id of the focused window.
*{shell}*: The shell of the focused window. It's 'xwayland' when the window is
2023-10-21 15:45:25 +00:00
running through xwayland, otherwise, it's 'xdg-shell'.
2022-08-10 20:24:48 +00:00
2021-04-21 10:18:33 +00:00
# REWRITE RULES
*rewrite* is an object where keys are regular expressions and values are
rewrite rules if the expression matches. Rules may contain references to
captures of the expression.
Regular expression and replacement follow ECMA-script rules.
2023-03-25 16:41:09 +00:00
If no expression matches, the format output is left unchanged.
2021-04-21 10:18:33 +00:00
Invalid expressions (e.g., mismatched parentheses) are skipped.
2019-08-26 17:00:46 +00:00
# EXAMPLES
```
"sway/window": {
2023-07-30 15:33:02 +00:00
"format": "{}",
"max-length": 50,
"rewrite": {
"(.*) - Mozilla Firefox": "🌎 $1",
"(.*) - zsh": "> [$1]"
}
2019-08-26 17:00:46 +00:00
}
```
# STYLE
- *#window*
2023-07-05 00:15:59 +00:00
The following classes are applied to the entire Waybar rather than just the
window widget:
2023-01-13 14:08:59 +00:00
- *window#waybar.empty* When no windows are in the workspace, or screen is not focused and offscreen-css option is not set
sway-window, Issue 1399: new style classes
Provides CSS classes empty, floating, tabbed, tiled, solo, stacked and
app_id.
Adds offscreen-css bool option (default false), only effective when
"all-outputs" is true. This adds styles on outputs without focused
node, according to its focused workspaces window situation.
Adds an "offscreen-css-text" string option (default empty), only
effective when "all-outputs" and "offscreen-style" are set. This
is shown as a text on outputs without a focused node.
Adds a "show-focused-workspace" bool option (default false) to indicate
the workspace name if the whole workspace is focused when nodes are
also present. If not set, empty text is shown, but css classes
according to nodes in the workspace are still applied.
Limitation:
When the top level layout changes, there is no sway event so the
module cannot react. Perhaps in the future recurring polling can
be added to go around this limitation.
2022-04-17 05:13:35 +00:00
- *window#waybar.solo* When one tiled window is in the workspace
- *window#waybar.floating* When there are only floating windows in the workspace
- *window#waybar.stacked* When there is more than one window in the workspace and the workspace layout is stacked
- *window#waybar.tabbed* When there is more than one window in the workspace and the workspace layout is tabbed
- *window#waybar.tiled* When there is more than one window in the workspace and the workspace layout is splith or splitv
2019-08-26 17:00:46 +00:00
- *window#waybar.<app_id>* Where *app_id* is the app_id or *instance* name like (*chromium*) of the only window in the workspace