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