Skip to content

Commit

Permalink
docs: update readme to include windows rules (glzr-io#654)
Browse files Browse the repository at this point in the history
  • Loading branch information
AmineDjeghri authored Aug 12, 2024
1 parent de8450e commit f87c2b3
Showing 1 changed file with 24 additions and 0 deletions.
24 changes: 24 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -215,6 +215,30 @@ workspaces:
keep_alive: false
```
### Config: Window rules
Commands can be run when a window is first launched. This is useful for adding window-specific behaviors like always starting a window as fullscreen, or assigning to a specific workspace.
Windows can be targeted by their process, class, and title. Multiple matching criteria can be used together to target a window more precisely.
```yaml
window_rules:
- commands: ["move --workspace 1"]
match:
# Move browsers to workspace 1.
- window_process: { regex: "msedge|brave|chrome" }

- commands: ["ignore"]
match:
# Ignores any Zebar windows.
- window_process: { equals: "zebar" }

# Ignores picture-in-picture windows for browsers.
# Note that *both* the title and class must match for the rule to run.
- window_title: { regex: "[Pp]icture.in.[Pp]icture" }
window_class: { regex: "Chrome_WidgetWin_1|MozillaDialogClass" }
```
### Config: Window effects
Visual effects can be applied to windows via the `window_effects` option. Currently, colored borders are the only effect available with more to come in the future.
Expand Down

0 comments on commit f87c2b3

Please sign in to comment.