makeover_webview/lib.rs
1//! The webview renderer for [`makeover_layout`].
2//!
3//! <!-- wiki: makeover-webview -->
4//!
5//! # The renderer that needs no palette
6//!
7//! `makeover-immediate` and `makeover-tui` both take a `Palette`, because egui
8//! and a terminal need an actual colour before they can put anything on
9//! screen. A webview does not: `var(--surface-raised)` *is* the late binding,
10//! and the browser resolves it against whatever `themes.js` last wrote onto
11//! `:root`.
12//!
13//! So this crate emits text naming intents, and never learns a colour. It is
14//! the deferral rule with no adapter in the way, and it is why the webview was
15//! always the wrong renderer to derive a vocabulary from: it can express
16//! anything, so it never pushes back.
17//!
18//! # Phase A: the stylesheet
19//!
20//! This module emits component CSS and no markup, deliberately. GoingsOn has
21//! 145 `innerHTML` sites and Balanced Breakfast 175 `createElement` sites, so
22//! moving markup is a migration where adopting a generated stylesheet is not.
23//! The apps keep every line of their markup and gain the classes.
24//!
25//! It is not a deletion either, which this header claimed until the measurement
26//! came in. Adoption across goingson removed 49 declarations net and *added* 25
27//! lines: a rule loses its depth declarations and gains a variant selector next
28//! to it, so the file stays the same size. What phase A moves is where depth is
29//! defined, not how much CSS exists. Numbers and method in the wiki note under
30//! "The deletion test, run".
31//!
32//! The bevel properties are byte-identical to what both apps already
33//! hand-write, which is asserted below.
34//!
35//! # Phase B: the markup, one description at a time
36//!
37//! [`form`] renders [`makeover_layout::Field`], which is the half of phase B
38//! whose description is settled. It emits strings, because both apps
39//! interpolate their fields into larger string-built forms and returning nodes
40//! would rewrite those too. It owns its own escaping, on the reasoning in that
41//! module: a Rust encoder can cover element text and attribute values with one
42//! function, where the apps need four and have to choose correctly at every
43//! call site.
44//!
45//! [`list`] is the other half: column tracks, the narrowing rules, and the cell
46//! containers a row is made of. It stops at the cell boundary and does not
47//! render what goes inside one, on the reasoning in that module. So phase B is
48//! now the frame around content in both directions, and what an app still owns
49//! is the content itself.
50//!
51//! # What phase A settled, and what it costs
52//!
53//! Decided 2026-07-29 against goingson's `styles.css` rather than against a
54//! component list. The useful finding there was that `.btn` (line 644),
55//! `.card` (768) and `.tag, .badge` (882) each hand-write the same
56//! composition, so three quarters of phase A is one rule with several names.
57//!
58//! Two of the four decisions change how goingson looks, and adoption should
59//! not be described as a pure deletion:
60//!
61//! - **Pressed carries its fill.** [`interactive_rules`] emits
62//! [`Depth::pressed`] whole. goingson presses to `--surface-sunken` today and
63//! will press to `--surface-well`, and hovers to `--surface-overlay` today
64//! and will hover to `--hover-surface`. Since `surface-well` inverts by theme
65//! where `surface-sunken` does not, a dark theme presses *lighter* than it
66//! hovers. That falls out of `makeover`'s own derivation, which says outright
67//! that `surface-sunken` cannot serve as a well, so if it reads wrong the
68//! answer is there and not here.
69//! - **Badges go flat.** See [`token_rules`].
70//!
71//! The other two: the progress trough is renderer-local and the scrollbar
72//! track was dropped ([`component_rules`]), and no class prefix ships by
73//! default, so adoption means deleting the app's hand-written rule in the same
74//! commit that adds the generated one. `.card`, `.badge` and the tab classes
75//! all already exist in goingson, and while both rules exist the cascade order
76//! decides which wins. That is the one real risk in adopting this, and it is
77//! why the migration lands per component rather than in one commit.
78//!
79//! # 0.10.0: the states this crate used to leave to its consumers
80//!
81//! [`interactive_rules`] emitted hover and pressed and stopped, because
82//! `makeover-layout` modelled no interaction state. Focus and disabled were
83//! therefore unsayable, and every app completed the primitive from outside the
84//! only way that works: by out-specifying a rule it does not own. goingson
85//! carries 19 such rules and the MNW server 21, and the three focus rings do
86//! not match each other.
87//!
88//! That also blocked the cascade-layer work outright. An app that declares
89//! `@layer` puts its own rules in a named layer, and unlayered declarations
90//! outrank every named layer regardless of specificity, so all of those
91//! overrides lose in the commit that adopts layers. They cannot simply be
92//! deleted, because they are the only thing supplying the missing states.
93//! Emitting the states here is what turns that adoption into a deletion.
94//!
95//! Four states now, in emission order, and the order is load-bearing: they are
96//! all specificity (0,2,0), so disabled beats hover by coming last and by
97//! nothing else. Nothing here reaches for `:not(:disabled)`, which would raise
98//! a selector this crate will shortly be wrapping in its own layer.
99//!
100//! Hover additionally sits inside a capability query now. `makeover-touch`
101//! answers whether a fingertip has hover and `makeover-geometry` spells the
102//! condition; this crate asks and does not decide. goingson's section 60 exists
103//! solely to take the hover state back on touch, which is a fight it should
104//! never have been handed.
105//!
106//! # 0.11.0: the layer contract
107//!
108//! [`stylesheet`] emits into the `makeover` cascade layer ([`CSS_LAYER`], which
109//! lives in `makeover-geometry` because that is the one crate every CSS emitter
110//! in the family already depends on). `makeover-geometry` 0.6.0 does the same
111//! for `geometry.css`.
112//!
113//! The cascade resolves origin and importance, then layer, then specificity,
114//! then source order, and **unlayered normal declarations outrank every named
115//! layer**. So before this, an app that declared `@layer base, components,
116//! responsive` put every rule it owns into a named layer and lost all of them to
117//! this unlayered file, regardless of specificity and regardless of loading
118//! last. Nothing errors when that happens: the CSS is valid, the minifier is
119//! happy, and buttons and badges look subtly wrong.
120//!
121//! That is why the layer belongs here rather than in each app. An app cannot fix
122//! it from its own stylesheet, because the fix is to layer the file it does not
123//! own.
124//!
125//! **What it flips**, and the reason each app wants a look when it bumps the
126//! pin: a generated rule that currently beats an app rule by being more specific
127//! stops beating it. The direction is always "the app wins", which is what the
128//! apps already assume, but a hand-written rule an app thought was dead can come
129//! back to life.
130//!
131//! An app should declare the order once, or the layer's position is decided by
132//! whichever generated file the browser happens to see first:
133//!
134//! ```css
135//! @layer makeover, base, components, responsive;
136//! ```
137//!
138//! [`in_css_layer`] is re-exported for an app that assembles its own stylesheet
139//! from this crate's pieces. goingson builds `tables.css` in its own `build.rs`
140//! out of [`list::narrowing_css`] and [`list::grid_template_columns`], and those
141//! rules are as generated as the ones here, so they belong in the same layer and
142//! this crate cannot put them there on the app's behalf.
143//!
144//! # 0.12.0: the ring gets its own width
145//!
146//! [`focus_rule`] reused [`Emit::border_width`] and emitted a 1px ring. That was
147//! an implementation convenience dressed as consistency with the invalid-field
148//! ring: a bevel and a focus indicator answer different questions, and only one
149//! of them has to be noticed from across a desk.
150//!
151//! Caught while adopting 0.11.0 into goingson, by the check the adoption tasks
152//! ask for. Every consumer had already written its own ring and all three chose
153//! at least 2px: the MNW server 2px across 10 rules, Balanced Breakfast 2px,
154//! goingson 2px on three rules and 3px on the one covering twelve selectors. The
155//! design system was the only thing in the tree saying 1px, so deleting the app
156//! rules in favour of it would have thinned the focus indicator everywhere.
157//!
158//! [`Emit::focus_width`] now carries it, defaulting to `2px`, and the offset is
159//! the same magnitude with its sign off the depth. Both values are the measured
160//! consensus rather than a new opinion.
161//!
162//! # 0.25.0: a cell says what it holds
163//!
164//! 0.23.0 gave a table its layout and left every cell the same. One `.cell`
165//! carried the whole thing, so a cell holding text and a cell holding a button
166//! were one class and one content colour, and a control in a cell was painted
167//! as text. That is the drift [`RowPart::intent`](makeover_layout::RowPart)
168//! has prevented for list rows since 0.2.0 and prevented for nothing here.
169//!
170//! makeover-layout 0.14.0's [`CellPart`](makeover_layout::CellPart) names the
171//! four things a cell holds, and [`table_rules`] turns them into
172//! `.cell-value`, `.cell-tokens`, `.cell-actions` and `.cell-link`. Only the
173//! first takes a colour: a token carries its own tone, an action is a control
174//! rather than text, and a link takes the action colour from the anchor it is.
175//!
176//! The colour going on `.cell-value` rather than on `.cell` is the fix rather
177//! than an implementation detail. On the container it cascades into the parts
178//! that are not text, which is the bug said in one rule.
179//!
180//! [`list::Cell::part`] is `Option<CellPart>` here, where it was
181//! `Option<RowPart>`. A table cell borrowing the list row's vocabulary was the
182//! drift with a type on it: the two answer different questions, and only one of
183//! them was ever about a cell.
184//!
185//! # 0.23.0: a table lays itself out, and a row shows its controls
186//!
187//! Three things a description could say and this renderer had no rule for,
188//! found together by rendering the MNW server's SSH-keys settings tab through
189//! `quasi` and preferring the hand-written Askama original.
190//!
191//! **A table had no layout at all.** [`list::narrowing_css`] emits the track
192//! list, and it has to be called with the columns, so it works where the
193//! columns are known at build time: goingson builds `tables.css` in its own
194//! `build.rs` and is untouched. A table a description produced knows its
195//! columns at render time, and the rules would have had to travel with the
196//! markup: a `<style>` element per table, which needs `style-src
197//! 'unsafe-inline'` that the MNW server is working to drop, or the head, which
198//! an htmx fragment swap does not carry. [`table_rules`] lays a table out with
199//! `display: table` instead, which aligns columns across rows knowing nothing
200//! about how many there are. [`Priority`](makeover_layout::Priority) hiding
201//! moves from a generated rule per dropped column to one rule per drop class,
202//! and [`list::column_classes`] is what puts those classes on a cell. A header
203//! row emitted by a renderer's own code should call it too, or the header and
204//! the body disagree about which column just dropped.
205//!
206//! **A destructive button had nowhere for its tone to land.** `.button` carried
207//! no tone, on the reading that a control's colour is its surface. Every
208//! consumer had written the danger rule itself. It joins the badge in taking
209//! the four tones as colour, off `data-tone`.
210//!
211//! **A list rendered as a bulleted list**, because nothing here reset the `ul`
212//! a renderer emits for one.
213//!
214//! `RowPart::revealed_on_hover` also stops being honoured, which its own doc
215//! sanctioned: a renderer decides. It was retired outright in makeover-layout
216//! 0.13.0, once this had been its only consumer for a release. The rule hid a
217//! row's actions until hover,
218//! and every escape it grew was a report that hiding was wrong for somebody:
219//! `focus-within` for the keyboard, the capability gate for a fingertip with no
220//! way to unhide. What survived hid the controls from pointer users alone, who
221//! are the ones scanning a list to learn what can be done to a row.
222//!
223//! # 0.17.0: the depth classes stop being controls
224//!
225//! [`depth_rules`] gave `.raised` the whole interactive set. A depth is a
226//! statement about shape, so that left the vocabulary with no raised surface
227//! that is merely an object, and an app wanting one had two moves: write its
228//! own class from tokens, or take a control class and cancel the control half.
229//! goingson took the second, in three variants over sixteen elements
230//! (`.card--static` at 14 call sites, `.card--muted` at 2, `.card--shell` at 1),
231//! each re-asserting the resting fill and bevel on `:hover` and `:active`.
232//!
233//! Measured before changing it: `.raised` is emitted into goingson, Balanced
234//! Breakfast and the MNW server, and none of the three has a single call site.
235//! The states were unasked-for everywhere at once, and dropping them costs no
236//! migration anywhere.
237//!
238//! `.card` and `.button` are unchanged. They are the same depth *and* controls,
239//! and they take their states from [`surface_rules`], which is where a state
240//! belongs: on the thing that claims to answer a pointer.
241//!
242//! # Substitution, three ways
243//!
244//! `Fill::Well` has no colour on makeover before 2.3.0, and each renderer
245//! answers that differently, which is the evidence that dropping
246//! `Fill::fallback` from the description was right:
247//!
248//! - `makeover-immediate` substitutes the page in Rust.
249//! - `makeover-tui` refuses to substitute and draws an edge instead, because a
250//! terminal would quantise the two together.
251//! - here, CSS already has the mechanism: `var(--surface-well,
252//! var(--surface-page))` falls back in the browser, and nothing in Rust
253//! decides anything.
254
255#![forbid(unsafe_code)]
256
257pub mod figure;
258pub mod form;
259pub mod list;
260pub mod meter;
261pub mod placeholder;
262pub mod vocabulary;
263
264use crate::list::{cell_part_class, part_class};
265use makeover_geometry::{Density, SizeClass};
266// Re-exported rather than redefined. An app assembling its own stylesheet out
267// of this crate's pieces needs the same layer name, and most such apps depend
268// on this crate and not on `makeover-geometry` directly: goingson builds
269// `tables.css` in its own build.rs from [`list::narrowing_css`], and those
270// rules are as generated as the ones here.
271pub use makeover_geometry::{CSS_LAYER, in_css_layer};
272use makeover_layout::{
273 Bevel, CellPart, Depth, Fill, Intent, RowPart, Selector, State, Token, Tone,
274};
275use makeover_touch::Affordance;
276use std::fmt::Write as _;
277
278/// How the emitted CSS is shaped.
279#[derive(Debug, Clone, Copy, PartialEq, Eq)]
280pub struct Emit {
281 /// Bevel thickness, as a CSS length.
282 ///
283 /// A value, so it arrives from the caller: border widths belong to
284 /// `makeover-geometry` and will come from there once it carries them.
285 pub border_width: &'static str,
286 /// Focus ring thickness, as a CSS length.
287 ///
288 /// Separate from [`border_width`](Self::border_width), which it reused
289 /// until 0.12.0. That reuse was an implementation convenience dressed as
290 /// consistency, and it emitted a 1px ring: a bevel and a focus indicator
291 /// are answering different questions, and only one of them has to be
292 /// noticed from across a desk.
293 ///
294 /// The default is the measured consensus rather than a new opinion. Every
295 /// consumer had already written its own ring and all three chose at least
296 /// 2px: the MNW server 2px across 10 rules, Balanced Breakfast 2px,
297 /// goingson 2px on three rules and 3px on the one covering twelve
298 /// selectors. The design system was the only thing in the tree saying 1px.
299 pub focus_width: &'static str,
300 /// Prefix for emitted class names, without the leading dot.
301 pub class_prefix: &'static str,
302}
303
304impl Default for Emit {
305 fn default() -> Self {
306 Self {
307 border_width: "1px",
308 focus_width: "2px",
309 class_prefix: "",
310 }
311 }
312}
313
314/// The CSS custom property holding a bevel's composition.
315#[must_use]
316pub fn bevel_var(bevel: Bevel) -> &'static str {
317 match bevel {
318 Bevel::Raised => "--bevel-raised",
319 Bevel::Inset => "--bevel-inset",
320 }
321}
322
323/// A `var()` reference to a fill intent, with the browser's own fallback where
324/// the intent may be absent.
325///
326/// The fallback is CSS syntax, not a decision made here. That is the whole
327/// difference between this renderer and the other two.
328#[must_use]
329pub fn fill_var(fill: Fill) -> String {
330 match fill {
331 Fill::Well => format!("var(--{}, var(--{}))", fill.token(), Fill::Page.token()),
332 other => format!("var(--{})", other.token()),
333 }
334}
335
336/// The two-tone edge as a `box-shadow` value.
337///
338/// Two inset shadows, one per corner pair: the light one offset down and
339/// right so it lands on the top and left edges, the dark one the other way.
340/// The same assignment `makeover-immediate` draws with polylines and
341/// `makeover-tui` draws with box-drawing characters.
342#[must_use]
343pub fn bevel_shadow(bevel: Bevel, opts: &Emit) -> String {
344 let (top_left, bottom_right) = bevel.edges();
345 let w = opts.border_width;
346 format!(
347 "inset {w} {w} 0 var(--{}), inset -{w} -{w} 0 var(--{})",
348 top_left.token(),
349 bottom_right.token()
350 )
351}
352
353/// The custom properties both bevels resolve through.
354///
355/// Emitted as properties rather than inlined into every rule because that is
356/// what the apps already do, and because a consumer that wants the edge
357/// without the fill reads the property directly.
358#[must_use]
359pub fn bevel_properties(opts: &Emit) -> String {
360 let mut css = String::new();
361 for bevel in [Bevel::Raised, Bevel::Inset] {
362 let _ = writeln!(
363 css,
364 " {}: {};",
365 bevel_var(bevel),
366 bevel_shadow(bevel, opts)
367 );
368 }
369 css.push_str(ELEVATION_PROPERTY);
370 css
371}
372
373/// The cast shadow of a surface that floats over the page.
374///
375/// Composed here for the reason the bevel pair is: `makeover` derives the tone,
376/// this crate owns the geometry, and neither has to know the other's numbers.
377///
378/// **Only for a surface that overlays the page.** A menu, a toast, a popover, a
379/// dropdown. A surface *in* the page takes `.raised` and its bevel, and a rule
380/// that reaches for this on a card or a plate has renamed a literal rather than
381/// replaced it.
382///
383/// Two lengths rather than one, because a single blur reads as a smudge at
384/// plate size and as a halo at menu size. The offset is small and downward: a
385/// Platinum-era menu sits just off the page rather than hovering above it.
386const ELEVATION_PROPERTY: &str =
387 " --elevation-overlay: 0 2px 4px var(--elevation), 0 8px 24px var(--elevation);\n";
388
389/// The class name for a depth.
390#[must_use]
391pub fn depth_class(depth: Depth, opts: &Emit) -> Option<String> {
392 let name = match depth {
393 Depth::Flat => return None,
394 Depth::Raised => "raised",
395 Depth::Well => "well",
396 Depth::Sunken => "sunken",
397 // A depth added to the description since this renderer was last
398 // built. No class, on the same footing as Flat: emitting a name
399 // whose rule body we cannot write would put a class in the markup
400 // that the stylesheet never defines.
401 _ => return None,
402 };
403 Some(format!("{}{name}", opts.class_prefix))
404}
405
406/// A prefixed class name.
407///
408/// Public since 0.27.0, for the renderers that emit markup this crate does not.
409/// A screen renderer writing `class="row"` has to prefix it the way the
410/// stylesheet half does or a prefixed app gets rules matching everything except
411/// the elements that renderer wrote, and the failure is invisible: the CSS
412/// stays valid and one element is unstyled. quasi-webview carried a byte
413/// identical copy of this function until it could call this one.
414#[must_use]
415pub fn class(name: &str, opts: &Emit) -> String {
416 format!("{}{name}", opts.class_prefix)
417}
418
419/// The class an option of a selector carries, which is what the rules key off.
420///
421/// Named for the option and not for the group: [`selector_rules`] styles the
422/// thing that gets picked, so `Selector::Tabs` is `tab` and not `tabs`. The
423/// distinction is not pedantry. quasi-webview spelled these `tabs`, `segmented`
424/// and `option`, put `toggle` on the wrapping element rather than on the
425/// buttons inside it, and every described selector in that renderer came out
426/// with no depth, no focus ring and no chosen state, while the toggle group got
427/// a bevel meant for its buttons.
428///
429/// The chosen option additionally carries `chosen`, the same way a latched chip
430/// carries `latched`. That name is this crate's too; there is no reason for a
431/// caller to spell it, and [`selector_rules`] is where it is written down.
432#[must_use]
433pub fn option_class(selector: Selector) -> &'static str {
434 match selector {
435 Selector::Tabs => "tab",
436 Selector::Segmented => "segment",
437 Selector::Toggle => "toggle",
438 }
439}
440
441/// The fill and edge declarations for a depth, as a rule body.
442///
443/// Empty for [`Depth::Flat`], which has neither and inherits what it sits on.
444/// Callers lean on the emptiness to skip the rule rather than emit a class that
445/// sets nothing: a class that sets no properties is a class that means "I
446/// thought about this", which is what comments are for.
447///
448/// The two halves are emitted independently because [`Depth::Sunken`] has a
449/// fill and no bevel. Requiring both, which this did before makeover-layout
450/// 0.3.0, silently dropped the fill for exactly that case. Independent does not
451/// mean unpaired: both halves still come off one `Depth`, so they cannot
452/// disagree about what the region is.
453#[must_use]
454pub fn depth_declarations(depth: Depth) -> String {
455 let mut css = String::new();
456 if let Some(fill) = depth.fill() {
457 let _ = writeln!(css, " background: {};", fill_var(fill));
458 }
459 if let Some(bevel) = depth.bevel() {
460 let _ = writeln!(css, " box-shadow: var({});", bevel_var(bevel));
461 }
462 css
463}
464
465/// One rule giving a selector a depth, or nothing when the depth declares
466/// nothing.
467#[must_use]
468pub fn depth_rule(selector: &str, depth: Depth) -> String {
469 let body = depth_declarations(depth);
470 if body.is_empty() {
471 return String::new();
472 }
473 format!(".{selector} {{\n{body}}}\n")
474}
475
476/// The media condition a hover rule has to sit inside, or `None` if hover is
477/// unconditional.
478///
479/// Two crates answer this and neither answer is made here. `makeover-touch`
480/// owns *whether* hover exists at a density, and `makeover-geometry` owns how
481/// that capability is spelled as a media condition. Asking both is what stops
482/// this renderer minting a third opinion, which is what all three apps did:
483/// goingson sniffed the user agent, Balanced Breakfast used `(hover: none)`
484/// alone, and the MNW server had no gate at all.
485///
486/// [`SizeClass`] is required by [`Affordance::available`] and ignored by this
487/// member, which reports as much through `reads_size`. Passing Compact is not
488/// a claim about width; the test below pins that every class agrees.
489fn hover_condition() -> Option<&'static str> {
490 if Affordance::Hover.available(Density::Touch, SizeClass::Compact) {
491 // A fingertip grew a hover state. Nothing to gate, and this renderer
492 // should not invent a reason to gate anyway.
493 None
494 } else {
495 Some(Density::Pointer.media_condition())
496 }
497}
498
499/// Put a rule inside a media query, or leave it alone.
500fn gated(condition: Option<&str>, rule: &str) -> String {
501 let Some(condition) = condition else {
502 return rule.to_string();
503 };
504 let mut css = format!("@media {condition} {{\n");
505 for line in rule.lines() {
506 // Blank lines stay blank. Indenting one leaves trailing whitespace,
507 // which is the sort of thing a formatter later reverts and calls a diff.
508 if line.is_empty() {
509 css.push('\n');
510 } else {
511 let _ = writeln!(css, " {line}");
512 }
513 }
514 css.push_str("}\n");
515 css
516}
517
518/// The keyboard focus ring, placed by the depth it lands on.
519///
520/// This is the webview's **focus ring** and nothing more. **Reach** and
521/// **focus** are both the browser's — the document decides what is reachable
522/// and `:focus-visible` decides which reached thing wears the ring — and no
523/// description states either. The three terms are defined once in
524/// `makeover_layout`'s crate header, "Reach, focus and the focus ring".
525///
526/// One ring for the whole system, because a focus ring's job is to be
527/// recognised and three apps having three of them is the failure. What varies
528/// is where it sits, and that comes off [`Depth`] rather than off a per-
529/// component choice: a well takes the ring inside its own edge, and anything
530/// standing proud of the page takes it outside.
531///
532/// `outline` rather than the composed `box-shadow` the invalid-field ring at
533/// [`field_rules`] uses, and deliberately the one place the two rings are built
534/// differently. A `box-shadow` ring has to restate the bevel beside it, because
535/// `box-shadow` is not additive and a lone ring silently drops the well out
536/// from under the element. That restatement is a second copy of the depth,
537/// living in a different function from the first, and it is exactly the
538/// duplication `Depth` exists to prevent. `outline` occupies its own property,
539/// so the bevel survives untouched and there is nothing to keep in agreement.
540/// They render the same: both are a flush ring one border-width wide.
541#[must_use]
542pub fn focus_rule(selector: &str, depth: Depth, opts: &Emit) -> String {
543 let w = opts.focus_width;
544 // Same magnitude either way, and only the sign comes off the depth. Both
545 // values are what the consumers had already converged on independently:
546 // 2px out is what all three wrote, and 2px in is the MNW server's own
547 // answer for the one inset ring it had.
548 let offset = match depth.bevel() {
549 // Inside the well, clear of its edge rather than painted over it.
550 Some(Bevel::Inset) => format!("calc(-1 * {w})"),
551 // Raised, or no edge at all. Outside, standing off by its own width.
552 _ => w.to_string(),
553 };
554 // The token by name. It is `makeover`'s, derived from the action colour,
555 // and reaching it through a description member was a second path to the
556 // same variable for as long as one existed.
557 format!(
558 ".{selector}:focus-visible {{\n outline: {w} solid var(--focus-ring);\n outline-offset: {offset};\n}}\n"
559 )
560}
561
562/// Present, visible, and not answering.
563///
564/// Matches the ARIA attribute as well as the pseudo-class, because `:disabled`
565/// only matches form elements and half the things this crate emits are not
566/// one: a `div` carrying `.chip` or `.tab` can never be `:disabled`. Keying on
567/// the accessible state is the pattern [`field_rules`] already establishes for
568/// `aria-invalid`, on the reasoning that one fact read by both the styling and
569/// the accessibility tree cannot drift from itself.
570///
571/// The rest depth is re-asserted rather than assumed, because this rule has to
572/// beat the hover and pressed rules above it. It does that on source order at
573/// equal specificity, not by out-specifying them: every rule this function's
574/// caller emits is (0,2,0), and adding a `:not(:disabled)` anywhere would raise
575/// one of them and have to be unpicked when this output moves inside its own
576/// cascade layer.
577#[must_use]
578pub fn disabled_rule(selector: &str, depth: Depth) -> String {
579 format!(
580 ".{selector}:disabled,\n.{selector}[aria-disabled=\"true\"] {{\n{} color: var(--{});\n cursor: not-allowed;\n}}\n",
581 depth_declarations(depth),
582 State::Disabled.token()
583 )
584}
585
586/// Every state a selector that answers a click implies: hover, pressed, focus
587/// and disabled, in that order.
588///
589/// Order is the whole cascade mechanism here. All four selectors are
590/// specificity (0,2,0), so disabled wins over hover and pressed by coming last
591/// and by nothing else.
592///
593/// Pressed emits [`Depth::pressed`] in full, fill and edge together. Emitting
594/// only the edge is what left goingson hand-writing `background:
595/// var(--surface-sunken)` on three separate rules, and a fill that does not
596/// travel with its edge is precisely the disagreement `Depth` exists to make
597/// unrepresentable. So the pressed fill comes from the description
598/// (`--surface-well`) rather than from whatever each app reached for.
599///
600/// Hover has no member in the description and is renderer policy: a terminal
601/// and an immediate-mode painter have no hover to express. It resolves against
602/// `--hover-surface`, which `makeover` already derives and which nothing
603/// consumed until now. What it *is* gated on is capability, via
604/// [`hover_condition`]. Before that gate existed the apps each wrote their own:
605/// goingson's section 60 exists solely to take back the hover state this
606/// function had just handed it, by out-specifying a rule it does not own.
607///
608/// `depth` is the selector's **rest** depth, used to place the focus ring and
609/// to restore the surface under a disabled control. The pressed rule keeps
610/// inverting from [`Depth::Raised`] regardless, which is what every caller got
611/// before this parameter existed: a tab's unchosen depth is
612/// [`Depth::Sunken`], and `Sunken.pressed()` is `Sunken`, so deriving the press
613/// from the rest depth would leave a tab with no press at all.
614#[must_use]
615pub fn interactive_rules(selector: &str, depth: Depth, opts: &Emit) -> String {
616 let mut css = gated(
617 hover_condition(),
618 &format!(".{selector}:hover {{\n background: var(--hover-surface);\n}}\n"),
619 );
620 css.push_str(&depth_rule(
621 &format!("{selector}:active"),
622 Depth::Raised.pressed(),
623 ));
624 css.push_str(&focus_rule(selector, depth, opts));
625 css.push_str(&disabled_rule(selector, depth));
626 css
627}
628
629/// One rule per depth: its fill and its edge, together.
630///
631/// A depth and nothing else. `.raised` says a surface sits on what is behind
632/// it, which is a statement about the shape and not about what happens when a
633/// pointer arrives, so it emits no hover, press, focus or disabled rule. The
634/// named surfaces are where interaction lives: `.card` and `.button` are the
635/// same depth *and* controls, and they get their states from
636/// [`surface_rules`].
637///
638/// This class carried the interactive set until 0.17.0, which left the
639/// vocabulary with no raised surface that is merely an object. Consumers that
640/// needed one took a control class and cancelled half of it instead: sixteen
641/// elements in goingson across three `.card--*` variants, each re-asserting the
642/// resting fill and bevel on `:hover` and `:active`. Nothing anywhere used
643/// `.raised` itself, so the states were unasked-for in every consumer at once.
644#[must_use]
645pub fn depth_rules(opts: &Emit) -> String {
646 let mut css = String::new();
647 for depth in [Depth::Raised, Depth::Well] {
648 let Some(class) = depth_class(depth, opts) else {
649 continue;
650 };
651 css.push_str(&depth_rule(&class, depth));
652 }
653 css
654}
655
656/// The three surfaces that are a depth with a name.
657///
658/// `button` and `card` are both [`Depth::Raised`], and `field` is a
659/// [`Depth::Well`] because that is the reading `Depth`'s own documentation
660/// gives a text field. Their bodies come out identical by construction rather
661/// than by hand: three hand-written copies in goingson's stylesheet is what
662/// phase A deletes, and generating them from one call is what stops them
663/// drifting apart again.
664fn surface_rules(opts: &Emit) -> String {
665 let mut css = String::new();
666 for name in ["button", "card"] {
667 let c = class(name, opts);
668 css.push_str(&depth_rule(&c, Depth::Raised));
669 css.push_str(&interactive_rules(&c, Depth::Raised, opts));
670 }
671
672 let field = class("field", opts);
673 css.push_str(&depth_rule(&field, Depth::Well));
674
675 // A field takes focus and refuses input like everything else here, and got
676 // neither until now, which is why all three apps hand-write a focus ring
677 // for it and no two of them match. No hover or pressed: a text field does
678 // not light up under the pointer and does not invert when clicked, so the
679 // two states `interactive_rules` would add are the two it does not have.
680 css.push_str(&focus_rule(&field, Depth::Well, opts));
681 css.push_str(&disabled_rule(&field, Depth::Well));
682
683 // Keyed on the ARIA attribute rather than on a class, so the visual state
684 // and the accessible state cannot drift apart: there is one fact and both
685 // read it. goingson already drove its invalid styling this way and was
686 // right to; the `.invalid` class this emitted before 0.5.0 was a second
687 // place to forget.
688 //
689 // The ring composes *after* the bevel rather than replacing it. box-shadow
690 // is not additive, so a lone ring silently dropped the well out from under
691 // an invalid field. Flat and unlit: this edge is saying "wrong", and
692 // lighting one side would have it say "raised" at the same time.
693 let _ = writeln!(
694 css,
695 ".{field}[aria-invalid=\"true\"] {{\n box-shadow: var({}), 0 0 0 {} var(--danger);\n}}",
696 bevel_var(Bevel::Inset),
697 opts.border_width
698 );
699 css
700}
701
702/// Badges and chips.
703///
704/// The one place phase A changes how goingson looks rather than only where its
705/// rules live. [`Token::Badge`] is [`Depth::Flat`], so a badge emits no fill
706/// and no edge at all, where goingson ships `.tag, .badge` as a single rule
707/// carrying the raised bevel. Splitting that means reading every call site to
708/// decide which of the two it always was.
709///
710/// What a badge does carry is a [`Tone`], the intent family it shares with
711/// notices and nothing else. Neutral is the bare class rather than a variant,
712/// because it is the absence of a status and not a status called "none".
713/// Text that goes somewhere.
714///
715/// The one inline control, and the vocabulary had no word for it until a
716/// description layer needed one. A table cell has carried `cell-link` since
717/// 0.14.0's part list, deliberately unruled because the cell's own rule covers
718/// it; what was missing is the same thing outside a table, which is what a
719/// described run holds when a sentence contains a link.
720///
721/// Colour and underline only. Whether a link is inline in a sentence or sitting
722/// on its own line is the app's layout, and how much room it takes is
723/// `makeover-geometry`'s. What is here is the pair of signals that say "this
724/// goes somewhere" and nothing that says where it sits.
725///
726/// The visited arm is deliberately absent. A link inside an app points at the
727/// app's own screens, which the user is expected to have been to, so painting
728/// them differently marks almost everything and distinguishes nothing.
729fn link_rules(opts: &Emit) -> String {
730 let mut css = String::new();
731 let link = class("link", opts);
732
733 let _ = writeln!(
734 css,
735 ".{link} {{\n color: var(--action-primary);\n \
736 text-decoration: underline;\n}}"
737 );
738 // The hover step is the same one every other control takes, and it is a
739 // colour rather than a surface: a link has no box to raise.
740 let _ = writeln!(
741 css,
742 "@media (hover: hover) and (pointer: fine) {{\n .{link}:hover \
743 {{\n color: var(--action-hover);\n }}\n}}"
744 );
745 let _ = writeln!(
746 css,
747 ".{link}:focus-visible {{\n outline: {} solid var(--focus-ring);\n \
748 outline-offset: 2px;\n}}",
749 opts.focus_width
750 );
751 // A link is often a `<button>` rather than an `<a>`: a renderer picks the
752 // element from the method, so a link that writes is a button that has to
753 // stop looking like one.
754 let _ = writeln!(
755 css,
756 "button.{link} {{\n background: none;\n border: none;\n \
757 padding: 0;\n font: inherit;\n cursor: pointer;\n}}"
758 );
759 css
760}
761
762fn token_rules(opts: &Emit) -> String {
763 let mut css = String::new();
764
765 // No `depth_rule` call here, deliberately: `Token::Badge.depth(_)` is Flat,
766 // and a label with an edge says it can be pressed.
767 let badge = class("badge", opts);
768 let _ = writeln!(
769 css,
770 ".{badge} {{\n color: var(--{});\n}}",
771 Tone::Neutral.token()
772 );
773 for tone in [Tone::Info, Tone::Success, Tone::Warning, Tone::Danger] {
774 let _ = writeln!(
775 css,
776 ".{badge}[data-tone=\"{0}\"] {{\n color: var(--{0});\n}}",
777 tone.token()
778 );
779 }
780
781 // A button carries the four tones a badge does. It had none, on the reading
782 // that a control's colour is its surface rather than its text, and that
783 // reading has one hole big enough to matter: the button that destroys
784 // something. Every consumer had written that rule itself, and a description
785 // that says `Tone::Danger` on an act had nowhere for it to land.
786 //
787 // Colour and not a fill, matching the badge. A red surface is a decision
788 // about emphasis that belongs to an app's own layer, and two of them
789 // fighting is worse than neither.
790 let button = class("button", opts);
791 for tone in [Tone::Info, Tone::Success, Tone::Warning, Tone::Danger] {
792 let _ = writeln!(
793 css,
794 ".{button}[data-tone=\"{0}\"] {{\n color: var(--{0});\n}}",
795 tone.token()
796 );
797 }
798
799 // A chip holds itself down, which is `Depth::pressed` arrived at
800 // independently by two apps. `removable` is a remove affordance, so it is
801 // markup and waits for phase B.
802 let chip = class("chip", opts);
803 let unlatched = Token::Chip { removable: false };
804 css.push_str(&depth_rule(&chip, unlatched.depth(false)));
805 css.push_str(&interactive_rules(&chip, unlatched.depth(false), opts));
806 css.push_str(&depth_rule(
807 &format!("{chip}.latched"),
808 unlatched.depth(true),
809 ));
810 css
811}
812
813/// The three selectors, each named by what it picks.
814///
815/// A tab comes *forward* to join the pane it opens, which is why
816/// [`Selector::Tabs`] chooses [`Depth::Raised`] where a segment and a toggle
817/// are held in. That is the folder semantic, and it is the whole reason the
818/// three are not one member with a flag.
819///
820/// [`Selector::abutting`] is not emitted: whether the options touch is
821/// spacing, and spacing is `makeover-geometry`'s question to answer.
822///
823/// Both states emit as of makeover-layout 0.3.0. Before it the description
824/// named only the chosen option, so an unchosen one fell through to
825/// [`Depth::Flat`] and nothing was drawn for it, which left goingson's tab
826/// strip hand-writing the recess that makes its chosen tab read as forward.
827fn selector_rules(opts: &Emit) -> String {
828 let mut css = String::new();
829 for selector in [Selector::Tabs, Selector::Segmented, Selector::Toggle] {
830 let c = class(option_class(selector), opts);
831 css.push_str(&depth_rule(&c, selector.unchosen()));
832 css.push_str(&interactive_rules(&c, selector.unchosen(), opts));
833 css.push_str(&depth_rule(&format!("{c}.chosen"), selector.chosen()));
834 }
835 css
836}
837
838/// The parts of a list row.
839///
840/// The list is written out rather than derived because `RowPart` is
841/// `#[non_exhaustive]` as of makeover-layout 0.9.0, so there is nothing to
842/// iterate. A member added upstream emits no rule until it is named here, which
843/// is the trade `non_exhaustive` makes: a silent gap instead of a build break.
844/// [`part_class`] carries the same list and the same obligation.
845fn row_rules(opts: &Emit) -> String {
846 let mut css = String::new();
847
848 // The container the rows sit in. Three zeroes and a keyword, all of them
849 // undoing a browser default the description never asked for: a described
850 // list of SSH keys is not a bulleted list, and it rendered as one because
851 // nothing here said otherwise. Not a size: there is no magnitude in it,
852 // which is the line this crate holds.
853 let _ = writeln!(
854 css,
855 ".{} {{\n list-style: none;\n margin: 0;\n padding: 0;\n}}",
856 class("list", opts)
857 );
858
859 for part in [
860 RowPart::Primary,
861 RowPart::Secondary,
862 RowPart::Meta,
863 RowPart::Actions,
864 RowPart::Tokens,
865 RowPart::Proportion,
866 ] {
867 let c = class(part_class(part), opts);
868
869 // Actions carry controls rather than text, and `RowPart::intent` says
870 // so by returning the same intent inheriting already gives. Pinning it
871 // would be louder than saying nothing. Tokens answer alike, for their
872 // own reason: each token carries its own tone, and a colour on the
873 // strip would fight the things sitting in it. A proportion is the same
874 // case again: the meter inside carries the tone.
875 if !matches!(
876 part,
877 RowPart::Actions | RowPart::Tokens | RowPart::Proportion
878 ) {
879 let _ = writeln!(css, ".{c} {{\n color: var(--{});\n}}", part.intent());
880 }
881
882 // A row's actions are shown at rest. `RowPart::revealed_on_hover` said
883 // otherwise and was not honoured here from 0.23.0; makeover-layout
884 // 0.13.0 retired the method, so there is no longer a description saying
885 // one thing and a renderer doing another.
886 //
887 // The rule was `opacity: 0` gated to pointer devices, revealed on
888 // `:hover` and on `:focus-within`. Each escape it needed was a report
889 // that hiding was wrong for somebody: `focus-within` because tabbing
890 // could never reach an action; the gate because a fingertip had no way
891 // to unhide, which both webview apps had already hand-written
892 // `opacity: 1` to undo. What was left was a control hidden from
893 // exactly one group: people using a pointer, who are also the group
894 // scanning a list to find out what can be done to a row.
895 //
896 // A settings screen is where that reads worst: the whole reason to be
897 // on it is to remove a key, and the button doing so was invisible
898 // until pointed at. A table cell's actions were never hidden, so the
899 // two arrangements now agree.
900 }
901 css
902}
903
904/// The progress trough these rules fill.
905///
906/// This was renderer-local chrome with nothing behind it until makeover-layout
907/// 0.10.0, which is the unusual order: the tones below were emitted for every
908/// bar in the tree while the only way to describe one was to concatenate the
909/// numbers into a heading. `Meter` is the word that arrived late, and
910/// [`meter::meter_html`](crate::meter::meter_html) is what now fills these.
911///
912/// The rules stay a superset of what a description can ask for. An app drawing
913/// its own bar keeps these classes, which is what the four goingson grew
914/// independently were adopted onto.
915///
916/// The trough is a [`Depth::Well`], the same reading a text field gets:
917/// something with its content down inside it.
918fn progress_rules(opts: &Emit) -> String {
919 let progress = class("progress", opts);
920 // `progress-fill` rather than a bare `fill`: an unprefixed build claims
921 // these names in the app's own stylesheet, and `.fill` is grabby enough to
922 // catch things that have nothing to do with progress. goingson already
923 // calls it `.progress-fill`, so this is also the name that deletes.
924 let fill = class("progress-fill", opts);
925 let mut css = depth_rule(&progress, Depth::Well);
926
927 // The untoned bar is `--action`, not [`Tone::Neutral`]. That is the one
928 // place this differs from the badge rules, and deliberately: a badge with
929 // no status is a muted label, while a bar with no status is still
930 // reporting progress, and `content-muted` would read as disabled.
931 let _ = writeln!(
932 css,
933 ".{progress} > .{fill} {{\n background: var(--action);\n}}"
934 );
935
936 // A bar can be saying something, same as a badge: goingson colours subtask
937 // progress as success and an over-estimate as danger, which is real
938 // information rather than decoration. Emitting the tones is what lets that
939 // survive adoption instead of staying hand-written.
940 for tone in [Tone::Info, Tone::Success, Tone::Warning, Tone::Danger] {
941 let _ = writeln!(
942 css,
943 ".{progress} > .{fill}[data-tone=\"{0}\"] {{\n background: var(--{0});\n}}",
944 tone.token()
945 );
946 }
947 css
948}
949
950/// A strip of figures, and the two spans inside each one.
951///
952/// Colour only, which is the deferral rule applied to a component that badly
953/// wants to break it. A figure reads as a figure because the value is set large
954/// over a small caption, and that is a size: `makeover-geometry` answers how
955/// much space and this crate answers what the thing is. Emitting `font-size`
956/// here would be this crate naming a value, which is the one thing it is defined
957/// by not doing, and `progress_rules` is the precedent — it emits the tones and
958/// never the width, because the width is not its to know.
959///
960/// So the arrangement and the type scale are the app's, and what is generated is
961/// the part an app cannot get right by itself: which of the two spans carries
962/// the tone.
963fn figure_rules(opts: &Emit) -> String {
964 let figure = class("figure", opts);
965 let value = class("figure-value", opts);
966 let caption = class("figure-caption", opts);
967 let change = class("figure-change", opts);
968 let mut css = String::new();
969
970 let _ = writeln!(
971 css,
972 ".{figure} > .{value} {{\n color: var(--{});\n}}",
973 Tone::Neutral.token()
974 );
975 let _ = writeln!(
976 css,
977 ".{figure} > .{caption} {{\n color: var(--content-muted);\n}}"
978 );
979 let _ = writeln!(
980 css,
981 ".{figure} > .{change} {{\n color: var(--content-muted);\n}}"
982 );
983
984 // A toned figure tones one part and never the caption. The caption is the
985 // noun and stays muted.
986 //
987 // Which part depends on whether there is a change, and that is the whole of
988 // what 0.13.0 changed here. A figure with a delta is an ordinary number that
989 // has moved in a direction worth reading, so the delta takes the colour and
990 // the number stays plain; a figure without one has nowhere else to put it.
991 // `:has` is what lets one attribute mean both, and the alternative was the
992 // emitter deciding by writing the attribute onto a different element, which
993 // leaves two elements able to disagree about a figure's one meaning.
994 for tone in [Tone::Info, Tone::Success, Tone::Warning, Tone::Danger] {
995 let _ = writeln!(
996 css,
997 ".{figure}[data-tone=\"{0}\"] > .{change} {{\n color: var(--{0});\n}}",
998 tone.token()
999 );
1000 let _ = writeln!(
1001 css,
1002 ".{figure}[data-tone=\"{0}\"]:not(:has(> .{change})) > .{value} \
1003 {{\n color: var(--{0});\n}}",
1004 tone.token()
1005 );
1006 }
1007 css
1008}
1009
1010/// A region's stand-in, and the header of a table that can be reordered.
1011///
1012/// Both are 0.12.0 members and both are colour and affordance only, which is
1013/// where `figure_rules` landed after trying to emit a type scale. How much room
1014/// a stand-in gets is a size — goingson has the same one at three, as
1015/// `--compact`, `--dashboard` and `--padded` — and a size is
1016/// `makeover-geometry`'s question.
1017///
1018/// The caret is the one thing here that is neither colour nor affordance, and it
1019/// is a renderer's own expression rather than a value the description named:
1020/// `aria-sort` is what the table actually says, and this turns it into something
1021/// visible for everyone not using a screen reader. A terminal draws its own; an
1022/// immediate-mode painter draws its own.
1023fn state_rules(opts: &Emit) -> String {
1024 let placeholder = class("placeholder", opts);
1025 let text = class("placeholder-text", opts);
1026 let heading = class("table-heading", opts);
1027 let mut css = String::new();
1028
1029 let _ = writeln!(
1030 css,
1031 ".{placeholder} > .{text} {{\n color: var(--content-muted);\n}}"
1032 );
1033 // Only the failure is toned. An empty list is the normal state of a new
1034 // install, and `Readiness::tone` is what says so.
1035 let _ = writeln!(
1036 css,
1037 ".{placeholder}[data-tone=\"{0}\"] > .{text} {{\n color: var(--{0});\n}}",
1038 Tone::Danger.token()
1039 );
1040
1041 // A header that reorders the table is a control, and the pointer is the
1042 // only part of saying so that is not the app's own type and spacing.
1043 let _ = writeln!(
1044 css,
1045 ".{heading}[data-sortable] {{\n cursor: pointer;\n}}"
1046 );
1047 // The caret carries its own leading space, the way `makeover-tui` and
1048 // `makeover-immediate` both write `" \u{25B2}"`. It used to be emitted bare,
1049 // and both apps that adopted the vocabulary had to put the gap back in their
1050 // own stylesheets on the same afternoon -- each having to work out first that
1051 // app CSS outranks this crate's cascade layer, so adding the space the
1052 // obvious way, as `content`, silently wins over the glyph and leaves the
1053 // heading with no caret at all. A consumer should not have to know that, and
1054 // with the space emitted here there is nothing left for one to add.
1055 //
1056 // The unsorted arm reserves the same box with the glyph hidden, so pressing
1057 // a heading does not reflow the row it sits in. Hidden rather than sized:
1058 // the reservation is the caret's own width, so it names no magnitude and
1059 // stays out of `makeover-geometry`'s territory.
1060 let _ = writeln!(
1061 css,
1062 ".{heading}[data-sortable]::after \
1063 {{\n content: \" \\2191\";\n visibility: hidden;\n}}"
1064 );
1065 for (direction, caret) in [("ascending", "\\2191"), ("descending", "\\2193")] {
1066 let _ = writeln!(
1067 css,
1068 ".{heading}[aria-sort=\"{direction}\"]::after \
1069 {{\n content: \" {caret}\";\n visibility: visible;\n}}"
1070 );
1071 }
1072 css
1073}
1074
1075/// The frame a table sits in.
1076///
1077/// # Why this is a CSS table and not the grid the rest of the module assumes
1078///
1079/// A grid row needs `grid-template-columns`, which has to name every column in
1080/// order, so it cannot be written without knowing the columns. That is what
1081/// [`list::narrowing_css`] is for, and it works: goingson builds `tables.css` in
1082/// its own `build.rs` out of it, and nothing here changes that.
1083///
1084/// It does not work for a table a *description* produced. Those columns are
1085/// known at render time rather than at build time, and the rules would have to
1086/// travel with the markup: a `<style>` element per table, which needs
1087/// `style-src 'unsafe-inline'` and so blocks the MNW server's standing plan to
1088/// drop it. The head is not an escape: a table swapped in by htmx after a
1089/// delete arrives as a fragment with no head at all.
1090///
1091/// A CSS table aligns its columns across rows knowing nothing about how many
1092/// there are, so there is no track list to emit and nothing per-table to carry.
1093/// The cost is that a described table cannot take a per-column fixed length,
1094/// which costs nothing today: [`Sizing`](list::Sizing) is looked up by column
1095/// name and a description carries no lengths to put in it, so every track a
1096/// described table could ask for is already content, fill or auto.
1097///
1098/// [`Priority`] hiding is unchanged in kind. It moves from a generated
1099/// `display: none` per dropped column to one rule per drop class, which is the
1100/// same fact addressed by class rather than by cutoff, and still never by
1101/// position.
1102fn table_rules(opts: &Emit) -> String {
1103 let table = class("table", opts);
1104 let head = class("table-head", opts);
1105 let row = class("table-row", opts);
1106 let heading = class("table-heading", opts);
1107 let cell = class("cell", opts);
1108 let mut css = String::new();
1109
1110 let _ = writeln!(
1111 css,
1112 ".{table} {{\n display: table;\n width: 100%;\n}}"
1113 );
1114 let _ = writeln!(css, ".{head},\n.{row} {{\n display: table-row;\n}}");
1115 let _ = writeln!(css, ".{heading},\n.{cell} {{\n display: table-cell;\n}}");
1116
1117 // A content column shrinks to what is in it. `width: 1%` is how a CSS table
1118 // is told that: auto layout hands the slack to the columns that asked for
1119 // room, and a column asking for almost none gets what it needs and no more.
1120 // The `nowrap` is what stops it being given less by wrapping.
1121 let _ = writeln!(
1122 css,
1123 ".{} {{\n white-space: nowrap;\n width: 1%;\n}}",
1124 class("cell-content", opts)
1125 );
1126
1127 // A fixed column has no length to be fixed to. The description carries none
1128 // and `Sizing` is not reachable from here, so it behaves as content: the
1129 // honest answer to a width nobody supplied, and the same one `Sizing::track`
1130 // gives it.
1131 let _ = writeln!(
1132 css,
1133 ".{} {{\n white-space: nowrap;\n}}",
1134 class("cell-fixed", opts)
1135 );
1136
1137 // Optional columns go at the narrowest class, secondary ones go with them,
1138 // which is the cutoff walk `kept_at` describes said as two media queries.
1139 // Essential columns have no rule at all, because never dropping is what not
1140 // being mentioned already means.
1141 for (size, drops) in [
1142 (
1143 SizeClass::Compact,
1144 &["cell-drops-first", "cell-drops-next"][..],
1145 ),
1146 (SizeClass::Medium, &["cell-drops-first"][..]),
1147 ] {
1148 let selectors: Vec<String> = drops
1149 .iter()
1150 .map(|drop| format!(".{}", class(drop, opts)))
1151 .collect();
1152 css.push_str(&gated(
1153 Some(&size.media_condition()),
1154 &format!("{} {{\n display: none;\n}}\n", selectors.join(",\n")),
1155 ));
1156 }
1157
1158 // What is inside a cell, which the table side could not say until
1159 // makeover-layout 0.14.0. Every cell was one `.cell` and one content
1160 // colour, so a button in a cell was painted as text -- the drift
1161 // `RowPart::intent` has prevented for list rows since 0.2.0 and prevented
1162 // for nothing here.
1163 //
1164 // The colour goes on `.cell-value` rather than on `.cell`, and that
1165 // placement is the whole fix. On the container it would cascade into the
1166 // tokens and the controls sitting beside the text, which is the bug said
1167 // in one rule; on the part that is text, it reaches text and stops.
1168 for part in [
1169 CellPart::Value,
1170 CellPart::Tokens,
1171 CellPart::Actions,
1172 CellPart::Link,
1173 ] {
1174 // Three of the four inherit, each for its own reason: a token carries
1175 // its own tone, an action is a control rather than text, and a link
1176 // takes the action colour from the anchor it is. `CellPart::intent`
1177 // says so by answering with the intent inheriting already gives, and
1178 // pinning that would be louder than saying nothing.
1179 //
1180 // Written as a skip-list rather than as a match on Value, so a member
1181 // added upstream gets its intent emitted rather than being silently
1182 // dropped. That is the same trade `part_class`'s fallback makes: land
1183 // plainly, never land as nothing.
1184 if !matches!(part, CellPart::Tokens | CellPart::Actions | CellPart::Link) {
1185 let _ = writeln!(
1186 css,
1187 ".{} {{\n color: var(--{});\n}}",
1188 class(cell_part_class(part), opts),
1189 part.intent()
1190 );
1191 }
1192 }
1193
1194 css
1195}
1196
1197/// The component layer: every named thing phase A emits.
1198///
1199/// No scrollbar track. It was on the phase A list and came off: eight lines of
1200/// `::-webkit-scrollbar` with no shape a terminal or an immediate-mode painter
1201/// would want handed to it, so it stays with the apps.
1202#[must_use]
1203pub fn component_rules(opts: &Emit) -> String {
1204 let mut css = String::new();
1205 css.push_str(&surface_rules(opts));
1206 css.push_str(&link_rules(opts));
1207 css.push_str(&token_rules(opts));
1208 css.push_str(&selector_rules(opts));
1209 css.push_str(&row_rules(opts));
1210 css.push_str(&progress_rules(opts));
1211 css.push_str(&figure_rules(opts));
1212 css.push_str(&state_rules(opts));
1213 css.push_str(&table_rules(opts));
1214 css
1215}
1216
1217/// The whole phase-A stylesheet: properties, depth rules and components, in
1218/// [`CSS_LAYER`], under a generated-file banner.
1219///
1220/// The banner sits outside the layer, because a comment participates in no
1221/// cascade and a reader opening the file should see what it is before seeing
1222/// an at-rule.
1223#[must_use]
1224pub fn stylesheet(opts: &Emit) -> String {
1225 format!(
1226 "/* Generated by makeover-webview from makeover-layout. Do not edit.\n \
1227 Depth is a fill and an edge together; naming them apart is what let\n \
1228 them disagree. See the crate's README and wiki note makeover-layout.\n\n \
1229 Everything below is in the `{CSS_LAYER}` cascade layer. Declare the\n \
1230 order once in your own stylesheet, or this layer's position is decided\n \
1231 by whichever generated file the browser happens to see first:\n\n \
1232 @layer {CSS_LAYER}, base, components, responsive; */\n{}",
1233 in_css_layer(&format!(
1234 ":root {{\n{}}}\n\n{}\n{}",
1235 bevel_properties(opts),
1236 depth_rules(opts),
1237 component_rules(opts)
1238 ))
1239 )
1240}
1241
1242#[cfg(test)]
1243mod tests {
1244 use super::*;
1245 use makeover_layout::Edge;
1246
1247 #[test]
1248 fn the_emitted_bevel_matches_what_the_apps_already_hand_write() {
1249 // Balanced Breakfast's styles.css, verbatim. Adoption has to be a
1250 // deletion, not a redesign, or nobody will take it.
1251 let opts = Emit::default();
1252 assert_eq!(
1253 bevel_shadow(Bevel::Raised, &opts),
1254 "inset 1px 1px 0 var(--bevel-light), inset -1px -1px 0 var(--bevel-dark)"
1255 );
1256 assert_eq!(
1257 bevel_shadow(Bevel::Inset, &opts),
1258 "inset 1px 1px 0 var(--bevel-dark), inset -1px -1px 0 var(--bevel-light)"
1259 );
1260 }
1261
1262 #[test]
1263 fn no_colour_ever_reaches_the_output() {
1264 let css = stylesheet(&Emit::default());
1265 assert!(!css.contains('#'), "a hex literal escaped into the CSS");
1266 assert!(
1267 !css.contains("rgb"),
1268 "a colour function escaped into the CSS"
1269 );
1270 // Every colour is named, never resolved.
1271 assert!(css.contains("var(--surface-raised)"));
1272 assert!(css.contains("var(--bevel-light)"));
1273 }
1274
1275 #[test]
1276 fn a_well_falls_back_through_css_rather_than_through_rust() {
1277 assert_eq!(
1278 fill_var(Fill::Well),
1279 "var(--surface-well, var(--surface-page))"
1280 );
1281 // Nothing else needs one.
1282 assert_eq!(fill_var(Fill::Raised), "var(--surface-raised)");
1283 assert_eq!(fill_var(Fill::Page), "var(--surface-page)");
1284 }
1285
1286 #[test]
1287 fn raised_and_well_do_not_collapse_onto_each_other() {
1288 let css = depth_rules(&Emit::default());
1289 assert!(css.contains(".raised {"));
1290 assert!(css.contains(".well {"));
1291 assert!(css.contains("var(--bevel-raised)"));
1292 assert!(css.contains("var(--bevel-inset)"));
1293 }
1294
1295 /// The cast shadow is composed here from the tone `makeover` derives, so
1296 /// neither crate has to hold the other's numbers.
1297 ///
1298 /// It is a `:root` property and deliberately not a depth class. There is no
1299 /// `Depth::Overlay` in the description layer, and adding one would be a
1300 /// claim about what a screen means rather than about how it is painted;
1301 /// until something asks for it, a consumer names the property on the rule
1302 /// for the menu or the toast it already has.
1303 #[test]
1304 fn the_cast_shadow_is_a_root_property_not_a_depth() {
1305 let css = bevel_properties(&Emit::default());
1306 assert!(css.contains("--elevation-overlay:"));
1307 assert!(css.contains("var(--elevation)"));
1308 assert!(
1309 !depth_rules(&Emit::default()).contains("elevation"),
1310 "elevation is not a depth class"
1311 );
1312 }
1313
1314 #[test]
1315 fn the_cascade_carries_the_pressed_state() {
1316 let css = surface_rules(&Emit::default());
1317 // The one thing this renderer gets free that the other two resolve by
1318 // hand, eighteen call sites deep in audiofiles' case. Asserted on a
1319 // named surface: pressing belongs to the control, not to the depth.
1320 assert!(css.contains(".card:active {"));
1321 assert!(css.contains(".button:active {"));
1322 }
1323
1324 #[test]
1325 fn the_depth_class_is_a_surface_and_not_a_control() {
1326 let css = depth_rules(&Emit::default());
1327 // The static surface the vocabulary was missing. Sixteen goingson
1328 // elements wore .card and cancelled its hover and press to get this,
1329 // because a raised object that is not pressable had no other spelling.
1330 for state in [":hover", ":active", ":focus-visible", ":disabled"] {
1331 assert!(
1332 !css.contains(&format!(".raised{state}")),
1333 "the depth class claimed {state}: {css}"
1334 );
1335 }
1336 assert!(css.contains("var(--bevel-raised)"), "still raised: {css}");
1337 }
1338
1339 #[test]
1340 fn pressing_moves_the_fill_and_not_only_the_edge() {
1341 // The decision-1 guard, and the regression that mattered: emitting the
1342 // bevel flip alone is what left goingson hand-writing `background:
1343 // var(--surface-sunken)` on .btn, .card and .tag/.badge alike, so none
1344 // of the three could be deleted.
1345 let pressed = interactive_rules("button", Depth::Raised, &Emit::default());
1346 assert!(pressed.contains(".button:active {"));
1347 assert!(
1348 pressed.contains("background: var(--surface-well, var(--surface-page))"),
1349 "pressed dropped its fill: {pressed}"
1350 );
1351 assert!(pressed.contains("box-shadow: var(--bevel-inset)"));
1352 }
1353
1354 #[test]
1355 fn pressed_takes_its_fill_from_the_description_not_from_the_app() {
1356 // goingson presses to --surface-sunken. The description says a pressed
1357 // raised region reads as a well, and makeover says outright that
1358 // surface-sunken cannot serve as one, so the app is the thing that
1359 // moves.
1360 //
1361 // Scoped to the pressed rules rather than to the whole sheet: since
1362 // makeover-layout 0.3.0 an unchosen tab is legitimately
1363 // --surface-sunken, so the token appearing somewhere in the output no
1364 // longer means the app's choice leaked in.
1365 let css = stylesheet(&Emit::default());
1366 let mut checked = 0;
1367 for rule in css.split("}\n") {
1368 if !rule.contains(":active") {
1369 continue;
1370 }
1371 checked += 1;
1372 assert!(
1373 !rule.contains("surface-sunken"),
1374 "a pressed rule took the app's fill: {rule}"
1375 );
1376 }
1377 assert!(checked > 0, "no pressed rules found to check");
1378 assert_eq!(
1379 Depth::Raised.pressed().fill(),
1380 Some(Fill::Well),
1381 "the description changed under us"
1382 );
1383 }
1384
1385 #[test]
1386 fn the_whole_stylesheet_is_emitted_in_the_family_layer() {
1387 // The point of 0.11.0. Unlayered normal declarations outrank every
1388 // named layer, so an app declaring `@layer base, components` loses
1389 // every rule it owns to this file until this file is layered too.
1390 let css = stylesheet(&Emit::default());
1391 assert!(css.contains(&format!("@layer {CSS_LAYER} {{")));
1392
1393 // Exactly one layer block, and nothing outside it but the banner.
1394 assert_eq!(css.matches("@layer").count(), 2, "banner names it once");
1395 let opened = css.find("@layer makeover {").expect("layer opens");
1396 for (i, line) in css.lines().enumerate() {
1397 let before_layer = css.lines().take(i).map(str::len).sum::<usize>() < opened;
1398 if before_layer || line.is_empty() {
1399 continue;
1400 }
1401 assert!(
1402 line.starts_with(" ") || line == "}" || line.starts_with(" "),
1403 "line outside the layer: {line:?}"
1404 );
1405 }
1406 }
1407
1408 #[test]
1409 fn the_generated_sheet_carries_no_trailing_whitespace() {
1410 // A checked-in generated file that a formatter wants to rewrite is a
1411 // diff every time somebody saves it.
1412 let css = stylesheet(&Emit::default());
1413 for (i, line) in css.lines().enumerate() {
1414 assert_eq!(line, line.trim_end(), "trailing whitespace on line {i}");
1415 }
1416 }
1417
1418 #[test]
1419 fn the_banner_tells_an_app_how_to_order_the_layer() {
1420 // Without a declared order the layer's position depends on which
1421 // generated file the browser sees first, which is not a contract.
1422 let css = stylesheet(&Emit::default());
1423 assert!(css.contains("@layer makeover, base, components, responsive;"));
1424 // And the banner is outside the layer, not a rule inside it.
1425 assert!(css.starts_with("/* Generated by makeover-webview"));
1426 }
1427
1428 #[test]
1429 fn a_primitive_owns_every_state_it_implies() {
1430 // The whole point of 0.10.0. Anything emitting a hover rule owes the
1431 // other three, or the consuming app supplies them by out-specifying a
1432 // rule it does not own: 19 such rules in goingson, 21 in the MNW
1433 // server, and three focus rings that do not match.
1434 let css = stylesheet(&Emit::default());
1435 for selector in ["button", "card", "chip", "tab", "segment", "toggle"] {
1436 assert!(css.contains(&format!(".{selector}:hover {{")), "{selector}");
1437 assert!(
1438 css.contains(&format!(".{selector}:active {{")),
1439 "{selector}"
1440 );
1441 assert!(
1442 css.contains(&format!(".{selector}:focus-visible {{")),
1443 "{selector} has no focus ring"
1444 );
1445 assert!(
1446 css.contains(&format!(".{selector}:disabled,")),
1447 "{selector} has no disabled state"
1448 );
1449 }
1450 }
1451
1452 #[test]
1453 fn a_field_takes_focus_and_refuses_input_without_taking_a_hover() {
1454 // A text field does not light up under the pointer, so it gets the two
1455 // states it has and not the two it does not.
1456 let css = stylesheet(&Emit::default());
1457 assert!(css.contains(".field:focus-visible {"));
1458 assert!(css.contains(".field:disabled,"));
1459 assert!(!css.contains(".field:hover {"));
1460 assert!(!css.contains(".field:active {"));
1461 }
1462
1463 #[test]
1464 fn disabled_is_emitted_after_hover_so_source_order_settles_it() {
1465 // Every one of these selectors is specificity (0,2,0), so nothing but
1466 // order decides which wins. A disabled button taking the hover fill is
1467 // the exact bug goingson's `.button:disabled:hover` was written to fix,
1468 // and the reason it had to reach (0,3,0) to do it.
1469 let css = interactive_rules("button", Depth::Raised, &Emit::default());
1470 let hover = css.find(":hover").expect("hover");
1471 let active = css.find(":active").expect("active");
1472 let focus = css.find(":focus-visible").expect("focus");
1473 let disabled = css.find(":disabled").expect("disabled");
1474 assert!(hover < active && active < focus && focus < disabled);
1475
1476 // And it restores the surface, or the hover fill survives underneath.
1477 let tail = &css[disabled..];
1478 assert!(tail.contains("background: var(--surface-raised)"));
1479 }
1480
1481 #[test]
1482 fn a_disabled_state_reaches_things_that_cannot_be_disabled() {
1483 // `:disabled` matches form elements only, and a chip is a div. Keying
1484 // on the ARIA attribute too is the pattern the invalid field already
1485 // set: one fact, read by the styling and the accessibility tree alike.
1486 let css = disabled_rule("chip", Depth::Raised);
1487 assert!(css.contains(".chip:disabled,"));
1488 assert!(css.contains(".chip[aria-disabled=\"true\"]"));
1489 assert!(css.contains("cursor: not-allowed"));
1490 }
1491
1492 #[test]
1493 fn the_focus_ring_does_not_disturb_the_bevel_it_lands_on() {
1494 // `outline` has its own property, so unlike the invalid ring there is
1495 // no bevel to restate beside it and nothing to keep in agreement.
1496 let opts = Emit::default();
1497 let css = focus_rule("button", Depth::Raised, &opts);
1498 assert!(css.contains("outline: 2px solid var(--focus-ring)"));
1499 assert!(!css.contains("box-shadow"), "the ring restated the bevel");
1500 }
1501
1502 #[test]
1503 fn a_well_takes_the_ring_inside_and_a_raised_surface_outside() {
1504 // One ring, placed by depth. The offset comes off `Depth::bevel` and
1505 // not off a per-component choice, which is what gave three apps three
1506 // different rings.
1507 let opts = Emit::default();
1508 assert!(focus_rule("field", Depth::Well, &opts).contains("outline-offset: calc(-1 * 2px)"));
1509 assert!(focus_rule("button", Depth::Raised, &opts).contains("outline-offset: 2px"));
1510 // Nothing to sit inside of, so it sits outside.
1511 assert!(focus_rule("badge", Depth::Sunken, &opts).contains("outline-offset: 2px"));
1512
1513 // And the ring is not the bevel. Reusing border_width emitted a 1px
1514 // ring that every consumer had already overridden.
1515 assert_ne!(opts.focus_width, opts.border_width);
1516 }
1517
1518 #[test]
1519 fn hover_is_gated_on_capability_and_the_keyboard_path_is_not() {
1520 // goingson's section 60 exists only to take back the hover state this
1521 // crate handed it. Gating at the source is what deletes that section
1522 // in all three apps rather than having each fight for it.
1523 let css = stylesheet(&Emit::default());
1524 let condition = format!("@media {}", Density::Pointer.media_condition());
1525 assert!(css.contains(&condition));
1526
1527 // What is gated is every hover state the surfaces carry. The row's
1528 // actions used to be the other half of this test and are not gated any
1529 // more, because they are not hidden any more: a rule that reveals
1530 // nothing needs no capability answer.
1531 let gated: Vec<&str> = css.lines().filter(|line| line.contains(":hover")).collect();
1532 assert!(!gated.is_empty(), "{css}");
1533 for line in gated {
1534 let indent = line.len() - line.trim_start().len();
1535 assert!(indent > 4, "an ungated hover rule: {line}");
1536 }
1537 assert!(!css.contains(".row:hover"), "{css}");
1538 }
1539
1540 #[test]
1541 fn the_capability_answer_is_asked_for_and_not_assumed() {
1542 // Both halves come from the crates that own them. If `makeover-touch`
1543 // ever says a fingertip has hover, this stops gating on its own.
1544 assert!(!Affordance::Hover.available(Density::Touch, SizeClass::Compact));
1545 assert!(Affordance::Hover.available(Density::Pointer, SizeClass::Compact));
1546 assert_eq!(hover_condition(), Some(Density::Pointer.media_condition()));
1547
1548 // And the size class passed to that call is not a claim about width.
1549 assert!(Affordance::Hover.reads_density());
1550 for size in [SizeClass::Compact, SizeClass::Medium, SizeClass::Expanded] {
1551 assert!(!Affordance::Hover.available(Density::Touch, size));
1552 }
1553 }
1554
1555 #[test]
1556 fn hover_resolves_against_the_token_makeover_already_derives() {
1557 let css = interactive_rules("card", Depth::Raised, &Emit::default());
1558 assert!(css.contains(".card:hover {"));
1559 assert!(css.contains("background: var(--hover-surface)"));
1560 // Not the app's choice, which was --surface-overlay.
1561 assert!(!css.contains("surface-overlay"));
1562 }
1563
1564 #[test]
1565 fn a_badge_gets_no_edge_and_no_fill() {
1566 // Decision 2, and the one visible redesign in phase A. Token::Badge is
1567 // Flat: an edge on a label says it can be pressed.
1568 let css = token_rules(&Emit::default());
1569 let badge = css
1570 .lines()
1571 .skip_while(|l| !l.starts_with(".badge {"))
1572 .take_while(|l| !l.starts_with('}'))
1573 .collect::<Vec<_>>()
1574 .join("\n");
1575 assert!(!badge.contains("box-shadow"), "badge kept an edge: {badge}");
1576 assert!(!badge.contains("background"), "badge kept a fill: {badge}");
1577 assert_eq!(Token::Badge.depth(false), Depth::Flat);
1578 assert_eq!(Token::Badge.depth(true), Depth::Flat);
1579 }
1580
1581 #[test]
1582 fn a_badge_carries_a_tone_and_neutral_is_the_bare_class() {
1583 let css = token_rules(&Emit::default());
1584 // Neutral is the absence of a status, not a status named "none".
1585 assert!(css.contains(".badge {\n color: var(--content-muted);"));
1586 assert!(!css.contains("data-tone=\"content-muted\""));
1587 for tone in ["info", "success", "warning", "danger"] {
1588 assert!(
1589 css.contains(&format!(".badge[data-tone=\"{tone}\"]")),
1590 "missing tone {tone}"
1591 );
1592 assert!(css.contains(&format!("color: var(--{tone})")));
1593 }
1594 }
1595
1596 #[test]
1597 fn a_chip_is_raised_and_latches_into_a_well() {
1598 let css = token_rules(&Emit::default());
1599 assert!(css.contains(".chip {"));
1600 assert!(css.contains(".chip.latched {"));
1601 assert!(css.contains(".chip:active {"));
1602 // The whole difference from a badge: it answers a click.
1603 assert!(Token::Chip { removable: false }.interactive());
1604 assert!(!Token::Badge.interactive());
1605 }
1606
1607 #[test]
1608 fn only_a_tab_comes_forward_when_chosen() {
1609 // The folder semantic. Collapsing the three selectors would lose it.
1610 let css = selector_rules(&Emit::default());
1611 assert!(css.contains(".tab.chosen {"));
1612 assert!(css.contains(".segment.chosen {"));
1613 assert!(css.contains(".toggle.chosen {"));
1614 assert_eq!(Selector::Tabs.chosen(), Depth::Raised);
1615 assert_eq!(Selector::Segmented.chosen(), Depth::Well);
1616 assert_eq!(Selector::Toggle.chosen(), Depth::Well);
1617
1618 let tab = css
1619 .lines()
1620 .skip_while(|l| !l.starts_with(".tab.chosen {"))
1621 .take_while(|l| !l.starts_with('}'))
1622 .collect::<Vec<_>>()
1623 .join("\n");
1624 assert!(
1625 tab.contains("var(--bevel-raised)"),
1626 "tab was held in: {tab}"
1627 );
1628 }
1629
1630 #[test]
1631 fn an_unchosen_tab_recedes_without_looking_picked() {
1632 let css = selector_rules(&Emit::default());
1633 // Recessed by colour and given no edge. An edge would make every option
1634 // look picked; flat would leave the chosen one nothing to come forward
1635 // from, which is the gap makeover-layout 0.3.0 closed.
1636 assert!(
1637 css.contains(".tab {\n background: var(--surface-sunken);\n}"),
1638 "unchosen tab is not recessed: {css}"
1639 );
1640 assert_eq!(Selector::Tabs.unchosen(), Depth::Sunken);
1641 assert!(css.contains(".tab:hover {"));
1642 }
1643
1644 #[test]
1645 fn a_segment_stands_up_so_the_chosen_one_can_be_held_in() {
1646 // The inverse of the tab, and why the three selectors are not one
1647 // member with a flag.
1648 let css = selector_rules(&Emit::default());
1649 assert!(css.contains(".segment {\n background: var(--surface-raised);"));
1650 assert_eq!(Selector::Segmented.unchosen(), Depth::Raised);
1651 assert_eq!(Selector::Segmented.chosen(), Depth::Well);
1652 }
1653
1654 #[test]
1655 fn a_rows_actions_are_shown_at_rest() {
1656 let css = row_rules(&Emit::default());
1657
1658 // The hover reveal is gone, and with it every escape it needed. What
1659 // it hid was hidden from pointer users alone, who are the ones
1660 // scanning a list to learn what can be done to a row.
1661 assert!(!css.contains("opacity"), "{css}");
1662 assert!(!css.contains("pointer-events"), "{css}");
1663 assert!(!css.contains(":hover"), "{css}");
1664 assert!(!css.contains(":focus-within"), "{css}");
1665
1666 // Nor is it hidden any other way. `display: none` would reflow the row
1667 // and `visibility: hidden` would take the actions out of the focus
1668 // order; the point is that neither is reached for.
1669 assert!(!css.contains("display: none"), "{css}");
1670 assert!(!css.contains("visibility:"), "{css}");
1671 }
1672
1673 #[test]
1674 fn a_figures_tone_lands_on_the_delta_when_there_is_one() {
1675 // 0.13.0. The delta is the part that reads as good or bad; the number
1676 // itself is an ordinary fact. A figure with no delta has nowhere else to
1677 // put the colour, so the value takes it, and `:has` is what lets one
1678 // attribute mean both without the emitter choosing an element.
1679 let css = stylesheet(&Emit::default());
1680
1681 assert!(
1682 css.contains(".figure[data-tone=\"success\"] > .figure-change"),
1683 "{css}"
1684 );
1685 assert!(
1686 css.contains(
1687 ".figure[data-tone=\"success\"]:not(:has(> .figure-change)) > .figure-value"
1688 ),
1689 "{css}"
1690 );
1691 // The caption is the noun and never takes the tone.
1692 assert!(
1693 !css.contains("[data-tone=\"success\"] > .figure-caption"),
1694 "{css}"
1695 );
1696 }
1697
1698 #[test]
1699 fn the_three_text_parts_take_their_intents_and_actions_inherits() {
1700 let css = row_rules(&Emit::default());
1701 assert!(css.contains(".row-primary {\n color: var(--content);"));
1702 assert!(css.contains(".row-secondary {\n color: var(--content-secondary);"));
1703 assert!(css.contains(".row-meta {\n color: var(--content-muted);"));
1704 // Actions carry controls, not text. Pinning the colour it would inherit
1705 // anyway is louder than saying nothing.
1706 assert!(!css.contains(".row-actions {\n color:"));
1707 }
1708
1709 #[test]
1710 fn the_token_strip_takes_no_colour_of_its_own() {
1711 // makeover-layout 0.9.0. A token carries its own tone, so a colour on
1712 // the strip would be a rule fighting the things sitting in it -- the
1713 // same reasoning as actions, reached for a different reason.
1714 let css = row_rules(&Emit::default());
1715 assert!(!css.contains(".row-tokens {\n color:"));
1716 }
1717
1718 #[test]
1719 fn an_unknown_row_part_renders_plainly_rather_than_failing_to_build() {
1720 // What `#[non_exhaustive]` bought and what it cost. `part_class` can no
1721 // longer be exhaustive, so a member added upstream lands as a bare
1722 // class with no rule instead of stopping the build. Asserting the
1723 // fallback exists is what keeps it from being written as `unreachable!`
1724 // by someone who reads the match as closed.
1725 assert_eq!(part_class(RowPart::Tokens), "row-tokens");
1726 assert_eq!(part_class(RowPart::Meta), "row-meta");
1727 }
1728
1729 #[test]
1730 fn the_progress_trough_is_a_well() {
1731 let css = progress_rules(&Emit::default());
1732 assert!(css.contains(".progress {"));
1733 assert!(css.contains("box-shadow: var(--bevel-inset)"));
1734 assert!(css.contains(".progress > .progress-fill {"));
1735 assert!(css.contains("background: var(--action)"));
1736 // A bare `.fill` would catch things that have nothing to do with
1737 // progress once the sheet lands unprefixed.
1738 assert!(!css.contains("> .fill "));
1739 }
1740
1741 #[test]
1742 fn a_progress_bar_can_carry_a_tone_and_defaults_to_action() {
1743 let css = progress_rules(&Emit::default());
1744 // Untoned is --action, not Tone::Neutral's content-muted: a bar with no
1745 // status is still reporting progress, and muted would read as disabled.
1746 assert!(css.contains(".progress > .progress-fill {\n background: var(--action);"));
1747 assert!(!css.contains("progress-fill {\n color: var(--content-muted)"));
1748 for tone in ["info", "success", "warning", "danger"] {
1749 assert!(
1750 css.contains(&format!(".progress > .progress-fill[data-tone=\"{tone}\"]")),
1751 "missing progress tone {tone}"
1752 );
1753 }
1754 // goingson's two live cases, which is why the tones are emitted at all.
1755 assert!(css.contains("[data-tone=\"success\"] {\n background: var(--success);"));
1756 assert!(css.contains("[data-tone=\"danger\"] {\n background: var(--danger);"));
1757 }
1758
1759 #[test]
1760 fn no_scrollbar_track_is_emitted() {
1761 // Decision 3's negative half. It was on the phase A list and came off;
1762 // this is what stops it drifting back in.
1763 let css = stylesheet(&Emit::default());
1764 assert!(!css.contains("scrollbar"));
1765 assert!(!css.contains("::-webkit"));
1766 }
1767
1768 #[test]
1769 fn an_invalid_field_is_ringed_without_being_lit() {
1770 let css = surface_rules(&Emit::default());
1771 assert!(css.contains(".field {"));
1772 // The ARIA attribute, not a class: one fact, read by both the visual
1773 // and the accessible state, so they cannot drift.
1774 assert!(css.contains(".field[aria-invalid=\"true\"] {"));
1775 assert!(!css.contains(".field.invalid"));
1776 // A flat ring: this edge says "wrong", and a two-tone bevel would have
1777 // it say "raised" at the same time.
1778 assert!(css.contains("0 0 0 1px var(--danger)"));
1779 }
1780
1781 #[test]
1782 fn an_invalid_field_keeps_the_well_underneath_it() {
1783 // box-shadow is not additive. A lone ring replaces the bevel and drops
1784 // the well out from under the field, which is what this emitted before
1785 // 0.5.0 and is the whole reason the rule composes.
1786 let css = surface_rules(&Emit::default());
1787 let invalid = css
1788 .lines()
1789 .skip_while(|l| !l.starts_with(".field[aria-invalid"))
1790 .take_while(|l| !l.starts_with('}'))
1791 .collect::<Vec<_>>()
1792 .join("\n");
1793 assert!(
1794 invalid.contains("var(--bevel-inset)"),
1795 "the well was dropped: {invalid}"
1796 );
1797 assert!(invalid.contains("var(--danger)"));
1798 }
1799
1800 #[test]
1801 fn button_and_card_come_out_identical_by_construction() {
1802 // The duplication phase A deletes. They are the same composition, so
1803 // the only honest way to emit both is from one call.
1804 let opts = Emit::default();
1805 let css = surface_rules(&opts);
1806 assert_eq!(
1807 depth_declarations(Depth::Raised),
1808 depth_declarations(Depth::Raised)
1809 );
1810 assert!(css.contains(".button {"));
1811 assert!(css.contains(".card {"));
1812 assert_eq!(
1813 interactive_rules("button", Depth::Raised, &Emit::default()).replace("button", "card"),
1814 interactive_rules("card", Depth::Raised, &Emit::default())
1815 );
1816 }
1817
1818 #[test]
1819 fn a_prefix_reaches_the_component_classes_too() {
1820 let opts = Emit {
1821 class_prefix: "mo-",
1822 ..Emit::default()
1823 };
1824 let css = stylesheet(&opts);
1825 for name in [
1826 "mo-button",
1827 "mo-card",
1828 "mo-field",
1829 "mo-badge",
1830 "mo-chip",
1831 "mo-tab",
1832 "mo-row-primary",
1833 "mo-progress",
1834 "mo-progress-fill",
1835 ] {
1836 assert!(css.contains(&format!(".{name}")), "unprefixed: {name}");
1837 }
1838 // The bare names must be gone entirely, or a prefixed build still
1839 // collides with the app's own stylesheet.
1840 assert!(!css.contains(".button {"));
1841 assert!(!css.contains(".card {"));
1842 assert!(!css.contains(".badge {"));
1843 }
1844
1845 #[test]
1846 fn the_class_a_renderer_puts_on_an_option_is_the_one_the_rules_key_off() {
1847 // `option_class` is the contract a screen renderer writes markup
1848 // against, and the rules below are the other half of it. They come off
1849 // one mapping now, so this asserts the mapping is the one that reaches
1850 // the stylesheet rather than that two lists still agree.
1851 let css = stylesheet(&Emit::default());
1852 for selector in [Selector::Tabs, Selector::Segmented, Selector::Toggle] {
1853 let name = option_class(selector);
1854 assert!(css.contains(&format!(".{name} {{")), "{name}: {css}");
1855 assert!(css.contains(&format!(".{name}.chosen {{")), "{name}: {css}");
1856 }
1857 assert_eq!(option_class(Selector::Tabs), "tab");
1858 }
1859
1860 #[test]
1861 fn the_caret_brings_its_own_gap_and_its_own_reserved_box() {
1862 let css = stylesheet(&Emit::default());
1863
1864 // The space is inside the glyph, which is what the other two renderers
1865 // write. Emitted bare, every consumer has to add it back, and the
1866 // obvious way to add it -- `content` in an app stylesheet, which is
1867 // unlayered and so outranks this sheet -- deletes the caret instead.
1868 assert!(css.contains("content: \" \\2191\";"), "{css}");
1869 assert!(css.contains("content: \" \\2193\";"), "{css}");
1870 assert!(!css.contains("content: \"\\2"), "{css}");
1871
1872 // The unsorted arm holds the box open so pressing a heading does not
1873 // move the row, and the sorted arms have to turn the glyph back on
1874 // after it: same specificity, so order is what decides.
1875 let reserve = css
1876 .find(".table-heading[data-sortable]::after")
1877 .expect("the reserved box is emitted");
1878 let sorted = css
1879 .find(".table-heading[aria-sort=\"ascending\"]::after")
1880 .expect("the ascending caret is emitted");
1881 assert!(reserve < sorted, "{css}");
1882 assert!(
1883 css[reserve..sorted].contains("visibility: hidden;"),
1884 "{css}"
1885 );
1886 assert!(css[sorted..].contains("visibility: visible;"), "{css}");
1887 }
1888
1889 #[test]
1890 fn a_destructive_button_has_somewhere_for_its_tone_to_land() {
1891 let css = component_rules(&Emit::default());
1892
1893 for tone in [Tone::Info, Tone::Success, Tone::Warning, Tone::Danger] {
1894 assert!(
1895 css.contains(&format!(".button[data-tone=\"{}\"]", tone.token())),
1896 "{css}"
1897 );
1898 }
1899 // Colour, not a fill. A red surface is an app's decision about emphasis.
1900 assert!(!css.contains(".button[data-tone=\"danger\"] {\n background"));
1901 }
1902
1903 #[test]
1904 fn a_described_list_is_not_a_bulleted_list() {
1905 let css = component_rules(&Emit::default());
1906 assert!(css.contains(".list {\n list-style: none;"), "{css}");
1907 }
1908
1909 #[test]
1910 fn a_table_lays_itself_out_without_being_told_its_columns() {
1911 // The whole point of the CSS table. A described table's columns are
1912 // known at render time, so anything the stylesheet has to be told about
1913 // them would have to travel with the markup.
1914 let css = component_rules(&Emit::default());
1915
1916 assert!(css.contains(".table {\n display: table;"), "{css}");
1917 assert!(css.contains("display: table-row;"), "{css}");
1918 assert!(css.contains("display: table-cell;"), "{css}");
1919 assert!(!css.contains("grid-template-columns"), "{css}");
1920 }
1921
1922 #[test]
1923 fn a_control_in_a_cell_is_not_painted_as_text() {
1924 // The point of makeover-layout 0.14.0's CellPart, and the table-side
1925 // twin of `the_three_text_parts_take_their_intents_and_actions_inherits`
1926 // above. One `.cell` and one content colour meant a button in a cell
1927 // inherited it.
1928 let css = table_rules(&Emit::default());
1929
1930 assert!(
1931 css.contains(".cell-value {\n color: var(--content);"),
1932 "{css}"
1933 );
1934 assert!(!css.contains(".cell-actions {\n color:"), "{css}");
1935 assert!(!css.contains(".cell-tokens {\n color:"), "{css}");
1936 assert!(!css.contains(".cell-link {\n color:"), "{css}");
1937
1938 // The colour is on the part that is text, never on the container. On
1939 // `.cell` it would cascade into the three parts that are not text,
1940 // which is the bug written as one rule.
1941 assert!(!css.contains(".cell {\n color:"), "{css}");
1942 }
1943
1944 #[test]
1945 fn an_unknown_cell_part_renders_plainly_rather_than_failing_to_build() {
1946 // `part_class`'s obligation, taken on for the table side too. CellPart
1947 // is `#[non_exhaustive]`, so a member added upstream must land as a
1948 // bare class rather than as a build that stops.
1949 assert_eq!(cell_part_class(CellPart::Value), "cell-value");
1950 assert_eq!(cell_part_class(CellPart::Actions), "cell-actions");
1951 }
1952
1953 #[test]
1954 fn a_column_drops_by_its_priority_and_never_by_its_position() {
1955 let css = component_rules(&Emit::default());
1956
1957 // Optional goes at the narrowest class and secondary goes with it,
1958 // which is `kept_at`'s cutoff walk said as two queries.
1959 let compact = css
1960 .find(&format!("@media {}", SizeClass::Compact.media_condition()))
1961 .expect("a compact query");
1962 let medium = css
1963 .find(&format!("@media {}", SizeClass::Medium.media_condition()))
1964 .expect("a medium query");
1965 assert!(css[compact..].contains(".cell-drops-next"), "{css}");
1966 assert!(!css[medium..].contains(".cell-drops-next"), "{css}");
1967
1968 // Essential columns are never mentioned, because not being mentioned is
1969 // already what never dropping means.
1970 assert!(!css.contains(".cell-keeps"), "{css}");
1971
1972 // And nothing counts. `nth-child` is the bug the priority vocabulary
1973 // exists to end.
1974 assert!(!css.contains("nth-child"), "{css}");
1975 }
1976
1977 #[test]
1978 fn the_whole_sheet_still_names_every_colour() {
1979 // The crate's founding property, asserted over the component layer and
1980 // not only the primitives.
1981 let css = stylesheet(&Emit::default());
1982 assert!(!css.contains('#'));
1983 assert!(!css.contains("rgb"));
1984 for line in css.lines() {
1985 // Declarations only: a selector or an at-rule can carry a colon of
1986 // its own (`:root`, `:hover`, `@media (hover: hover)`) and declares
1987 // nothing. Keyed on the trailing semicolon rather than on leading
1988 // indentation, which only ever worked as a proxy for nesting depth
1989 // and stopped when the sheet gained a cascade layer around it.
1990 let trimmed = line.trim();
1991 if !trimmed.ends_with(';') {
1992 continue;
1993 }
1994 let Some((_, value)) = trimmed.split_once(": ") else {
1995 continue;
1996 };
1997 if value.contains("var(--") {
1998 continue;
1999 }
2000 // Everything left has to be a keyword, a number or a
2001 // caller-supplied length, never a colour.
2002 //
2003 // The length arm is what the comment above always claimed and the
2004 // list never covered: `border_width` arrives from `Emit` and lands
2005 // bare in the focus ring's offset, where the bevel had only ever
2006 // used it inside an `inset` shadow.
2007 let opts = Emit::default();
2008 assert!(
2009 value.contains("inset")
2010 || value.contains(opts.border_width)
2011 || value.contains(opts.focus_width)
2012 // 0.12.0's two: a sortable header is a control and says so
2013 // with the pointer, and the caret is this renderer's own
2014 // expression of `aria-sort`. Neither is a colour, which is
2015 // what this test is actually about, and neither is a size,
2016 // which is the other thing this crate must not name. The
2017 // leading space inside the glyph is the same thing the other
2018 // two renderers write into theirs, so it is part of the
2019 // caret rather than spacing this crate decided on.
2020 || value
2021 .trim_start_matches('"')
2022 .trim_start()
2023 .starts_with("\\2")
2024 || matches!(
2025 value.trim_end_matches(';'),
2026 "0" | "1"
2027 | "none"
2028 | "auto"
2029 | "not-allowed"
2030 | "pointer"
2031 // The caret's reserved box. Visibility is presence,
2032 // not magnitude and not colour.
2033 | "hidden"
2034 | "visible"
2035 // The link's two signals. `underline` is a line and
2036 // `inherit` defers to whatever the app set, so
2037 // neither names a colour or a magnitude.
2038 | "underline"
2039 | "inherit"
2040 // The table frame. `display` is structure and not a
2041 // size; `nowrap` is what makes a content column
2042 // content. The two widths are the awkward pair and
2043 // they are still not sizes: `100%` is "all of
2044 // whatever you were given" and `1%` is the CSS
2045 // table idiom for "shrink to fit", which is a
2046 // behaviour spelled as a number because CSS has no
2047 // keyword for it. Neither names a magnitude, which
2048 // is the thing this crate leaves to
2049 // makeover-geometry.
2050 | "table"
2051 | "table-row"
2052 | "table-cell"
2053 | "nowrap"
2054 | "100%"
2055 | "1%"
2056 ),
2057 "unrecognised literal value: {line}"
2058 );
2059 }
2060 }
2061
2062 #[test]
2063 fn flat_emits_nothing_at_all() {
2064 assert_eq!(depth_class(Depth::Flat, &Emit::default()), None);
2065 assert!(!depth_rules(&Emit::default()).contains("flat"));
2066 }
2067
2068 #[test]
2069 fn a_prefix_namespaces_every_class() {
2070 let opts = Emit {
2071 class_prefix: "mo-",
2072 ..Emit::default()
2073 };
2074 let css = depth_rules(&opts);
2075 assert!(css.contains(".mo-raised {"));
2076 assert!(css.contains(".mo-well {"));
2077 assert!(!css.contains(".raised {"));
2078 }
2079
2080 #[test]
2081 fn the_border_width_is_the_callers() {
2082 let opts = Emit {
2083 border_width: "2px",
2084 ..Emit::default()
2085 };
2086 assert!(bevel_shadow(Bevel::Raised, &opts).contains("inset 2px 2px 0"));
2087 }
2088
2089 #[test]
2090 fn edges_agree_with_the_description() {
2091 // Not a tautology: it is the guard that a CSS-shaped convenience never
2092 // quietly reverses which side is lit.
2093 let (tl, br) = Bevel::Raised.edges();
2094 assert_eq!(tl.token(), Edge::Light.token());
2095 assert_eq!(br.token(), Edge::Dark.token());
2096 }
2097}