Skip to main content

kiln.ui.image

Draws an image loaded from a file.

An image at different sizes and aspect ratios, followed by a solid recoloured version

Recolouring keeps alpha and replaces RGB. The opaque terminal mark disappears along with the original colours.

Show Lua

Requires rsvg-convert.

Save the Lua file as /tmp/kiln-figure.lua, then run:

kiln-client eval 'dofile("/tmp/kiln-figure.lua")'

It opens on the focused screen and closes after two minutes. To close it early:

kiln-client eval 'if kiln_reference_figure then kiln_reference_figure.stop() end'
local kiln = require("kiln")
local ui, widgets = kiln.ui, kiln.widgets
if kiln_reference_figure then kiln_reference_figure.stop() end

local F = {
bg = "#282828", fg = "#ebdbb2", panel = "#32302f", slot = "#504945",
muted = "#bdae93", amber = "#d79921", blue = "#83a598", green = "#b8bb26",
width = 940, label_width = 300,
}
function F.text(text, cfg)
cfg = cfg or {}
cfg.color = cfg.color or F.fg
cfg.font = cfg.font or "Sans"
cfg.size = cfg.size or 19
ui.text(text, cfg)
end
function F.block(text, cfg)
cfg = cfg or {}
ui.box({ w = cfg.w or 72, h = cfg.h or 30, color = cfg.color or F.blue,
radius = 4, align = "center" }, function()
F.text(text, { color = F.bg, size = 16 })
end)
end
function F.row(label, draw, opts)
opts = opts or {}
return function()
ui.row({ w = "grow", gap = 20, align = { y = "center" } }, function()
ui.box({ w = F.label_width }, function()
F.text(label, { font = "monospace", size = 17, color = F.muted })
end)
ui.box({ w = "grow", h = opts.h or 44, pad = opts.pad or 6,
radius = 8, border = { width = 1, color = F.slot },
align = { y = "center" } }, draw)
end)
end
end
function F.scene(title, subtitle, rows, opts)
opts = opts or {}
local s = screen.focused or screen.all()[1]
assert(s, "a screen is required")
local popup = ui.popup {
id = "kiln-reference-figure", screen = s, w = F.width, pad = 28, gap = 12,
color = F.bg, fit = false, band = opts.band,
fn = function()
F.text(title, { size = 36, font = "Sans Bold" })
F.text(subtitle, { size = 21, color = F.muted })
ui.box({ h = 6 })
for _, row in ipairs(rows) do row() end
end,
}
local figure = { popup = popup, screen = s }
function figure.stop()
popup:destroy()
if figure.timer then core.timer_cancel(figure.timer); figure.timer = nil end
if kiln_reference_figure == figure then kiln_reference_figure = nil end
if figure.cleanup then figure.cleanup() end
end
kiln_reference_figure = figure
figure.timer = core.timer(120000, figure.stop)
popup:show(s)
return figure
end
function F.clients(count)
local result = {}
for _, c in ipairs(client.all()) do
if c.mapped and not c.override_redirect then result[#result + 1] = c end
end
assert(#result >= count, "open " .. count .. " clients before running this figure")
return result
end
function F.client_scene(title, subtitle, rows, opts)
local previous = kiln.declare_clients
local replacement = function() end
kiln.declare_clients = replacement
local figure = F.scene(title, subtitle, rows, opts)
figure.cleanup = function()
if kiln.declare_clients == replacement then kiln.declare_clients = previous end
kiln.dirty()
end
return figure
end

local path = assert(kiln.asset.svg("reference-image", 128, 128, [[
<svg xmlns="http://www.w3.org/2000/svg" width="64" height="64" viewBox="0 0 64 64">
<rect x="4" y="4" width="56" height="56" rx="10" fill="#83a598"/>
<path d="M18 20l12 12-12 12M34 44h14" fill="none" stroke="#282828" stroke-width="5"/>
</svg>]]), "rsvg-convert is required")
return F.scene("kiln.ui.image", "Explicit size, aspect ratio and recolouring", {
F.row('w = 32, h = 32', function() ui.image(path, { w = 32, h = 32 }) end),
F.row('w = 64, aspect = 1', function() ui.image(path, { w = 64, aspect = 1 }) end, { h = 80 }),
F.row('w = 96, h = 48', function() ui.image(path, { w = 96, h = 48 }) end, { h = 64 }),
F.row('recolor = "#d79921"', function() ui.image(path, { w = 48, h = 48, recolor = F.amber }) end, { h = 64 }),
})
ui.image(path, cfg?)

Example​

ui.image(os.getenv("HOME") .. "/.config/kiln/icon.png", {
w = 24, h = 24, recolor = "#8ec07c",
})

Options​

FieldTypeDefaultBehaviour
idelement IDnilID for readback or input.
wsizing"fit"Width.
hsizing"fit"Height.
aspectnumbernilWidth divided by height.
radiusnumber0Corner radius.
recolorcolournilReplaces RGB while preserving the image's alpha mask.
on_pressfunctionnilPointer press callback (ev).

Behaviour​

Images have no intrinsic layout size. Set both axes, or one axis and aspect. Decoded images are cached by path. Unused images may be evicted when the cache exceeds its budget. core.image_reload(path) invalidates a cached file; call kiln.dirty() to redraw it. A failed decode logs an error and draws no image. The image constructor accepts only the fields above. Wrap it in a box for borders, padding or other handlers.