makeover_layout/lib.rs
1//! The renderer-agnostic half of the make-family design system.
2//!
3//! <!-- wiki: makeover-layout -->
4//!
5//! `makeover` answers *what colour*, and varies by theme. `makeover-geometry`
6//! answers *how much space*, and varies by density and surface. This crate
7//! answers *what the thing is*, and varies by nothing.
8//!
9//! # The deferral rule
10//!
11//! A description names intents and relationships, never values. Say
12//! [`Fill::Raised`], never `#D9DDF4`. Say `Gap::Peer`, never `6px`. What is
13//! left once colour and spacing are deferred is **composition**: which edges
14//! are lit, what inverts on press, what nests in what.
15//!
16//! The constraint that shapes all of it: a renderer that can only paint
17//! rectangles has to be able to express the result. egui has no
18//! `box-shadow: inset` and one stroke per widget with no per-side control; a
19//! terminal has box-drawing characters and one cell of resolution, and cannot
20//! draw a two-tone lit edge at all. A description that assumes per-side edges
21//! is a CSS description wearing a neutral name. So this crate names the
22//! *intent* — this region is a well — and each renderer chooses an expression
23//! it can actually produce, including dropping half of one.
24//!
25//! # Scope
26//!
27//! Depth came first: the bevel and the surfaces it shapes. That much was
28//! settled the hard way — the vocabulary here was read off audiofiles'
29//! `ui::theme` and `ui::widgets`, which are the only implementation written
30//! by a consumer with no CSS, then checked against both webview apps. All
31//! three agreed once Balanced Breakfast's fills were corrected.
32//!
33//! 0.2.0 adds the rest of the description, each member drawn the same way,
34//! from what the three apps already hand-write rather than from a taxonomy:
35//!
36//! - Components. [`Token`] (badge against chip), [`Notice`] (toast against
37//! banner), [`RowPart`], [`Heading`], [`Selector`], [`Readiness`], and
38//! [`Tone`], which is the one intent family they share.
39//! - Schemas. [`Field`] for forms and [`Column`] for lists and tables.
40//! - Structure. [`Region`] for the parts of a screen, [`Arrangement`] for how
41//! a screen is put together.
42//!
43//! **Validation** was absent on purpose here, on the grounds that neither app
44//! had a shared story. That reasoning is retired — see 0.11.0 below, which is
45//! where the constraints arrived and why the argument did not survive contact
46//! with what the apps were measured to do.
47//!
48//! 0.3.0 closes a gap the first real adoption found, which is what adopting
49//! against goingson first was for. [`Selector`] described only the *chosen*
50//! option, so an unchosen one fell through to [`Depth::Flat`] and no renderer
51//! drew it; goingson's tab strip recesses its unchosen tabs by hand and could
52//! not delete the line, because being recessed is *why* the chosen tab reads as
53//! coming forward. So [`Selector::unchosen`] joins `chosen`, and saying it
54//! needed [`Fill::Sunken`] and [`Depth::Sunken`]: a surface set back by colour
55//! with no edge, which is neither a well nor level-with.
56//!
57//! 0.7.0 adds [`State`], the interaction axis, closing the gap that adopting
58//! against three apps rather than one made visible. The description named
59//! rest and, through [`Depth::pressed`], pressed. It named neither focus nor
60//! disabled, so `makeover-webview` emitted a hover rule and stopped, and each
61//! consumer completed the primitive from outside by out-specifying a rule it
62//! did not own: 19 such rules in goingson, 21 in the MNW server, a further set
63//! in Balanced Breakfast, and three focus rings that do not match. The axis is
64//! deliberately two members wide, because hover and pressed belong where they
65//! already are. [`State`]'s own docs carry that argument.
66//!
67//! 0.8.0 finishes [`Field`], which described a field well enough to label it and
68//! not well enough to draw it. Writing `makeover-webview`'s form emitter found
69//! three things missing and the renderer supplied all three from outside: the
70//! current value, a select's options, and the placeholder. Two of those move
71//! here and one does not.
72//!
73//! - [`Field::placeholder`] is user-facing text sitting beside `label` and
74//! `hint`. There was never a reading on which it was renderer state; it was
75//! outside only because adding a field to a published struct is breaking.
76//! - [`Field::options`] moves because every renderer needs them and each was
77//! going to invent its own shape. [`Choice`] is the shape `makeover-webview`
78//! already arrived at, taken as-is rather than redesigned.
79//! - The current value stays renderer-side and is not coming here. It is the
80//! one of the three that is genuinely state: a webview reads it out of the
81//! DOM, an immediate-mode renderer holds a `&mut` to the app's own field, and
82//! a description that carried it would be a form model.
83//!
84//! 0.9.0 opens [`RowPart`], which was the last closed enum in the vocabulary,
85//! and adds [`RowPart::Tokens`]. Both halves come from the same finding, made
86//! by the first two real screens described through the router rather than by
87//! reading a stylesheet.
88//!
89//! A goingson project card carries two trailing badges, a type and a toned
90//! status; a contact card carries a primary email *and* a strip of tags. `Meta`
91//! is one slot and one string, so both ports joined their facts with a
92//! separator and lost what the second one was: a status reads as text where it
93//! used to read as colour. [`Token`] already says exactly the right thing — a
94//! small labelled thing with a kind, a tone and an optional action — and could
95//! only ever be a node in its own right, never inside a row.
96//!
97//! So the missing thing was permission rather than a concept. `Tokens` is that
98//! permission, and `#[non_exhaustive]` arrives with it so the next member is not
99//! a lockstep event across three renderers. The pairing is the point: this
100//! enum's own consumer in `makeover-webview` carried a comment predicting it
101//! would stop compiling one day, which is a lockstep break written down and
102//! waited for rather than prevented.
103//!
104//! Balanced Breakfast was checked before the member was added, because one
105//! consumer wanting something is not evidence. It packs a count and two icon
106//! buttons into the same single `Meta` slot while leaving `Actions` empty, so
107//! the slot was already straining under a second consumer for a different
108//! reason.
109//!
110//! 0.10.0 adds [`Meter`], a proportion carried as a pair rather than as a
111//! percentage. Its own docs carry the argument; the short form is that the
112//! percentage shape had already been tried in goingson and had already needed a
113//! companion flag to recover what rounding and clamping threw away.
114//!
115//! 0.11.0 is four members from the quasi proving ground, batched into one
116//! release because pre-1.0 a minor is breaking and a cascade is nine repos.
117//! Three findings that arrived with them turned out not to belong here at all:
118//! this crate has no notion of an action, a route or a destination, so anything
119//! asking what a control *calls* was never the vocabulary's to say.
120//!
121//! - [`Figure`], a value with a caption. goingson had five of them across five
122//! screens with five class vocabularies for the one shape, which is the
123//! divergence this crate exists to end, sitting in plain sight and counted for
124//! the first time.
125//! - [`RowPart::Proportion`], so a [`Meter`] can sit in a row. `Meter` reached
126//! two of its seven sites at 0.10.0 and the other five are row-shaped. Exactly
127//! [`RowPart::Tokens`]'s problem with a different payload, and it takes
128//! `Tokens`' answer: the part carries the description of a bar, not a node.
129//! - [`Field::max_length`], [`Field::min`] and [`Field::max`], joining
130//! [`Field::required`], which had been sitting here as the sole constraint
131//! while the header above claimed there were none. The set stops before
132//! `pattern`, which fails the renderer test and is one site in one app.
133//! - [`FieldKind::File`]. Every host has an honest answer — a native picker, an
134//! `<input type="file">`, a path prompt, an argument — and it carries no
135//! accepted-types list because `accept` appears at zero sites in either app.
136//!
137//! The evidence rule changed under these, and it is worth recording because four
138//! earlier decisions were made under the old one. The two-app test said a shape
139//! earns a word once a second app wants it. It is backwards: a rule that
140//! withholds a word until a second app has duplicated the code guarantees the
141//! duplication, and app three writes it a third time. The bar is now generic
142//! against bespoke — is this furniture any app would have, or is it this app's
143//! own? Bespoke keeps [`Region::Bespoke`], which already carries a completion
144//! heatmap and is the right answer for a calendar nobody will build twice.
145//!
146//! 0.12.0 is two more from the same proving ground, and the same sorting
147//! happened first: six findings came out of a measurement of goingson's whole
148//! frontend, and four of them turned out to be asking what a control *calls*,
149//! which this crate cannot say. The two that were really here:
150//!
151//! - [`Readiness`] grows from two states to four. It named `Ready` and
152//! `Pending` and stopped, so a screen whose list came back empty had nothing
153//! to say about it; goingson draws an empty state at 27 sites and Balanced
154//! Breakfast at 9. `Empty` and `Failed` are the same axis rather than a new
155//! member beside it, because a region shows one of the four and never two.
156//! `#[non_exhaustive]` arrives with them, the pairing [`RowPart`] made at
157//! 0.9.0 and for the same reason.
158//! - [`Column::sortable`], [`Column::sorted`] and [`Sort`]. The one finding in
159//! the set that completes a member rather than adding one: `Column` shipped
160//! with a width and a priority and could not say that a table is ordered by a
161//! column, so a described table could draw no caret and offer no reordering.
162//!
163//! 0.14.0 is two additive members on two `#[non_exhaustive]` enums, released
164//! together because publishing twice for that is waste and the cascade below
165//! this crate is nine repos.
166//!
167//! - [`Depth::Overlay`]. The enum could say raised, well, sunken and flat, and
168//! could not say that a surface sits *over* the page. Every renderer already
169//! had the surface — `makeover-tui`'s `Palette::overlay`,
170//! `makeover-immediate`'s `Palette::elevation`, `makeover-webview`'s
171//! `--elevation-overlay` — and none of them could be reached from a
172//! description. buckets_of_money has 16 modals waiting on it.
173//! - [`CellPart`], which is [`RowPart`] for tables. A row's parts have carried
174//! their own content intent since 0.2.0, so `.row-actions` inherits rather
175//! than taking a text colour; a table cell had no such vocabulary and
176//! `makeover-webview` emitted one undifferentiated `.cell`, so a button in a
177//! cell was painted as text. The four members are the four things quasi's
178//! `Cell` was measured to hold, and the count is in that crate's history
179//! rather than assumed here.
180//!
181//! 0.15.0 adds [`FieldKind::Date`] and [`FieldKind::DateTime`], on the argument
182//! [`FieldKind::Email`] was admitted on: a webview emits a different `type=`,
183//! which is a native picker, the platform's validation and a different keyboard
184//! on a touch device. Described as text with a "YYYY-MM-DD" hint, all three are
185//! lost.
186//!
187//! Two members and not one or five, from a count rather than from symmetry: 13
188//! sites of `date` and 13 of `datetime-local` across the MNW server and
189//! goingson, and zero of `time`, `month` or `week`. The wire format each takes
190//! is named here as [`DATE_FORMAT`] and [`DATETIME_FORMAT`], because a host
191//! left to pick its own would disagree with a server silently, and
192//! [`FieldKind::temporal`] is the pair asked about once rather than at each
193//! renderer. `FieldKind`'s own comment claiming `radio` was the last HTML input
194//! type missing was already false when 0.8.1 wrote it; these are what it was
195//! missing.
196//!
197//! What each of the 0.12.0 findings deliberately leaves out is the address — what pressing a
198//! header calls, and where an empty state's "Add your first project" button
199//! goes. That is the boundary this crate is defined by, and four findings moved
200//! across it rather than being answered here.
201//!
202//! 0.19.0 narrows [`State`] to [`State::Disabled`] alone. `State::Focus` is
203//! gone: a description never states what has focus, because what focus *is*
204//! differs per host and every renderer had already decided for itself — the
205//! webview draws it from `:focus-visible`, egui refused the variant outright,
206//! and quasi-tui honoured it once at startup and overrode it thereafter.
207//!
208//! 0.20.0 adds [`Region::Widget`], the third tier, and `#[non_exhaustive]` to
209//! [`Region`] with it. Every vocabulary finding until now had two answers
210//! available — grow the primitive set, or [`Region::Bespoke`] — and a whole
211//! class of thing is wrong for both. A carousel is not a primitive, because a
212//! terminal has none and that is the test `Node::Html` failed. It is not
213//! bespoke either, because bespoke is what one app owns and every part of a
214//! carousel is furniture plus members this crate already has.
215//!
216//! The cost of the binary was that refusing a primitive was expensive: the app
217//! hand-rolls the thing forever, so the pressure always ran toward growing the
218//! primitive set with one host's idioms. A named assembly changes what "no"
219//! costs without changing what the vocabulary can say.
220//!
221//! MNW's carousel is the first consumer and was the finding that started it: one
222//! partial, three pages, an ordered set of frames with a position, prev/next and
223//! a dot strip, all of it sayable already and none of it nameable. See wiki
224//! `widget-tier` for the ownership model, which is why this member carries a
225//! name a renderer may decline to know.
226//!
227//! 0.21.0 adds [`Image`] and [`Fit`], found by trying to describe MNW's
228//! carousel under 0.20.0's widget tier and getting one step in. Nothing named a
229//! picture. The vocabulary could say a number with a caption, a badge, a meter
230//! and a table, and could not say the thing three of MNW's public pages are
231//! mostly made of.
232//!
233//! It reads as an oversight and is a measurement: 24 `<img>` sites across 22
234//! MNW templates, against one in goingson and none in Balanced Breakfast or
235//! audiofiles. A picture is furniture a *content platform* has, and MNW is the
236//! only one in the tree, so the evidence never arrived from the two-app
237//! direction the earlier rule looked in. Under the generic-against-bespoke bar
238//! it is not close: a picture is not one app's own.
239//!
240//! A primitive rather than a widget, which is worth stating now that the tier
241//! makes it a real question. A widget is an assembly of things already sayable
242//! and a picture is a leaf, assembled from nothing. It also passes the test
243//! `Node::Html` failed — every host has an honest answer, including a terminal,
244//! which has a graphics protocol or has [`Image::alt`].
245//!
246//! [`Image`] carries no source, the split [`Act`] already makes: an address is
247//! not this crate's to hold. See its own docs, which is where the argument is.
248//!
249//! 0.22.0 finishes [`Image`], which 0.21.0 shipped unable to say how much room
250//! a picture needs. Without that a renderer cannot reserve space, so a picture
251//! occupies nothing until its bytes arrive and then takes its full height at
252//! once. Measured on MNW's landing page: a 478px jump per frame and a
253//! cumulative layout shift of 0.087 for the page.
254//!
255//! - [`Image::intrinsic`], the picture's own dimensions, carried as [`Extent`].
256//! A fact about the asset rather than a display size, which is what keeps it
257//! on this side of the deferral rule: 5120x3412 is what the file *is*, and no
258//! renderer can learn it without fetching the bytes.
259//! - [`Loading`], and the default flips to [`Loading::Eager`]. 0.21.0 emitted
260//! the webview's `loading="lazy"` for every picture, which read one
261//! consumer's habit as a rule. Deferring a picture that is on screen at first
262//! paint saves nothing and makes its shift land later. The carousel is the
263//! case that proves this cannot be one renderer-wide setting: its first frame
264//! is on screen and its others are not, in one widget, at one moment.
265//!
266//! 0.23.0 adds [`Showing`], which is three open findings collapsing into one
267//! member. A tab group could not say which tab was open, a carousel could not
268//! say which frame was up, and a disclosure could not say whether its child was
269//! showing. All three are the same missing sentence, and while it was missing a
270//! renderer had two moves: match on a widget name, or draw every child.
271//!
272//! So the widget tier was taking the blame for a gap one level below it. With
273//! this a renderer derives its chrome from the description — labels get a strip,
274//! no labels get previous/position/next — once, for every widget there will ever
275//! be, and [`Region::Widget`]'s name goes back to being app vocabulary a
276//! renderer may decline to know.
277//!
278//! Only the kind lives here. Which child is up, and what each child is called,
279//! sit with whatever holds the regions, the same split [`Selector`] already made
280//! against `Node::Select`.
281//!
282//! 0.27.0 adds [`Region::Group`], which closes a gap this crate had carried
283//! since 0.2.0 without noticing: [`Heading::Section`] is documented as naming a
284//! block within the screen, and there was no block. A section heading is a leaf
285//! beside the things it names, so the description could say a section had
286//! *started* and never that one had ended.
287//!
288//! Found by asking how a screen distinguishes groups of settings by colour, and
289//! the answer turned out to be two findings rather than one. This is the first
290//! and it is the precondition: there is nothing to tint until there is a
291//! container. The second — every renderer already resolves `category.one`
292//! through `category.six` and no description can reach any of them — is filed
293//! and not shipped here.
294//!
295//! What the colour question settled anyway, because it shapes this member: the
296//! group carries no colour and no ordinal. A renderer distinguishing sibling
297//! groups derives the assignment from their order, which is
298//! [`Region::Columns`]' reasoning about counts applied to colour — the children
299//! say, and a value here would be a second source for something the description
300//! already states by containing them.
301//!
302//! 0.28.0 is what audiofiles' forms port found it could not say, three findings
303//! filed against a working conversion rather than guessed at in advance. All
304//! three are about a *question* rather than about a control, which is the line
305//! this crate keeps having to redraw.
306//!
307//! - [`FieldKind::Range`] and [`Field::step`]. A bounded number the user drags
308//! across, where both ends being on screen is what the question means. The
309//! reading to resist is that this is [`FieldKind::Number`] with bounds, and it
310//! is [`FieldKind::Radio`]'s argument again: a validated number can be out of
311//! range and a slider cannot, so the bounds stop being a rule and become the
312//! control's extent. [`Field::bounded`] is the check a renderer asks, since a
313//! range missing an end has nothing to draw.
314//! - [`Choice::unavailable`]. An option that is real, worth showing, and cannot
315//! be picked yet. Without it an app either drops the option — and the user
316//! never learns it is there — or hand-rolls the control outside the
317//! description, which is what audiofiles' instrument panel did: a permanently
318//! disabled radio plus a hand-written line saying what would enable it.
319//! `#[non_exhaustive]` arrives on [`Choice`] in the same release, so this is
320//! the last breaking addition to it.
321//! - Not a member at all: [`Field::placeholder`] on a chooser. It was sayable
322//! already and no renderer read it, so a select with nothing chosen showed an
323//! empty box and the instruction lived on a disabled button elsewhere. The
324//! renderers moved, not the description.
325//!
326//! # Reach, focus and the focus ring
327//!
328//! Three terms, and no others, for what 0.19.0 moved out of the description.
329//! **Reach** is which things can take focus and in what order; a browser reads
330//! it off the document, a TUI derives it from draw order, egui from its own id
331//! stack. **Focus** is which reached thing has the keyboard right now: the
332//! renderer's, live, never described and never round-tripped through a
333//! description. The **focus ring** is the visible cue; the token (`focus-ring`,
334//! derived by `makeover` from the action colour) is the one shared artifact and
335//! the drawing is the renderer's. Retired as names for any of this: "focus
336//! stroke", "focus cue", "wants focus". "Caret" is a different thing — the text
337//! cursor inside a field — and keeps its name.
338//!
339//! # The three tones, and what a colour claims
340//!
341//! One rule, settled 2026-08-16, for how colour says whether a thing can be
342//! used. Every renderer answers to it, and it is stated here because the
343//! description is what names the intents.
344//!
345//! | the thing | intent |
346//! |-----------|--------|
347//! | active, emphasised, the thing itself | `content` |
348//! | inactive but usable: it still answers a press | `content-secondary` |
349//! | inert: disabled, or not a control at all | `content-muted` |
350//!
351//! `content-muted` is the one with a claim in it. [`State::Disabled`] resolves
352//! to it, so a live control wearing it is telling the user it will not answer —
353//! and being wrong about that is worse than being quiet, because the user's
354//! response is to stop trying. A sortable column heading that was never sorted,
355//! and every unchosen option in a radio group, both read as dead lists that way;
356//! those are the two this rule was written out of. What is legitimately muted is
357//! a caption, a hint, a placeholder, a meter's reading, an axis label: text that
358//! was never going to answer anything.
359//!
360//! The three are one ramp and not three colours. `makeover`'s `Emphasis` derives
361//! the quieter two from the ink, so "one step back" means the same distance in
362//! every theme and a renderer cannot land between them by picking its own.
363//!
364//! # First paint is final paint
365//!
366//! One rule, settled 2026-08-16. Nothing may change size or position after it is
367//! first drawn, and nothing may stand in for content that has not arrived yet.
368//! Both halves are absolute.
369//!
370//! It is stated here, rather than left to each renderer, because a renderer can
371//! only reserve space the description gave it enough to size. A member whose
372//! size depends on its content therefore owes whatever makes it sizeable while
373//! the content is still absent, and that is the second admission test for a new
374//! member: not only does it compose something this crate already names, it can
375//! be laid out before it is filled.
376//!
377//! The mechanism is a reservation, and [`Sort`]'s caret is the worked example.
378//! The caret is drawn into a box its own width whether or not the column is
379//! sorted, so pressing a heading cannot reflow the row it sits in. The box names
380//! no magnitude, which is what keeps it out of `makeover-geometry`'s territory.
381//! Reserve from what is known; never discover geometry from what has not
382//! arrived.
383//!
384//! The trap is an `Option` that means "not yet". [`Readiness::Pending`] is the
385//! honest way to say a region is still waiting. An optional *measurement* is
386//! not: a count that shows up later widens the text that prints it and moves
387//! everything beside it, which is the reflow this rule exists to forbid. So an
388//! `Option` on a measurement means the host will never know it — a property of
389//! the query, fixed for the life of the screen — and a renderer sizes for the
390//! answer it was handed rather than for the one it hopes is coming.
391//!
392//! # Any width, one answer
393//!
394//! The sibling of the rule above, and settled the same day. That one is
395//! independence from *when*; this one is independence from *how you got here*.
396//!
397//! A rendering is a pure function of the description and the viewport. The same
398//! description at the same width is the same output, whatever widths came
399//! before it. No renderer may carry geometry across frames, and none may narrow
400//! by counting.
401//!
402//! The failure this forbids is ordinary enough to be the default everywhere
403//! else: a page that hides its sidebar below some width, remembers that it hid
404//! it, and does not bring it back the same way. Layout there is a function of
405//! `(width, history)`, so dragging a window to 900 wide is a different screen
406//! depending on whether you came from 1400 or from 600. Nobody chose that; it
407//! is what measuring and remembering produce.
408//!
409//! The mechanism is [`Width`] for what grows and [`Priority`] for what drops.
410//! Both are declared, both are read off the description, and neither needs a
411//! measurement. A renderer narrows by raising a cutoff over a total order,
412//! never by counting what fits and stopping — `makeover-tui`'s table states
413//! that as its own rule and tests it, and `makeover-webview` reaches the same
414//! place with `@media` and `display: none`, which is path-independent by
415//! construction because CSS has nowhere to keep the previous width.
416//!
417//! Two things follow for anything new. A member that would need last frame's
418//! size to lay out this frame is refused, the same way a member that cannot be
419//! sized before it is filled is refused. And a fact about what disappears
420//! belongs in the description, because a host that has to infer it can only
421//! infer it from a measurement.
422//!
423//! # Where the description stops
424//!
425//! The rule is that a member is added when an app needs a fact the vocabulary
426//! cannot state, and refused when what it wants is presentation it should be
427//! asking a renderer for. That is the whole test. It is not a quota, and the
428//! goal is every screen described.
429//!
430//! ## What the timeline refusal got wrong, 2026-08-15
431//!
432//! This section used to read "a day-plan timeline, a kanban board and a
433//! calendar are not describable here and will not become describable", and it
434//! propagated: 12 files across three apps, three libraries and the design wiki
435//! cited it, including audiofiles and the MNW server, neither of which has a
436//! timeline. It is withdrawn, and [`Track`] is the member it was refusing.
437//!
438//! The error was pricing. The argument assumed a timeline needs a component
439//! library's worth of vocabulary, and nobody measured it. Held against
440//! goingson's `day-planning-render.js`, the members it actually needed and
441//! could not get were two integers: where a thing starts, and how long it
442//! lasts. Labels, gridlines, item bodies and tones were all furniture this
443//! crate already named. A refusal that expensive should have carried a
444//! measurement, and did not.
445//!
446//! The reasoning underneath it survives and is still the test: slot heights,
447//! gridline colour, how overlapping things stack, which hour scrolls into view.
448//! Those are presentation, they stay the renderer's, and [`Track`] carries none
449//! of them. What changed is the conclusion, not the principle.
450//!
451//! ## The other two, measured 2026-08-15
452//!
453//! The same sentence refused a kanban board and a calendar. Both were counted
454//! the way the timeline should have been, and neither came out where the
455//! refusal put it.
456//!
457//! **Kanban: one member, and it is [`Region::Columns`].** Held against
458//! goingson's `tasks-kanban.js`, every card fact was already sayable — title,
459//! project, due date, the blocked and unblocks badges, subtask progress, the
460//! open action and the context menu are `Row`'s existing parts. A column is a
461//! heading, a count and a list. What nothing could say was that the columns are
462//! *peers*: [`Arrangement`] offers list-detail and sidebar-content, and a board
463//! described as either is a lie about the screen. Dragging a card between
464//! columns never entered into it — a drop's effect is "set status", a discrete
465//! action `Row`'s menu already carries, and the drag itself is affordance.
466//!
467//! **Calendar: no members, no consumer, and a sharper reason (Max,
468//! 2026-08-15).** The month grid's primacy in calendar apps is an artifact of
469//! paper: paper cannot be queried, so it has to show every day at once as a
470//! fallback index. Routes, search and ranking do that job better, which is the
471//! argument `events-calendar.js` already lost to a segmented list on
472//! 2026-08-11.
473//!
474//! Three jobs survive that reasoning, and only one of them needs a grid:
475//!
476//! 1. **Spans across days** — a stretch of leave, a trip, a sprint. You cannot
477//! see "away the 3rd to the 17th" in a list without diffing dates. This is
478//! [`Track`] with [`Unit::Days`], not a calendar, and
479//! [`Track::days`] is it.
480//! 2. **Density at a glance** — which weeks were heavy. That is a heatmap, and
481//! goingson describes both of its heatmaps as lists already.
482//! 3. **Weekday periodicity** — "every other Tuesday", "the 15th is a
483//! Saturday". This is the only job that needs the seven-column wrap, because
484//! alignment is the whole of what makes it visible.
485//!
486//! So the open question is not "is a calendar describable" but "is job 3 worth
487//! a member", and nothing in the tree asks for job 3 yet. GoingsOn
488//! quasicoherent `4a1237b6`.
489//!
490//! A month grid renders today as a
491//! [`Table`](crate::Column): seven weekday columns, weeks as rows, blanks for
492//! the offset. goingson's monthly review reached this conclusion before this
493//! note did and describes its month as a list of days that had something on
494//! them, marking today with an ordinary badge. What the tree actually contains
495//! is two completion heatmaps — one scalar per day — and no calendar at all:
496//! `events-calendar.js` was deleted 2026-08-11 in favour of a segmented list,
497//! and no MNW template mentions one. So the refusal was defending a screen
498//! nobody has. If one is built, measure again; the facts already fit and only
499//! the grid's shape would be in question.
500//!
501//! The pattern worth keeping from all three: one sentence refused three things
502//! for one reason, and the reason was wrong three different ways. Count the
503//! members.
504//!
505//! [`Region::Bespoke`] remains for the genuinely app-owned, and its
506//! justification does not depend on the withdrawn claim. The
507//! description names the *place* and the app owns the contents, so a screen
508//! containing a timeline is still a whole screen and still routable. Without
509//! it, the four goingson screens that make the app worth using would need a
510//! second, undescribed path beside the router, and two paths is how a
511//! vocabulary starts drifting from its app again.
512//!
513//! [`Region::Widget`] sits between that limit and the primitives, and it does
514//! not move the limit. A widget is an assembly of members this crate *already*
515//! has, under a name a renderer may or may not recognise. Anything that needs a
516//! member the vocabulary does not have is still a finding about the vocabulary
517//! or still bespoke; naming an assembly buys no new expressive power, which is
518//! exactly why it is safe to let the set grow outside this crate.
519
520#![forbid(unsafe_code)]
521
522/// A colour intent this crate refers to but never resolves.
523///
524/// The string is the token name `makeover` publishes, so a renderer can look
525/// it up without this crate knowing what colour came back.
526pub trait Intent {
527 /// The `makeover` intent token this resolves against.
528 fn token(self) -> &'static str;
529}
530
531/// Which way the light falls across a two-tone edge.
532///
533/// The whole content of a bevel, once colour and thickness are deferred. The
534/// light is always assumed to come from the top left: every consumer measured
535/// agreed on that and none of them ever varied it, so it is an invariant here
536/// rather than a parameter.
537///
538/// # The two corners that belong to both edges
539///
540/// Top-right and bottom-left are where the lit run meets the shaded one, and
541/// the description's claim is that they belong to *both*. How a renderer says
542/// that is its own business, because the answer is bounded by resolution and
543/// not by taste:
544///
545/// - A terminal cell is roughly 8x17 device pixels, so giving the whole corner
546/// to one tone thickens that edge by a cell and reads as one run overrunning
547/// the other. A half-cell glyph divides the cell already, so `makeover-tui`
548/// splits it and recovers real information. Its box-drawing fallback cannot:
549/// a single stroke has no half to give, so there both corners go to dark.
550/// - A pixel bevel is a one-point stroke by default, which makes the corner a
551/// one-point square. There is nothing to divide — a diagonal seam across one
552/// point is sub-pixel, and antialiasing renders it as the blend a mitred join
553/// already produces. So `makeover-immediate` mitres and is *not* diverging;
554/// it is the same rule at a resolution where the split degenerates.
555///
556/// Stated here so the difference reads as a decision rather than as drift. A
557/// renderer with room to divide the corner should; one without should mitre or
558/// pick the shaded tone, and neither is a bug.
559#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
560pub enum Bevel {
561 /// Lit from the top left: light on top and left, dark on bottom and right.
562 Raised,
563 /// The same edge inverted, which is also the pressed state of anything
564 /// that draws itself [`Bevel::Raised`].
565 Inset,
566}
567
568impl Bevel {
569 /// The edge intents, as `(top_left, bottom_right)`.
570 ///
571 /// Split out from any painting because the inversion *is* the idea, and
572 /// it is the one part every renderer implements identically.
573 #[must_use]
574 pub const fn edges(self) -> (Edge, Edge) {
575 match self {
576 Self::Raised => (Edge::Light, Edge::Dark),
577 Self::Inset => (Edge::Dark, Edge::Light),
578 }
579 }
580
581 /// Pressing inverts. A raised control reads as inset while held.
582 ///
583 /// Stated here rather than left to each consumer because a cascade can
584 /// carry a pressed state and an immediate-mode renderer cannot: audiofiles
585 /// resolves this per call site, eighteen times.
586 #[must_use]
587 pub const fn pressed(self) -> Self {
588 match self {
589 Self::Raised => Self::Inset,
590 Self::Inset => Self::Raised,
591 }
592 }
593}
594
595/// One side of a bevel, named by the intent it takes.
596#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
597pub enum Edge {
598 /// The lit side.
599 Light,
600 /// The shadowed side.
601 Dark,
602}
603
604impl Intent for Edge {
605 fn token(self) -> &'static str {
606 match self {
607 Self::Light => "bevel-light",
608 Self::Dark => "bevel-dark",
609 }
610 }
611}
612
613/// A surface intent a region is filled with.
614///
615/// `#[non_exhaustive]`, so a renderer must carry a wildcard arm and a new
616/// member is additive rather than breaking. Added 0.4.0, after [`Sunken`]
617/// (an additive member, 0.3.0) hard-broke `makeover-tui` and
618/// `makeover-immediate` at compile time and left neither able to move until
619/// both published. The vocabulary exists to grow and the renderers exist to
620/// disagree about how much of it they answer, so growth must not be a
621/// lockstep event. The renderer's wildcard is not a hole: [`Fill`] is
622/// resolved through a fallible lookup, and a missing intent is answered with
623/// structure rather than with a substituted colour.
624///
625/// [`Sunken`]: Fill::Sunken
626#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
627#[non_exhaustive]
628pub enum Fill {
629 /// The page behind everything.
630 Page,
631 /// A surface lifted off the page: cards, controls, menus, toasts.
632 Raised,
633 /// A surface floating above the page rather than resting on it.
634 Overlay,
635 /// The inside of a well.
636 Well,
637 /// A surface set back from the one it sits on, by colour and nothing else.
638 ///
639 /// Not a well. A well is a hole with an edge, and the two are authored in
640 /// opposite directions: `makeover` derives `surface-well` by inverting
641 /// against the theme's own content colour, while `surface-sunken` is
642 /// authored and free to sit darker than raised (goingson's does). Naming
643 /// only the well left the recessed-with-no-edge surface unsayable, which is
644 /// what an unchosen tab is: it recedes so the chosen one can come forward,
645 /// and it carries no bevel of its own.
646 ///
647 /// Added 0.3.0, from goingson's tab strip, which hand-writes exactly this
648 /// and could not delete the line because no member described it.
649 Sunken,
650}
651
652// No `fallback` here, deliberately. An earlier cut had `Fill::Well` fall back
653// to `Fill::Page` so a consumer on makeover 2.2.0, which has no `surface-well`,
654// had something to paint. makeover-tui found that wrong within a day: page is
655// the surface a well is usually cut into, so on a terminal that substitution
656// produces exactly the invisibility it was meant to prevent, and the right
657// answer there is a drawn edge rather than a different colour.
658//
659// Substituting one intent for another is renderer policy. The description says
660// what the region is and stops.
661
662impl Intent for Fill {
663 fn token(self) -> &'static str {
664 match self {
665 Self::Page => "surface-page",
666 Self::Raised => "surface-raised",
667 Self::Overlay => "surface-overlay",
668 Self::Well => "surface-well",
669 Self::Sunken => "surface-sunken",
670 }
671 }
672}
673
674/// How a region sits relative to the surface behind it.
675///
676/// Fill and bevel are named together because naming them apart is what let
677/// them disagree. Every consumer measured had at least one region carrying a
678/// raised bevel over a recessed fill: audiofiles fixed it in `raised_frame`
679/// and recorded the bug in its doc comment, and Balanced Breakfast still had
680/// twelve of them a year later. A single name for the pair makes that
681/// unrepresentable.
682/// `#[non_exhaustive]` for the same reason as [`Fill`], and in the same
683/// release: a depth this renderer has no drawing for should cost it a
684/// wildcard arm, not a compile error and a wait on someone else's publish.
685#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
686#[non_exhaustive]
687pub enum Depth {
688 /// Level with its surroundings. No edge.
689 Flat,
690 /// A card laid on the panel it sits in.
691 Raised,
692 /// A hole in the panel, with content down inside it. For anything the
693 /// user looks *into*: a table body, a tag tree, a text field.
694 Well,
695 /// Set back from what it sits on, by colour alone. No edge.
696 ///
697 /// The one member carrying a fill without a bevel, so a renderer cannot
698 /// assume the two arrive together. That is deliberate and it is still the
699 /// pairing rule: both halves come off the same `Depth`, so they cannot
700 /// disagree, and here one half is legitimately absent.
701 ///
702 /// Distinct from [`Depth::Flat`], which has no fill either and inherits.
703 /// Recessed and level-with are different claims, and only one of them
704 /// needs a colour.
705 Sunken,
706 /// A surface sitting *over* the page rather than in it. A modal, a popover,
707 /// a menu.
708 ///
709 /// Takes elevation and no bevel: a surface overlaying the page is lifted
710 /// off it, and a surface in the page is cut into it. That is the same
711 /// pairing rule the rest of the enum holds, applied to the one case where
712 /// the separation is not an edge at all — the lift and the scrim behind it
713 /// are already saying where the surface is.
714 ///
715 /// Every renderer had the surface before it had this variant.
716 /// `makeover-tui` carries `Palette::overlay`, `makeover-immediate` gained
717 /// `Palette::elevation` at 0.10.0, and `makeover-webview` emits
718 /// `--elevation-overlay`. What was missing was the route from a description
719 /// to any of them, which is why this is one variant rather than a feature.
720 Overlay,
721}
722
723impl Depth {
724 /// The edge this depth is drawn with, if it has one.
725 #[must_use]
726 pub const fn bevel(self) -> Option<Bevel> {
727 match self {
728 // Sunken joins Flat here, for the opposite reason: Flat has no edge
729 // because nothing separates it from its surroundings, and Sunken has
730 // none because its colour is already doing the separating.
731 Self::Flat | Self::Sunken => None,
732 // A third reason to have no edge, which is why it gets its own arm
733 // rather than joining the two above: an overlay is separated by the
734 // lift and by the scrim behind it, so an edge would be a second
735 // answer to a question already answered.
736 Self::Overlay => None,
737 Self::Raised => Some(Bevel::Raised),
738 Self::Well => Some(Bevel::Inset),
739 }
740 }
741
742 /// The surface this depth is filled with.
743 ///
744 /// [`Depth::Flat`] has no fill of its own: it inherits whatever it sits on,
745 /// which is the difference between level-with and painted-the-same-colour.
746 #[must_use]
747 pub const fn fill(self) -> Option<Fill> {
748 match self {
749 Self::Flat => None,
750 Self::Raised => Some(Fill::Raised),
751 Self::Well => Some(Fill::Well),
752 Self::Sunken => Some(Fill::Sunken),
753 Self::Overlay => Some(Fill::Overlay),
754 }
755 }
756
757 /// Pressing a raised region reads as a well, and nothing else moves.
758 ///
759 /// [`Depth::Overlay`] is untouched along with the rest: an overlay is a
760 /// surface, not a control, so there is nothing there to press.
761 #[must_use]
762 pub const fn pressed(self) -> Self {
763 match self {
764 Self::Raised => Self::Well,
765 other => other,
766 }
767 }
768}
769
770/// An interaction state a region can be in, beside whatever [`Depth`] it is.
771///
772/// Orthogonal to depth on purpose. A disabled button is still [`Depth::Raised`]
773/// and a disabled field is still a [`Depth::Well`], so folding either member
774/// into `Depth` would make [`Depth::bevel`] and [`Depth::fill`] answer for
775/// something that is not a depth, and would leave disabled-button and
776/// disabled-field sharing one variant that cannot tell them apart.
777///
778/// # Why hover and pressed are not members
779///
780/// The line is whether every renderer has the state to express, not whether CSS
781/// does. Hover is renderer policy and `makeover-webview` says so in its own
782/// header: a terminal and an immediate-mode painter have no pointer hovering
783/// over anything, and pressed already arrives through [`Bevel::pressed`] and
784/// [`Depth::pressed`], where it belongs, because pressing is a depth inversion
785/// rather than a separate condition.
786///
787/// Focus and disabled are different in kind. A TUI has a focused widget and a
788/// greyed-out one; so does egui. Both were unsayable here, so all three webview
789/// consumers supplied them from outside the primitive by out-specifying rules
790/// they did not own: goingson alone carries 19 of them, and the MNW server
791/// another 21. That is the divergence this crate exists to end, arriving one
792/// layer down.
793///
794/// # The principle this encodes
795///
796/// A primitive owns every state it implies. A renderer that emits a hover rule
797/// for a thing owes disabled and the capability answer for that same thing,
798/// because anything less exports the completion work to N consumers who will
799/// each do it differently.
800///
801/// Focus is not on that list and was removed from this axis in 0.19.0. It is
802/// the renderer's, decided after the description; see the crate header, "Reach,
803/// focus and the focus ring", for the three terms and who owns each.
804///
805/// `#[non_exhaustive]` for the reason [`Fill`] and [`Depth`] carry it: growth
806/// must not be a lockstep event across the three renderers.
807#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
808#[non_exhaustive]
809pub enum State {
810 /// Present, visible, and not answering.
811 ///
812 /// Not the same as absent, and deliberately not a [`Fill`]: a disabled
813 /// control keeps the surface it always had and stops responding, so what
814 /// changes is its content and its interactivity rather than what it is.
815 Disabled,
816}
817
818impl State {
819 /// Whether a region in this state stops answering the pointer.
820 ///
821 /// Stated in the description rather than left to each renderer, on the same
822 /// reasoning as [`Bevel::pressed`]: a cascade carries it for free and an
823 /// immediate-mode renderer resolves it per call site, so leaving it unsaid
824 /// means resolving it once per consumer and disagreeing.
825 #[must_use]
826 pub const fn suppresses_interaction(self) -> bool {
827 // A match rather than a bare `true`, so a member added to this
828 // `#[non_exhaustive]` axis has to answer the question rather than
829 // inheriting an answer.
830 match self {
831 Self::Disabled => true,
832 }
833 }
834}
835
836impl Intent for State {
837 fn token(self) -> &'static str {
838 match self {
839 // Reusing the muted content intent rather than minting a
840 // `disabled` colour. Disabled is a reduction and not a status, and
841 // `makeover-webview`'s progress rules already record the reading
842 // that `content-muted` is what disabled looks like.
843 Self::Disabled => "content-muted",
844 }
845 }
846}
847
848/// What a region is saying, when it is saying something.
849///
850/// The one intent family shared by badges, notices and nothing else. Kept
851/// separate from [`Fill`] because a surface is where a thing sits and a tone is
852/// what it means, and the three apps agree on the four statuses:
853/// `info_banner` / `warning_banner` in audiofiles, `.toast-info` /
854/// `.toast-success` / `.toast-error` in goingson, `.toast.success` /
855/// `.toast.error` in Balanced Breakfast.
856///
857/// The per-tag palette (`category-one` through `category-six`) is deliberately
858/// not here. Which colour a *particular* tag takes is app domain, and both
859/// webview apps already carry it as a `data-color` attribute.
860#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
861pub enum Tone {
862 /// No status. Reads as ordinary de-emphasised content.
863 Neutral,
864 /// Something worth knowing and nothing to do about it.
865 Info,
866 /// Something finished and it worked.
867 Success,
868 /// Something the user should look at before continuing.
869 Warning,
870 /// Something broken, or something about to be destroyed.
871 Danger,
872}
873
874impl Intent for Tone {
875 fn token(self) -> &'static str {
876 match self {
877 // Neutral has no status token of its own. It takes the muted
878 // content intent, which is what both webview apps already spell as
879 // `data-color="muted"`.
880 Self::Neutral => "content-muted",
881 Self::Info => "info",
882 Self::Success => "success",
883 Self::Warning => "warning",
884 Self::Danger => "danger",
885 }
886 }
887}
888
889/// A small labelled thing that sits inside something else.
890///
891/// Two members, because the three apps drew three taxonomies and only one line
892/// runs through all of them: does it answer a click. audiofiles has
893/// `classification_badge` (a label) against `tag_chip`, `tag_chip_removable`
894/// and `selectable_tag` (all of which do). Balanced Breakfast has `.tag` and
895/// `.badge` against `.tag-chip`. goingson is the one that has to move: its
896/// `.tag` and `.badge` are a single CSS rule, so every call site has to be read
897/// to decide which of the two it always was.
898///
899/// The evidence that a chip is a real concept rather than a badge with a
900/// cursor: audiofiles inverts its bevel on press and Balanced Breakfast latches
901/// `.tag-chip.active` with the inset bevel. Two independent arrivals at "a chip
902/// holds itself down", which is exactly what [`Depth::pressed`] already says.
903#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
904pub enum Token {
905 /// Non-interactive status or count. Answers no click.
906 Badge,
907 /// An interactive or removable token. Answers a click, and latches if it
908 /// stands for a filter that is either on or off.
909 Chip {
910 /// Whether it carries its own remove affordance.
911 removable: bool,
912 },
913}
914
915impl Token {
916 /// Whether this answers a click.
917 ///
918 /// The whole difference between the two members, and the reason a renderer
919 /// with no hover (a touch surface, a terminal) can still tell them apart.
920 #[must_use]
921 pub const fn interactive(self) -> bool {
922 matches!(self, Self::Chip { .. })
923 }
924
925 /// How it sits, given whether it is currently latched down.
926 ///
927 /// A badge is flat: it is a label, and giving it an edge would say it can
928 /// be pressed. A chip is raised, and inset while latched.
929 #[must_use]
930 pub const fn depth(self, latched: bool) -> Depth {
931 match self {
932 Self::Badge => Depth::Flat,
933 Self::Chip { .. } if latched => Depth::Well,
934 Self::Chip { .. } => Depth::Raised,
935 }
936 }
937}
938
939/// Something the app is telling the user, unprompted.
940///
941/// Two concepts, not one with a placement. They differ in more than where they
942/// sit: a toast is transient, stacked and self-dismissing, and a banner is
943/// persistent, in flow, one per region, and dismissed by fixing the condition
944/// it reports. Folding them into one member with a placement parameter would
945/// make lifetime, stacking and dismissal all placement-dependent, which is the
946/// description leaking renderer policy.
947///
948/// All three apps have banners: `info_banner` and `warning_banner` in
949/// audiofiles, five of them in goingson (sync, sync-result, vacation-day,
950/// timer-active, past-review), `.update-banner` in Balanced Breakfast. The two
951/// webview apps also have toasts. So neither member is speculative, and no app
952/// gains a concept it lacks except audiofiles, whose renderer may legitimately
953/// decline to draw a toast at all.
954#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
955pub enum Notice {
956 /// Transient, stacked, dismisses itself.
957 Toast,
958 /// Persistent, in flow, one per region, dismissed by fixing the cause.
959 Banner,
960}
961
962impl Notice {
963 /// Whether it goes away on its own.
964 #[must_use]
965 pub const fn transient(self) -> bool {
966 matches!(self, Self::Toast)
967 }
968
969 /// How it sits.
970 ///
971 /// A toast floats above the page rather than resting on it, which is
972 /// [`Fill::Overlay`]'s whole reason to exist. A banner is a card in the
973 /// flow. Both are raised, and they are raised off different things.
974 #[must_use]
975 pub const fn fill(self) -> Fill {
976 match self {
977 Self::Toast => Fill::Overlay,
978 Self::Banner => Fill::Raised,
979 }
980 }
981}
982
983/// The parts of a list row.
984///
985/// Four to begin with, taken from Balanced Breakfast, which was the only
986/// consumer that had all of them (`row-primary`, `row-secondary`, `row-meta`,
987/// `row-actions`). audiofiles has two and no slot structure at all, so it gains
988/// meta and actions as real work rather than a rename; goingson moves off
989/// `task-row` / `task-cell`.
990///
991/// [`Tokens`](Self::Tokens) joined at 0.9.0, and `#[non_exhaustive]` with it.
992/// See the crate header for why the two arrived together.
993///
994/// # Meta against Tokens
995///
996/// The line is whether the thing has its own standing. `Meta` is one short
997/// trailing fact about the row, written as text: a count, a size, a date.
998/// `Tokens` is a set of small labelled things, each of which can be toned and
999/// can answer a click. "3 files" is meta. A status badge that is amber, and a
1000/// tag you can click to filter by, are tokens.
1001///
1002/// Keeping them apart is what a single widened slot would have foreclosed. A
1003/// renderer can right-align one string and cannot usefully do the same to a
1004/// strip of chips, and a fact that is not clickable should not be drawn as
1005/// though it were.
1006#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
1007#[non_exhaustive]
1008pub enum RowPart {
1009 /// The thing itself. What the row is called.
1010 Primary,
1011 /// Supporting text under the primary.
1012 Secondary,
1013 /// A short trailing fact: a count, a size, a date.
1014 Meta,
1015 /// Controls that act on this row.
1016 Actions,
1017 /// Small labelled things belonging to the row: badges, chips, tags.
1018 ///
1019 /// Each carries its own [`Token`] kind and [`Tone`], so a renderer with no
1020 /// colour still has the kind to work with, and one with no chips still has
1021 /// the label. That is the constrained-consumer test this vocabulary exists
1022 /// to pass, and it is why the tone lives on the token rather than on the
1023 /// part.
1024 Tokens,
1025 /// How much of a set the row's thing has done: a [`Meter`] in the row.
1026 ///
1027 /// Added 0.11.0, `da5666ae`, and it is [`Tokens`](Self::Tokens)'s problem
1028 /// again with a different payload. [`Meter`] arrived at 0.10.0 and closed
1029 /// two of the seven sites that asked for it; the other five sit in rows, and
1030 /// a row holds no nodes by the ruling that a row part may not carry an
1031 /// arbitrary node — the door through which a description becomes a
1032 /// templating language. So the part carries the *description of a bar*
1033 /// rather than a node, exactly as `Tokens` carries tags rather than nodes.
1034 ///
1035 /// Without it a row flattens the proportion into [`Meta`](Self::Meta) as
1036 /// "3/7 subtasks", which keeps both numbers and loses the reading, the same
1037 /// way a toned status badge read as prose before `Tokens`.
1038 Proportion,
1039}
1040
1041impl RowPart {
1042 /// The content intent the part takes.
1043 #[must_use]
1044 pub const fn intent(self) -> &'static str {
1045 match self {
1046 Self::Primary => "content",
1047 Self::Secondary => "content-secondary",
1048 Self::Meta => "content-muted",
1049 // Actions carry controls rather than text, so they inherit.
1050 Self::Actions => "content",
1051 // So do tokens: each one carries its own tone, and a part-level
1052 // intent underneath it would fight the token that sits on it.
1053 Self::Tokens => "content",
1054 // And so does a proportion, for the same reason: the meter carries
1055 // the tone, and it is about the ratio rather than about the row.
1056 Self::Proportion => "content",
1057 }
1058 }
1059}
1060
1061/// How far down the heading tree a title sits.
1062///
1063/// Three, and only the three that are actually headings. The bands those used
1064/// to be filed with (goingson's `.page-header`, Balanced Breakfast's `.header`
1065/// and `.detail-header`) are arrangement, not type, and live at
1066/// [`Region::Band`]. One of them contains no text at all.
1067#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
1068pub enum Heading {
1069 /// Names the whole screen. One per screen.
1070 Page,
1071 /// Names a block within the screen.
1072 Section,
1073 /// Names a sub-block inside an already-named section.
1074 Subsection,
1075}
1076
1077impl Heading {
1078 /// Whether a rule follows the heading.
1079 ///
1080 /// audiofiles' `section_header` draws a separator and its
1081 /// `subsection_label` deliberately does not, which is the only thing
1082 /// distinguishing the two once weight and colour are deferred.
1083 #[must_use]
1084 pub const fn separated(self) -> bool {
1085 matches!(self, Self::Section)
1086 }
1087}
1088
1089/// A control that picks between things.
1090///
1091/// Three, because three distinct behaviours are in play and collapsing any two
1092/// loses something. A segmented control picks a value; a tab picks a pane; a
1093/// toggle picks nothing and simply holds itself on or off.
1094#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
1095pub enum Selector {
1096 /// Exactly one of N, and the options abut.
1097 Segmented,
1098 /// Independent on or off, on its own.
1099 Toggle,
1100 /// Navigation between panes. The folder semantic.
1101 Tabs,
1102}
1103
1104impl Selector {
1105 /// How the chosen option sits.
1106 ///
1107 /// Held in for a segmented control and a toggle, which is the same shape
1108 /// pressing produces and the whole economy of the idiom: one appearance,
1109 /// two reasons to wear it. A tab is the exception, because the selected
1110 /// folder tab comes *forward* to join the pane it opens.
1111 #[must_use]
1112 pub const fn chosen(self) -> Depth {
1113 match self {
1114 Self::Segmented | Self::Toggle => Depth::Well,
1115 Self::Tabs => Depth::Raised,
1116 }
1117 }
1118
1119 /// How the options that were *not* picked sit.
1120 ///
1121 /// Added 0.3.0. Describing only [`Selector::chosen`] left the unchosen
1122 /// option falling through to [`Depth::Flat`], which says it is level with
1123 /// the strip it sits in, and no renderer emitted anything for it. That is
1124 /// wrong in both directions and goingson proved it: its unchosen tabs are
1125 /// recessed by hand, and being recessed is *why* the chosen one reads as
1126 /// coming forward. Against a flat strip, a raised chosen tab is a bevel
1127 /// drawn on the strip's own colour, which is a much weaker folder effect
1128 /// than the contrast the idiom is named after.
1129 ///
1130 /// Each member is the inverse of its chosen state, which is the whole
1131 /// content of "picked" once colour is deferred:
1132 ///
1133 /// - Tabs recede, so the chosen one comes forward.
1134 /// - A segment and a toggle stand up, so the chosen one is held in.
1135 #[must_use]
1136 pub const fn unchosen(self) -> Depth {
1137 match self {
1138 Self::Tabs => Depth::Sunken,
1139 Self::Segmented | Self::Toggle => Depth::Raised,
1140 }
1141 }
1142
1143 /// Whether the options touch.
1144 ///
1145 /// The gap is the entire difference between a segmented control and a row
1146 /// of buttons that happen to sit near each other, which is what audiofiles'
1147 /// `segmented_control` says in its own comment and why it zeroes the
1148 /// spacing by hand.
1149 #[must_use]
1150 pub const fn abutting(self) -> bool {
1151 matches!(self, Self::Segmented | Self::Tabs)
1152 }
1153}
1154
1155/// What is in a region right now.
1156///
1157/// The state, not the shimmer. Whether pending paints a skeleton, a spinner or
1158/// nothing at all is renderer policy, the same class of decision that got
1159/// `Fill::fallback` deleted from this crate. goingson and Balanced Breakfast
1160/// each grew a skeleton with differently-named parts; both keep them, as the
1161/// webview renderer's expression of [`Readiness::Pending`]. audiofiles has none
1162/// and needs none, because an immediate-mode renderer simply repaints.
1163///
1164/// # Four states and not two, as of 0.12.0
1165///
1166/// `703f4cd2`. It named `Ready` and `Pending` and stopped, so a described screen
1167/// whose list came back empty had to render an empty region or invent its own
1168/// placeholder text, and neither says what it is. goingson draws one at 27 sites
1169/// across 12 files and Balanced Breakfast at 9, with a class family that had
1170/// already drifted into `empty-state`, `empty-state--error`, `error-state` and
1171/// six more.
1172///
1173/// The four are one axis because they are mutually exclusive: a region shows its
1174/// content, or a sign that it is coming, or a sign that there is none, or a sign
1175/// that it broke. Never two. That is the test for one enum against several
1176/// fields, and it is why this grew rather than a new member arriving beside it.
1177///
1178/// # What is not here
1179///
1180/// **The message.** "No projects yet" is content, and this names a state. It
1181/// lives with whatever holds the region — in quasi's case a `Slot` — alongside
1182/// the action that leads out of the emptiness, since an address is the one thing
1183/// this crate never names.
1184///
1185/// **How much room it gets.** goingson's `--compact`, `--dashboard` and
1186/// `--padded` are the same state at three sizes, and a size is
1187/// `makeover-geometry`'s question. Naming them here would be this crate stating
1188/// values again.
1189///
1190/// **The icon.** Presentation, and each host has its own answer or none.
1191#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
1192#[non_exhaustive]
1193pub enum Readiness {
1194 /// The content is here.
1195 Ready,
1196 /// The content is on its way.
1197 ///
1198 /// For a region that changes *after* the first paint, and never for the
1199 /// first paint itself: see "First paint is final paint" in the crate header.
1200 /// A host that renders once, with its data already in hand, has nothing to
1201 /// say this about, and a screen arriving in this state is describing a
1202 /// moment its host should not have been in.
1203 ///
1204 /// What stands in occupies the geometry the content will occupy. A stand-in
1205 /// sized to itself rather than to what replaces it is the reflow the rule
1206 /// forbids, arriving one repaint later.
1207 Pending,
1208 /// The content arrived and there is none of it.
1209 ///
1210 /// Not a failure. An empty list is the normal state of a new install, and a
1211 /// renderer that drew it in a danger tone would be reporting a fault where
1212 /// there is none.
1213 Empty,
1214 /// The content did not arrive.
1215 Failed,
1216}
1217
1218impl Readiness {
1219 /// Whether the region draws its own content, or something standing in for
1220 /// it.
1221 ///
1222 /// The question every renderer asks first, so it is answered once here
1223 /// rather than by a `matches!` in each. A state added later is a stand-in
1224 /// until proven otherwise: falling back to drawing content that may not be
1225 /// there is the worse of the two mistakes.
1226 #[must_use]
1227 pub const fn shows_content(self) -> bool {
1228 matches!(self, Self::Ready)
1229 }
1230
1231 /// What the state means, for a renderer choosing a colour.
1232 ///
1233 /// Derived rather than carried, which is the opposite of [`Meter`] and
1234 /// [`Figure`], and the difference is worth stating: a proportion's meaning
1235 /// depends on what is being counted and only the app knows it, while
1236 /// "nothing here yet" and "this broke" mean the same thing in every app that
1237 /// will ever have them.
1238 #[must_use]
1239 pub const fn tone(self) -> Tone {
1240 match self {
1241 Self::Failed => Tone::Danger,
1242 _ => Tone::Neutral,
1243 }
1244 }
1245}
1246
1247/// How much of a set is done.
1248///
1249/// Added 0.10.0. Nine sites across the two webview apps drew a bar and nothing
1250/// here named one, so every described screen concatenated the two numbers into
1251/// its heading text instead: "Subtasks 3/7", "Time Tracking 45m tracked / 30m
1252/// est, over". Every fact survives that and the reading does not, which is the
1253/// same loss `RowPart::Tokens` closed when a toned status badge became prose.
1254///
1255/// # Why a pair and not a percentage
1256///
1257/// Both numbers, not the percentage the apps compute from them. The percentage
1258/// was the obvious shape and it had already been tried: goingson's
1259/// `Task::time_progress` divides, rounds, and then clamps to 100, which throws
1260/// away the one case the bar exists to show — 45 minutes tracked against a
1261/// 30-minute estimate. It carries a separate `is_over_estimate` boolean beside
1262/// it to recover the fact the clamp dropped. A pair keeps the over-run without a
1263/// companion flag, and [`percent`](Meter::percent) is still one call away for a
1264/// renderer that wants it.
1265///
1266/// The pair is also what the apps already have at every site. All seven
1267/// determinate bars write the ratio into the accessible layer and never the
1268/// percentage: `title="3/7 subtasks"`, `aria-label="3 of 7 subtasks completed"`,
1269/// a milestone's own `3/7` span. Given 43 nothing can recover "3 of 7", so a
1270/// percentage member would have made [`label`](Meter::label) mandatory at every
1271/// call site, which is the concatenated text this member removes, moved one
1272/// layer down.
1273///
1274/// # What this is not
1275///
1276/// The progress of an *operation*. Two of the nine sites are that — goingson's
1277/// focus timer, Balanced Breakfast's feed fetch — and they get nothing here, on
1278/// purpose. Both are imperative controllers over a live handle, driven by a tick
1279/// or an event stream, and a description is built once and dropped. Holding one
1280/// would mean growing a way to update a description between renders, which is a
1281/// different feature. [`Readiness::Pending`] and a [`Notice::Toast`] carry the
1282/// honest part.
1283///
1284/// The two cases are distinguishable in the markup rather than by taste: every
1285/// determinate bar in both apps carries a tone, and neither operation bar
1286/// carries one. Two codebases drew that line the same way without coordinating.
1287#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
1288pub struct Meter<'a> {
1289 /// How much is done. May exceed [`total`](Self::total), and that is the
1290 /// case worth drawing.
1291 pub done: u32,
1292 /// How much there is to do. Zero means there is no set, not that the set is
1293 /// complete.
1294 pub total: u32,
1295 /// What the proportion means right now.
1296 ///
1297 /// Carried rather than derived, because no renderer can work it out. The
1298 /// same 90% is [`Tone::Success`] on a subtask rollup and [`Tone::Danger`] on
1299 /// a time estimate, and goingson picks between them from `is_over_estimate`,
1300 /// a fact about the data and not about the number.
1301 pub tone: Tone,
1302 /// What is being counted, if the bar says so: "subtasks", "tasks".
1303 ///
1304 /// The noun, not the ratio. A renderer builds "3 of 7 subtasks" from this
1305 /// and the two numbers; handing it the assembled string would put the
1306 /// sentence order in the description, where a terminal at one line and a
1307 /// tooltip want different ones.
1308 pub label: Option<&'a str>,
1309}
1310
1311impl<'a> Meter<'a> {
1312 /// A proportion with no tone and no label.
1313 #[must_use]
1314 pub const fn new(done: u32, total: u32) -> Self {
1315 Self {
1316 done,
1317 total,
1318 tone: Tone::Neutral,
1319 label: None,
1320 }
1321 }
1322
1323 /// What the proportion means.
1324 #[must_use]
1325 pub const fn tone(mut self, tone: Tone) -> Self {
1326 self.tone = tone;
1327 self
1328 }
1329
1330 /// What is being counted.
1331 #[must_use]
1332 pub const fn label(mut self, label: &'a str) -> Self {
1333 self.label = Some(label);
1334 self
1335 }
1336
1337 /// How full the bar is, 0 to 100, clamped.
1338 ///
1339 /// For drawing, which is the only thing a clamped number is good for. Ask
1340 /// [`overflowing`](Self::overflowing) before reporting it as a fact, or this
1341 /// is `time_progress`'s bug again with the clamp moved.
1342 ///
1343 /// An empty set reads as 0. Nothing is done, because there is nothing to do
1344 /// and no bar to fill; the apps guard on the count before drawing at all.
1345 #[must_use]
1346 pub const fn percent(&self) -> u8 {
1347 if self.total == 0 {
1348 return 0;
1349 }
1350 let scaled = (self.done as u64 * 100) / self.total as u64;
1351 if scaled > 100 { 100 } else { scaled as u8 }
1352 }
1353
1354 /// Whether more is done than there was to do.
1355 ///
1356 /// The fact [`percent`](Self::percent) destroys, kept reachable so a
1357 /// renderer can mark the over-run rather than drawing a full bar and
1358 /// implying it landed exactly.
1359 #[must_use]
1360 pub const fn overflowing(&self) -> bool {
1361 self.done > self.total
1362 }
1363
1364 /// Whether there is a set at all.
1365 ///
1366 /// A meter over nothing is sayable on purpose, for the same reason a field
1367 /// with no options is: it is what an app with an unloaded count actually
1368 /// has, and a renderer that shows an empty bar says so on screen rather than
1369 /// dividing by zero.
1370 #[must_use]
1371 pub const fn is_empty(&self) -> bool {
1372 self.total == 0
1373 }
1374}
1375
1376/// One figure with a caption: a number and what it counts.
1377///
1378/// The dashboard shape. A large value over a small caption, several of them in a
1379/// strip: a current streak, a completion rate, a total. Added 0.11.0,
1380/// `93c6a174`, after goingson turned out to have five of them across five
1381/// screens with five class vocabularies for the one shape — `task-overview-stat`,
1382/// `stat-box`, `month-stat-item`, `contact-summary-stat`, `sync-stat`. Four put
1383/// the value above the caption and one inverts it, which is drift inside the
1384/// shape rather than a second shape.
1385///
1386/// # Why the value is text
1387///
1388/// "17", "84%", "12/30", "3d". A figure is whatever the app computed, already
1389/// formatted, and the formatting is the app's because only it knows whether the
1390/// number is a percentage, a duration or a ratio. This carries none of the
1391/// arithmetic [`Meter`] carries, and that is the difference between them: a
1392/// meter is a proportion a renderer draws, and a figure is a fact a renderer
1393/// sets in type.
1394///
1395/// # Tone is carried, for [`Meter`]'s reason
1396///
1397/// Three of the five sites tone the figure by their own means — `red`/`blue` on
1398/// the weekly review, a `${type}` class on the monthly one, `sync-stat-warn` on
1399/// sync. So tone is carried at every site that needs it and derived at none, and
1400/// no renderer can work out that a streak of zero is worth colouring.
1401///
1402/// # What is not here
1403///
1404/// Whether the figure answers a click. One of the five is a control — sync's
1405/// "Not Applied: 3" opens the list — and an action is not something this crate
1406/// can name: nothing here knows what a route is. That belongs beside the figure
1407/// in whatever layer holds the actions, the same way a row's activation sits
1408/// beside its parts rather than inside them.
1409///
1410/// The arrangement is not here either. Several figures in a strip is a set, and
1411/// a renderer given them one at a time cannot tell it is looking at one; the
1412/// layer that holds the tree is where the set gets said.
1413#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
1414pub struct Figure<'a> {
1415 /// The number, formatted the way the app means it to read.
1416 pub value: &'a str,
1417 /// What it counts. The caption under the value.
1418 pub caption: &'a str,
1419 /// How the value has moved, if the app is tracking that.
1420 ///
1421 /// Added 0.13.0. Text, for [`value`](Self::value)'s reason: only the app
1422 /// knows whether a move reads as `+12.5%`, `+3` or `2x`, and a renderer
1423 /// handed a number would have to guess.
1424 ///
1425 /// This is what [`tone`](Self::tone) was for and had no consumer of. The MNW
1426 /// server has four screens whose stat card is a label, a value and a delta,
1427 /// and the delta is the toned part: the figure itself is an ordinary fact
1428 /// and it is the movement that reads as good or bad. Without this the delta
1429 /// has to be folded into the caption, which loses the tone and reads as a
1430 /// longer caption rather than as a second, smaller line.
1431 pub change: Option<&'a str>,
1432 /// What the figure means right now. [`Tone::Neutral`] is an ordinary fact.
1433 ///
1434 /// Applies to [`change`](Self::change) where there is one, since that is the
1435 /// part that carries the judgement, and to the value where there is not.
1436 pub tone: Tone,
1437}
1438
1439impl<'a> Figure<'a> {
1440 /// A figure that is an ordinary fact.
1441 #[must_use]
1442 pub const fn new(value: &'a str, caption: &'a str) -> Self {
1443 Self {
1444 value,
1445 caption,
1446 change: None,
1447 tone: Tone::Neutral,
1448 }
1449 }
1450
1451 /// How the value has moved.
1452 #[must_use]
1453 pub const fn change(mut self, change: &'a str) -> Self {
1454 self.change = Some(change);
1455 self
1456 }
1457
1458 /// What the figure means.
1459 #[must_use]
1460 pub const fn tone(mut self, tone: Tone) -> Self {
1461 self.tone = tone;
1462 self
1463 }
1464}
1465
1466/// Something the user can do, and what it costs to say so.
1467///
1468/// Added 0.17.0, out of `quasi-tui`: the terminal renderer had drawn one of
1469/// these for months and every other consumer that wanted a button had written
1470/// its own, because this layer named [`RowPart::Actions`] as a *slot* and never
1471/// named the thing that goes in it. Beside [`Meter`] and [`Figure`] for the
1472/// reason those are here: a renderer that is handed the parts has to decide how
1473/// to say them, and a renderer that is handed a finished string has already had
1474/// the decision made for it.
1475///
1476/// No address. Where a control goes is the app's business and every host
1477/// follows it differently — an `hx-get`, a protocol URL, a function call — so
1478/// the description says what the control *is* and the caller keeps what it
1479/// does. That is the same split [`Choice`] makes.
1480///
1481/// No confirmation flag either, and that one is a finding rather than an
1482/// omission: a question asked *after* a control is pressed belongs to whatever
1483/// is holding the interaction, and a renderer that drew it would be asking
1484/// before there was anything to answer.
1485/// How a picture sits in the box it is given.
1486///
1487/// An intent rather than a value, so a renderer picks the expression it has:
1488/// `object-fit` in a webview, a texture's UV rect in egui, and in a terminal a
1489/// choice about how many cells the blit gets. Named because MNW already makes
1490/// the distinction deliberately at 17 sites and makes it three different ways,
1491/// which is a policy the app decided rather than one a shared crate would be
1492/// picking by accident.
1493#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Default)]
1494#[non_exhaustive]
1495pub enum Fit {
1496 /// The picture's own proportions, and the box takes the height they imply.
1497 ///
1498 /// The default because it is the only one that shows the whole picture at
1499 /// its own shape, so a renderer that ignores this enum entirely is still
1500 /// right about the common case. A screenshot wants this; the shipped MNW
1501 /// carousel sets no `object-fit` at all, which is this.
1502 #[default]
1503 Natural,
1504 /// Fill the box and crop whatever does not fit.
1505 ///
1506 /// For a picture in a slot whose shape the layout fixed: a thumbnail, an
1507 /// avatar, cover art. 15 of MNW's 17 sites.
1508 Cover,
1509 /// Fit inside the box whole, leaving space on two sides.
1510 ///
1511 /// The letterbox. For when the whole picture matters more than filling the
1512 /// space, and the space is not the picture's shape.
1513 Contain,
1514}
1515
1516/// A picture, and what it says to someone who is not looking at it.
1517///
1518/// # No source
1519///
1520/// [`Act`]'s split, for [`Act`]'s reason. A source is an address, and this
1521/// crate has no notion of an address: it says what a thing *is* and the caller
1522/// keeps what it points at. The three findings dropped from 0.11.0 were all
1523/// this same shape.
1524///
1525/// It matters more here than it does for a control, because a picture is the
1526/// one member where the address is most of what a webview needs and *none* of
1527/// what the description knows. `quasi_router::Node::Image` carries the URL, the
1528/// way it carries an `Action` for a control.
1529///
1530/// # Why [`alt`](Self::alt) is not optional
1531///
1532/// Every other host has to draw something, and for two of the three the alt
1533/// text is not a fallback but the whole rendering: a terminal without a
1534/// graphics protocol has the words and nothing else. Making it optional would
1535/// make "this picture is invisible on a terminal" the default, and the
1536/// description would be carrying a webview assumption in its shape.
1537///
1538/// An image that genuinely says nothing — a rule, a spacer, a decoration
1539/// repeating what the text beside it already said — is an empty `alt`, which is
1540/// the same thing HTML means by it and is a claim rather than an oversight.
1541#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
1542pub struct Image<'a> {
1543 /// What the picture says, for anything not showing it.
1544 ///
1545 /// Empty means the picture is decorative and adds nothing to the text
1546 /// around it. See the type's own docs on why this is not an `Option`.
1547 pub alt: &'a str,
1548 /// A visible line under the picture, where the app wants one.
1549 ///
1550 /// Distinct from [`alt`](Self::alt) and the difference is who it is for: a
1551 /// caption is content everybody reads, alt text is what stands in for the
1552 /// picture. A screenshot captioned "The library view" still needs alt text
1553 /// describing what is in the shot.
1554 pub caption: Option<&'a str>,
1555 /// How it sits in the box it is given.
1556 pub fit: Fit,
1557 /// The picture's own dimensions, where the app knows them.
1558 ///
1559 /// **Not a display size**, and that distinction is what makes this belong
1560 /// here rather than fall foul of the deferral rule. Saying a picture should
1561 /// be 320 points wide is a layout value and is not the description's to
1562 /// give. Saying the file is 5120x3412 is a fact *about the picture*, the
1563 /// same kind of fact [`alt`](Self::alt) is, and no renderer can find it out
1564 /// without fetching the bytes.
1565 ///
1566 /// # What it is for, and it is not decoration
1567 ///
1568 /// Without it a renderer cannot reserve room, so the picture occupies
1569 /// nothing until it arrives and then takes its full height at once,
1570 /// shoving everything below it down the screen. Measured on MNW's landing
1571 /// page 2026-08-14: a 478px jump per frame, and a cumulative layout shift
1572 /// of 0.087 for the page, which is most of the way to the 0.1 that counts
1573 /// as bad.
1574 ///
1575 /// Every host wants it and none can derive it. A webview writes `width` and
1576 /// `height` so the browser holds the space; egui sizes a texture; a
1577 /// terminal with a graphics protocol scales a blit into cells. This was
1578 /// missing from 0.21.0, which is the release that added [`Image`], and its
1579 /// absence is the defect rather than an omission.
1580 ///
1581 /// `None` is honest and common: a creator-uploaded image whose dimensions
1582 /// the app never recorded genuinely does not know. It means the renderer
1583 /// cannot reserve, not that the picture has no size.
1584 pub intrinsic: Option<Extent>,
1585 /// Whether the picture is needed with the screen, or can arrive later.
1586 pub loading: Loading,
1587}
1588
1589/// A picture's own pixel dimensions.
1590///
1591/// Deliberately not [`makeover_geometry`]'s business. Geometry answers *how
1592/// much space a thing should get*, which is a scale question with the same
1593/// answer on every screen. This is the intrinsic size of one asset, which is a
1594/// fact about that asset and varies per picture.
1595///
1596/// [`makeover_geometry`]: https://docs.rs/makeover-geometry
1597#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
1598pub struct Extent {
1599 /// Width in the picture's own pixels.
1600 pub width: u32,
1601 /// Height in the picture's own pixels.
1602 pub height: u32,
1603}
1604
1605impl Extent {
1606 /// A picture's dimensions.
1607 #[must_use]
1608 pub const fn new(width: u32, height: u32) -> Self {
1609 Self { width, height }
1610 }
1611
1612 /// Width over height, or `None` if either side is zero.
1613 ///
1614 /// The form a renderer actually reserves space with: a box that knows its
1615 /// proportion holds the right height at any width, which is what a
1616 /// responsive picture needs and what a fixed pixel height cannot give.
1617 #[must_use]
1618 pub fn ratio(self) -> Option<f32> {
1619 (self.width > 0 && self.height > 0).then(|| self.width as f32 / self.height as f32)
1620 }
1621}
1622
1623/// When a picture is needed.
1624///
1625/// A claim about *importance and position* rather than a fetch mechanism, which
1626/// is why it is the description's to make: only the app knows whether a picture
1627/// is the first thing on the screen or the fortieth thing down a list.
1628///
1629/// # Eager is the default, and that is a correctness choice
1630///
1631/// 0.21.0 emitted the webview's `loading="lazy"` for every picture, on the
1632/// evidence that the one consumer measured wrote it. That was reading a habit
1633/// as a rule. Deferring a picture that is on screen at first paint does not
1634/// save anything -- it is needed immediately either way -- and it delays the
1635/// arrival, so the space it eventually takes is claimed later and the shift is
1636/// more visible, not less.
1637///
1638/// So the safe answer is the default and the optimisation is opted into. A
1639/// carousel is the case that proves the two cannot be one setting for the
1640/// renderer to choose: its first frame is on screen and its other frames are
1641/// not, in the same widget, at the same moment.
1642#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Default)]
1643#[non_exhaustive]
1644pub enum Loading {
1645 /// Needed with the screen. Fetch it now.
1646 #[default]
1647 Eager,
1648 /// Not on screen yet. It can wait until it is near.
1649 Lazy,
1650}
1651
1652impl<'a> Image<'a> {
1653 /// A picture that carries its own proportions.
1654 #[must_use]
1655 pub const fn new(alt: &'a str) -> Self {
1656 Self {
1657 alt,
1658 caption: None,
1659 fit: Fit::Natural,
1660 intrinsic: None,
1661 loading: Loading::Eager,
1662 }
1663 }
1664
1665 /// The picture's own dimensions, so a renderer can hold its place.
1666 #[must_use]
1667 pub const fn intrinsic(mut self, width: u32, height: u32) -> Self {
1668 self.intrinsic = Some(Extent::new(width, height));
1669 self
1670 }
1671
1672 /// This picture is not on screen yet; it can arrive when it is near.
1673 #[must_use]
1674 pub const fn lazy(mut self) -> Self {
1675 self.loading = Loading::Lazy;
1676 self
1677 }
1678
1679 /// A visible line under it.
1680 #[must_use]
1681 pub const fn caption(mut self, caption: &'a str) -> Self {
1682 self.caption = Some(caption);
1683 self
1684 }
1685
1686 /// How it sits in its box.
1687 #[must_use]
1688 pub const fn fit(mut self, fit: Fit) -> Self {
1689 self.fit = fit;
1690 self
1691 }
1692
1693 /// Whether the picture adds anything for someone not looking at it.
1694 ///
1695 /// A renderer with no way to show a picture uses this to decide between
1696 /// drawing the alt text and drawing nothing at all. Both are correct and
1697 /// the difference is this flag: standing in for a decorative rule with the
1698 /// word "decoration" is worse than leaving the space empty.
1699 #[must_use]
1700 pub const fn speaks(self) -> bool {
1701 !self.alt.is_empty()
1702 }
1703}
1704
1705/// What a [`Track`]'s integers count.
1706///
1707/// `Track::fraction` never needed this -- the arithmetic is the same whatever
1708/// the numbers mean -- which is exactly how the ruler came to assume minutes
1709/// and print `00:00` over a month. A renderer drawing an axis has to write a
1710/// label, and it cannot derive the unit from the numbers.
1711///
1712/// Added 2026-08-15, after a probe put a fifteen-day span on a
1713/// thirty-one-slot track and got correct geometry under a wall clock.
1714#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Default)]
1715#[non_exhaustive]
1716pub enum Unit {
1717 /// Minutes from the start of a day. A day view.
1718 #[default]
1719 Minutes,
1720 /// Whole days. A month strip, a sprint, a stretch of leave.
1721 ///
1722 /// A day-granularity axis is a *strip*, not a calendar: one line with
1723 /// spans laid along it. What it deliberately does not do is wrap into
1724 /// weeks, which is the shape that makes weekday periodicity visible and
1725 /// the one job of a month grid that a strip cannot take over. See the
1726 /// crate header.
1727 Days,
1728}
1729
1730/// A window on an axis, in whatever [`Unit`] its [`Track`] counts.
1731///
1732/// The axis a [`Track`] draws. Offsets rather than instants, because a
1733/// description carrying a `DateTime` would carry a timezone with it and the
1734/// vocabulary has no business holding one. The app knows which day or month
1735/// this is; the description says how far along it a thing sits.
1736///
1737/// `to` is exclusive and may exceed the natural period, which is how a span
1738/// running past the end is said without a second date: under
1739/// [`Unit::Minutes`], `Span::new(1320, 1560)` is 22:00 to 02:00.
1740#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
1741pub struct Span {
1742 from: u16,
1743 to: u16,
1744}
1745
1746impl Span {
1747 /// Midnight to midnight, the ordinary day.
1748 pub const DAY: Self = Self { from: 0, to: 1440 };
1749
1750 /// A span, clamped to a sane one.
1751 ///
1752 /// An empty or backwards span is a caller bug that should not cost a
1753 /// renderer a division by zero, so `to` is forced at least one minute past
1754 /// `from` rather than returning an error nobody can act on. Same reasoning
1755 /// as [`Share::percent`], which clamps rather than refuses.
1756 #[must_use]
1757 pub const fn new(from: u16, to: u16) -> Self {
1758 Self {
1759 from,
1760 to: if to > from { to } else { from + 1 },
1761 }
1762 }
1763
1764 /// The first minute on the axis.
1765 #[must_use]
1766 pub const fn from(self) -> u16 {
1767 self.from
1768 }
1769
1770 /// One past the last minute on the axis.
1771 #[must_use]
1772 pub const fn to(self) -> u16 {
1773 self.to
1774 }
1775
1776 /// How much the axis covers, in its track's unit. Never zero.
1777 #[must_use]
1778 pub const fn length(self) -> u16 {
1779 self.to - self.from
1780 }
1781
1782 /// Whether an offset falls on this axis.
1783 #[must_use]
1784 pub const fn holds(self, minute: u16) -> bool {
1785 minute >= self.from && minute < self.to
1786 }
1787}
1788
1789impl Default for Span {
1790 fn default() -> Self {
1791 Self::DAY
1792 }
1793}
1794
1795/// Where a thing sits on a [`Track`], and for how long.
1796///
1797/// The one fact a list cannot carry and the whole reason this primitive exists.
1798/// A list says what order things come in; a track says a thing starts 135
1799/// minutes along and lasts 45, which is a different claim and not derivable
1800/// from the first.
1801#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
1802pub struct Placement {
1803 at: u16,
1804 length: u16,
1805}
1806
1807impl Placement {
1808 /// A placement, clamped to a drawable one.
1809 ///
1810 /// Zero length becomes one for the same reason [`Span::new`] clamps: a
1811 /// zero-height thing is invisible rather than expressive, and every
1812 /// renderer would need its own guard.
1813 #[must_use]
1814 pub const fn new(at: u16, length: u16) -> Self {
1815 Self {
1816 at,
1817 length: if length == 0 { 1 } else { length },
1818 }
1819 }
1820
1821 /// Offset from the axis origin, matching [`Span`]'s.
1822 #[must_use]
1823 pub const fn at(self) -> u16 {
1824 self.at
1825 }
1826
1827 /// How long it lasts, in its track's unit. Never zero.
1828 #[must_use]
1829 pub const fn length(self) -> u16 {
1830 self.length
1831 }
1832
1833 /// One past its last minute.
1834 #[must_use]
1835 pub const fn end(self) -> u16 {
1836 self.at + self.length
1837 }
1838
1839 /// Whether two placements cover any of the same time.
1840 ///
1841 /// Geometry, and deliberately not a described field. Whether an overlap is
1842 /// a *conflict* is the app's judgment -- a meeting inside a block of free
1843 /// time overlaps and is fine -- and that judgment travels the way every
1844 /// other judgment does, as a [`Tone`] on the thing itself. What a renderer
1845 /// needs in order to lay two things side by side instead of on top of each
1846 /// other is this, and it can compute it.
1847 ///
1848 /// The alternative was a `conflicts: bool` on each entry, which is state
1849 /// that can disagree with the times beside it. Two sources for one fact is
1850 /// how a screen starts rendering a conflict badge on a thing that no longer
1851 /// conflicts.
1852 #[must_use]
1853 pub const fn overlaps(self, other: Self) -> bool {
1854 self.at < other.end() && other.at < self.end()
1855 }
1856}
1857
1858/// A time axis: things placed by when they happen, rather than flowed.
1859///
1860/// # Why this is a primitive
1861///
1862/// This crate refused to name it until 2026-08-15, on the argument that a
1863/// description expressive enough to draw a timeline is a component library
1864/// wearing a description's name. The refusal is withdrawn, and it is worth
1865/// being precise about what was wrong with it, because the reasoning it used
1866/// applies to real cases and should not be discarded with it.
1867///
1868/// What a timeline needs that a [`List`](Region::Pane) does not is **one**
1869/// thing: placement. Where a thing sits is a fact about the thing, the way a
1870/// row's primary text is, and it is not derivable from order. Everything else a
1871/// day view draws -- the labels, the gridlines, the item bodies, the tones --
1872/// is furniture this vocabulary already names. Measured against goingson's
1873/// `day-planning-render.js`, the only members it needed and could not get were
1874/// `at` and `minutes`.
1875///
1876/// So the timeline was never a component library's worth of vocabulary. It was
1877/// two integers, and the refusal was priced as though it were the whole widget.
1878/// The test that matters is not "does this shape look complicated" but "how
1879/// many members does it actually add, and are they facts or presentation".
1880/// Slot heights, gridline colour, how overlaps stack and which hour scrolls
1881/// into view on open are all presentation and all stay the renderer's, which is
1882/// why they are absent here.
1883///
1884/// # What it does not carry
1885///
1886/// No pixel measure, no scroll offset, no drag affordance. A renderer draws the
1887/// span at whatever density its host uses; `makeover-geometry` owns that the
1888/// way it owns everything else measured in pixels.
1889#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
1890pub struct Track {
1891 /// The window the axis covers.
1892 pub span: Span,
1893 /// The granularity a thing can be placed on, in minutes.
1894 ///
1895 /// goingson's day view is 15, giving 96 slots across a day. A renderer uses
1896 /// it to decide where gridlines fall and what a drop lands on; it does not
1897 /// constrain [`Placement`], because data arriving from a calendar does not
1898 /// respect anyone's grid.
1899 pub slot: u16,
1900 /// How often the axis labels itself, in its own unit.
1901 ///
1902 /// 60 gives an hourly ruler over a 15-minute grid, which is the common
1903 /// shape and the reason this is separate from `slot`. Zero means an
1904 /// unlabelled axis.
1905 pub tick: u16,
1906 /// What `span`, `slot`, `tick` and every [`Placement`] on it count.
1907 ///
1908 /// The one field here a renderer cannot derive, and the reason it exists:
1909 /// [`fraction`](Self::fraction) is unit-agnostic, so a day-granularity
1910 /// track produced correct geometry under an hours-and-minutes ruler until
1911 /// this was added. Geometry never needed it; a label always did.
1912 pub unit: Unit,
1913}
1914
1915impl Track {
1916 /// An ordinary day: midnight to midnight, quarter-hour slots, hourly ticks.
1917 pub const DAY: Self = Self {
1918 span: Span::DAY,
1919 slot: 15,
1920 tick: 60,
1921 unit: Unit::Minutes,
1922 };
1923
1924 /// A track over `span`, with the day's usual granularity.
1925 #[must_use]
1926 pub const fn over(span: Span) -> Self {
1927 Self {
1928 span,
1929 slot: 15,
1930 tick: 60,
1931 unit: Unit::Minutes,
1932 }
1933 }
1934
1935 /// A strip of whole days: one slot a day, a label a week.
1936 ///
1937 /// The shape a stretch of leave or a sprint is drawn on. Not a calendar --
1938 /// it does not wrap into weeks, and the crate header says why that
1939 /// distinction is the whole of what a month grid still has over this.
1940 #[must_use]
1941 pub const fn days(span: Span) -> Self {
1942 Self {
1943 span,
1944 slot: 1,
1945 tick: 7,
1946 unit: Unit::Days,
1947 }
1948 }
1949
1950 /// How many slots the axis holds.
1951 ///
1952 /// Rounded up, so a span that does not divide evenly by `slot` still has a
1953 /// slot covering its tail rather than dropping it. Never zero: `slot` of 0
1954 /// reads as one slot spanning the whole axis rather than a division by
1955 /// zero, since a renderer asking this question has already committed to
1956 /// drawing something.
1957 #[must_use]
1958 pub const fn slots(self) -> u16 {
1959 if self.slot == 0 {
1960 1
1961 } else {
1962 self.span.length().div_ceil(self.slot)
1963 }
1964 }
1965
1966 /// Where a placement sits on the axis, as a fraction from 0.0 to 1.0.
1967 ///
1968 /// The one calculation every renderer would otherwise write itself, and the
1969 /// place the three would drift apart. Clamped, so a placement outside the
1970 /// span draws at the edge rather than off it -- an event running past
1971 /// midnight is a real thing and truncating it is better than either
1972 /// panicking or drawing it somewhere impossible.
1973 #[must_use]
1974 pub fn fraction(self, minute: u16) -> f32 {
1975 let span = f32::from(self.span.length());
1976 let offset = f32::from(minute.saturating_sub(self.span.from()));
1977 (offset / span).clamp(0.0, 1.0)
1978 }
1979}
1980
1981impl Default for Track {
1982 fn default() -> Self {
1983 Self::DAY
1984 }
1985}
1986
1987#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
1988pub struct Act<'a> {
1989 /// What the control says.
1990 pub label: &'a str,
1991 /// The key that reaches it where a host has keys.
1992 ///
1993 /// The one member written for a terminal before there was one. A webview
1994 /// hangs it off `accesskey` or ignores it; a terminal has nothing else to
1995 /// offer, so this is the whole of how a control is reached there.
1996 pub key: Option<&'a str>,
1997 /// What pressing it means. [`Tone::Danger`] is the destructive one.
1998 pub tone: Tone,
1999 /// Disabled, or nothing said.
2000 ///
2001 /// [`State::Disabled`] is what changes what a renderer may do: see
2002 /// [`State::suppresses_interaction`], which is what says a disabled control
2003 /// is drawn and not reachable. It has been the only member since 0.19.0,
2004 /// and a control's focus is not sayable here at all — see the crate header,
2005 /// "Reach, focus and the focus ring".
2006 pub state: Option<State>,
2007}
2008
2009impl<'a> Act<'a> {
2010 /// An ordinary control, reachable, with no key.
2011 #[must_use]
2012 pub const fn new(label: &'a str) -> Self {
2013 Self {
2014 label,
2015 key: None,
2016 tone: Tone::Neutral,
2017 state: None,
2018 }
2019 }
2020
2021 /// The key that reaches it.
2022 #[must_use]
2023 pub const fn key(mut self, key: &'a str) -> Self {
2024 self.key = Some(key);
2025 self
2026 }
2027
2028 /// What pressing it means.
2029 #[must_use]
2030 pub const fn tone(mut self, tone: Tone) -> Self {
2031 self.tone = tone;
2032 self
2033 }
2034
2035 /// Focus, or disabled.
2036 #[must_use]
2037 pub const fn state(mut self, state: State) -> Self {
2038 self.state = Some(state);
2039 self
2040 }
2041
2042 /// Whether the control is drawn and does not answer.
2043 #[must_use]
2044 pub fn disabled(&self) -> bool {
2045 self.state.is_some_and(State::suppresses_interaction)
2046 }
2047}
2048
2049/// A named part of a screen.
2050///
2051/// The thing `makeover-geometry` deliberately does not name: it names the space
2052/// *between* things by relationship, and nothing named the things. Six named
2053/// members, taken from what the two webview apps actually use, plus
2054/// [`Region::Bespoke`] for the parts no description should reach. Both apps'
2055/// `layout.css` currently names exactly two things, `.raised` and `.well`, so
2056/// this layer is absent rather than divergent, which makes it the cheapest of
2057/// the schemas to add and the easiest to over-build.
2058///
2059/// `#[non_exhaustive]` arrives with [`Region::Widget`], the pairing [`RowPart`]
2060/// made at 0.9.0 and [`Readiness`] at 0.12.0, and for the same reason: the
2061/// member after this one should not be a lockstep event across three renderers.
2062#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
2063#[non_exhaustive]
2064pub enum Region<'a> {
2065 /// A full-width strip with a title slot and an actions cluster, either of
2066 /// which may be empty. goingson's `.page-header`, Balanced Breakfast's
2067 /// `.header` and `.detail-header` are all this, differing only in which
2068 /// slots they fill.
2069 Band,
2070 /// A persistent column beside the content, holding navigation.
2071 Sidebar,
2072 /// A region of content with its own scroll.
2073 Pane,
2074 /// Things that belong together, and nothing else.
2075 ///
2076 /// The block [`Heading::Section`] has been naming since 0.2.0 without the
2077 /// vocabulary being able to contain it. A section heading is a leaf sitting
2078 /// *beside* the things it names, so nothing said where a section started or
2079 /// ended and a renderer learned one had ended only because the next heading
2080 /// arrived.
2081 ///
2082 /// # The measurement
2083 ///
2084 /// 41 [`Heading::Section`] sites across the ten screens described through
2085 /// the router, not one of them contained. audiofiles' settings screen is the
2086 /// clearest: one pane holding a heading, a field, a heading, two toggles, a
2087 /// heading, a toggle and a heading, which is four sections and no
2088 /// containers. Under the hand-written CSS the ports are replacing the same
2089 /// block is spelled `.settings-section` in goingson, `.form-section` and
2090 /// `.content-section` in the MNW server, `.help-section` in Balanced
2091 /// Breakfast: three apps, four names, one shape.
2092 ///
2093 /// # Why the existing members were the wrong answer
2094 ///
2095 /// [`Pane`](Self::Pane) is what apps reached for, and it is 28 of the 45
2096 /// regions in the described screens. It claims a scroll of its own and
2097 /// [`Depth::Well`], so four settings groups inside a pane are four wells
2098 /// inside a well and four scroll contexts. Neither claim is true of a group.
2099 ///
2100 /// [`Widget`](Self::Widget) is wrong from the other side. Its own docs say a
2101 /// widget is never how a primitive gets added by the back door, and a run of
2102 /// related controls under a heading is furniture any app would have, which
2103 /// is the generic-against-bespoke bar a primitive has to clear.
2104 ///
2105 /// # What it does not carry
2106 ///
2107 /// **A heading.** A group usually has one and it is an ordinary node in the
2108 /// body, the way it already was. A group of related toggles with no heading
2109 /// is a real thing and a mandatory slot would forbid it.
2110 ///
2111 /// **A depth.** [`Depth::Flat`], on [`Bespoke`](Self::Bespoke)'s reasoning:
2112 /// it inherits, and an app that wants its group in a well puts it in a
2113 /// [`Pane`](Self::Pane), which composes rather than adding a knob here.
2114 ///
2115 /// **A colour.** Distinguishing sibling groups by colour is the thing this
2116 /// member was asked for and it is deliberately not stated here. The
2117 /// description says these things belong together; which of the theme's
2118 /// categorical colours a renderer reaches for, and whether it reaches for
2119 /// one at all, is derived from sibling order at the renderer. A terminal
2120 /// that tints nothing and separates with a rule is honouring this.
2121 Group,
2122 /// Two panes side by side, where the left chooses what the right shows.
2123 Split,
2124 /// Peer regions across, all of them equals.
2125 ///
2126 /// A kanban board's columns, and the shape [`Split`](Self::Split) is not:
2127 /// a split's two panes stand in a master-detail relationship, where the
2128 /// left chooses what the right shows. These choose nothing about each
2129 /// other. Each is a whole region and the set is the arrangement.
2130 ///
2131 /// # What it does not carry
2132 ///
2133 /// **How many.** The children say, and a count here would be a second
2134 /// source for something the description already states by containing them.
2135 ///
2136 /// **How wide.** Peers are equal by definition, so there is no [`Share`] to
2137 /// state. A board whose columns wanted different widths would be a
2138 /// different member, and no app has one.
2139 ///
2140 /// **What happens when there is no room.** Scroll across, wrap, or collapse
2141 /// to one column at a time: all three are right on some host, none is
2142 /// derivable from the description, and every one of them is presentation.
2143 /// A terminal that stacks them vertically is honouring this, not degrading
2144 /// it.
2145 ///
2146 /// # Why it is not an `Arrangement`
2147 ///
2148 /// [`Arrangement`] is the page's shape, and a board is usually a region
2149 /// *inside* a page that also has a band over it. Naming it here composes;
2150 /// naming it there would make a screen either a board or a list-detail and
2151 /// never a band above a board. It also keeps [`Arrangement::share`]
2152 /// meaningful, which a peer arrangement has no answer for.
2153 Columns,
2154 /// A set of panes, one visible at a time, with a [`Selector::Tabs`] above.
2155 TabGroup,
2156 /// Content over a scrim, taking input until dismissed.
2157 Modal,
2158 /// A region this crate names the *place* of and nothing else. The app owns
2159 /// what goes in it.
2160 ///
2161 /// The escape hatch, and the thing that keeps the description honest about
2162 /// its own limits. A day-plan timeline, a kanban board, a calendar and the
2163 /// paint interaction over the timeline are not describable here and are not
2164 /// going to become describable: a description expressive enough to produce
2165 /// a timeline is a widget library wearing a description's name.
2166 ///
2167 /// But a screen containing one still has to be a screen. Without this
2168 /// member the description covers only the boring screens, and the four that
2169 /// make goingson worth using would need a second, undescribed path beside
2170 /// the router. Two paths is how the vocabulary starts drifting from the app
2171 /// again, which is the exact failure this crate exists to end.
2172 ///
2173 /// So the description says "a thing called `day-plan` goes here" and stops.
2174 /// The name is opaque: this crate never interprets it, and no renderer is
2175 /// expected to know what it means beyond handing the space over.
2176 Bespoke {
2177 /// What the app calls it. Never interpreted here.
2178 name: &'a str,
2179 },
2180 /// A named assembly of things the vocabulary already says.
2181 ///
2182 /// The third tier, between a primitive and [`Bespoke`](Self::Bespoke).
2183 /// Stated by Max 2026-08-12 answering the carousel: "something in between a
2184 /// primitive and a bespoke interface, like a widget, which is just an
2185 /// assembly of primitives." Full note: wiki `widget-tier`.
2186 ///
2187 /// # What separates it from the two members either side
2188 ///
2189 /// A primitive is a thing every renderer draws from scratch, and the test
2190 /// it has to pass is that every host has an honest answer. A carousel fails
2191 /// that test — a terminal has no carousel — which is the same refusal
2192 /// `Node::Html` got and is why the carousel sat unsayable for months.
2193 ///
2194 /// [`Bespoke`](Self::Bespoke) fails it from the other side. Bespoke is for
2195 /// what one app owns and nobody will build twice, and it carries *no*
2196 /// contents: the description names the place and stops. A carousel is
2197 /// furniture any app would have, and every part of it — an ordered set of
2198 /// frames, a position, prev and next, a strip of position indicators — is
2199 /// already sayable. Only the assembly had no name.
2200 ///
2201 /// So this member is the pair the other two are not: a name **and**
2202 /// contents. The contents are the assembly, in the region's own body, said
2203 /// in members that already exist.
2204 ///
2205 /// # Why the name does not have to be understood
2206 ///
2207 /// A renderer that recognises the name draws it the way its host does it: a
2208 /// carousel in a webview, a pager with a count in a terminal, a selector in
2209 /// egui. A renderer that does not recognise it walks the body, which is
2210 /// primitives all the way down and which it can already draw.
2211 ///
2212 /// That is what lets the widget set be **open** without every renderer
2213 /// knowing every widget. An unrecognised widget degrades to its assembly
2214 /// instead of failing, so a second or third party can name one without
2215 /// three renderers releasing in lockstep to accept it. Contrast
2216 /// [`Bespoke`](Self::Bespoke), which no renderer can degrade: there is
2217 /// nothing under it to fall back to.
2218 ///
2219 /// # What it does not do
2220 ///
2221 /// A widget is an assembly of things the vocabulary *already* says, so it
2222 /// buys no expressive power. Anything needing a member the vocabulary does
2223 /// not have is a finding about the vocabulary, and the answer to a finding
2224 /// is to add the member. A widget is never the way a primitive gets added
2225 /// by the back door.
2226 ///
2227 /// This used to say "it does not make a timeline describable, and the
2228 /// refusal in the crate header stands unchanged". The timeline is
2229 /// describable as of 2026-08-15 -- see [`Track`] -- and it got there the
2230 /// way the paragraph above says it should have: by adding the two members
2231 /// that were missing, not by dressing the screen up as an assembly.
2232 Widget {
2233 /// What the assembly is called. This crate never interprets it, and a
2234 /// renderer is free not to know it.
2235 name: &'a str,
2236 },
2237}
2238
2239impl<'a> Region<'a> {
2240 /// How the region sits on what is behind it.
2241 #[must_use]
2242 pub const fn depth(self) -> Depth {
2243 match self {
2244 Self::Band | Self::Sidebar | Self::Split | Self::TabGroup => Depth::Flat,
2245 // Flat, and it inherits. A group says its contents belong together
2246 // and says nothing about the surface they sit on, so a group in a
2247 // pane is in a well and a group on the page is on the page. An app
2248 // wanting one lifted puts it in a `Pane`.
2249 Self::Group => Depth::Flat,
2250 // Flat, and it is the container rather than the columns. Each
2251 // column is its own region and brings its own depth; a well here
2252 // would put a second edge around a row of wells.
2253 Self::Columns => Depth::Flat,
2254 // A pane is looked into, the same as a table body or a tag tree.
2255 Self::Pane => Depth::Well,
2256 Self::Modal => Depth::Raised,
2257 // Flat because it inherits: a bespoke region takes the depth of
2258 // whatever frames it. An app that wants its timeline in a well puts
2259 // it in a `Pane`, which composes rather than adding a knob here.
2260 //
2261 // A widget inherits for the same reason and it matters more here,
2262 // because a widget is drawn by whichever renderer recognises it. A
2263 // depth set here would be this crate deciding that a carousel is
2264 // raised on every host, which is the kind of value the deferral
2265 // rule exists to refuse.
2266 Self::Bespoke { .. } | Self::Widget { .. } => Depth::Flat,
2267 }
2268 }
2269
2270 /// Whether this crate can say anything about the region's contents.
2271 ///
2272 /// A renderer walks the description and hands every region it understands
2273 /// to the right drawing code. This is how it tells the two apart, and the
2274 /// reason it is a method rather than a `matches!` at each renderer: there
2275 /// is exactly one opaque member and there should stay exactly one.
2276 ///
2277 /// [`Widget`](Self::Widget) is described, and that is the whole of what
2278 /// separates it from [`Bespoke`](Self::Bespoke) here. Both carry a name
2279 /// this crate never interprets; only one of them carries contents under it.
2280 /// A renderer that does not recognise a widget's name still walks its body,
2281 /// so there is nothing for it to hand over and nothing it cannot draw.
2282 #[must_use]
2283 pub const fn described(self) -> bool {
2284 !matches!(self, Self::Bespoke { .. })
2285 }
2286
2287 /// The name an app gave this region, if it gave one.
2288 ///
2289 /// [`Bespoke`](Self::Bespoke) and [`Widget`](Self::Widget) are the two
2290 /// members that carry a name, for two different purposes: one says what the
2291 /// app will fill the space with, the other says what the assembly under it
2292 /// is called. A renderer dispatching on either wants the string without
2293 /// caring which member it came from, and writing that `matches!` at each
2294 /// renderer is how the two drift apart.
2295 #[must_use]
2296 pub const fn name(self) -> Option<&'a str> {
2297 match self {
2298 Self::Bespoke { name } | Self::Widget { name } => Some(name),
2299 // Spelled out rather than a wildcard, so a member added later has
2300 // to answer whether it carries a name instead of inheriting `None`
2301 // by sitting under a `_`.
2302 Self::Band
2303 | Self::Sidebar
2304 | Self::Pane
2305 | Self::Group
2306 | Self::Split
2307 | Self::Columns
2308 | Self::TabGroup
2309 | Self::Modal => None,
2310 }
2311 }
2312}
2313
2314/// How many of a region's children are visible at once.
2315///
2316/// `4dcd241b`. Three findings turned out to be one sentence the vocabulary
2317/// could not say: *this region holds several children and shows some of them,
2318/// and the reader can change which.* [`Region::TabGroup`] existed with nothing
2319/// saying which tab was open, a carousel had nothing saying which frame was up,
2320/// and a disclosure had nothing saying whether its one child was showing at all.
2321///
2322/// Because the fact lived nowhere, a renderer had two moves: hardcode a widget
2323/// name, or draw every child. That is what put per-widget code in renderers, and
2324/// it was the missing member rather than the widget tier that put it there.
2325///
2326/// # What is here and what is not
2327///
2328/// The *kind*, and only the kind. Which child is currently up is the current
2329/// answer, and a layer that defers every address does not hold the current
2330/// answer either — the split [`Selector`] already makes, where this crate says
2331/// what kind of chooser a thing is and the router says which option is picked.
2332/// So a holder of regions carries the index and the per-child label beside this.
2333///
2334/// # What a renderer does with it
2335///
2336/// Derives its chrome, once, for every widget rather than per name:
2337///
2338/// - Children carrying labels get a strip of the labels, the current one marked.
2339/// - Children carrying none get previous, position, next.
2340/// - [`AtMostOne`](Self::AtMostOne) over one child gets a summary line that
2341/// opens.
2342///
2343/// The name on [`Region::Widget`] survives as app vocabulary, for a renderer
2344/// that wants to do something *special* with one, which is what it should have
2345/// been from the start.
2346///
2347/// Degradation runs the way it already did: a renderer ignoring this draws every
2348/// child, which is more content rather than less.
2349#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Default)]
2350#[non_exhaustive]
2351pub enum Showing {
2352 /// Every child, in order. What every region did before this existed.
2353 #[default]
2354 All,
2355 /// Exactly one. A carousel, a tab group.
2356 One,
2357 /// One, or none. A disclosure, which is closed until it is opened.
2358 AtMostOne,
2359}
2360
2361impl Showing {
2362 /// Whether the reader can change which child is up.
2363 ///
2364 /// The question every renderer's region arm asks before deriving any
2365 /// chrome, and a method rather than a `matches!` at each renderer for
2366 /// [`Region::name`]'s reason: three renderers writing the same comparison is
2367 /// how they come to disagree about a member added later.
2368 #[must_use]
2369 pub const fn selective(self) -> bool {
2370 !matches!(self, Self::All)
2371 }
2372
2373 /// Whether showing nothing is a legal state.
2374 ///
2375 /// True only for [`AtMostOne`](Self::AtMostOne). A renderer needs this to
2376 /// know whether its control closes as well as moves: a carousel's row moves
2377 /// between frames and never reaches empty, and a disclosure's summary line
2378 /// is the same control wearing its closed state.
2379 #[must_use]
2380 pub const fn dismissible(self) -> bool {
2381 matches!(self, Self::AtMostOne)
2382 }
2383}
2384
2385/// A window onto a sequence: where it starts, how much it covers, and how long
2386/// the sequence is when that is known.
2387///
2388/// The mechanism under two things the vocabulary deliberately keeps apart. A
2389/// carousel is a window of one frame over children that are all present; a
2390/// paged list is a window of a page over rows most of which were never fetched.
2391/// Those are different facts and they stay different types — [`Showing`] says
2392/// which child is up, [`Paging`] says where a reader is in a query — but the
2393/// arithmetic underneath is one piece of code, so a terminal and a browser
2394/// cannot come to disagree about which frame is last.
2395///
2396/// # Why `of` is optional and `count` is not
2397///
2398/// `count` is what is on screen and is therefore always known. `of` is the
2399/// length of the thing being windowed, and a host that cannot count says so by
2400/// leaving it empty **for the life of the screen**. It is never "not counted
2401/// yet": see "First paint is final paint" in the crate header. A total that
2402/// turns up on a later pass widens the text that prints it.
2403///
2404/// # Clamping
2405///
2406/// Every derivation clamps rather than refusing, and a zero `count` answers
2407/// `None` rather than dividing. A window past the end is a bug in the host, and
2408/// a renderer that answered it by drawing nothing would report a region that
2409/// vanished, which is the hardest kind of bug to find from what is on screen.
2410/// [`Share::percent`] clamps for the same reason.
2411#[derive(Debug, Clone, Copy, PartialEq, Eq, Default)]
2412pub struct Window {
2413 /// The index into the sequence where the window starts.
2414 pub from: usize,
2415 /// How many the window covers. One, for a carousel.
2416 pub count: usize,
2417 /// How long the sequence is, when the host can say.
2418 pub of: Option<usize>,
2419}
2420
2421impl Window {
2422 /// A window of `count`, starting at `from`, over a sequence of unknown
2423 /// length.
2424 #[must_use]
2425 pub const fn new(from: usize, count: usize) -> Self {
2426 Self {
2427 from,
2428 count,
2429 of: None,
2430 }
2431 }
2432
2433 /// How long the sequence is.
2434 #[must_use]
2435 pub const fn of(mut self, of: usize) -> Self {
2436 self.of = Some(of);
2437 self
2438 }
2439
2440 /// One item of a sequence whose length is known. A carousel frame.
2441 #[must_use]
2442 pub const fn frame(at: usize, of: usize) -> Self {
2443 Self {
2444 from: at,
2445 count: 1,
2446 of: Some(of),
2447 }
2448 }
2449
2450 /// Which window this is, counting from zero.
2451 ///
2452 /// `None` when `count` is zero, which is the only input with no answer
2453 /// rather than a clamped one.
2454 #[must_use]
2455 pub const fn index(self) -> Option<usize> {
2456 if self.count == 0 {
2457 return None;
2458 }
2459 Some(self.from / self.count)
2460 }
2461
2462 /// How many windows the sequence holds.
2463 ///
2464 /// `None` unless both the length and a non-zero `count` are known. A
2465 /// partial answer here would be a renderer drawing "of 0".
2466 #[must_use]
2467 pub const fn windows(self) -> Option<usize> {
2468 match self.of {
2469 Some(of) if self.count > 0 => Some(of.div_ceil(self.count)),
2470 _ => None,
2471 }
2472 }
2473
2474 /// Whether anything sits before this window.
2475 #[must_use]
2476 pub const fn has_before(self) -> bool {
2477 self.from > 0
2478 }
2479
2480 /// How many sit after this window, when the length is known.
2481 ///
2482 /// Here rather than in each renderer for [`Showing::selective`]'s reason:
2483 /// three of them writing the same subtraction is how they come to disagree,
2484 /// and this one has an underflow in it for whoever writes it fourth.
2485 #[must_use]
2486 pub const fn after(self) -> Option<usize> {
2487 match self.of {
2488 Some(of) => Some(of.saturating_sub(self.from.saturating_add(self.count))),
2489 None => None,
2490 }
2491 }
2492
2493 /// Whether anything sits after it.
2494 ///
2495 /// `true` when the length is unknown: a host that cannot count cannot rule
2496 /// out more, and offering a way forward that turns out to be empty is the
2497 /// cheaper of the two mistakes.
2498 #[must_use]
2499 pub const fn has_after(self) -> bool {
2500 match self.of {
2501 Some(of) => self.from.saturating_add(self.count) < of,
2502 None => true,
2503 }
2504 }
2505
2506 /// The window with `from` brought inside the sequence.
2507 ///
2508 /// A no-op when the length is unknown, since there is nothing to clamp
2509 /// against.
2510 #[must_use]
2511 pub const fn clamped(mut self) -> Self {
2512 if let Some(of) = self.of
2513 && self.from >= of
2514 {
2515 // `max(1)` by hand: `Ord::max` is not const yet, and a zero-count
2516 // window would otherwise clamp onto the end rather than inside it.
2517 let step = if self.count == 0 { 1 } else { self.count };
2518 self.from = of.saturating_sub(step);
2519 }
2520 self
2521 }
2522}
2523
2524/// Where a reader is in a set that arrived in parts.
2525///
2526/// A [`Window`] wearing the paged reading of itself. Distinct from a carousel's
2527/// window at the top level on purpose, because the intent differs and a call
2528/// site should say which one it means, while the arithmetic below is shared so
2529/// the two cannot drift apart.
2530///
2531/// # The two idioms, and which one a renderer may draw
2532///
2533/// Load-more and numbered pages are both this type. Which is honest is
2534/// [`paged`](Self::paged): a set whose page size is known can be drawn as
2535/// "Page 3 of 8", and one without can only be drawn as "150 of 400" and a way
2536/// forward. Saying it here rather than letting each renderer guess is the point
2537/// — three renderers inferring it from the numbers is how they come to disagree.
2538///
2539/// # What it does not carry
2540///
2541/// No addresses. `makeover-layout` cannot name an action, and the way to ask for
2542/// the next part is the host's: `quasi_router` pairs this with the addresses the
2543/// same way `Row` pairs its parts with `Row::activate`. That split is the reason
2544/// this type is reusable by a carousel, which has nothing to ask.
2545#[derive(Debug, Clone, Copy, PartialEq, Eq, Default)]
2546pub struct Paging {
2547 /// The window onto the set.
2548 pub window: Window,
2549 /// Whether the parts are a fixed size, and so whether pages are countable.
2550 ///
2551 /// `false` for load-more, where the window simply grew and "page 2" would
2552 /// name nothing.
2553 pub paged: bool,
2554}
2555
2556impl Paging {
2557 /// A page of `per`, starting at `from`.
2558 #[must_use]
2559 pub const fn pages(from: usize, per: usize) -> Self {
2560 Self {
2561 window: Window::new(from, per),
2562 paged: true,
2563 }
2564 }
2565
2566 /// The first `shown`, with more behind them.
2567 ///
2568 /// The load-more shape: the window starts at the beginning and grows, so
2569 /// there is no page to number.
2570 #[must_use]
2571 pub const fn more(shown: usize) -> Self {
2572 Self {
2573 window: Window::new(0, shown),
2574 paged: false,
2575 }
2576 }
2577
2578 /// How many there are altogether.
2579 ///
2580 /// Left unsaid by a host that cannot count, and left unsaid **for good**:
2581 /// a total arriving later widens whatever prints it. See "First paint is
2582 /// final paint" in the crate header.
2583 #[must_use]
2584 pub const fn of(mut self, of: usize) -> Self {
2585 self.window = self.window.of(of);
2586 self
2587 }
2588
2589 /// Which page this is, counting from one, when pages are countable.
2590 ///
2591 /// One-based because it is read aloud. [`Window::index`] is the zero-based
2592 /// form for anyone indexing with it.
2593 #[must_use]
2594 pub const fn page(self) -> Option<usize> {
2595 if !self.paged {
2596 return None;
2597 }
2598 match self.window.index() {
2599 Some(index) => Some(index + 1),
2600 None => None,
2601 }
2602 }
2603
2604 /// How many pages there are, when that is countable.
2605 #[must_use]
2606 pub const fn pages_total(self) -> Option<usize> {
2607 if !self.paged {
2608 return None;
2609 }
2610 self.window.windows()
2611 }
2612
2613 /// How many are on screen.
2614 #[must_use]
2615 pub const fn shown(self) -> usize {
2616 self.window.count
2617 }
2618
2619 /// How many there are, when the host counted.
2620 #[must_use]
2621 pub const fn total(self) -> Option<usize> {
2622 self.window.of
2623 }
2624
2625 /// How many are not shown yet, when the host counted.
2626 ///
2627 /// The figure a load-more control puts in its label. `None` is the honest
2628 /// and common case: a set that cannot say how many more there are still has
2629 /// a way to ask for them.
2630 #[must_use]
2631 pub const fn remaining(self) -> Option<usize> {
2632 self.window.after()
2633 }
2634
2635 /// Whether there is anything further on.
2636 #[must_use]
2637 pub const fn has_more(self) -> bool {
2638 self.window.has_after()
2639 }
2640
2641 /// Whether there is anything back the other way.
2642 #[must_use]
2643 pub const fn has_previous(self) -> bool {
2644 self.window.has_before()
2645 }
2646}
2647
2648/// How much of the width an arrangement's first region takes.
2649///
2650/// `e0fd485e`. Nothing said how much room a region got, so every renderer
2651/// invented its own number and two hosts showing one screen disagreed about
2652/// its proportions. A webview never noticed, because the stylesheet answered
2653/// once for every consumer; a terminal has no stylesheet to inherit from, so
2654/// `quasi-tui` picked 24 columns for a sidebar and 40% for a list pane and
2655/// neither had anything behind it.
2656///
2657/// # A proportion, never a unit
2658///
2659/// Held as a percentage, and that is the only form it comes in. A description
2660/// carrying columns would be describing a terminal and one carrying pixels a
2661/// webview, and the whole point is that both honour the same fact: a terminal
2662/// resolves it against a column count, a webview writes it into a grid, and
2663/// neither has to know what the other did.
2664///
2665/// It is not [`makeover_geometry::Ratio`]'s job either, which was the first
2666/// guess. Geometry is scales that answer the same for every screen and takes
2667/// no input that would let a sidebar screen differ from a list-detail one.
2668///
2669/// [`makeover_geometry::Ratio`]: https://docs.rs/makeover-geometry
2670#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, PartialOrd, Ord)]
2671pub struct Share(u8);
2672
2673impl Share {
2674 /// What a sidebar takes, when nobody says otherwise.
2675 ///
2676 /// A quarter. `quasi-tui` drew 24 columns, which is a quarter of a
2677 /// 96-column terminal and about a fifth of a wide one; a quarter is that
2678 /// number said in the form a webview can honour too.
2679 pub const SIDEBAR: Self = Self(25);
2680
2681 /// What the list side of a list-detail takes, when nobody says otherwise.
2682 ///
2683 /// `quasi-tui`'s 40%, which was already a proportion and is the one number
2684 /// this member did not have to invent.
2685 pub const LIST: Self = Self(40);
2686
2687 /// A share of the width, as a percentage.
2688 ///
2689 /// Clamped to 5..=95 rather than refused. A description that asked for a
2690 /// region of nothing is a bug in the app, and a renderer drawing a region
2691 /// zero cells wide reports it as a region that vanished, which is the
2692 /// hardest kind of bug to find from what is on the screen.
2693 #[must_use]
2694 pub const fn percent(percent: u8) -> Self {
2695 Self(if percent < 5 {
2696 5
2697 } else if percent > 95 {
2698 95
2699 } else {
2700 percent
2701 })
2702 }
2703
2704 /// The share as a percentage.
2705 #[must_use]
2706 pub const fn as_percent(self) -> u8 {
2707 self.0
2708 }
2709
2710 /// This share of a width, rounded to the nearest whole unit.
2711 ///
2712 /// What a terminal calls to turn the proportion into columns. At least one,
2713 /// because a region the description named should be visible: a screen
2714 /// 3 columns wide is unusable either way, and a sidebar that is there is a
2715 /// truer picture of the description than a sidebar that is not.
2716 #[must_use]
2717 pub const fn of(self, whole: u16) -> u16 {
2718 let taken = (whole as u32 * self.0 as u32).div_ceil(100);
2719 if taken == 0 { 1 } else { taken as u16 }
2720 }
2721}
2722
2723/// How a screen is laid out.
2724///
2725/// Two, and the second is not a variant of the first. goingson is list-detail,
2726/// Balanced Breakfast is sidebar plus content, and neither app has a third.
2727/// The tab group is a modifier rather than a member, because goingson uses it
2728/// *inside* the same content region rather than instead of one.
2729///
2730/// This exists at all because the router has to be able to express a screen
2731/// rather than only a control. Discovering the arrangement layer missing after
2732/// the renderers exist is a redesign; naming two now is a morning.
2733///
2734/// # Why the share rides here
2735///
2736/// `e0fd485e`. A share is per-arrangement: how much a sidebar takes and how
2737/// much a list side takes are different questions, and this enum is the only
2738/// thing that knows which one is being asked. Geometry would have had to invent
2739/// a channel to be told.
2740///
2741/// [`list_detail`](Self::list_detail) and
2742/// [`sidebar_content`](Self::sidebar_content) build these with the default
2743/// shares, so a screen that has no opinion does not have to have one.
2744#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
2745pub enum Arrangement {
2746 /// A list that chooses what the detail beside it shows.
2747 ListDetail {
2748 /// Whether the detail side is a [`Region::TabGroup`].
2749 tabbed: bool,
2750 /// How much of the width the list side takes.
2751 share: Share,
2752 },
2753 /// Navigation down the side, content filling the rest.
2754 SidebarContent {
2755 /// How much of the width the sidebar takes.
2756 share: Share,
2757 },
2758}
2759
2760impl Arrangement {
2761 /// A list and a detail beside it, at the default share.
2762 #[must_use]
2763 pub const fn list_detail(tabbed: bool) -> Self {
2764 Self::ListDetail {
2765 tabbed,
2766 share: Share::LIST,
2767 }
2768 }
2769
2770 /// A sidebar and content beside it, at the default share.
2771 #[must_use]
2772 pub const fn sidebar_content() -> Self {
2773 Self::SidebarContent {
2774 share: Share::SIDEBAR,
2775 }
2776 }
2777
2778 /// How much of the width the first region takes.
2779 #[must_use]
2780 pub const fn share(self) -> Share {
2781 match self {
2782 Self::ListDetail { share, .. } | Self::SidebarContent { share } => share,
2783 }
2784 }
2785
2786 /// The same arrangement, at this share.
2787 #[must_use]
2788 pub const fn with_share(self, share: Share) -> Self {
2789 match self {
2790 Self::ListDetail { tabbed, .. } => Self::ListDetail { tabbed, share },
2791 Self::SidebarContent { .. } => Self::SidebarContent { share },
2792 }
2793 }
2794}
2795
2796/// How wide the content of a whole screen runs.
2797///
2798/// `0eccff0d`, and [`Share`]'s sibling one level up: that one says how a
2799/// screen's width is divided between regions, this says how much of the window
2800/// the screen uses in the first place. Both are the description's, which is
2801/// what answering the two together settled.
2802///
2803/// Measured in the MNW server, where 69 of 72 templates carry exactly one of
2804/// three mutually exclusive classes and the choice is per screen. GoingsOn
2805/// reaches for `max-width` 56 times and Balanced Breakfast 12, neither with a
2806/// token for it, so three apps were solving one thing by hand.
2807///
2808/// # Named for the measure, not for MNW's classes
2809///
2810/// A renderer that is not a browser has to answer this too, and `padded-page`
2811/// tells a terminal nothing. The three say how wide the text runs, which is a
2812/// question every renderer can answer: a webview with a `max-width`, a terminal
2813/// with gutters, an immediate-mode frame with its own width.
2814///
2815/// `#[non_exhaustive]` for [`Fill`]'s reason. The set is closed today because
2816/// the measurement found three, and a fourth arriving should not be a lockstep
2817/// release across nine repos.
2818#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Default)]
2819#[non_exhaustive]
2820pub enum Measure {
2821 /// The whole width, with gutters. The default, and 53 of the 69.
2822 ///
2823 /// What a dashboard, a table and a settings screen want: the content is
2824 /// wide because the content *is* wide, and constraining it would waste the
2825 /// window.
2826 #[default]
2827 Wide,
2828 /// Capped at a comfortable page width, centred. 13 of the 69.
2829 ///
2830 /// A form, a sign-in, a purchase. Content that does not get better by
2831 /// getting wider, but is not prose either.
2832 Contained,
2833 /// Capped at a line length that reads well. 3 of the 69.
2834 ///
2835 /// Prose. The narrowest of the three, and the one with a reason outside
2836 /// taste: a line of text past roughly 75 characters costs the reader the
2837 /// return sweep.
2838 Reading,
2839}
2840
2841impl Measure {
2842 /// A stable name, for a renderer that needs to spell it.
2843 ///
2844 /// Here rather than in each renderer for [`Sort::as_str`]'s reason: three
2845 /// renderers spelling one enum is three chances to spell it differently.
2846 #[must_use]
2847 pub const fn as_str(self) -> &'static str {
2848 match self {
2849 Self::Wide => "wide",
2850 Self::Contained => "contained",
2851 Self::Reading => "reading",
2852 }
2853 }
2854}
2855
2856/// What kind of value a form field takes.
2857///
2858/// The union of the two vocabularies that diverged, which is what triggered
2859/// this crate. They have since converged on their own: both apps now have a
2860/// `renderFormField` emitting the same anatomy, and what is left differing is
2861/// the kind set, the error shape, and whether the return is a string or a node.
2862///
2863/// Validation is deliberately absent. Neither app has a shared story (goingson
2864/// validates after collecting the form data, with per-field transform hooks;
2865/// Balanced Breakfast has `required` and nothing else), and a schema that
2866/// describes fields but not constraints acquires a constraint layer per app,
2867/// which is exactly how the current divergence started. Naming it absent is a
2868/// decision; leaving it unmentioned would not be.
2869/// `#[non_exhaustive]` for the reason [`Fill`] is: renderers match on this and
2870/// the set keeps growing, so growth must not be a lockstep event. Email, Url
2871/// and Tel arriving in 0.5.0 is the second growth in two releases.
2872#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
2873#[non_exhaustive]
2874pub enum FieldKind {
2875 /// A single line of text.
2876 Text,
2877 /// A single line of text that must never be echoed, logged or round-tripped
2878 /// through anything that might persist it.
2879 Secret,
2880 /// A number.
2881 Number,
2882 /// A number inside bounds the user drags across, where the range being
2883 /// visible is the point.
2884 ///
2885 /// Not [`Number`](Self::Number) with [`min`](Field::min) and
2886 /// [`max`](Field::max), which is the reading to resist and is the same
2887 /// resistance [`Radio`](Self::Radio) needed against `Select`. A bounded
2888 /// number and a validated number are different *questions*. A validated
2889 /// number is typed and can be wrong: the bounds are a rule the answer is
2890 /// checked against, and being told "must be at least 1" afterwards is the
2891 /// normal course of it. A range cannot be out of range at all, because the
2892 /// bounds are the control's extent rather than a rule, and the two ends are
2893 /// what the question means — audiofiles asks for a classifier threshold
2894 /// between 0 and 1, where 0 is never and 1 is only-on-certainty, and a typed
2895 /// 0.72 says nothing without both ends on screen beside it.
2896 ///
2897 /// A renderer cannot infer which one is meant from `min`/`max` alone, which
2898 /// is why this is a kind and not an inference: goingson's `min="1"` duration
2899 /// is a validated number and would become a slider.
2900 ///
2901 /// The membership test passes without stretching: a webview emits
2902 /// `<input type="range">`, egui has `Slider`, a terminal draws a bar and
2903 /// takes arrow keys, a CLI takes a bounded argument.
2904 ///
2905 /// # It owes its bounds
2906 ///
2907 /// [`min`](Field::min) and [`max`](Field::max) are `Option` for every other
2908 /// kind and are **required** here, in the sense the description can require
2909 /// anything: [`Field::bounded`] is the check, and a range missing one has no
2910 /// extent for a renderer to draw. What a renderer does with an unbounded
2911 /// range is its own call and both answers are honest — fall back to a typed
2912 /// number, or pick a host default — so this is stated rather than enforced,
2913 /// the way every other constraint here is.
2914 ///
2915 /// [`Field::step`] is the third fact and is genuinely optional: absent, the
2916 /// host's own granularity stands.
2917 ///
2918 /// Added 0.28.0, from audiofiles' classifier thresholds and storage cap
2919 /// picker (`fb93426b`), where four sliders were hand-rolled against a
2920 /// vocabulary that could not say what they were.
2921 Range,
2922 /// An email address.
2923 ///
2924 /// Distinct from [`Text`](Self::Text) because the distinction is not
2925 /// decoration: a webview renderer emits `type="email"`, which on a touch
2926 /// device changes the keyboard that appears and turns on the platform's own
2927 /// validation. goingson ships to iOS, so collapsing this into text costs a
2928 /// keyboard with no `@` on it.
2929 ///
2930 /// Added 0.5.0, from goingson's contact form.
2931 Email,
2932 /// A URL. Same reasoning as [`Email`](Self::Email).
2933 ///
2934 /// Added 0.5.0, from goingson's contact-social and contact-feed forms.
2935 Url,
2936 /// A telephone number. Same reasoning as [`Email`](Self::Email), and the
2937 /// clearest case of it: the keyboard is a numeric pad rather than letters.
2938 ///
2939 /// Added 0.5.0, from goingson's contact-phone form.
2940 Tel,
2941 /// A calendar day, with no time of day in it.
2942 ///
2943 /// [`Email`](Self::Email)'s argument, and it carries further: a webview
2944 /// emits `type="date"`, which is a native picker, the platform's own
2945 /// validation, and on a touch device the date keyboard. Described as
2946 /// [`Text`](Self::Text) with a hint reading "YYYY-MM-DD", all three are
2947 /// lost and the hint is doing the platform's job in prose.
2948 ///
2949 /// The membership test passes on every host without stretching: a webview
2950 /// and a Tauri app emit the input, egui has a date picker, a terminal
2951 /// prompts for a day and can validate it, a CLI takes an argument.
2952 ///
2953 /// # The value is ISO 8601, `YYYY-MM-DD`
2954 ///
2955 /// Named here rather than left to each host, because a host that picks
2956 /// differently sends a server something it parses differently, and the
2957 /// failure is silent and per-host. It is `<input type="date">`'s own wire
2958 /// format, so the webview renderer owes nothing to honour it and the other
2959 /// hosts have one spelling to meet. [`DATE_FORMAT`] is the constant, and a
2960 /// test asserts this doc and that constant agree.
2961 ///
2962 /// Added 0.15.0, from the MNW server's git access-token expiry
2963 /// (`user_ssh_keys_tab.html`) and six further sites across the server and
2964 /// goingson.
2965 Date,
2966 /// A calendar day and a time of day together.
2967 ///
2968 /// Apart from [`Date`](Self::Date) because the question is different rather
2969 /// than more precise: "which day does this expire" and "at what moment does
2970 /// this publish" are asked by different screens and answered by different
2971 /// controls. A webview emits `type="datetime-local"` for one and
2972 /// `type="date"` for the other, and a host that collapsed them would ask
2973 /// half the tree for a precision it does not want.
2974 ///
2975 /// Both arrived together on measurement rather than on symmetry: 13 sites
2976 /// of each across the MNW server and goingson, and **zero** of `time`,
2977 /// `month` or `week`, which is why those are not here. A member added for a
2978 /// case nobody has is a member designed against nothing, which is
2979 /// [`File`](Self::File)'s reasoning about `accept` applied to a whole
2980 /// member.
2981 ///
2982 /// # The value is `YYYY-MM-DDTHH:MM`, local, with no zone
2983 ///
2984 /// `<input type="datetime-local">`'s own format, and the "local" is the
2985 /// load-bearing half: the value carries no offset and no `Z`, so the moment
2986 /// it names is only fixed once something supplies a zone. That is the app's
2987 /// business and not the description's. Seconds are absent, which is the
2988 /// browser's own default and is left as the rule rather than restated as a
2989 /// constraint. [`DATETIME_FORMAT`] is the constant.
2990 ///
2991 /// [`Field::min`] and [`Field::max`] already take "the host's own spelling
2992 /// of a bound", so a floor of *not in the past* needs nothing new here: it
2993 /// is a string in this same format.
2994 ///
2995 /// Added 0.15.0, from goingson's snooze picker and day planner and the MNW
2996 /// server's publish-at fields.
2997 DateTime,
2998 /// Several lines of text.
2999 Textarea,
3000 /// One of a fixed set, offered behind a control that shows one at a time.
3001 Select,
3002 /// One of a fixed set, with every option on screen at once.
3003 ///
3004 /// Not a presentation of [`Select`](Self::Select), which is the reading to
3005 /// resist: what differs is a property of the *question*. A choice that is
3006 /// consequential or irreversible has to be readable without opening
3007 /// anything, because a closed control shows one option and hides the rest,
3008 /// and the one it shows is whichever was current before the user had read
3009 /// the alternatives. audiofiles asks whether a library copies samples into
3010 /// its store or references them where they lie — which cannot be changed
3011 /// afterwards — and had already promoted that out of a checkbox by hand,
3012 /// with a comment giving this reason, before the description could say it.
3013 ///
3014 /// It was described here at 0.8.1 as "the one HTML input type this enum was
3015 /// missing", which was not true then and is not true now: `file` arrived at
3016 /// 0.11.0 and `date` and `datetime-local` at 0.15.0. Everything here is
3017 /// still an `<input type=...>`, a `<select>` or a `<textarea>`, and the way
3018 /// this enum grows is by a site being measured rather than by a list being
3019 /// completed, so "the last one" is not a claim it should make again.
3020 ///
3021 /// Added 0.8.1, from audiofiles' Add Library form.
3022 Radio,
3023 /// On or off.
3024 Checkbox,
3025 /// A file the user picks from wherever the host keeps files.
3026 ///
3027 /// Added 0.11.0, `844b5ae0`, from goingson's project-dashboard attachments
3028 /// column. It was filed as a router finding — a control whose destination is
3029 /// a host capability rather than an address — and splitting it is what made
3030 /// it two answers instead of one member satisfying neither. *Opening* a file
3031 /// is a one-way handoff and needs no new API. *Picking* one returns a value
3032 /// into a write, which is a form concern, which is this.
3033 ///
3034 /// The membership test passes on every host and not by a stretch: a Tauri
3035 /// app opens a native picker, a server renders `<input type="file">`, a
3036 /// terminal prompts for a path, a CLI takes an argument. That is closer to
3037 /// [`Email`](Self::Email), which exists because it changes the keyboard,
3038 /// than to anything bespoke.
3039 ///
3040 /// It carries no accepted-types list and no multiple flag, and that is
3041 /// measured rather than deferred: `accept` appears at zero sites in either
3042 /// app. A member added for a case nobody has is a member designed against
3043 /// nothing.
3044 File,
3045 /// Carried through the form and never shown.
3046 Hidden,
3047}
3048
3049/// The wire format a [`FieldKind::Date`] value takes: ISO 8601, `YYYY-MM-DD`.
3050///
3051/// A constant rather than a sentence in a doc comment, because the reason to
3052/// name the format at all is that a host picking its own would fail silently
3053/// against a server parsing another. A host that cannot emit the native control
3054/// still has one spelling to meet, and can say which one it meant.
3055pub const DATE_FORMAT: &str = "%Y-%m-%d";
3056
3057/// The wire format a [`FieldKind::DateTime`] value takes: `YYYY-MM-DDTHH:MM`,
3058/// local, carrying no zone and no seconds.
3059///
3060/// [`DATE_FORMAT`]'s sibling and there for its reason. The absent zone is a
3061/// property of the value rather than an omission: the moment is not fixed until
3062/// something outside the description supplies one.
3063pub const DATETIME_FORMAT: &str = "%Y-%m-%dT%H:%M";
3064
3065impl FieldKind {
3066 /// Whether the value the kind takes is a moment rather than a string.
3067 ///
3068 /// Named once here for the reason [`offers_options`](Self::offers_options)
3069 /// is: two kinds answer yes, and a host that has to parse or format a value
3070 /// needs to ask without spelling the pair out at each renderer. A third
3071 /// temporal kind should land here and nowhere else.
3072 ///
3073 /// The format each one takes is [`DATE_FORMAT`] and [`DATETIME_FORMAT`].
3074 #[must_use]
3075 pub const fn temporal(self) -> bool {
3076 matches!(self, Self::Date | Self::DateTime)
3077 }
3078
3079 /// Whether the field is drawn at all.
3080 #[must_use]
3081 pub const fn visible(self) -> bool {
3082 !matches!(self, Self::Hidden)
3083 }
3084
3085 /// Whether the value must be kept out of logs and diagnostics.
3086 #[must_use]
3087 pub const fn confidential(self) -> bool {
3088 matches!(self, Self::Secret)
3089 }
3090
3091 /// Where the field's own label sits.
3092 ///
3093 /// A checkbox labels itself on the right of the box; everything else takes
3094 /// a label above. Both webview apps already do this and both special-case
3095 /// it inline, which is the tell that it belongs in the description.
3096 ///
3097 /// A [`Radio`](Self::Radio) is not one of them, and the near-miss is worth
3098 /// naming: its *options* each label themselves, but the field still asks a
3099 /// question above them, so the group takes a label like everything else.
3100 #[must_use]
3101 pub const fn labels_itself(self) -> bool {
3102 matches!(self, Self::Checkbox)
3103 }
3104
3105 /// Whether the kind reads [`Field::options`].
3106 ///
3107 /// Two kinds do, so the pair is named once here rather than spelled out at
3108 /// each renderer and again in [`Field::options`]' own doc, where "every
3109 /// kind but `Select`" was true for exactly one release. A third
3110 /// option-taking kind should land here and nowhere else.
3111 #[must_use]
3112 pub const fn offers_options(self) -> bool {
3113 matches!(self, Self::Select | Self::Radio)
3114 }
3115}
3116
3117/// One option offered by a field [`FieldKind::offers_options`] accepts.
3118///
3119/// Two strings, because the submitted value and the read label are different
3120/// facts and every renderer that has tried to collapse them has had to
3121/// un-collapse them later. `makeover-webview` invented this shape writing its
3122/// form emitter and it is taken here unchanged; moving it down rather than
3123/// re-deriving it is the point, since the second and third renderers were each
3124/// going to arrive at a near-miss of it.
3125/// `#[non_exhaustive]` as of 0.28.0, which every other type here that a
3126/// renderer matches or builds has carried for releases. It was the omission
3127/// that made [`unavailable`](Self::unavailable) a breaking change across 40
3128/// literal sites in six repos, and it arrives with that member so the price is
3129/// paid once and never again.
3130#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
3131#[non_exhaustive]
3132pub struct Choice<'a> {
3133 /// What is submitted.
3134 pub value: &'a str,
3135 /// What is read.
3136 pub label: &'a str,
3137 /// Why it cannot be picked right now, when it cannot.
3138 ///
3139 /// One member rather than an `available: bool` beside a reason, and the
3140 /// conflation is the point: an option greyed out with no explanation is a
3141 /// dead end the user cannot act on, and it is exactly the state the app
3142 /// that found this gap had to patch by hand with a line of prose under the
3143 /// control. Making the reason mandatory means the description cannot say
3144 /// the useless half.
3145 ///
3146 /// The option stays in the list. Dropping it is what an app does today, and
3147 /// it costs the user the knowledge that the thing exists at all —
3148 /// audiofiles' multi-sample mode appears on its own once a second sample is
3149 /// dropped, so a user who never sees it never learns what to drop.
3150 ///
3151 /// **Not [`Field::error`], and not [`Field::hint`].** An error is about the
3152 /// answer and a hint is standing help for the whole question; this is about
3153 /// one option among several, which is the level neither of those reaches.
3154 ///
3155 /// **Not disabled-the-state.** `State::Disabled` is about a whole field
3156 /// refusing to answer. This says the field is live and one of its answers
3157 /// is not available yet, which is a different sentence and the reason the
3158 /// tone rule matters here: the *other* options are still usable.
3159 ///
3160 /// Added 0.28.0, from audiofiles' instrument mode selector (`e761833e`).
3161 pub unavailable: Option<&'a str>,
3162}
3163
3164impl<'a> Choice<'a> {
3165 /// An option whose submitted value is also its label.
3166 #[must_use]
3167 pub const fn plain(value: &'a str) -> Self {
3168 Self::new(value, value)
3169 }
3170
3171 /// An option that submits one string and reads as another.
3172 ///
3173 /// A constructor rather than a literal, which is what `#[non_exhaustive]`
3174 /// costs and buys: outside this crate the struct cannot be built by naming
3175 /// its members, so every call site goes through here and the next member
3176 /// added breaks none of them.
3177 #[must_use]
3178 pub const fn new(value: &'a str, label: &'a str) -> Self {
3179 Self {
3180 value,
3181 label,
3182 unavailable: None,
3183 }
3184 }
3185
3186 /// The same option, not pickable yet, and why.
3187 ///
3188 /// Builder-shaped because the reason is the rare case: 39 of the 40 option
3189 /// sites measured across the tree do not have one.
3190 #[must_use]
3191 pub const fn unless(mut self, reason: &'a str) -> Self {
3192 self.unavailable = Some(reason);
3193 self
3194 }
3195
3196 /// Whether the option can be picked right now.
3197 ///
3198 /// The predicate a renderer branches on, so that "unavailable" is read as
3199 /// one condition in one place rather than as `unavailable.is_some()` at
3200 /// three renderers, one of which will invert it.
3201 #[must_use]
3202 pub const fn available(&self) -> bool {
3203 self.unavailable.is_none()
3204 }
3205}
3206
3207/// One field of a form.
3208///
3209/// Borrowed rather than owned: a description is built, read once by a renderer,
3210/// and dropped. Nothing here outlives the screen it describes.
3211///
3212/// # What it carries, and what it does not
3213///
3214/// Stated here so the next renderer does not re-ask, which is what the first
3215/// two both did. It carries everything a renderer needs to *draw* the field:
3216/// its kind, what it is called, what it is asked for, its standing help, what
3217/// is wrong with it now, whether it is compulsory, whether it hides behind a
3218/// disclosure, its ghost text, and the options it offers.
3219///
3220/// It does not carry the **current value**, and it is not going to. That is the
3221/// one thing here that is genuinely renderer state: a webview reads it back out
3222/// of the DOM, an immediate-mode renderer holds a `&mut` to the app's own field
3223/// and writes through it, and a terminal keeps an edit buffer. A description
3224/// that carried the value would have to carry a way to write it back, at which
3225/// point it is a form model and no longer a description.
3226///
3227/// **Constraints** are here and enforcement is not, which is one line rather
3228/// than two. [`required`], [`max_length`], [`min`] and [`max`] are facts about
3229/// the *question*, so a renderer can emit its host's idiom for each — an HTML
3230/// attribute, a marked label, a clamped spinner — and the platform helps the
3231/// user before anything is submitted. Deciding that a value is wrong stays with
3232/// whoever validated, and [`error`] is that decision arriving back.
3233///
3234/// The set stops before `pattern`, and stops there on both tests at once. A
3235/// regex has an honest answer in a webview and none anywhere else: egui would
3236/// have to run it per keystroke and decide what a half-typed value means, which
3237/// is enforcement wearing description's clothes. And it is one site in goingson
3238/// and none in Balanced Breakfast, against 8 and 1 for `maxlength`. Measured
3239/// 2026-08-09, `2cbad3e2`.
3240///
3241/// [`error`]: Field::error
3242/// [`required`]: Field::required
3243/// [`max_length`]: Field::max_length
3244/// [`min`]: Field::min
3245/// [`max`]: Field::max
3246#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
3247pub struct Field<'a> {
3248 /// What kind of value it takes.
3249 pub kind: FieldKind,
3250 /// The name the value is submitted under.
3251 pub name: &'a str,
3252 /// What the user is asked for.
3253 pub label: &'a str,
3254 /// Standing help, shown whether or not anything is wrong.
3255 pub hint: Option<&'a str>,
3256 /// What is currently wrong with the value.
3257 pub error: Option<&'a str>,
3258 /// Ghost text shown while the field is empty.
3259 ///
3260 /// User-facing text, and it sits with `label` and `hint` rather than with
3261 /// the value because it is a property of the *question* and not of the
3262 /// answer. It lived renderer-side in `makeover-webview` until 0.8.0 for one
3263 /// reason and it was not a reading on where it belonged: adding a field to
3264 /// a published struct is a breaking change.
3265 ///
3266 /// Not a substitute for a label. A field labelled only by its placeholder
3267 /// loses its label the moment anything is typed, and no renderer here can
3268 /// make that not happen, so the description keeps both.
3269 pub placeholder: Option<&'a str>,
3270 /// The options offered, in the order they are offered.
3271 ///
3272 /// Empty for every kind [`FieldKind::offers_options`] rejects. A field
3273 /// described with no options is sayable on purpose: it is what an app with
3274 /// an unfinished-loading option list actually has, and a renderer showing
3275 /// an empty control says so on screen rather than in a log.
3276 ///
3277 /// Which option is *current* is not here. That is the value, and the value
3278 /// is renderer state.
3279 pub options: &'a [Choice<'a>],
3280 /// Whether the form refuses to submit without it.
3281 pub required: bool,
3282 /// The longest the value may be, in characters.
3283 ///
3284 /// Added 0.11.0 with [`min`](Self::min) and [`max`](Self::max), joining
3285 /// [`required`](Self::required), which had been the only constraint here
3286 /// since before the crate wrote down that it carried none.
3287 pub max_length: Option<u32>,
3288 /// The lowest value accepted, as the host would write it.
3289 ///
3290 /// Text rather than a number, because the bound is only a number for some
3291 /// of the kinds that take one. goingson's own sites are `min="1"` on a
3292 /// duration and `min="2026-08-09T14:30"` on a datetime, and a numeric member
3293 /// could say the first and not the second. The [`kind`](Self::kind) already
3294 /// says how to read it, the same way it does for the value.
3295 pub min: Option<&'a str>,
3296 /// The highest value accepted, as the host would write it. See
3297 /// [`min`](Self::min).
3298 pub max: Option<&'a str>,
3299 /// The granularity the value moves in, as the host would write it.
3300 ///
3301 /// Text for [`min`](Self::min)'s reason, and it earns it twice over: the
3302 /// step of a date is a day and the step of a threshold is 0.01, and a
3303 /// numeric member could say one of them.
3304 ///
3305 /// Absent means the host's own granularity, which is the honest default
3306 /// rather than a missing value: a webview's `<input>` steps by 1 unless told
3307 /// otherwise, and that is the browser's rule and not this crate's to
3308 /// restate. It matters most to [`FieldKind::Range`], where the host default
3309 /// turns a 0-to-1 threshold into a two-position control, and it is not
3310 /// exclusive to it: a stepped [`Number`](FieldKind::Number) is the same fact
3311 /// about a typed value.
3312 ///
3313 /// Added 0.28.0 with [`FieldKind::Range`].
3314 pub step: Option<&'a str>,
3315 /// Whether the field lives behind a "more options" disclosure.
3316 pub extended: bool,
3317}
3318
3319impl<'a> Field<'a> {
3320 /// A plain required-nothing field of the given kind.
3321 #[must_use]
3322 pub const fn new(kind: FieldKind, name: &'a str, label: &'a str) -> Self {
3323 Self {
3324 kind,
3325 name,
3326 label,
3327 hint: None,
3328 error: None,
3329 placeholder: None,
3330 options: &[],
3331 required: false,
3332 max_length: None,
3333 min: None,
3334 max: None,
3335 step: None,
3336 extended: false,
3337 }
3338 }
3339
3340 /// A bounded number the user drags across its whole extent.
3341 ///
3342 /// The third under-described kind, and it gets a constructor for
3343 /// [`select`](Self::select)'s reason: a range is the one kind whose bounds
3344 /// are not a rule but the control itself, so a call site that forgot them
3345 /// has a slider with nothing to slide across. Taking them as arguments is
3346 /// what makes that unsayable.
3347 ///
3348 /// [`step`](Self::step) stays a field rather than a fourth argument. It is
3349 /// genuinely optional — the host's granularity is a real answer — and the
3350 /// two bounds are not.
3351 #[must_use]
3352 pub const fn range(name: &'a str, label: &'a str, min: &'a str, max: &'a str) -> Self {
3353 Self {
3354 min: Some(min),
3355 max: Some(max),
3356 ..Self::new(FieldKind::Range, name, label)
3357 }
3358 }
3359
3360 /// A select offering the given options.
3361 ///
3362 /// One of the two kinds under-described by [`Field::new`], so it gets a
3363 /// constructor rather than leaving every call site to remember that a
3364 /// select with an empty `options` renders as an empty select.
3365 #[must_use]
3366 pub const fn select(name: &'a str, label: &'a str, options: &'a [Choice<'a>]) -> Self {
3367 Self::offering(FieldKind::Select, name, label, options)
3368 }
3369
3370 /// A radio group offering the given options.
3371 ///
3372 /// The other. Same hazard as [`select`](Self::select) and a worse one: a
3373 /// radio group with no options draws nothing at all, so a call site that
3374 /// forgot them has an empty rectangle rather than a visibly empty control.
3375 #[must_use]
3376 pub const fn radio(name: &'a str, label: &'a str, options: &'a [Choice<'a>]) -> Self {
3377 Self::offering(FieldKind::Radio, name, label, options)
3378 }
3379
3380 /// The shared body of the two constructors that take options.
3381 ///
3382 /// Private, and keyed on the kind rather than exposed, because the two
3383 /// public names are the point: a call site says which question it is
3384 /// asking, not which flag it is setting.
3385 const fn offering(
3386 kind: FieldKind,
3387 name: &'a str,
3388 label: &'a str,
3389 options: &'a [Choice<'a>],
3390 ) -> Self {
3391 Self {
3392 options,
3393 ..Self::new(kind, name, label)
3394 }
3395 }
3396
3397 /// Whether the field is currently reporting a problem.
3398 ///
3399 /// Read this rather than testing `error.is_some()` at each renderer: the
3400 /// error state has to mark the field's whole group and not only the
3401 /// message, because a renderer with no descendant selectors (egui, a
3402 /// terminal) cannot find the group from the message. goingson already marks
3403 /// the group and Balanced Breakfast does not, so goingson's shape is the
3404 /// one taken here.
3405 #[must_use]
3406 pub const fn invalid(&self) -> bool {
3407 self.error.is_some()
3408 }
3409
3410 /// Whether the field carries both ends of its extent.
3411 ///
3412 /// Only [`FieldKind::Range`] owes them, and it owes them absolutely: a
3413 /// slider with one end missing has no extent to draw. Named here rather
3414 /// than left to each renderer to test `min.is_some() && max.is_some()`,
3415 /// which is three renderers arriving at the same condition and one of them
3416 /// getting it wrong, and named as a question about the *field* rather than
3417 /// about the kind because the kind cannot see the bounds.
3418 ///
3419 /// It is a check and not a guarantee. Nothing here refuses to build an
3420 /// unbounded range — [`Field::range`] is what makes the bounded one easy —
3421 /// so a renderer asks this and falls back to whatever its host does
3422 /// honestly with a number.
3423 #[must_use]
3424 pub const fn bounded(&self) -> bool {
3425 self.min.is_some() && self.max.is_some()
3426 }
3427}
3428
3429/// How much room a placement asks for.
3430///
3431/// A column says it, and so does a [`Field`]. An intent, so the actual floor
3432/// stays with `makeover-geometry`. goingson's task table spells these as
3433/// `minmax(200px, 1fr)`, `140px` and content-sized; only the first three words
3434/// of that survive deferral.
3435/// `#[non_exhaustive]`, for the reason [`Fill`] and [`FieldKind`] are: a
3436/// renderer matches on this and a vocabulary that grows must not break every
3437/// renderer when it does.
3438#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
3439#[non_exhaustive]
3440pub enum Width {
3441 /// Takes what it needs and no more.
3442 Content,
3443 /// A fixed share, the same at every width.
3444 Fixed,
3445 /// Absorbs whatever is left over.
3446 ///
3447 /// **Several fills divide what is left equally.** Stated because it would
3448 /// otherwise be undefined and each renderer would invent something, and
3449 /// stated this way because equal division is the only sharing rule that
3450 /// answers to "Any width, one answer" without a tiebreak: allocating in
3451 /// declaration order makes the result depend on the order the description
3452 /// was written in, which is a fact about the source file and not about the
3453 /// screen. It documents what both renderers already do — CSS grid gives
3454 /// `1fr 1fr`, ratatui gives each a `Constraint::Fill(1)` — rather than
3455 /// changing anything.
3456 ///
3457 /// So a row of fills is a legal thing to describe, and there is no rule
3458 /// against it. Measured 2026-08-16, every table in the tree uses exactly
3459 /// one, which is the discipline this would otherwise have had to forbid.
3460 Fill,
3461}
3462
3463/// What a column is worth when there is not room for all of them.
3464///
3465/// Ordered: [`Priority::Optional`] drops first, [`Priority::Essential`] never
3466/// drops. This replaces addressing columns by position, which is what both
3467/// webview apps do today and is a live bug rather than only verbosity. goingson
3468/// hides mobile columns with `nth-child(n+5)` against a seven-column table, so
3469/// inserting a column silently hides the wrong one.
3470/// `#[non_exhaustive]`, same reasoning as [`Width`]. Note the ordering is the
3471/// whole point of the type, so a new tier has to be declared in its place in
3472/// the sequence rather than appended.
3473#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
3474#[non_exhaustive]
3475pub enum Priority {
3476 /// Dropped first.
3477 Optional,
3478 /// Dropped once the optional columns are gone.
3479 Secondary,
3480 /// Never dropped. Without it the row does not identify itself.
3481 Essential,
3482}
3483
3484/// One column of a table.
3485///
3486/// Described once. The grid track, the cell order and the drop behaviour are
3487/// all derived from this, rather than being three hand-written encodings that
3488/// must agree and are never checked against each other.
3489#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
3490pub struct Column<'a> {
3491 /// The heading, and the name the cell is addressed by.
3492 pub name: &'a str,
3493 /// How much room it asks for.
3494 pub width: Width,
3495 /// What it is worth when room runs out.
3496 pub priority: Priority,
3497 /// Whether the user can reorder the table by this column.
3498 ///
3499 /// `ce620871`. What reordering *calls* is not here — that is an address, and
3500 /// this crate names none — so a host pairs this with the route the way it
3501 /// pairs a row's parts with the row's activation. This says the affordance
3502 /// exists, which is what a renderer needs to draw a header a user can press
3503 /// rather than a heading they cannot.
3504 pub sortable: bool,
3505 /// Which way the table is ordered by this column, if it is.
3506 ///
3507 /// `None` on every column but the one in force. A renderer draws the caret
3508 /// from this and a webview sets `aria-sort`, which is why it is per column
3509 /// rather than a single fact on the table: the host idiom is a property of
3510 /// the header cell.
3511 ///
3512 /// Independent of [`sortable`](Self::sortable) rather than implied by it,
3513 /// because both combinations mean something. A column sorted and not
3514 /// sortable is a list ordered by a key the user cannot change, which is a
3515 /// real thing to describe and a caret worth drawing.
3516 pub sorted: Option<Sort>,
3517}
3518
3519/// Which way a column is ordered.
3520///
3521/// Two, because there is no third. "Unsorted" is [`Column::sorted`] being
3522/// `None`, and folding it in here would be the same absence said twice.
3523#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
3524pub enum Sort {
3525 /// Smallest, earliest or first alphabetically at the top.
3526 Ascending,
3527 /// The other way.
3528 Descending,
3529}
3530
3531impl Sort {
3532 /// The other direction, for a header that flips when pressed.
3533 #[must_use]
3534 pub const fn reversed(self) -> Self {
3535 match self {
3536 Self::Ascending => Self::Descending,
3537 Self::Descending => Self::Ascending,
3538 }
3539 }
3540
3541 /// What a webview writes into `aria-sort`.
3542 ///
3543 /// Named here rather than in the webview renderer because a terminal and an
3544 /// immediate-mode painter both want the same two words for a caret's label,
3545 /// and three renderers picking their own is the drift this crate ends.
3546 #[must_use]
3547 pub const fn as_str(self) -> &'static str {
3548 match self {
3549 Self::Ascending => "ascending",
3550 Self::Descending => "descending",
3551 }
3552 }
3553
3554 /// The caret a renderer draws for this direction.
3555 ///
3556 /// Here for [`as_str`](Self::as_str)'s reason, said about a glyph rather
3557 /// than a word: three renderers picking their own is the drift this crate
3558 /// ends. They had picked their own — two on the solid triangles and
3559 /// `makeover-webview` on the arrows U+2191/U+2193 — and agreeing by
3560 /// coincidence in three files is not agreement.
3561 ///
3562 /// Settled 2026-08-16 (Max): the solid triangles, U+25B2 and U+25BC. The
3563 /// reason generalizes past this pair and is the house rule now — prefer the
3564 /// bolder, simpler glyph over the thinner or more complicated one. A third
3565 /// spelling is not open for re-argument.
3566 ///
3567 /// **Bare, with no spacing.** Where the gap goes is each renderer's
3568 /// business: `makeover-tui` and `makeover-immediate` carry a leading space
3569 /// inside their `TableStyle` string and a webview emits its own in
3570 /// `content`, so folding a space in here would make one of the two wrong.
3571 ///
3572 /// Neither face the web apps self-host carries these — IBM Plex Mono has one
3573 /// glyph in the whole geometric-shapes block and Lato has none — so a
3574 /// browser falls back per glyph until the in-house face ships with them
3575 /// drawn in (makeover `6d6d9146`, wiki `typography-standard`). Cosmetic
3576 /// drift in one renderer, not a reason to spell it three ways.
3577 #[must_use]
3578 pub const fn glyph(self) -> &'static str {
3579 match self {
3580 Self::Ascending => "\u{25B2}",
3581 Self::Descending => "\u{25BC}",
3582 }
3583 }
3584}
3585
3586impl<'a> Column<'a> {
3587 /// A column that absorbs slack and drops after the optional ones.
3588 #[must_use]
3589 pub const fn new(name: &'a str) -> Self {
3590 Self {
3591 name,
3592 width: Width::Fill,
3593 priority: Priority::Secondary,
3594 sortable: false,
3595 sorted: None,
3596 }
3597 }
3598
3599 /// Whether this column survives at the given cutoff.
3600 ///
3601 /// A renderer narrows by raising the cutoff, and never by counting
3602 /// positions.
3603 #[must_use]
3604 pub const fn kept_at(&self, cutoff: Priority) -> bool {
3605 (self.priority as u8) >= (cutoff as u8)
3606 }
3607}
3608
3609/// What a table cell holds.
3610///
3611/// [`RowPart`] for tables, and it exists for the same reason: a part that
3612/// carries a control is not text, and a renderer with one class for the whole
3613/// cell paints it as though it were. `makeover-webview` emitted a single
3614/// `.cell` until 0.25.0, so a button in a cell inherited the cell's content
3615/// colour, which is the exact drift [`RowPart::intent`] prevents for rows and
3616/// prevented for nothing here.
3617///
3618/// Four members, and the count is what quasi's `Cell` was measured to carry:
3619/// a value, tokens (33 cells across 22 server templates), actions (30 rows
3620/// carrying a control, 5 beside a value) and a link (35 cells across 18
3621/// templates). Nothing was added past what something holds.
3622///
3623/// `#[non_exhaustive]` for [`RowPart`]'s reason: growth here must not be a
3624/// lockstep event across three renderers.
3625///
3626/// # No hover-reveal
3627///
3628/// [`RowPart`] carried a `revealed_on_hover` until 0.13.0 retired it, and this
3629/// enum never gets one. A cell's actions are shown at rest in every consumer
3630/// measured, and a member nothing uses is one three renderers owe an answer
3631/// for.
3632#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
3633#[non_exhaustive]
3634pub enum CellPart {
3635 /// The cell's own text.
3636 Value,
3637 /// Small labelled things in the cell: a status badge, a chip.
3638 Tokens,
3639 /// Controls that act on what the row is about.
3640 Actions,
3641 /// The cell's value, where the value is itself a link.
3642 Link,
3643}
3644
3645impl CellPart {
3646 /// The content intent the part takes.
3647 ///
3648 /// One part is text and three are not, so three answer with the intent
3649 /// inheriting already gives. That is [`RowPart::intent`]'s shape with the
3650 /// text side narrower: a cell's secondary and muted readings are the
3651 /// column's business, not the cell's.
3652 #[must_use]
3653 pub const fn intent(self) -> &'static str {
3654 match self {
3655 Self::Value => "content",
3656 // A token carries its own tone, and a part-level intent underneath
3657 // it would fight the token sitting on it.
3658 Self::Tokens => "content",
3659 // Actions carry controls rather than text.
3660 Self::Actions => "content",
3661 // A link takes the action colour from the control it is, rather
3662 // than the cell's text colour from the cell it sits in.
3663 Self::Link => "content",
3664 }
3665 }
3666}
3667
3668#[cfg(test)]
3669mod tests {
3670 use super::*;
3671
3672 #[test]
3673 fn the_four_readiness_states_are_one_axis_and_only_one_shows_content() {
3674 // Mutually exclusive is the test for one enum against several fields: a
3675 // region shows its content, or that it is coming, or that there is none,
3676 // or that it broke. Never two.
3677 assert!(Readiness::Ready.shows_content());
3678 for state in [Readiness::Pending, Readiness::Empty, Readiness::Failed] {
3679 assert!(!state.shows_content());
3680 }
3681 }
3682
3683 #[test]
3684 fn a_region_shows_all_of_its_children_unless_it_says_otherwise() {
3685 // The default is the behaviour every region had before this member
3686 // existed, which is what keeps it additive: a description written
3687 // against 0.22.0 says the same thing under 0.23.0.
3688 assert_eq!(Showing::default(), Showing::All);
3689 assert!(!Showing::All.selective());
3690 }
3691
3692 #[test]
3693 fn only_a_disclosure_can_show_nothing() {
3694 // The two derived idioms differ in one respect and this is it. A
3695 // carousel's row moves between frames and never reaches empty; a
3696 // disclosure's summary line is the same control wearing its closed
3697 // state, so a renderer has to know which it is drawing.
3698 assert!(Showing::AtMostOne.dismissible());
3699 assert!(!Showing::One.dismissible());
3700 assert!(!Showing::All.dismissible());
3701
3702 // Both are selective, though. Deriving chrome is one question and
3703 // whether that chrome closes is another.
3704 assert!(Showing::One.selective());
3705 assert!(Showing::AtMostOne.selective());
3706 }
3707
3708 #[test]
3709 fn an_empty_region_is_not_a_broken_one() {
3710 // An empty list is the normal state of a new install. Drawing it in a
3711 // danger tone reports a fault where there is none, and this is the one
3712 // place the distinction is carried.
3713 assert_eq!(Readiness::Empty.tone(), Tone::Neutral);
3714 assert_eq!(Readiness::Failed.tone(), Tone::Danger);
3715 assert_eq!(Readiness::Pending.tone(), Tone::Neutral);
3716 }
3717
3718 #[test]
3719 fn a_column_can_be_sorted_without_being_sortable() {
3720 // Both combinations mean something, which is why the two fields are
3721 // independent rather than one implying the other. A list ordered by a
3722 // key the user cannot change is a real thing with a caret worth drawing.
3723 let fixed = Column {
3724 sorted: Some(Sort::Descending),
3725 ..Column::new("Created")
3726 };
3727
3728 assert!(!fixed.sortable);
3729 assert_eq!(fixed.sorted.map(Sort::as_str), Some("descending"));
3730
3731 let offered = Column {
3732 sortable: true,
3733 ..Column::new("Name")
3734 };
3735 assert_eq!(offered.sorted, None);
3736 }
3737
3738 #[test]
3739 fn a_direction_flips_and_says_what_it_is() {
3740 assert_eq!(Sort::Ascending.reversed(), Sort::Descending);
3741 assert_eq!(Sort::Descending.reversed().reversed(), Sort::Descending);
3742 assert_eq!(Sort::Ascending.as_str(), "ascending");
3743 }
3744
3745 #[test]
3746 fn a_direction_carries_its_caret_and_the_two_are_not_the_same_glyph() {
3747 // The spelling every renderer reads, so that agreeing is composition
3748 // rather than three files happening to hold the same literal.
3749 assert_eq!(Sort::Ascending.glyph(), "\u{25B2}");
3750 assert_eq!(Sort::Descending.glyph(), "\u{25BC}");
3751 assert_ne!(Sort::Ascending.glyph(), Sort::Descending.glyph());
3752 // Bare. The gap is the renderer's, and a space here would be a second
3753 // one wherever a renderer already carries its own.
3754 for d in [Sort::Ascending, Sort::Descending] {
3755 assert_eq!(d.glyph().trim(), d.glyph());
3756 }
3757 }
3758
3759 #[test]
3760 fn a_figure_carries_its_tone_because_no_renderer_can_derive_it() {
3761 // Three of goingson's five sites tone the figure by their own means, so
3762 // tone is carried at every site that needs it and derived at none. The
3763 // same reasoning `Meter` reached, from a different direction.
3764 let streak = Figure::new("0", "Current Streak").tone(Tone::Warning);
3765 assert_eq!(streak.tone, Tone::Warning);
3766 assert_eq!(Figure::new("17", "Total").tone, Tone::Neutral);
3767 }
3768
3769 #[test]
3770 fn a_figures_change_is_the_toned_part_and_is_absent_by_default() {
3771 // 0.13.0. The MNW server's stat card is a label, a value and a delta,
3772 // across four screens, and the delta is what reads as good or bad. Tone
3773 // had no consumer before this: the figure itself is an ordinary fact.
3774 let views = Figure::new("1,204", "Views")
3775 .change("+12.5%")
3776 .tone(Tone::Success);
3777 assert_eq!(views.change, Some("+12.5%"));
3778 assert_eq!(views.tone, Tone::Success);
3779
3780 // A figure with nothing to compare against says so by having no change,
3781 // rather than by carrying an empty string a renderer has to test for.
3782 assert_eq!(Figure::new("3.1%", "Conversion").change, None);
3783 }
3784
3785 #[test]
3786 fn a_figures_value_is_text_because_only_the_app_knows_what_it_is() {
3787 // "84%", "12/30", "3d". A figure is whatever the app computed, already
3788 // formatted, and that is the line between this and `Meter`: a meter is
3789 // a proportion a renderer draws, a figure is a fact it sets in type.
3790 for value in ["84%", "12/30", "3d"] {
3791 assert_eq!(Figure::new(value, "Rate").value, value);
3792 }
3793 }
3794
3795 #[test]
3796 fn a_proportion_is_a_row_part_and_takes_no_intent_of_its_own() {
3797 // The meter carries the tone, so a part-level intent underneath would
3798 // fight it. Same answer `Tokens` needed, for the same reason.
3799 assert_eq!(RowPart::Proportion.intent(), RowPart::Tokens.intent());
3800 }
3801
3802 #[test]
3803 fn a_file_field_is_drawn_and_offers_no_options() {
3804 // It is a control the user operates, unlike `Hidden`, and it does not
3805 // pick from a list the description carries, unlike `Select`.
3806 assert!(FieldKind::File.visible());
3807 assert!(!FieldKind::File.offers_options());
3808 assert!(!FieldKind::File.confidential());
3809 }
3810
3811 #[test]
3812 fn a_constraint_is_a_fact_about_the_question_and_not_a_verdict() {
3813 // The whole model: the description carries the rule, the renderer emits
3814 // its host's idiom, and `error` is what arrives back when someone
3815 // validated. Nothing here decides a value is wrong.
3816 let field = Field {
3817 max_length: Some(100),
3818 min: Some("1"),
3819 max: Some("240"),
3820 required: true,
3821 ..Field::new(FieldKind::Number, "minutes", "Minutes")
3822 };
3823 assert!(!field.invalid());
3824
3825 // A bound is text because it is only a number for some of the kinds
3826 // that take one. goingson has both shapes live.
3827 let when = Field {
3828 min: Some("2026-08-09T14:30"),
3829 ..Field::new(FieldKind::Text, "starts", "Starts")
3830 };
3831 assert_eq!(when.min, Some("2026-08-09T14:30"));
3832 }
3833
3834 #[test]
3835 fn a_meter_keeps_the_over_run_the_percentage_throws_away() {
3836 // The whole reason this is a pair. goingson's `Task::time_progress`
3837 // clamps to 100 and then carries `is_over_estimate` beside it to say
3838 // what the clamp dropped; a meter says both from one fact.
3839 let over = Meter::new(45, 30);
3840 assert_eq!(over.percent(), 100);
3841 assert!(over.overflowing());
3842
3843 let exact = Meter::new(30, 30);
3844 assert_eq!(exact.percent(), over.percent());
3845 assert!(!exact.overflowing());
3846 }
3847
3848 #[test]
3849 fn an_empty_set_does_not_divide_by_zero() {
3850 // Sayable on purpose, so it has to be answerable. A meter over an
3851 // unloaded count is what an app actually has for a frame.
3852 let none = Meter::new(0, 0);
3853 assert_eq!(none.percent(), 0);
3854 assert!(none.is_empty());
3855 assert!(!none.overflowing());
3856 }
3857
3858 #[test]
3859 fn the_ratio_survives_where_a_percentage_would_not() {
3860 // Given 43 nothing can recover "3 of 7", which is why the numbers are
3861 // carried and the label names only the noun.
3862 let m = Meter::new(3, 7).label("subtasks");
3863 assert_eq!(m.percent(), 42);
3864 assert_eq!((m.done, m.total), (3, 7));
3865 assert_eq!(m.label, Some("subtasks"));
3866 }
3867
3868 #[test]
3869 fn tone_is_carried_because_no_renderer_can_derive_it() {
3870 // The same fullness means opposite things on two of goingson's bars,
3871 // and only the app knows which.
3872 let subtasks = Meter::new(9, 10).tone(Tone::Success);
3873 let estimate = Meter::new(9, 10).tone(Tone::Danger);
3874 assert_eq!(subtasks.percent(), estimate.percent());
3875 assert_ne!(subtasks.tone, estimate.tone);
3876 // Untoned by default: a bar says nothing about status until something
3877 // says so, the same way a row is not selectable until told.
3878 assert_eq!(Meter::new(9, 10).tone, Tone::Neutral);
3879 }
3880
3881 #[test]
3882 fn an_act_is_reachable_until_it_is_disabled() {
3883 // The one member a renderer must branch on, and since 0.19.0 the only
3884 // member there is. A stated state is not by itself a reason to stop
3885 // answering, which is the distinction `State` makes and every
3886 // hand-rolled button in the tree had to remember.
3887 assert!(!Act::new("Save").disabled());
3888 assert!(Act::new("Save").state(State::Disabled).disabled());
3889 }
3890
3891 #[test]
3892 fn an_act_carries_its_key_because_a_terminal_has_nothing_else() {
3893 // No key is the ordinary case, and the webview hosts that ignore it
3894 // are why it stayed optional.
3895 assert_eq!(Act::new("Delete").key, None);
3896 let quit = Act::new("Quit").key("q").tone(Tone::Danger);
3897 assert_eq!(quit.key, Some("q"));
3898 assert_eq!(quit.tone, Tone::Danger);
3899 }
3900
3901 #[test]
3902 fn a_meter_does_not_overflow_on_large_counts() {
3903 // done * 100 in u32 would wrap somewhere past 42 million. Counts that
3904 // size are not tasks, but a description layer that silently reports 3%
3905 // for a full bar is worse than one that is slow.
3906 let big = Meter::new(u32::MAX, u32::MAX);
3907 assert_eq!(big.percent(), 100);
3908 assert!(!big.overflowing());
3909 }
3910
3911 #[test]
3912 fn inset_is_raised_with_the_light_moved() {
3913 let (rl, rd) = Bevel::Raised.edges();
3914 let (il, id) = Bevel::Inset.edges();
3915 assert_eq!((rl, rd), (Edge::Light, Edge::Dark));
3916 assert_eq!((il, id), (rd, rl));
3917 }
3918
3919 #[test]
3920 fn pressing_twice_is_a_no_op() {
3921 for b in [Bevel::Raised, Bevel::Inset] {
3922 assert_eq!(b.pressed().pressed(), b);
3923 }
3924 }
3925
3926 #[test]
3927 fn a_raised_region_is_never_filled_with_a_recessed_surface() {
3928 // The bug this vocabulary exists to make unrepresentable.
3929 assert_eq!(Depth::Raised.fill(), Some(Fill::Raised));
3930 assert_eq!(Depth::Raised.bevel(), Some(Bevel::Raised));
3931 assert_eq!(Depth::Well.bevel(), Some(Bevel::Inset));
3932 assert_ne!(Depth::Well.fill(), Depth::Raised.fill());
3933 }
3934
3935 #[test]
3936 fn state_is_orthogonal_to_depth() {
3937 // The reason State is its own axis and not a Depth member: a disabled
3938 // button and a disabled field are both disabled and are not the same
3939 // shape, which one shared variant could not have said.
3940 assert_eq!(Depth::Raised.fill(), Some(Fill::Raised));
3941 assert_eq!(Depth::Well.fill(), Some(Fill::Well));
3942 assert!(State::Disabled.suppresses_interaction());
3943 }
3944
3945 #[test]
3946 fn only_disabled_stops_answering() {
3947 // Kept in spirit from the version where `Focus` was the counter-example:
3948 // suppressing interaction is `Disabled`'s alone, so a member added here
3949 // later does not get to inherit it by being a state.
3950 assert!(State::Disabled.suppresses_interaction());
3951 }
3952
3953 #[test]
3954 fn disabled_resolves_against_an_intent_makeover_already_derives() {
3955 // No new token, so this costs no `makeover` release.
3956 assert_eq!(State::Disabled.token(), "content-muted");
3957 }
3958
3959 #[test]
3960 fn flat_has_neither_edge_nor_fill() {
3961 assert_eq!(Depth::Flat.bevel(), None);
3962 assert_eq!(Depth::Flat.fill(), None);
3963 }
3964
3965 #[test]
3966 fn sunken_is_recessed_by_colour_with_no_edge() {
3967 // The one member carrying a fill without a bevel. A renderer that
3968 // assumes the two arrive together drops the fill silently, which is
3969 // exactly what makeover-webview did before 0.3.0.
3970 assert_eq!(Depth::Sunken.fill(), Some(Fill::Sunken));
3971 assert_eq!(Depth::Sunken.bevel(), None);
3972 }
3973
3974 #[test]
3975 fn sunken_and_flat_are_different_claims() {
3976 // Both edgeless, and only one of them needs a colour. Collapsing them
3977 // is what left an unchosen tab unsayable.
3978 assert_eq!(Depth::Flat.bevel(), Depth::Sunken.bevel());
3979 assert_ne!(Depth::Flat.fill(), Depth::Sunken.fill());
3980 }
3981
3982 #[test]
3983 fn a_sunken_surface_is_not_a_well() {
3984 // Authored in opposite directions: makeover derives surface-well by
3985 // inverting against the theme's content colour, while surface-sunken is
3986 // authored and may sit darker than raised.
3987 assert_ne!(Fill::Sunken, Fill::Well);
3988 assert_eq!(Fill::Sunken.token(), "surface-sunken");
3989 assert_eq!(Fill::Well.token(), "surface-well");
3990 }
3991
3992 #[test]
3993 fn every_selector_describes_both_of_its_states() {
3994 // The gap 0.3.0 closed. Before it, only `chosen` existed and the
3995 // unchosen option fell through to Flat at every renderer.
3996 for s in [Selector::Tabs, Selector::Segmented, Selector::Toggle] {
3997 assert_ne!(
3998 s.chosen(),
3999 s.unchosen(),
4000 "{s:?} cannot tell picked from unpicked"
4001 );
4002 }
4003 }
4004
4005 #[test]
4006 fn only_a_tab_inverts_the_other_way() {
4007 // Tabs recede so the chosen one comes forward; a segment and a toggle
4008 // stand up so the chosen one is held in. That inversion is the whole
4009 // content of "picked" once colour is deferred, and it is why the three
4010 // are not one member with a flag.
4011 assert_eq!(Selector::Tabs.unchosen(), Depth::Sunken);
4012 assert_eq!(Selector::Tabs.chosen(), Depth::Raised);
4013
4014 for s in [Selector::Segmented, Selector::Toggle] {
4015 assert_eq!(s.unchosen(), Depth::Raised);
4016 assert_eq!(s.chosen(), Depth::Well);
4017 // Held in is what pressing produces: one appearance, two reasons.
4018 assert_eq!(s.unchosen().pressed(), s.chosen());
4019 }
4020 }
4021
4022 #[test]
4023 fn pressing_a_card_makes_a_well() {
4024 assert_eq!(Depth::Raised.pressed(), Depth::Well);
4025 assert_eq!(
4026 Depth::Raised.pressed().bevel(),
4027 Depth::Raised.bevel().map(Bevel::pressed)
4028 );
4029 // Only raised regions respond to being pressed.
4030 assert_eq!(Depth::Flat.pressed(), Depth::Flat);
4031 assert_eq!(Depth::Well.pressed(), Depth::Well);
4032 // An overlay is a surface, not a control.
4033 assert_eq!(Depth::Overlay.pressed(), Depth::Overlay);
4034 }
4035
4036 #[test]
4037 fn an_overlay_is_lifted_rather_than_edged() {
4038 // The wave-2 rule: a surface over the page takes elevation, a surface
4039 // in the page takes a bevel. Both halves come off the one Depth, so
4040 // they cannot disagree.
4041 assert_eq!(Depth::Overlay.fill(), Some(Fill::Overlay));
4042 assert_eq!(Depth::Overlay.bevel(), None);
4043
4044 // Three depths have no bevel and they are not the same claim. Flat has
4045 // nothing to separate from, Sunken's colour is doing the separating,
4046 // and an overlay is separated by the lift.
4047 assert_ne!(Depth::Overlay.fill(), Depth::Sunken.fill());
4048 assert_ne!(Depth::Overlay.fill(), Depth::Flat.fill());
4049 }
4050
4051 #[test]
4052 fn intents_name_makeover_tokens_and_nothing_else() {
4053 assert_eq!(Edge::Light.token(), "bevel-light");
4054 assert_eq!(Edge::Dark.token(), "bevel-dark");
4055 assert_eq!(Fill::Raised.token(), "surface-raised");
4056 assert_eq!(Fill::Well.token(), "surface-well");
4057 // No value ever leaves this crate.
4058 for t in [
4059 Edge::Light.token(),
4060 Edge::Dark.token(),
4061 Tone::Danger.token(),
4062 Tone::Neutral.token(),
4063 State::Disabled.token(),
4064 ] {
4065 assert!(!t.starts_with('#'), "{t} looks like a value");
4066 assert!(
4067 !t.chars().next().unwrap().is_ascii_digit(),
4068 "{t} is a value"
4069 );
4070 }
4071 }
4072
4073 #[test]
4074 fn a_badge_cannot_be_pressed_and_a_chip_latches() {
4075 // The one line that runs through all three apps' taxonomies.
4076 assert!(!Token::Badge.interactive());
4077 assert!(Token::Chip { removable: false }.interactive());
4078 assert!(Token::Chip { removable: true }.interactive());
4079
4080 // A badge is a label, so giving it an edge would lie about it.
4081 assert_eq!(Token::Badge.depth(false), Depth::Flat);
4082 assert_eq!(Token::Badge.depth(true), Depth::Flat);
4083
4084 // A latched chip wears the same shape a pressed one does.
4085 let chip = Token::Chip { removable: false };
4086 assert_eq!(chip.depth(false), Depth::Raised);
4087 assert_eq!(chip.depth(true), Depth::Raised.pressed());
4088 }
4089
4090 #[test]
4091 fn a_toast_and_a_banner_differ_in_more_than_placement() {
4092 assert!(Notice::Toast.transient());
4093 assert!(!Notice::Banner.transient());
4094 // A toast floats above the page; a banner rests in the flow.
4095 assert_eq!(Notice::Toast.fill(), Fill::Overlay);
4096 assert_eq!(Notice::Banner.fill(), Fill::Raised);
4097 }
4098
4099 #[test]
4100 fn emphasis_falls_off_down_the_row() {
4101 // `revealed_on_hover` was asserted here until 0.13.0 retired it. It said
4102 // a row's actions stay hidden until hover, which stopped being true when
4103 // makeover-webview 0.23.0 showed them at rest, and nothing had consumed
4104 // it for a release either way.
4105 assert_eq!(RowPart::Primary.intent(), "content");
4106 assert_eq!(RowPart::Secondary.intent(), "content-secondary");
4107 assert_eq!(RowPart::Meta.intent(), "content-muted");
4108 }
4109
4110 #[test]
4111 fn a_token_part_carries_no_intent_of_its_own() {
4112 // Each token carries its own tone, so a part-level intent underneath
4113 // would fight the thing sitting on it. Same reasoning as actions, which
4114 // is why they answer alike.
4115 assert_eq!(RowPart::Tokens.intent(), RowPart::Actions.intent());
4116 assert_eq!(RowPart::Tokens.intent(), "content");
4117 }
4118
4119 #[test]
4120 fn the_two_temporal_kinds_are_the_two_that_name_a_moment() {
4121 // The pair is named once so a host with parsing to do asks here rather
4122 // than spelling it out, which is `offers_options`' reason.
4123 assert!(FieldKind::Date.temporal());
4124 assert!(FieldKind::DateTime.temporal());
4125
4126 for kind in [
4127 FieldKind::Text,
4128 FieldKind::Secret,
4129 FieldKind::Number,
4130 FieldKind::Email,
4131 FieldKind::Url,
4132 FieldKind::Tel,
4133 FieldKind::Range,
4134 FieldKind::Textarea,
4135 FieldKind::Select,
4136 FieldKind::Radio,
4137 FieldKind::Checkbox,
4138 FieldKind::File,
4139 FieldKind::Hidden,
4140 ] {
4141 assert!(!kind.temporal(), "{kind:?}");
4142 }
4143 }
4144
4145 #[test]
4146 fn a_date_carries_no_time_and_a_datetime_carries_no_zone() {
4147 // The formats are the whole reason the members are worth naming apart
4148 // from text, so the doc comments and the constants have to agree. A
4149 // host reading one and meeting the other is the silent failure.
4150 assert_eq!(DATE_FORMAT, "%Y-%m-%d");
4151 assert!(!DATE_FORMAT.contains("%H"), "a day carries no hour");
4152
4153 assert_eq!(DATETIME_FORMAT, "%Y-%m-%dT%H:%M");
4154 assert!(
4155 DATETIME_FORMAT.starts_with(DATE_FORMAT),
4156 "a moment starts with the day it is on"
4157 );
4158 // Local, and that is a property of the value rather than an omission.
4159 assert!(!DATETIME_FORMAT.contains("%Z"), "no zone name");
4160 assert!(!DATETIME_FORMAT.ends_with('Z'), "not UTC-stamped");
4161 assert!(!DATETIME_FORMAT.contains("%S"), "no seconds by default");
4162 }
4163
4164 #[test]
4165 fn a_temporal_kind_takes_a_label_above_it_and_offers_no_options() {
4166 // Neither is a checkbox and neither is a fixed set, so both fall where
4167 // text does. Asserted because a new kind lands in three predicates and
4168 // only one of them is the interesting one.
4169 for kind in [FieldKind::Date, FieldKind::DateTime] {
4170 assert!(kind.visible(), "{kind:?}");
4171 assert!(!kind.confidential(), "{kind:?}");
4172 assert!(!kind.labels_itself(), "{kind:?}");
4173 assert!(!kind.offers_options(), "{kind:?}");
4174 }
4175 }
4176
4177 #[test]
4178 fn a_cell_part_names_an_intent_and_only_the_value_is_text() {
4179 // The table half of what RowPart::intent does for rows. A cell holding
4180 // a control and a cell holding text answered alike until 0.14.0, and a
4181 // control in a cell took the cell's text colour.
4182 assert_eq!(CellPart::Value.intent(), "content");
4183
4184 for part in [CellPart::Tokens, CellPart::Actions, CellPart::Link] {
4185 // Each for its own reason -- a token carries its tone, an action is
4186 // a control, a link takes the action colour -- and all three reach
4187 // the intent inheriting already gives.
4188 assert_eq!(part.intent(), CellPart::Value.intent(), "{part:?}");
4189 }
4190 }
4191
4192 #[test]
4193 fn every_cell_part_answers_with_a_token_and_never_a_value() {
4194 for part in [
4195 CellPart::Value,
4196 CellPart::Tokens,
4197 CellPart::Actions,
4198 CellPart::Link,
4199 ] {
4200 let intent = part.intent();
4201 assert!(!intent.is_empty(), "{part:?} names nothing");
4202 assert!(!intent.starts_with('#'), "{part:?} looks like a value");
4203 }
4204 }
4205
4206 #[test]
4207 fn a_separator_is_what_tells_a_section_from_a_subsection() {
4208 assert!(Heading::Section.separated());
4209 assert!(!Heading::Subsection.separated());
4210 assert!(!Heading::Page.separated());
4211 }
4212
4213 #[test]
4214 fn a_chosen_segment_is_held_in_and_a_chosen_tab_comes_forward() {
4215 assert_eq!(Selector::Segmented.chosen(), Depth::Well);
4216 assert_eq!(Selector::Toggle.chosen(), Depth::Well);
4217 // The exception, and the whole folder semantic: the open tab joins its
4218 // pane rather than sinking away from it.
4219 assert_eq!(Selector::Tabs.chosen(), Depth::Raised);
4220
4221 // A held-in segment is indistinguishable from a pressed raised one,
4222 // which is the economy the light model buys over a colour swap.
4223 assert_eq!(Selector::Segmented.chosen(), Depth::Raised.pressed());
4224
4225 // A toggle stands alone; the other two are built out of parts that
4226 // touch.
4227 assert!(Selector::Segmented.abutting());
4228 assert!(Selector::Tabs.abutting());
4229 assert!(!Selector::Toggle.abutting());
4230 }
4231
4232 #[test]
4233 fn columns_are_peers_and_a_split_is_not() {
4234 // The distinction the member exists for. A split's two panes stand in a
4235 // master-detail relationship; columns choose nothing about each other.
4236 // Both are flat, so depth cannot tell them apart and the doc has to.
4237 assert_eq!(Region::Columns.depth(), Depth::Flat);
4238 assert_eq!(Region::Split.depth(), Depth::Flat);
4239 assert_ne!(Region::Columns, Region::Split);
4240 }
4241
4242 #[test]
4243 fn columns_carry_no_count_and_no_share() {
4244 // The two things a board is always asked to carry and must not. How
4245 // many is what the children say; how wide is settled by "peers are
4246 // equal".
4247 //
4248 // The guard is the binding itself and it is a compile-time one: adding
4249 // a field to `Columns` stops this line compiling, which is a better
4250 // failure than any assertion about it. Written out rather than inlined
4251 // for exactly that reason.
4252 let columns: Region<'_> = Region::Columns;
4253 assert_eq!(columns.name(), None);
4254 }
4255
4256 #[test]
4257 fn columns_are_described_and_the_escape_hatch_is_still_one_member() {
4258 // A board's contents are ordinary description all the way down, so a
4259 // renderer that does not lay them across still draws every column.
4260 // Stacking them vertically is honouring this member, not degrading it.
4261 assert!(Region::Columns.described());
4262 assert!(!Region::Bespoke { name: "timeline" }.described());
4263 }
4264
4265 #[test]
4266 fn a_span_never_has_zero_minutes_however_it_is_asked_for() {
4267 // Every renderer divides by this. A caller passing a backwards or empty
4268 // span is a bug, but it is not a bug worth a panic three renderers deep.
4269 assert_eq!(Span::new(600, 600).length(), 1);
4270 assert_eq!(Span::new(600, 300).length(), 1);
4271 assert_eq!(Span::DAY.length(), 1440);
4272 }
4273
4274 #[test]
4275 fn a_span_can_run_past_midnight_without_a_second_date() {
4276 // 22:00 to 02:00. The alternative was carrying a date, which drags a
4277 // timezone into the vocabulary for the sake of one night shift.
4278 let overnight = Span::new(1320, 1560);
4279 assert_eq!(overnight.length(), 240);
4280 assert!(overnight.holds(1500));
4281 assert!(!overnight.holds(1200));
4282 }
4283
4284 #[test]
4285 fn overlap_is_computed_rather_than_declared() {
4286 // The reason Placement carries no `conflicts` flag: the times already
4287 // say it, and a second source for one fact is how a stale conflict
4288 // badge outlives the conflict.
4289 let morning = Placement::new(540, 60); // 09:00-10:00
4290 let overlapping = Placement::new(570, 60); // 09:30-10:30
4291 let after = Placement::new(600, 60); // 10:00-11:00
4292
4293 assert!(morning.overlaps(overlapping));
4294 assert!(overlapping.overlaps(morning), "overlap is symmetric");
4295 // Touching end to end is not overlapping: `to` is exclusive, so a
4296 // 10:00 start does not collide with a 10:00 end.
4297 assert!(!morning.overlaps(after));
4298 assert!(!after.overlaps(morning));
4299 }
4300
4301 #[test]
4302 fn a_placement_is_always_drawable() {
4303 assert_eq!(Placement::new(540, 0).length(), 1);
4304 assert_eq!(Placement::new(540, 30).end(), 570);
4305 }
4306
4307 #[test]
4308 fn a_track_places_the_fraction_every_renderer_would_otherwise_compute() {
4309 let day = Track::DAY;
4310 assert!((day.fraction(0) - 0.0).abs() < f32::EPSILON);
4311 assert!((day.fraction(720) - 0.5).abs() < f32::EPSILON);
4312 // Clamped rather than off the end: an event running past the span's
4313 // close draws at the edge, which beats panicking or drawing nowhere.
4314 assert!((day.fraction(2000) - 1.0).abs() < f32::EPSILON);
4315 }
4316
4317 #[test]
4318 fn a_track_counts_its_slots_and_never_divides_by_zero() {
4319 assert_eq!(Track::DAY.slots(), 96);
4320 assert_eq!(Track::over(Span::new(540, 1020)).slots(), 32);
4321 // A span that does not divide evenly keeps a slot for its tail.
4322 assert_eq!(Track::over(Span::new(0, 50)).slots(), 4);
4323 // slot: 0 is a caller bug that reads as one slot, not a panic.
4324 let degenerate = Track {
4325 span: Span::DAY,
4326 slot: 0,
4327 tick: 60,
4328 unit: Unit::Minutes,
4329 };
4330 assert_eq!(degenerate.slots(), 1);
4331 }
4332
4333 #[test]
4334 fn a_track_carries_facts_and_no_presentation() {
4335 // The guard on the thing the withdrawn refusal was right about. If a
4336 // pixel measure, a scroll offset or a colour ever lands on Track, the
4337 // member has stopped being a fact about the data and the timeline
4338 // really has become a component library wearing a description's name.
4339 let day = Track::DAY;
4340 assert_eq!(day.span, Span::DAY);
4341 assert_eq!(day.slot, 15);
4342 assert_eq!(day.tick, 60);
4343 assert_eq!(day.unit, Unit::Minutes);
4344
4345 // Three fields when this was written, and the fourth came here to say
4346 // why, which is the whole point of the assertion. `unit` is what the
4347 // integers COUNT -- a fact about the data, unavailable from the numbers
4348 // themselves, and the absence of it is what let a month strip render
4349 // under a wall clock. A fifth field still has to argue, and "the
4350 // renderer would find it handy" is still not the argument.
4351 // Destructured rather than rebuilt: this is the form that names every
4352 // field and stops compiling when a fifth arrives, without binding
4353 // anything a lint has to forgive.
4354 let Track {
4355 span: _,
4356 slot: _,
4357 tick: _,
4358 unit: _,
4359 } = day;
4360 }
4361
4362 #[test]
4363 fn a_day_strip_is_the_same_arithmetic_under_a_different_unit() {
4364 // The probe that found the defect, kept as a test. Fifteen days from
4365 // day three, on a thirty-one day month: the geometry was always right
4366 // and only the label was wrong, which is why `unit` is a fact and not
4367 // presentation.
4368 let march = Track::days(Span::new(0, 31));
4369 assert_eq!(march.slots(), 31);
4370 assert_eq!(march.unit, Unit::Days);
4371
4372 let leave = Placement::new(2, 15);
4373 assert!((march.fraction(leave.at()) - 2.0 / 31.0).abs() < 0.0001);
4374 assert!((march.fraction(leave.end()) - 17.0 / 31.0).abs() < 0.0001);
4375 }
4376
4377 #[test]
4378 fn a_pane_is_looked_into_and_a_band_is_not() {
4379 assert_eq!(Region::Pane.depth(), Depth::Well);
4380 assert_eq!(Region::Modal.depth(), Depth::Raised);
4381 for r in [
4382 Region::Band,
4383 Region::Sidebar,
4384 Region::Group,
4385 Region::Split,
4386 Region::TabGroup,
4387 ] {
4388 assert_eq!(r.depth(), Depth::Flat, "{r:?} should carry no edge");
4389 }
4390 }
4391
4392 #[test]
4393 fn exactly_one_region_is_opaque() {
4394 // The escape hatch is one member and stays one member. If a second
4395 // undescribed region ever appears, the description has started
4396 // conceding rather than deferring.
4397 for r in [
4398 Region::Band,
4399 Region::Sidebar,
4400 Region::Pane,
4401 Region::Group,
4402 Region::Split,
4403 Region::TabGroup,
4404 Region::Modal,
4405 // A widget is described, and that is the whole of what separates it
4406 // from a bespoke here. Both carry a name this crate never reads;
4407 // only one of them has contents under it that a renderer which does
4408 // not know the name can still walk.
4409 Region::Widget { name: "carousel" },
4410 ] {
4411 assert!(r.described(), "{r:?} should be describable");
4412 }
4413 assert!(!Region::Bespoke { name: "day-plan" }.described());
4414 }
4415
4416 #[test]
4417 fn a_picture_that_says_nothing_is_a_claim_and_not_an_oversight() {
4418 // The distinction a renderer with no graphics protocol runs on: draw
4419 // the words, or draw nothing. Standing in for a decorative rule with
4420 // the word "decoration" is worse than leaving the space empty.
4421 assert!(Image::new("The library view, mid-import").speaks());
4422 assert!(!Image::new("").speaks());
4423 }
4424
4425 #[test]
4426 fn a_caption_and_alt_text_are_not_the_same_line() {
4427 // A caption is content everybody reads; alt text stands in for the
4428 // picture. A screenshot with a caption still needs alt text.
4429 let shot = Image::new("A file list with three rows selected").caption("The library view");
4430 assert_eq!(shot.caption, Some("The library view"));
4431 assert!(shot.speaks());
4432 assert_ne!(shot.alt, shot.caption.unwrap());
4433 }
4434
4435 #[test]
4436 fn a_picture_can_say_how_much_room_to_hold() {
4437 // The whole point: a renderer reserves from the ratio, so the space is
4438 // right at any width. A fixed height would only be right at one.
4439 let shot = Image::new("a screenshot").intrinsic(5120, 3412);
4440 let e = shot.intrinsic.expect("carried");
4441 assert_eq!((e.width, e.height), (5120, 3412));
4442 assert!((e.ratio().unwrap() - 1.5006).abs() < 0.001);
4443 }
4444
4445 #[test]
4446 fn a_picture_with_no_dimensions_reserves_nothing_rather_than_guessing() {
4447 // `None` is honest: a creator upload whose size was never recorded does
4448 // not know it. A renderer must not invent one.
4449 assert_eq!(Image::new("unknown upload").intrinsic, None);
4450 assert_eq!(Extent::new(0, 10).ratio(), None);
4451 assert_eq!(Extent::new(10, 0).ratio(), None);
4452 }
4453
4454 #[test]
4455 fn a_picture_is_wanted_now_unless_the_app_says_otherwise() {
4456 // Eager is the safe default and lazy is the opt-in, because deferring
4457 // something already on screen saves nothing and moves its shift later.
4458 assert_eq!(Image::new("hero").loading, Loading::Eager);
4459 assert_eq!(Loading::default(), Loading::Eager);
4460 assert_eq!(Image::new("frame 2").lazy().loading, Loading::Lazy);
4461 }
4462
4463 #[test]
4464 fn a_picture_keeps_its_own_proportions_unless_told_otherwise() {
4465 // The default is the one that shows the whole picture at its own shape,
4466 // so a renderer ignoring Fit entirely is still right about the common
4467 // case. The shipped MNW carousel sets no object-fit at all, which is
4468 // this.
4469 assert_eq!(Image::new("a").fit, Fit::Natural);
4470 assert_eq!(Fit::default(), Fit::Natural);
4471 assert_eq!(Image::new("a").fit(Fit::Cover).fit, Fit::Cover);
4472 }
4473
4474 #[test]
4475 fn a_group_contains_a_section_without_claiming_to_be_a_pane() {
4476 // The whole of why this is a member rather than a `Pane`. A pane is
4477 // looked into and scrolls; a group is neither, and four groups inside a
4478 // settings pane described as panes are four wells inside a well.
4479 assert_eq!(Region::Pane.depth(), Depth::Well);
4480 assert_eq!(Region::Group.depth(), Depth::Flat);
4481 assert_ne!(Region::Group, Region::Pane);
4482
4483 // Described, and it carries no name: a group is a primitive every
4484 // renderer draws from scratch, which is what separates it from the two
4485 // members that do carry one.
4486 assert!(Region::Group.described());
4487 assert_eq!(Region::Group.name(), None);
4488 }
4489
4490 #[test]
4491 fn a_section_heading_names_a_block_that_now_exists() {
4492 // `Heading::Section` has said "names a block within the screen" since
4493 // 0.2.0 and there was no block. The pairing is the point, and it is the
4494 // reason a group carries no heading of its own: the heading is an
4495 // ordinary node in the body, and a group without one is legal.
4496 assert!(Heading::Section.separated());
4497 assert_eq!(Region::Group.depth(), Depth::Flat);
4498 }
4499
4500 #[test]
4501 fn a_widget_inherits_its_depth_the_way_a_bespoke_does() {
4502 // Stronger than the bespoke case: a widget is drawn by whichever
4503 // renderer recognises the name, so a depth chosen here would be this
4504 // crate deciding a carousel is raised on every host.
4505 assert_eq!(Region::Widget { name: "carousel" }.depth(), Depth::Flat);
4506 assert_eq!(Region::Widget { name: "pager" }.depth(), Depth::Flat);
4507 }
4508
4509 #[test]
4510 fn a_name_is_readable_without_asking_which_member_carried_it() {
4511 // A renderer dispatching on a name wants the string, not the member.
4512 // Writing that `matches!` at each renderer is how the two drift apart.
4513 assert_eq!(Region::Widget { name: "carousel" }.name(), Some("carousel"));
4514 assert_eq!(
4515 Region::Bespoke { name: "day-plan" }.name(),
4516 Some("day-plan")
4517 );
4518
4519 for r in [
4520 Region::Band,
4521 Region::Sidebar,
4522 Region::Pane,
4523 Region::Group,
4524 Region::Split,
4525 Region::TabGroup,
4526 Region::Modal,
4527 ] {
4528 assert_eq!(r.name(), None, "{r:?} names nothing an app chose");
4529 }
4530 }
4531
4532 #[test]
4533 fn a_bespoke_region_inherits_its_depth_rather_than_choosing_one() {
4534 // The app owns the contents, not the placement. An app that wants its
4535 // timeline in a well frames it in a Pane.
4536 assert_eq!(Region::Bespoke { name: "day-plan" }.depth(), Depth::Flat);
4537 assert_eq!(Region::Bespoke { name: "kanban" }.depth(), Depth::Flat);
4538 }
4539
4540 #[test]
4541 fn a_screen_with_a_bespoke_region_is_still_a_whole_screen() {
4542 // The argument the member exists for: goingson's day-plan has to be
4543 // routable, or the description covers only the boring screens and the
4544 // interesting four need a second path beside the router.
4545 let day_plan = [
4546 Region::Band,
4547 Region::Bespoke { name: "day-plan" },
4548 Region::Sidebar,
4549 ];
4550 assert_eq!(day_plan.iter().filter(|r| r.described()).count(), 2);
4551 assert_eq!(day_plan.iter().filter(|r| !r.described()).count(), 1);
4552 }
4553
4554 #[test]
4555 fn a_secret_field_is_marked_as_one_and_a_hidden_field_is_not_drawn() {
4556 let secret = Field::new(FieldKind::Secret, "password", "Password");
4557 assert!(secret.kind.confidential());
4558 assert!(secret.kind.visible());
4559
4560 assert!(!FieldKind::Hidden.visible());
4561 // Nothing else is confidential, or the marker means nothing.
4562 for k in [
4563 FieldKind::Text,
4564 FieldKind::Number,
4565 FieldKind::Textarea,
4566 FieldKind::Select,
4567 FieldKind::Checkbox,
4568 FieldKind::Hidden,
4569 ] {
4570 assert!(!k.confidential(), "{k:?} should not be confidential");
4571 }
4572
4573 // Only a checkbox carries its own label.
4574 assert!(FieldKind::Checkbox.labels_itself());
4575 assert!(!FieldKind::Text.labels_itself());
4576 }
4577
4578 #[test]
4579 fn a_plain_field_offers_nothing_and_a_select_offers_its_options() {
4580 let text = Field::new(FieldKind::Text, "title", "Title");
4581 assert!(text.options.is_empty());
4582 assert_eq!(text.placeholder, None);
4583
4584 let sizes = [Choice::plain("small"), Choice::plain("large")];
4585 let select = Field::select("size", "Size", &sizes);
4586 assert_eq!(select.kind, FieldKind::Select);
4587 assert_eq!(select.options.len(), 2);
4588 }
4589
4590 #[test]
4591 fn a_choice_says_what_submits_and_what_is_read_apart() {
4592 // The whole reason it is two strings. `plain` is the case where they
4593 // coincide, and it is a shorthand rather than the general shape.
4594 let plain = Choice::plain("7");
4595 assert_eq!((plain.value, plain.label), ("7", "7"));
4596
4597 let spelled = Choice::new("7", "One week");
4598 assert_ne!(spelled.value, spelled.label);
4599 assert!(
4600 spelled.available(),
4601 "an option is pickable until it says not"
4602 );
4603 }
4604
4605 #[test]
4606 fn a_radio_asks_the_same_question_as_a_select_and_is_not_the_same_kind() {
4607 // Both offer a fixed set and both read `options`, so the two
4608 // constructors differ in exactly one thing. That one thing is the
4609 // point: a renderer decides whether the alternatives are readable
4610 // without opening anything, and it can only decide that if the
4611 // description said which question was asked.
4612 let styles = [
4613 Choice::new("copy", "Copy samples in"),
4614 Choice::new("reference", "Reference in place"),
4615 ];
4616 let radio = Field::radio("storage", "Storage style", &styles);
4617 let select = Field::select("storage", "Storage style", &styles);
4618
4619 assert_eq!(radio.kind, FieldKind::Radio);
4620 assert_ne!(radio.kind, select.kind);
4621 assert_eq!(radio.options, select.options);
4622 assert_eq!(
4623 Field {
4624 kind: select.kind,
4625 ..radio
4626 },
4627 select
4628 );
4629 }
4630
4631 #[test]
4632 fn an_unavailable_option_cannot_be_silent_about_it() {
4633 // The whole content of the one-member shape: saying an option is not
4634 // pickable and saying why are the same act, so the greyed-out-with-no-
4635 // reason state is unsayable rather than merely discouraged.
4636 let multi =
4637 Choice::new("multi", "Multi-sample").unless("Drop a second sample onto the keyboard.");
4638 assert!(!multi.available());
4639 assert_eq!(
4640 multi.unavailable,
4641 Some("Drop a second sample onto the keyboard.")
4642 );
4643
4644 // And the option is still in the list, carrying what it submits, so a
4645 // renderer draws it rather than the app dropping it.
4646 assert_eq!(multi.value, "multi");
4647 assert_eq!(multi.label, "Multi-sample");
4648 }
4649
4650 #[test]
4651 fn a_range_carries_both_ends_and_a_validated_number_need_not() {
4652 // The distinction the kind exists for, asserted rather than only
4653 // written down: bounds are a rule for one and the control itself for
4654 // the other.
4655 let threshold = Field::range("review", "Review above", "0", "1");
4656 assert_eq!(threshold.kind, FieldKind::Range);
4657 assert!(threshold.bounded());
4658 assert_eq!(threshold.min, Some("0"));
4659 assert_eq!(threshold.max, Some("1"));
4660 // Granularity is the host's until an app says otherwise.
4661 assert_eq!(threshold.step, None);
4662
4663 // goingson's duration: a typed number with a floor, and it must not
4664 // read as a slider.
4665 let minutes = Field {
4666 min: Some("1"),
4667 ..Field::new(FieldKind::Number, "minutes", "Minutes")
4668 };
4669 assert_ne!(minutes.kind, FieldKind::Range);
4670 assert!(!minutes.bounded(), "one end is a rule, not an extent");
4671 }
4672
4673 #[test]
4674 fn a_range_described_with_one_end_says_so_rather_than_being_refused() {
4675 // Nothing here enforces the pair, for the reason nothing here enforces
4676 // `required`: the description states the constraint and the renderer
4677 // asks. What it must not do is look bounded.
4678 let half = Field {
4679 max: Some("1"),
4680 ..Field::new(FieldKind::Range, "review", "Review above")
4681 };
4682 assert!(!half.bounded());
4683 }
4684
4685 #[test]
4686 fn exactly_the_option_taking_kinds_say_so() {
4687 // The renderers branch on this rather than on a list of their own, so
4688 // a kind added without a decision here renders its options nowhere.
4689 assert!(FieldKind::Select.offers_options());
4690 assert!(FieldKind::Radio.offers_options());
4691 for kind in [
4692 FieldKind::Text,
4693 FieldKind::Secret,
4694 FieldKind::Number,
4695 FieldKind::Email,
4696 FieldKind::Url,
4697 FieldKind::Tel,
4698 FieldKind::Range,
4699 FieldKind::Textarea,
4700 FieldKind::Checkbox,
4701 FieldKind::Hidden,
4702 ] {
4703 assert!(!kind.offers_options(), "{kind:?} does not offer options");
4704 }
4705 }
4706
4707 #[test]
4708 fn a_radio_group_takes_a_label_even_though_its_options_carry_their_own() {
4709 // The near-miss: each option is labelled beside its own button, so a
4710 // renderer could plausibly read the group as self-labelling and drop
4711 // the question. Checkbox is the only kind that does that.
4712 assert!(!FieldKind::Radio.labels_itself());
4713 assert!(FieldKind::Checkbox.labels_itself());
4714 }
4715
4716 #[test]
4717 fn a_select_with_no_options_is_sayable() {
4718 // An app whose option list has not loaded has exactly this. Making it
4719 // unrepresentable would push the state somewhere less visible, and a
4720 // renderer drawing an empty select reports it on screen.
4721 let loading = Field::select("project", "Project", &[]);
4722 assert!(loading.options.is_empty());
4723 }
4724
4725 #[test]
4726 fn the_description_carries_the_question_and_never_the_answer() {
4727 // The line 0.8.0 drew. Placeholder and options are properties of what
4728 // is being asked; the current value is what came back, and no field
4729 // here holds one.
4730 let f = Field {
4731 placeholder: Some("yyyy-mm-dd"),
4732 ..Field::new(FieldKind::Text, "due", "Due")
4733 };
4734 assert_eq!(f.placeholder, Some("yyyy-mm-dd"));
4735 // A placeholder is not a label, and having one does not excuse the
4736 // field from carrying the other.
4737 assert_eq!(f.label, "Due");
4738 }
4739
4740 #[test]
4741 fn a_field_reports_its_own_error_state() {
4742 let mut f = Field::new(FieldKind::Text, "title", "Title");
4743 assert!(!f.invalid());
4744 f.error = Some("Required");
4745 assert!(f.invalid());
4746 }
4747
4748 #[test]
4749 fn columns_drop_by_priority_and_never_by_position() {
4750 let cols = [
4751 Column {
4752 width: Width::Fill,
4753 priority: Priority::Essential,
4754 ..Column::new("Title")
4755 },
4756 Column {
4757 width: Width::Fixed,
4758 priority: Priority::Secondary,
4759 ..Column::new("Due")
4760 },
4761 Column {
4762 width: Width::Fixed,
4763 priority: Priority::Optional,
4764 ..Column::new("Estimate")
4765 },
4766 ];
4767
4768 // Widest: everything survives.
4769 assert_eq!(
4770 cols.iter()
4771 .filter(|c| c.kept_at(Priority::Optional))
4772 .count(),
4773 3
4774 );
4775 // Narrower: the optional column goes first.
4776 let kept: Vec<_> = cols
4777 .iter()
4778 .filter(|c| c.kept_at(Priority::Secondary))
4779 .map(|c| c.name)
4780 .collect();
4781 assert_eq!(kept, ["Title", "Due"]);
4782 // Narrowest: only what identifies the row.
4783 let kept: Vec<_> = cols
4784 .iter()
4785 .filter(|c| c.kept_at(Priority::Essential))
4786 .map(|c| c.name)
4787 .collect();
4788 assert_eq!(kept, ["Title"]);
4789 }
4790
4791 #[test]
4792 fn inserting_a_column_does_not_move_what_gets_dropped() {
4793 // The bug the ordinal form has and this form cannot: goingson hides
4794 // `nth-child(n+5)` against a seven-column table, so a column inserted
4795 // anywhere to the left silently hides a different one.
4796 let before = [
4797 Column::new("Title"),
4798 Column {
4799 width: Width::Fixed,
4800 priority: Priority::Optional,
4801 ..Column::new("Estimate")
4802 },
4803 ];
4804 let after = [
4805 Column::new("Title"),
4806 Column::new("Project"), // inserted
4807 Column {
4808 width: Width::Fixed,
4809 priority: Priority::Optional,
4810 ..Column::new("Estimate")
4811 },
4812 ];
4813
4814 fn dropped<'a>(cols: &[Column<'a>]) -> Vec<&'a str> {
4815 cols.iter()
4816 .filter(|c| !c.kept_at(Priority::Secondary))
4817 .map(|c| c.name)
4818 .collect()
4819 }
4820 assert_eq!(dropped(&before), ["Estimate"]);
4821 assert_eq!(dropped(&after), ["Estimate"]);
4822 }
4823
4824 #[test]
4825 fn an_arrangement_carries_the_tab_group_as_a_modifier() {
4826 // goingson uses the tab group inside the content region rather than
4827 // instead of one, so it is not a third arrangement.
4828 let go = Arrangement::list_detail(true);
4829 let plain = Arrangement::list_detail(false);
4830 assert_ne!(go, plain);
4831 assert_ne!(go, Arrangement::sidebar_content());
4832 }
4833
4834 #[test]
4835 fn a_share_is_a_proportion_and_resolves_the_same_way_everywhere() {
4836 // The point of the member: a terminal reading columns and a webview
4837 // reading a grid honour one fact, so two hosts showing one screen agree
4838 // about its proportions.
4839 assert_eq!(Share::LIST.as_percent(), 40);
4840 assert_eq!(Share::LIST.of(100), 40);
4841 assert_eq!(
4842 Share::SIDEBAR.of(96),
4843 24,
4844 "quasi-tui's 24 columns, said as a quarter"
4845 );
4846 }
4847
4848 #[test]
4849 fn a_region_never_resolves_to_nothing() {
4850 // A region the description named should be visible. A zero-width one
4851 // reads on screen as a region that vanished, which is the hardest kind
4852 // of bug to find from what is drawn.
4853 assert_eq!(Share::percent(5).of(1), 1);
4854 assert_eq!(Share::percent(5).of(0), 1);
4855 }
4856
4857 #[test]
4858 fn a_share_outside_the_range_is_clamped_rather_than_refused() {
4859 assert_eq!(Share::percent(0), Share::percent(5));
4860 assert_eq!(Share::percent(200), Share::percent(95));
4861 }
4862
4863 #[test]
4864 fn the_share_rides_on_the_arrangement_that_knows_which_question_it_is() {
4865 // How much a sidebar takes and how much a list side takes are different
4866 // questions, and this enum is the only thing that knows which is being
4867 // asked.
4868 assert_eq!(Arrangement::sidebar_content().share(), Share::SIDEBAR);
4869 assert_eq!(Arrangement::list_detail(false).share(), Share::LIST);
4870
4871 let narrow = Arrangement::sidebar_content().with_share(Share::percent(20));
4872 assert_eq!(narrow.share(), Share::percent(20));
4873 assert!(matches!(narrow, Arrangement::SidebarContent { .. }));
4874 }
4875
4876 #[test]
4877 fn a_measure_defaults_to_the_one_53_of_69_templates_asked_for() {
4878 // The default is meaningful: a screen nobody said anything about uses
4879 // the window it was given.
4880 assert_eq!(Measure::default(), Measure::Wide);
4881 assert_eq!(Measure::Reading.as_str(), "reading");
4882 }
4883
4884 #[test]
4885 fn readiness_names_the_state_and_not_the_shimmer() {
4886 // Two members and no third. If a skeleton ever appears in this enum,
4887 // the deferral rule has been broken.
4888 assert_ne!(Readiness::Ready, Readiness::Pending);
4889 }
4890
4891 #[test]
4892 fn a_window_with_no_length_still_answers_what_it_can() {
4893 // The uncounted case is the common one, not the degenerate one: a query
4894 // that asked for 51 to learn there were more than 50 knows there are,
4895 // and not how many.
4896 let uncounted = Window::new(100, 50);
4897 assert_eq!(uncounted.index(), Some(2));
4898 assert_eq!(uncounted.windows(), None);
4899 assert!(uncounted.has_before());
4900 // Unknown length cannot rule out more, and offering a way forward that
4901 // turns out empty is the cheaper mistake.
4902 assert!(uncounted.has_after());
4903 }
4904
4905 #[test]
4906 fn a_counted_window_knows_where_it_ends() {
4907 let last = Window::new(350, 50).of(400);
4908 assert_eq!(last.index(), Some(7));
4909 assert_eq!(last.windows(), Some(8));
4910 assert!(last.has_before());
4911 assert!(!last.has_after());
4912
4913 let first = Window::new(0, 50).of(400);
4914 assert!(!first.has_before());
4915 assert!(first.has_after());
4916 }
4917
4918 #[test]
4919 fn a_window_that_does_not_divide_evenly_rounds_up() {
4920 // 401 rows in pages of 50 is eight pages and a straggler, which is nine
4921 // pages. Rounding down would make the last one unreachable.
4922 assert_eq!(Window::new(0, 50).of(401).windows(), Some(9));
4923 }
4924
4925 #[test]
4926 fn a_zero_count_answers_none_rather_than_dividing() {
4927 let empty = Window::new(0, 0).of(400);
4928 assert_eq!(empty.index(), None);
4929 assert_eq!(empty.windows(), None);
4930 // And it still clamps rather than panicking.
4931 assert_eq!(Window::new(900, 0).of(400).clamped().from, 399);
4932 }
4933
4934 #[test]
4935 fn a_window_past_the_end_clamps_inside_rather_than_vanishing() {
4936 // `Slot::current`'s reasoning, one layer down: a description pointing
4937 // past the end is a host bug, and answering it by drawing nothing
4938 // reports a region that vanished.
4939 assert_eq!(Window::new(900, 50).of(400).clamped().from, 350);
4940 // Nothing to clamp against when the length is unknown.
4941 assert_eq!(Window::new(900, 50).clamped().from, 900);
4942 }
4943
4944 #[test]
4945 fn a_carousel_frame_is_a_window_of_one() {
4946 // The shape a carousel instantiates. Same code as a paged list, which is
4947 // the whole reason `Window` exists rather than two copies of it.
4948 let third = Window::frame(2, 5);
4949 assert_eq!(third.index(), Some(2));
4950 assert_eq!(third.windows(), Some(5));
4951 assert!(third.has_before());
4952 assert!(third.has_after());
4953
4954 let last = Window::frame(4, 5);
4955 assert!(!last.has_after());
4956 }
4957
4958 #[test]
4959 fn numbered_pages_read_from_one_and_load_more_has_no_page() {
4960 // The page number is read aloud, so it is one-based; `Window::index` is
4961 // the zero-based form for indexing.
4962 let third = Paging::pages(100, 50).of(400);
4963 assert_eq!(third.page(), Some(3));
4964 assert_eq!(third.pages_total(), Some(8));
4965 assert_eq!(third.total(), Some(400));
4966 assert!(third.has_previous());
4967 assert!(third.has_more());
4968
4969 // Load-more grew a window from the start, so "page 2" would name
4970 // nothing and the type says so rather than inventing one.
4971 let grown = Paging::more(150).of(400);
4972 assert_eq!(grown.page(), None);
4973 assert_eq!(grown.pages_total(), None);
4974 assert_eq!(grown.shown(), 150);
4975 assert!(!grown.has_previous());
4976 assert!(grown.has_more());
4977 }
4978
4979 #[test]
4980 fn an_uncounted_paging_offers_forward_and_admits_no_total() {
4981 // What a host that will not pay for a COUNT describes. `None` here is
4982 // permanent: a total arriving later would widen the text that prints it,
4983 // which is the reflow "first paint is final paint" forbids.
4984 let feed = Paging::more(50);
4985 assert_eq!(feed.total(), None);
4986 assert_eq!(feed.pages_total(), None);
4987 assert_eq!(feed.remaining(), None);
4988 assert!(feed.has_more());
4989 }
4990
4991 #[test]
4992 fn what_is_left_is_derived_and_never_underflows() {
4993 assert_eq!(Paging::more(150).of(400).remaining(), Some(250));
4994 assert_eq!(Paging::pages(350, 50).of(400).remaining(), Some(0));
4995 // A host that overshot its own total gets zero rather than a wrapped
4996 // usize, which would print as "18446744073709551516 remaining".
4997 assert_eq!(Paging::more(500).of(400).remaining(), Some(0));
4998 }
4999}