Skip to main content

Module domkit

Module domkit 

Source
Expand description

The DOM widget catalog (CSS-styled controls, select popover, chat blocks). The DOM widget catalog: ready-made El trees for the common controls and chat building blocks, styled by KIT_CSS (every look is a CSS rule an app may override by appending its own sheet, see sheet_with).

widgetbuilderelement / classeshit ids
buttonbuttonbutton.k-btn (.primary, .ghost)id
switchswitchbutton.k-switch + Control::Switch (:checked)id
checkboxcheckboxdiv.k-check > span.k-box + Control::Checkboxid
text inputinputdiv.k-input + Control::Input (:focus)id
number fieldnumber_input + NumberSpecdiv.k-num > div.k-input, div.k-steps > button.k-stepid, {id}:inc, {id}:dec
spinnerspinnerspan.k-spinner + Control::Spinner—
select triggerselect_triggerselect.k-select (.open)id
select popoverselect_popoverfixed div.k-pop > div.k-opt (.sel, .dis) > label + div.k-sub{id}:opt:{i} (enabled rows only)
message bubblebubblediv.k-msg.me / .them > div.k-who, div.k-body (runs), div.k-timeid
hover action rowaction_rowdiv.k-actions > button.k-act{id}:{key}
collapsible cardcarddiv.k-card (.open) > div.k-card-head + div.k-card-bodyid (the head)
chip / filterchipbutton.k-chip (.on)id
bannerbannerdiv.k-banner.info / .warn / .error{id}:act, {id}:close
side panelside_panelfixed div.k-side > div.k-side-head + div.k-side-body{id}:close
tabstabsdiv.k-tabs > button.k-tab (.on){id}:tab:{i}
segmentedsegmenteddiv.k-seg > button.k-seg-btn (.on){id}:{i}
listlistdiv.k-list > div.k-li (.sel){id}:row:{i}
radio groupradio_groupdiv.k-radio-group > div.k-radio (.sel) > ring + dot{id}:{key}
tabletablediv.k-table > grid div.k-tr (.k-th, .sel) > div.k-td (.num){id}:row:{i}
menumenufixed div.k-menu > div.k-mi (.danger, .dis), div.k-sep{id}:item:{i}
dialogdialogfixed div.k-scrim + div.k-dialog > head, body, foot{id}:scrim, {id}:close, {id}:foot:{i}
tooltiptooltipfixed div.k-tip—
toaststoastsfixed div.k-toasts > div.k-toast (.ok, .warn, .error){id}:{i}:close
toolbar (opt-in TOOLBAR_CSS)toolbar + ToolItemdiv.k-toolbar (.vert) > button.k-tool (.on, .dis) > span.k-tool-icon, div.k-tool-split > button.k-tool-chev, div.k-tool-sep, div.k-tool-fill{id}:{key}, {id}:{key}:menu
flyoutmenu at flyout_atfixed div.k-menu beside its tool{id}:item:{i}
stat, progress, badge, kbd, fieldstat, progress, badge, kbd, fielddiv.k-stat, div.k-progress, span.k-badge, span.k-kbd, div.k-fieldid (stat)

The light look is LIGHT_VARS on the page root (theme_vars); every colour in KIT_CSS is a --k-* variable.

Inline markdown for bubbles is inline_md; long lists render only their visible rows with VirtualList. Kit widgets from uzor-framework go inside a DOM tree through an embed slot (El::slot + Dom::slots); a DOM tree goes inside a kit panel by laying it out in the panel’s rect.

Modules§

icons
Icon bodies used by the catalog.

Structs§

ListView
What part of a long option list a popover shows. The select’s own model (keyboard, wheel, type-to-filter) keeps it; the popover only draws it.
MenuItem
One entry of a menu.
NumberSpec
The rules of a number field (number_input): range, step, shown decimals. The value stays text while it is typed (-, 1. and an empty field are fine); the app reads it with NumberSpec::parse, the steppers and the arrow keys go through NumberSpec::stepped, and leaving the field tidies it with NumberSpec::normalized (uzor-framework’s kit::dom does all three).
SelectOpt
One option of a select.
ToolItem
One toolbar entry (toolbar).
VirtualList
A virtualized list: only the rows in (or near) the viewport are built and laid out; spacers stand for the rest. Row heights start at an estimate and are learned from laid-out rows (VirtualList::measure), so long chats stay cheap.
Window
The rows a VirtualList shows and the space around them.

Enums§

ToolKind
What a toolbar entry is.

Constants§

KIT_CSS
The catalog’s default look (dark, 13px Inter). Variables on :root theme it: --k-accent, --k-bg, --k-fg, --k-muted, --k-line, --k-panel.
KIT_TOUCH_CSS
Touch-sized targets, applied under @media (pointer: coarse) (a finger: iOS / Android builds, or the last input was touch). Apple asks for 44 pt, Material for 48 dp: controls grow to 44 px, list rows to 48 px, text to 15 px. The look stays the same; only sizes change. sheet and sheet_with include it after KIT_CSS; the app’s own rules still win.
LIGHT_VARS
Inline :root overrides for the light look: put them on the page root (El::new("div.k-root").css(LIGHT_VARS)); custom properties cascade to the subtree.
TOOLBAR_CSS
The toolbar’s look, opt-in (not in KIT_CSS, so apps without a toolbar do not carry it): append it with sheet_with (sheet_with(TOOLBAR_CSS), or after the app’s own rules to let them win).

Functions§

action_row
A hover action row (reply, react, copy, more…): (key, icon body, name) per button, hits {id}:{key}.
badge
A small status pill (kind: "", ok, warn, error, muted).
banner
A banner (kind: info, warn, error) with an optional action button ({id}:act) and a close button ({id}:close).
bubble
A chat message bubble: optional sender line, markdown body (inline_md), time.
button
A push button.
card
A collapsible card: the head (hit id) toggles open; the body shows when open.
centered
A w × h box centred in viewport (where a dialog goes).
checkbox
A checkbox with its label; the row is the hit.
chip
A filter chip.
chips_input
A chips input (G11): removable tokens ({id}:rm:{i}) plus a trailing field hit {id}:field the app focuses for typing. picked_chip_remove reads the index.
combo
A searchable combobox (G5): trigger hit {id}:trigger; when open, a popover with a query field {id}:query and option hits {id}:opt:{i} (already filtered by the app). The app owns open / query state and re-renders.
data_table
A data table (G7): sticky header with per-column sort hits {id}:sort:{i} and row hits {id}:row:{i}. sort = (column, ascending) draws the arrow.
dialog
A modal dialog at at over a full-viewport scrim ({id}:scrim, a hit so a click outside can close it), with a title, a close button ({id}:close), body and footer buttons {id}:foot:{i} (the first is .primary).
field
A labelled form row: a small caption above control.
flyout_at
Where a tool’s flyout goes: beside the tool anchor (to its right on a vertical toolbar, below it on a horizontal one, 4 px off), w × h, kept inside viewport.
grid_presets
A docking / layout preset picker (G14): one button per preset, hit {id}:{key}, the active one carries .on.
icon
A 24×24 stroke icon (currentColor) from its path markup.
inline_md
Inline markdown to DOM runs: **bold**, *italic* / _italic_, ***both***, `code` (verbatim), http(s) links (a.link, hit url:…) and @nick mentions (a.mention, hit nick:…). Unclosed markers stay literal; _ only opens at a word start and closes at a word end (snake_case stays as is).
input
A single-line text input showing edit.
kbd
A keyboard shortcut hint (span.k-kbd).
list
A list of rows (div.k-li, .sel for selected), each a main label and an optional muted side text; hits {id}:row:{i}.
menu
A context menu / command list as a position: fixed box at at (viewport coordinates; see popover_at). Enabled items are hits {id}:item:{i} (i counts separators too, so it is the index into items).
menu_with_open
menu with row open_sub carrying .open so its nested submenu (G12) shows. Submenu items are hits {id}:sub:{i}:{j}.
number_input
A number field: a text input (id) with up / down steppers ({id}:inc, {id}:dec). The rules are a NumberSpec; in uzor-framework register them with kit::dom(..).number(id, spec), which filters typing, steps on the buttons, the arrow keys and the wheel over the focused field, and tidies the text on blur.
picked
The tab, segment, row or item index a hit id names ({id}:{kind}:{i}, or {id}:{i} for an empty kind).
picked_chip_remove
The index of a chip remove hit ({id}:rm:{i}), if hit is one of this input’s tokens.
picked_opt
The option index a select popover hit id names ({id}:opt:{i}).
picked_radio
The key of a radio row hit ({id}:{key}), if hit is one of this group’s rows.
picked_reorder
The index of a reorder handle hit ({id}:drag:{i}).
picked_swatch
The index of a swatch hit ({id}:{i}), if hit is one of this grid’s cells.
picked_tool
The tool a toolbar hit names: (key, false) for the button, (key, true) for its flyout chevron.
popover_at
Where a popover h tall goes for a trigger at anchor in viewport: below it, or above when it does not fit below and fits better above; at least the trigger’s width.
progress
A progress bar, v in 0 … 1.
radio_group
A radio group: one choice of many, compact 32 px rows 4 px apart (the mlc language-picker metrics: 15.5 px ring with a 1.5 px border, an 8 px dot when on, a 13 px label at x=30). Each row is a hit {id}:{key}; the selected row carries .sel (accent ring + dot). The hover highlight is div.k-radio:hover — set --k-hover: transparent to turn it off.
range2
A two-thumb range slider (G3 dual): fills between lo and hi. Hits {id}:track, {id}:lo, {id}:hi; the app decides which thumb a drag moves.
reorder_handle
A drag handle for row / tab reordering (G8): hit {id}:drag:{i}; the app owns the drag (pointer capture) and reorders its own model.
segmented
A segmented control (one choice of a few, e.g. Dark / Light): hits {id}:{i}.
select_list
select_popover for a windowed, searchable list: rows view.top .. of opts (the already filtered options; hits keep their index in opts), the highlighted row, a search line and a scroll thumb. “No matches” when opts is empty. The popover is position: fixed at at, so at is in the coordinates of the viewport given to lay_out_in (the window, origin 0,0). Its rows’ --k-accent (the chosen row’s tick) can be set inline on the returned element.
select_popover
The open select’s list as a position: fixed popover at at (see popover_at): it paints above the page and does not scroll with it. Enabled rows are hits {id}:opt:{i}; chosen is marked .sel (with a tick).
select_trigger
The closed select: the chosen label and a chevron.
selectable_text
Read-only text the user can select / copy (G10). Selection is the DOM’s own text selection; the box is a hit {id} so the app can focus it.
sheet
KIT_CSS (plus KIT_TOUCH_CSS) parsed against the current media environment.
sheet_with
KIT_CSS followed by the app’s own rules (later rules of equal specificity win).
side_panel
A side panel docked right (position: fixed: it stays while the page scrolls), with a title row and a close button ({id}:close).
slider
A horizontal slider of explicit pixel width w (G3): a 4 px track, an accent fill up to value, and a 14 px thumb. Hits: {id}:track and {id}:thumb; map a pointer x back with slider_value. The thumb/track are hits so the app owns the drag (pointer capture) and re-renders with the new value.
slider_fraction
Normalised position of value in [min, max], clamped to 0..=1.
slider_value
Map a pointer x (relative to the slider’s left edge, width w) to a value.
slot
An embed slot box (div.k-slot) named key, w × h: a kit widget or canvas goes in its content box (see Dom::slots).
spinner
A busy spinner at time t seconds.
stat
A metric tile: a caption, a big value and a muted note.
swatches
A wrapping grid of colour swatches (G4 L1). Each cell is a hit {id}:{i}; the selected cell carries .sel (accent border). picked_swatch reads the index back from a hit.
switch
A switch (role="switch"): the track is the button’s box, the knob its control.
switch_at
A switch whose knob is at pos (0 … 1) while it slides.
table
A table: a header row and data rows on one CSS grid track list (columns, e.g. "1fr 80px"); num columns align right. Rows are hits {id}:row:{i}, .sel for selected.
tabs
A tab strip: one button.k-tab per label (.on for active), hits {id}:tab:{i}.
theme_vars
The page-root inline variables for the dark ("", the sheet’s own :root) or light look.
toasts
A toast stack in the bottom-right corner of the viewport: (kind, text) per toast (kind as for banner); each has a close hit {id}:{i}:close.
toolbar
A toolbar (style it with TOOLBAR_CSS): a row, or a column when vertical, of ToolItems. Hits {id}:{key} per enabled button, {id}:{key}:menu per split chevron (open its flyout with menu at flyout_at); picked_tool reads them.
tooltip
A tooltip below anchor (fixed, viewport coordinates).