Luigit
repositories / dotfiles

dotfiles

bugabingas dorkfiles

owned by admin

pi/agent/skills/optional/quickshell/examples/README.md

Raw
Rendered preview

Quickshell examples

These examples demonstrate small configuration shapes. Before adapting one, resolve the installed Quickshell version and check its official type pages.

Example Demonstrates
01-hello-bar A PanelWindow as the entry root
02-per-monitor-bar A Variants root and one panel per screen
03-clock A top-anchored clock panel
04-pipewire-volume Tracked PipeWire state and reactive slider binding
05-osd-volume Scope, Connections, Timer, LazyLoader, and PanelWindow
06-ipc-control Explicitly typed IpcHandler functions
07-composite-bar Several installed services in one panel
08-notification-daemon Plain notification summary/body rendering without unsupported capability claims

Validation boundary

Use qmllint for static structure and imports. Do not launch these examples on the user's real desktop merely to validate the skill. A panel maps a desktop surface, and the notification example attempts to own the session notification service.

Runtime checks require a nested compositor and isolated runtime and service state. Interaction and visual acceptance are separate from static or offscreen loading.

The authentication and lockscreen APIs are intentionally not represented by runnable examples here because routine validation must not start live authentication or session-lock flows.

# Quickshell examples

These examples demonstrate small configuration shapes.
Before adapting one, resolve the installed Quickshell version and check its official type pages.

| Example                  | Demonstrates                                                                    |
| ------------------------ | ------------------------------------------------------------------------------- |
| `01-hello-bar`           | A `PanelWindow` as the entry root                                               |
| `02-per-monitor-bar`     | A `Variants` root and one panel per screen                                      |
| `03-clock`               | A top-anchored clock panel                                                      |
| `04-pipewire-volume`     | Tracked PipeWire state and reactive slider binding                              |
| `05-osd-volume`          | `Scope`, `Connections`, `Timer`, `LazyLoader`, and `PanelWindow`                |
| `06-ipc-control`         | Explicitly typed `IpcHandler` functions                                         |
| `07-composite-bar`       | Several installed services in one panel                                         |
| `08-notification-daemon` | Plain notification summary/body rendering without unsupported capability claims |

## Validation boundary

Use `qmllint` for static structure and imports.
Do not launch these examples on the user's real desktop merely to validate the skill.
A panel maps a desktop surface, and the notification example attempts to own the session notification service.

Runtime checks require a nested compositor and isolated runtime and service state.
Interaction and visual acceptance are separate from static or offscreen loading.

The authentication and lockscreen APIs are intentionally not represented by runnable examples here because routine validation must not start live authentication or session-lock flows.