smelt.dialog¶
Tier: UiHost - Requires a terminal UI; calling these from headless mode raises.
Visibility: Public - Stable Lua API intended for user config and plugins.
Root-docked modal dialog primitives. UiHost-only.
smelt.dialog.content¶
Types: smelt.win.Win, smelt.buf.Buf
General-purpose body leaf. Pass opts.buf to wrap an existing buffer
or opts.text to spin up a fresh read-only one. opts.readonly can
force the backing buffer's readonly flag when a caller supplies opts.buf.
opts.interactive enables focus + vim keymaps (when the user has vim mode
on); opts.wrap mirrors smelt.win.new. opts.pad_left / opts.pad_right
override the dialog gutter. Returns (leaf, buf).
smelt.dialog.current¶
Return the topmost active dialog ctx (the same shape passed to
on_submit/keymap handlers: { resolve, close, win, panels,
focused_leaf }), or nil if no dialog is open. Use it inside
leaf:key(...) callbacks - those normally lack a path to the
dialog's resolve handle.
smelt.dialog.input¶
Types: smelt.win.Win, smelt.buf.Buf, smelt.input.Input
Build a line-input leaf with a fresh buffer. placeholder shows when the
buffer is empty. opts.pad_left / opts.pad_right override the dialog
gutter; opts.wrap = true lets long input soft-wrap across visual rows
while preserving single-line submit semantics. Returns (leaf, buf, input)
so callers can keep using the buffer directly or opt into the first-class
input handle.
smelt.dialog.list¶
Types: smelt.buf.Buf, smelt.win.Win
Wrap an existing buf as a selectable list leaf. Use when the buffer
contents need to be mutated live (vs. the snapshot supplied to
smelt.dialog.menu). opts.surface defaults to "list"; opts.selected
(0-based) sets the initial cursor row.
smelt.dialog.markdown¶
Types: smelt.win.Win, smelt.buf.Buf
Render text as a non-focusable markdown leaf. Convenience wrapper
around smelt.dialog.content for static narrative panels (notes,
summaries, intros). Returns (leaf, buf).
smelt.dialog.menu¶
Types: smelt.dialog.MenuItem, smelt.dialog.MenuOpts, smelt.win.Win
smelt.dialog.open¶
Types: smelt.dialog.Opts
Coroutine-blocking dialog opener. Builds the root dialog from opts.panels
(each { leaf, height }), wires opts.keymaps, then yields the
caller until a handler calls ctx.resolve(value). Must run inside a
smelt.spawn (or tool execute) frame; returns the resolved value or
nil on dismiss.
smelt.dialog.open_handle¶
Types: smelt.dialog.Opts
Non-coroutine open. Returns { win, panels, close() } synchronously.
The consumer drives the lifecycle via on_submit / on_dismiss
callbacks and tears down with handle:close(). No value flows back
- use smelt.dialog.open when you need to read the result.
smelt.dialog.picker¶
Types: smelt.dialog.PickerOpts
Coroutine-blocking Telescope-style picker. Stacks a single-line input
on top of a list driven by smelt.list.new; navigation forwards from
input to list, Enter resolves with the selected item. See the doc
block above NAV_KEYS for every accepted opts field. Returns the
value resolved from on_submit (defaults to the highlighted item) or
nil on dismiss.
smelt.dialog.title¶
Return a title spec styled for dialog/window chrome. Use this for raw
overlays or layout leaves that should match dialog title treatment;
smelt.dialog.open applies it automatically to its own title and panels.
smelt.dialog.viewer¶
Types: smelt.buf.Buf, smelt.win.Win
Open a read-only content dialog. Pass text for plain text, lines for
plain line tables, styled for styled lines, or buf for a live buffer the
caller will update after opening. Returns (handle, buf, leaf).