aboutsummaryrefslogtreecommitdiffstats
path: root/keybinds/README.md
diff options
context:
space:
mode:
authorDanilo M. <danix@danix.xyz>2026-09-25 19:14:29 +0200
committerDanilo M. <danix@danix.xyz>2026-09-25 19:14:29 +0200
commit36bda4f820d87cc55cac5bfac165c291316ca606 (patch)
treedea84f57d0f94cd289aef5df1e9c37da44750646 /keybinds/README.md
parent2cbc78d4fcc1f14bc9aba3d27e69a77fbde030a6 (diff)
downloadquickshell-36bda4f820d87cc55cac5bfac165c291316ca606.tar.gz
quickshell-36bda4f820d87cc55cac5bfac165c291316ca606.zip
feat(keybinds): live keybind reminder overlay
Modelled on window-switcher: a Scope with a 1x1 keepalive PanelWindow plus a LazyLoader'd overlay, opened via IpcHandler (SUPER+k is bound in a different repo). hyprctl binds -j is asked fresh on every opening so the list matches whatever Hyprland has loaded, with Binds.group() from task 1 turning it into the grid's {name, rows} groups. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Diffstat (limited to 'keybinds/README.md')
-rw-r--r--keybinds/README.md38
1 files changed, 38 insertions, 0 deletions
diff --git a/keybinds/README.md b/keybinds/README.md
new file mode 100644
index 0000000..05d4277
--- /dev/null
+++ b/keybinds/README.md
@@ -0,0 +1,38 @@
+# keybinds
+
+Every Hyprland keybind with what it does, grouped, over a dimmed screen.
+SUPER+k opens it, Escape or a click closes it.
+
+The list is `hyprctl binds -j`, asked on every opening, so it is what Hyprland
+has loaded: binds generated in Lua loops included, and an edit to
+`keybindings.lua` shows once `hyprctl reload` makes it real, not before.
+There is no cache to go stale.
+
+`hyprctl` reports every Lua action as `__lua` with an opaque number, so the
+text comes from each bind's `description` option, written `Group: Label`:
+
+ hl.bind("SUPER + w", hl.dsp.exec_cmd(P.browser), { description = "Apps: Browser" })
+
+The part before `: ` is the heading. A bind with no description is listed
+last under "Undescribed", so a missing one shows instead of vanishing.
+
+## Running
+
+ qs -p ./keybinds
+ qs -p ./keybinds ipc call keybinds toggle
+
+## Blur
+
+Optional, in the Hyprland config:
+
+ hl.layer_rule({
+ name = "blur-keybinds",
+ match = { namespace = "^(quickshell-keybinds)$" },
+ blur = true,
+ xray = false,
+ ignore_alpha = 0.1,
+ })
+
+## Check
+
+ node keybinds/test_binds.js