Reference
A config loads the stdlib once:
local kiln = require("kiln")
client, screen, tag, layer, drag, notification and core are globals.
Objects
Declarations read object properties each frame. See Frames and Dirty State for which writes schedule one.
| Module | Description |
|---|---|
| client | A window: geometry, tags, focus, floating, fullscreen, its methods and signals. |
| tag | A workspace: selection, its client list, layout, and layout parameters. |
| screen | An output: geometry, workarea, tags, bars, and the DPI facts. |
| layer | A layer-shell surface: panels, launchers, and lockers from other programs. |
| notification | A desktop notification: urgency, actions, timeout, and its lifecycle. |
Libraries
| Module | Description |
|---|---|
| kiln | The top-level module: spawn, rules, key, button, and what it re-exports. |
| kiln.ui | Constructors with per-function options and examples. Shared sizing, input, floats and bands. |
| kiln.widgets | Form controls, bar cells and client decorations. Options, defaults and callbacks for each function. |
| kiln.layout | The layout contract, the nine built-in families, and the tag properties they read. |
| Keys, Buttons, and Rules | Binding keys and pointer buttons, and matching clients with rules. |
| kiln.defaults | The replaceable default policies the runtime installs. |
| kiln.placement | Placement helpers for floating clients. |
| kiln.menu | Popup menus: the show cfg, item schema, keyboard navigation, and the client list. |
| Theme Variables | Every kiln.theme key with its default, plus kiln.modkey. |
System
Native APIs, signals and commands for scripting and debugging.
| Module | Description |
|---|---|
| Signal Index | Every signal on every class, in one table. |
| core | The raw native boundary the stdlib is built on: declare primitives, timers, input. |
| Origin Events | The compositor events that drive the runtime, and what each carries. |
| Environment and IPC | Environment variables, the IPC socket, and evaluating Lua from outside. |
| kiln-client | The command-line client: every verb, selectors, reflection, JSON output. |