docs: per-compositor Quick Preview keybind recipes - #7
Conversation
niri, Hyprland, and Sway snippets using the newest-screenshot recipe (compositors don't know the file-manager selection; see caveat C). Documents the toggle behavior (one bind opens and closes, PR #5) and the layer-rule-vs-window-rule matching distinction: layer rules match the namespace 'quickview', window rules match the app ID and only apply on the no-layer-shell fallback path. niri snippet validated with 'niri validate'.
|
Caution Review failedThe pull request is closed. ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
Disabled knowledge base sources:
Summary by CodeRabbit
WalkthroughAdds a new "Compositor keybind (advanced)" documentation section to templates/keybind-examples.md, describing QuickView's single-instance toggle behavior, a rule-matching cheat sheet, and compositor-specific keybind examples for niri, Hyprland, and Sway. ChangesKeybind documentation update
Estimated code review effort: 1 (Trivial) | ~5 minutes Poem
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: c304e41e13
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| layerrule = blur, quickview | ||
|
|
||
| # Fallback path only (no layer shell): keep the borderless window floating. | ||
| windowrulev2 = float, class:^(io\.github\.Green2Grey2\.QuickView)$ |
There was a problem hiding this comment.
For current Hyprland users on Arch, these rule examples use the old rule grammar: the Hyprland 0.54 Window Rules docs show layer rules as layerrule = blur on, match:namespace waybar and window matches as match:class, while this snippet uses layerrule = blur, quickview and windowrulev2 ... class:. Users copying the recipe on Hyprland 0.53/0.54+ will get config errors or rules that do not apply, so the example should either use the new match:namespace / match:class form or be explicitly labeled for old Hyprland versions.
Useful? React with 👍 / 👎.
1 participant
Extends
templates/keybind-examples.mdwith concrete niri / Hyprland / Sway snippets (Phase 6, last item). Uses the newest-screenshot recipe since compositors don't know the file-manager selection (existing caveat C). Documents the single-instance toggle (one bind suffices, PR #5) and the layer-rule (namespacequickview) vs window-rule (app ID, fallback path only) distinction.niri snippet validated with
niri validateagainst niri 26.04. Docs-only change.