Skip to main content

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.

ModuleDescription
clientA window: geometry, tags, focus, floating, fullscreen, its methods and signals.
tagA workspace: selection, its client list, layout, and layout parameters.
screenAn output: geometry, workarea, tags, bars, and the DPI facts.
layerA layer-shell surface: panels, launchers, and lockers from other programs.
notificationA desktop notification: urgency, actions, timeout, and its lifecycle.

Libraries​

ModuleDescription
kilnThe top-level module: spawn, rules, key, button, and what it re-exports.
kiln.uiConstructors with per-function options and examples. Shared sizing, input, floats and bands.
kiln.widgetsForm controls, bar cells and client decorations. Options, defaults and callbacks for each function.
kiln.layoutThe layout contract, the nine built-in families, and the tag properties they read.
Keys, Buttons, and RulesBinding keys and pointer buttons, and matching clients with rules.
kiln.defaultsThe replaceable default policies the runtime installs.
kiln.placementPlacement helpers for floating clients.
kiln.menuPopup menus: the show cfg, item schema, keyboard navigation, and the client list.
Theme VariablesEvery kiln.theme key with its default, plus kiln.modkey.

System​

Native APIs, signals and commands for scripting and debugging.

ModuleDescription
Signal IndexEvery signal on every class, in one table.
coreThe raw native boundary the stdlib is built on: declare primitives, timers, input.
Origin EventsThe compositor events that drive the runtime, and what each carries.
Environment and IPCEnvironment variables, the IPC socket, and evaluating Lua from outside.
kiln-clientThe command-line client: every verb, selectors, reflection, JSON output.

See also​