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