Skip to main content

kiln.widgets

kiln.widgets declares bars and client decorations from kiln.ui elements. Values belong to your config; these functions do not create persistent widget objects. Read widget conventions for state, callbacks and IDs.

Form widgets​

FunctionDisplays
progressA horizontal fill from 0 to 1.
separatorA horizontal or vertical line.
toggleA boolean switch.
sliderA draggable value from 0 to 1.

widgets.progress(cfg)​

See progress options and example.

widgets.separator(cfg?)​

See separator options and example.

widgets.toggle(cfg)​

See toggle options and example.

widgets.slider(cfg)​

See slider options and example.

Bar cells​

FunctionDisplays
taglistTags on a screen.
tasklistClient titles and icons.
systrayStatus-notifier items.
layoutboxThe selected layout.
layoutlistA menu for selecting layouts.
clockDate and time, updated each minute.

widgets.filter​

See tasklist filters.

The handler table​

See press and scroll callbacks.

Client widgets​

FunctionDeclares
clientBorder, titlebar, surface and resize handles.
titlebarTitle and window buttons.
resize_handlesEight invisible resize targets.

The module table is the extension point​

See replacing a widget.

Writable by a config​

See the API available to widgets.

See also​