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