AlexandClaude Opus 4.8
a3b39cfcf6
Port information that previously lived only in the GitHub wiki into the authoritative scdoc man pages, so the man pages become the single source of truth for module documentation. 33 man pages enriched (options, format replacements, actions, style selectors, troubleshooting and implementation notes). Additions were verified against the source; stale/incorrect wiki entries were deliberately not ported. All pages still compile with scdoc. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
108 lines
2.9 KiB
Scdoc
108 lines
2.9 KiB
Scdoc
waybar-hyprland-window(5)
|
|
|
|
# NAME
|
|
|
|
waybar - hyprland window module
|
|
|
|
# DESCRIPTION
|
|
|
|
The *window* module displays the title of the currently focused window in Hyprland.
|
|
|
|
# CONFIGURATION
|
|
|
|
Addressed by *hyprland/window*
|
|
|
|
*format*: ++
|
|
typeof: string ++
|
|
default: {title} ++
|
|
The format, how information should be displayed. On {} the current window title is displayed.
|
|
|
|
*max-length*: ++
|
|
typeof: integer ++
|
|
The maximum length in character the module should display.
|
|
|
|
*rewrite*: ++
|
|
typeof: object ++
|
|
Rules to rewrite window title. See *rewrite rules*.
|
|
|
|
*separate-outputs*: ++
|
|
typeof: bool ++
|
|
Show the active window of the monitor the bar belongs to, instead of the focused window.
|
|
|
|
*fallback*: ++
|
|
typeof: string ++
|
|
Text to display when the focused window title is empty (for example when no window is focused).
|
|
|
|
*tooltip-format*: ++
|
|
typeof: string ++
|
|
The format of the tooltip shown on hover. Supports the same replacements as *format*. Requires *tooltip* to be enabled. When unset, the tooltip falls back to the formatted label text. ++
|
|
default: (the formatted label text)
|
|
|
|
*icon*: ++
|
|
typeof: bool ++
|
|
default: false ++
|
|
Option to hide the application icon.
|
|
|
|
*icon-size*: ++
|
|
typeof: integer ++
|
|
default: 24 ++
|
|
Option to change the size of the application icon.
|
|
|
|
*expand*: ++
|
|
typeof: bool ++
|
|
default: false ++
|
|
Enables this module to consume all left over space dynamically.
|
|
|
|
# FORMAT REPLACEMENTS
|
|
See the output of "hyprctl clients" for examples
|
|
|
|
*{title}*: The current title of the focused window.
|
|
|
|
*{initialTitle}*: The initial title of the focused window.
|
|
|
|
*{class}*: The current class of the focused window.
|
|
|
|
*{initialClass}*: The initial class of the focused window.
|
|
|
|
# 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.
|
|
|
|
If no expression matches, the title is left unchanged.
|
|
|
|
Invalid expressions (e.g., mismatched parentheses) are skipped.
|
|
|
|
# EXAMPLES
|
|
|
|
```
|
|
"hyprland/window": {
|
|
"format": "{}",
|
|
"rewrite": {
|
|
"(.*) - Mozilla Firefox": "🌎 $1",
|
|
"(.*) - zsh": "> [$1]"
|
|
}
|
|
}
|
|
```
|
|
|
|
# STYLE
|
|
|
|
- *#window*
|
|
- *window#waybar.empty #window* When no windows are in the workspace
|
|
|
|
The following classes are applied to the entire Waybar rather than just the
|
|
window widget:
|
|
|
|
- *window#waybar.empty* When no windows are in the workspace
|
|
- *window#waybar.solo* When one tiled window is visible in the workspace
|
|
(floating windows may be present)
|
|
- *window#waybar.<app_id>* Where *<app_id>* is the *class* (e.g. *chromium*) of
|
|
the solo tiled window in the workspace (use *hyprctl clients* to see classes)
|
|
- *window#waybar.floating* When there are only floating windows in the workspace
|
|
- *window#waybar.fullscreen* When there is a fullscreen window in the workspace;
|
|
useful with Hyprland's *fullscreen, 1* mode
|
|
- *window#waybar.swallowing* When there is a swallowed window in the workspace
|