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