diff options
| author | Danilo M. <danix@danix.xyz> | 2026-09-14 12:38:36 +0200 |
|---|---|---|
| committer | Danilo M. <danix@danix.xyz> | 2026-09-14 12:38:36 +0200 |
| commit | 901e7d83f8af3defe2c602daad98fd3c67e1dd7c (patch) | |
| tree | 75d64e7c30ce018ca8237eba4535877f0162d50b /desktop | |
| parent | 54f028ed563daed9b49bf1fabee9d47060335304 (diff) | |
| download | quickshell-901e7d83f8af3defe2c602daad98fd3c67e1dd7c.tar.gz quickshell-901e7d83f8af3defe2c602daad98fd3c67e1dd7c.zip | |
docs: correct drawer exit behaviour and dead module commands
The README claimed a click outside returns to the grid; it closes the
drawer, and only Escape-with-a-page or the back arrow return to the grid.
The three moved module READMEs' run and IPC commands still named the
deleted volume-osd, mail-overview and vm-manager paths, so point them at
qs -p desktop and ipc call drawer open sound|mail|vm.
Diffstat (limited to 'desktop')
| -rw-r--r-- | desktop/README.md | 7 | ||||
| -rw-r--r-- | desktop/modules/mail/README.md | 20 | ||||
| -rw-r--r-- | desktop/modules/sound/README.md | 16 | ||||
| -rw-r--r-- | desktop/modules/vm/README.md | 16 |
4 files changed, 33 insertions, 26 deletions
diff --git a/desktop/README.md b/desktop/README.md index 0350f9a..e443ca0 100644 --- a/desktop/README.md +++ b/desktop/README.md @@ -4,9 +4,10 @@ One drawer, left of DP-1, hosting the things a desktop lets you adjust. Reached from a launcher at the left end of waybar. The drawer opens as a grid of tiles, and clicking a tile either opens that -module's page or fires an action. Escape, a click outside, or a module's back -arrow returns to the grid; Escape again closes the drawer. It takes keyboard -focus while it is open, so those keys reach it. +module's page or fires an action. A module's back arrow, and Escape while a +page is showing, return to the grid; Escape on the grid, or a click outside, +closes the drawer. It takes keyboard focus while it is open, so those keys +reach it. ## Running it diff --git a/desktop/modules/mail/README.md b/desktop/modules/mail/README.md index 022bdda..8ae2bd2 100644 --- a/desktop/modules/mail/README.md +++ b/desktop/modules/mail/README.md @@ -3,9 +3,9 @@ > **Now the `mail` module of the `desktop/` shell.** It is no longer a > standalone component: start the shell with `qs -p desktop` and open the page > from the drawer, or deep-link with `qs -p desktop ipc call drawer open mail`. -> The `mail-overview` paths below are historical, the scripts now live under -> `desktop/modules/mail/`, and the waybar click uses `ipc call drawer open -> mail`. See `desktop/README.md`. +> The scripts live under `desktop/modules/mail/`. See `desktop/README.md`; the +> `blur-mail` namespace in the Theme section below is historical, since this +> page now rides the drawer's `quickshell-desktop` surface. Unread mail across every account, as one waybar number and a drawer behind it. Clicking the icon opens the drawer; Escape or a click outside closes it. @@ -30,12 +30,12 @@ Clicking the icon opens the drawer; Escape or a click outside closes it. ## Running it - qs -p . + qs -p ./desktop It is started from `autostart.lua` and reached over IPC, so the shell has to be running for the waybar click to do anything: - qs -p ~/Programming/GIT/quickshell/mail-overview ipc call mail toggle + qs -p ./desktop ipc call drawer open mail Write that path out in full in the real config. Waybar's `exec` and `on-click` have no shell to expand `~`, and neither do Hyprland's Lua strings. @@ -107,8 +107,8 @@ JSON line per database commit, and waybar redraws on each line. There is no "custom/mail": { "format": "<span font='18px'></span> {}", "return-type": "json", - "exec": "~/Programming/GIT/quickshell/mail-overview/waybar-mail.sh", - "on-click": "qs -p ~/Programming/GIT/quickshell/mail-overview ipc call mail toggle", + "exec": "~/Programming/GIT/quickshell/desktop/modules/mail/waybar-mail.sh", + "on-click": "qs -p ~/Programming/GIT/quickshell/desktop ipc call drawer open mail", "on-click-right": "~/bin/mailsync.sh", "tooltip": false } @@ -135,7 +135,7 @@ bigger. Each message is a bullet on its own line with a blank line between, under a bold `New Mail` heading with the account and count as the second line. Started from `autostart.lua`, it runs for the whole session. - /home/you/Programming/GIT/quickshell/mail-overview/mail-notify.sh + /home/you/Programming/GIT/quickshell/desktop/modules/mail/mail-notify.sh It watches the same xapian directory the waybar module does, for the same reason and with the same 0.3s debounce. It is a **separate process rather @@ -187,8 +187,8 @@ notmuch: ## Geometry, and the one property that differs from the other panels The window is a fullscreen overlay with a dimmed backdrop and the drawer itself -anchored to its top right, which is the idiom `vm-manager` and `appearance` both -use and what gives click-outside-to-close and a focusable item for Escape. +anchored to its top right, which is the idiom the vm and appearance panels +both use and what gives click-outside-to-close and a focusable item for Escape. It differs from those two in one property: `exclusionMode` is `Normal`, not `Ignore`. Waybar claims an exclusive zone at the top of this screen, so diff --git a/desktop/modules/sound/README.md b/desktop/modules/sound/README.md index d1c50fc..dd42de2 100644 --- a/desktop/modules/sound/README.md +++ b/desktop/modules/sound/README.md @@ -3,9 +3,9 @@ > **Now the `sound` module of the `desktop/` shell.** It is no longer a > standalone component: start the shell with `qs -p desktop` and open the > module's page from the drawer, or deep-link with -> `qs -p desktop ipc call drawer open sound`. The prose below predates the -> merge and its standalone `volume-osd` commands are historical. See -> `desktop/README.md`. +> `qs -p desktop ipc call drawer open sound`. See `desktop/README.md`. The +> prose below describes the module as it was built when it ran alone; its +> behaviour is unchanged. An on-screen display for volume, covering both output (speakers) and input (microphone). It appears at the bottom of the screen when the level or mute @@ -23,11 +23,15 @@ state changes, and fades out 1.5 seconds later. ## Running it - qs -p . + qs -p ./desktop -From Hyprland, to start it with the session: +The sound page is reached from the drawer, or deep-linked directly: - exec-once = qs -p ~/Programming/GIT/quickshell/volume-osd + qs -p ./desktop ipc call drawer open sound + +From Hyprland, to start the shell with the session: + + exec-once = qs -p ~/Programming/GIT/quickshell/desktop ## Now playing diff --git a/desktop/modules/vm/README.md b/desktop/modules/vm/README.md index 03ad1b5..79c60f5 100644 --- a/desktop/modules/vm/README.md +++ b/desktop/modules/vm/README.md @@ -3,8 +3,9 @@ > **Now the `vm` module of the `desktop/` shell.** It is no longer a > standalone component: start the shell with `qs -p desktop` and open the page > from the drawer, or deep-link with `qs -p desktop ipc call drawer open vm`. -> The `vm-manager` paths and the `panel toggle` IPC below are historical. See -> `desktop/README.md`. +> See `desktop/README.md`; the `blur-vm-manager` namespace in the Theme section +> below is historical, since this page now rides the drawer's +> `quickshell-desktop` surface. A drawer for libvirt virtual machines: state, live statistics, the actions that make sense in the current state, and the snapshot list. It replaces the @@ -20,17 +21,18 @@ menu half of `rofi-qemu.sh`, which could only ever show a list of strings. ## Running it - qs -p . + qs -p ./desktop -`SUPER+v` toggles it, through an IPC call, so the shell has to be running -first. Both are wired in the Hyprland config: +The vm page is reached from the drawer, or deep-linked directly with +`qs -p ./desktop ipc call drawer open vm`. `SUPER+v` does exactly that, so the +shell has to be running first. Both are wired in the Hyprland config: -- autostart.lua - hl.exec_cmd("qs -p ~/Programming/GIT/quickshell/vm-manager") + hl.exec_cmd("qs -p ~/Programming/GIT/quickshell/desktop") -- keybindings.lua hl.bind(mainMod .. " + v", hl.dsp.exec_cmd( - "qs -p ~/Programming/GIT/quickshell/vm-manager ipc call panel toggle")) + "qs -p ~/Programming/GIT/quickshell/desktop ipc call drawer open vm")) Write those two paths out in full in the real config: `exec_cmd` runs the command directly, with no shell to expand `~`. |
