Skip to main content

makeover_immediate/
widget.rs

1//! The described things that are not fields, tables or frames.
2//!
3//! A meter, a token, a control, a figure, and a wait. `makeover-tui` has had
4//! most of these since its
5//! own `widget` module and this crate has not, which is the gap that showed up
6//! the moment anything tried to draw a whole `quasi_router::Screen` in egui:
7//! the screen walk had a renderer for the containers and nothing for four of the
8//! nodes inside them, so the drawing would have landed in the consumer, one copy
9//! per app. That is the divergence this suite exists to end, so it lands here.
10//!
11//! # What "in egui" changes, and what it does not
12//!
13//! The semantics are `makeover-tui`'s, deliberately: a meter is a bar and a
14//! reading, a badge is round and a chip is square, a control names its key where
15//! the description gave one, and a figure puts the movement on the value rather
16//! than on the caption. Those are description-level readings and they do not get
17//! a second opinion per host.
18//!
19//! What differs is forced by the target rather than chosen. A terminal spends a
20//! whole cell on a character and returns a `Line` for the caller to place; egui
21//! paints an arbitrary rect and answers a [`Response`], so every function here
22//! draws into the `Ui` it is given and hands back what the user did to it. That
23//! is also why nothing here takes a `focused` flag the way `makeover-tui`'s
24//! `act` does: egui owns focus, which is the rule the crate header states.
25
26use egui::{Align, Layout, Response, RichText, Sense, Ui, Vec2};
27use makeover_layout::{Act, Awaiting, Bar, Chart, Fact, Figure, Meter, State, Token, Tone};
28use makeover_timing::activity_blink;
29use std::time::Duration;
30
31use crate::Palette;
32
33/// The sizes a widget cannot derive from the description.
34///
35/// Every number a caller might reasonably want different, in one place, on the
36/// footing [`FrameStyle`](crate::FrameStyle) and [`FieldStyle`](crate::FieldStyle)
37/// already establish: this crate owns no sizes.
38#[derive(Debug, Clone, Copy, PartialEq)]
39pub struct WidgetStyle {
40    /// How tall a meter's bar is drawn.
41    pub meter_height: f32,
42    /// How wide a meter's bar runs, or `None` to take the width on offer.
43    ///
44    /// `None` is the honest default in immediate mode: a bar in a side panel and
45    /// a bar in a wide pane are the same description, and the available width is
46    /// the only thing either of them knows.
47    pub meter_width: Option<f32>,
48    /// How tall a chart stands, in points.
49    ///
50    /// A chart's own, not [`meter_height`](Self::meter_height): a meter is a
51    /// rule set into a line of text and a chart is a figure with room of its
52    /// own. `makeover-webview` defers the same number to `--chart-height` for
53    /// the same reason, and 200 is the same default.
54    pub chart_height: f32,
55    /// The corner radius on a meter's trough and on a token.
56    pub radius: u8,
57    /// Inside a token, around its label.
58    pub token_padding: Vec2,
59    /// Between a figure's value and its caption.
60    pub figure_gap: f32,
61    /// How much larger a figure's value is drawn than the body text.
62    ///
63    /// A multiplier rather than a size, so a figure scales with whatever text
64    /// style the app has set rather than pinning a point size this crate has no
65    /// business choosing.
66    pub figure_scale: f32,
67    /// The side of the activity mark, square.
68    ///
69    /// Small on purpose. The mark says one thing and a reader should have to
70    /// look at it to read it, which is the difference between an indicator and
71    /// an animation competing with the content it sits beside.
72    pub mark_size: f32,
73}
74
75impl Default for WidgetStyle {
76    /// Bars at 6pt taking the width on offer, a figure at double text size, and
77    /// the activity mark a square a little larger than a bar is tall.
78    fn default() -> Self {
79        Self {
80            meter_height: 6.0,
81            meter_width: None,
82            chart_height: 200.0,
83            radius: 3,
84            token_padding: Vec2::new(6.0, 2.0),
85            figure_gap: 2.0,
86            figure_scale: 2.0,
87            mark_size: 8.0,
88        }
89    }
90}
91
92/// A proportion as a bar and a reading.
93///
94/// The reading is built here from the two numbers and the noun, for the reason
95/// `makeover-tui` states: [`Meter::label`] carries the noun alone, so each
96/// renderer picks its own sentence order rather than the description picking one
97/// for all of them.
98///
99/// **A bar that has run over is drawn full and reads over.** `done` may exceed
100/// `total` and that is the case worth drawing, per `Meter`'s own docs: the fill
101/// is clamped because a rect cannot be longer than itself, and the reading is
102/// not, because "9/6" is the fact the user needs. Clamping both would hide the
103/// overrun entirely, which is the bug goingson's `is_over_estimate` flag exists
104/// to recover from on the other side.
105///
106/// A zero `total` is no set rather than a complete one, so it draws empty.
107pub fn meter(ui: &mut Ui, meter: &Meter<'_>, palette: &Palette, style: &WidgetStyle) -> Response {
108    let width = style
109        .meter_width
110        .unwrap_or_else(|| ui.available_width().max(1.0));
111    ui.horizontal(|ui| {
112        let (rect, response) =
113            ui.allocate_exact_size(Vec2::new(width, style.meter_height), Sense::hover());
114        // The trough is the sunken surface rather than a tint of the tone: a
115        // bar is a thing set into the page with something in it, which is what
116        // `Fill::Sunken` means, and tinting the empty half would read as a
117        // second, paler proportion.
118        ui.painter().rect_filled(rect, style.radius, palette.sunken);
119        let share = if meter.total == 0 {
120            0.0
121        } else {
122            (f64::from(meter.done) / f64::from(meter.total)).min(1.0)
123        };
124        #[expect(
125            clippy::cast_possible_truncation,
126            reason = "a share is 0..=1 and the product is a width in points"
127        )]
128        let filled = (f64::from(rect.width()) * share) as f32;
129        if filled > 0.0 {
130            let mut fill = rect;
131            fill.set_width(filled);
132            ui.painter()
133                .rect_filled(fill, style.radius, palette.tone(meter.tone));
134        }
135        let reading = match meter.label {
136            Some(label) => format!("{}/{} {label}", meter.done, meter.total),
137            None => format!("{}/{}", meter.done, meter.total),
138        };
139        ui.label(RichText::new(reading).color(palette.content_muted));
140        response
141    })
142    .inner
143}
144
145/// A badge or a chip.
146///
147/// A badge is the table model's (wiki `table-model`), as `makeover-webview`
148/// draws it: a fill of its tone surface inside a one-point edge in its tone,
149/// the label in content ink. A neutral badge fills with the raised surface and
150/// takes the border for its edge. The tone is never the ink, which measured
151/// 1.34:1 as text on goingson's warning.
152///
153/// A chip is outlined in its tone, and filled while latched.
154///
155/// **A chip answers a click and a badge does not**, which is
156/// [`Token::interactive`] and is the whole difference between the members. The
157/// `Response` comes back either way, so a caller that presses a badge is
158/// pressing something this function said was not interactive; the sense is what
159/// makes egui agree.
160///
161/// `latched` is a chip that is switched on, and it fills rather than outlines. A
162/// terminal has to collide latched with focus because it has one spare axis for
163/// two facts; egui does not, so it does not.
164///
165/// A chip's removable half is not drawn, on `makeover-tui`'s reasoning: a second
166/// control inside a token is a question for whoever owns the interaction rather
167/// than for a drawing.
168pub fn token(
169    ui: &mut Ui,
170    label: &str,
171    kind: Token,
172    tone: Tone,
173    latched: bool,
174    palette: &Palette,
175    style: &WidgetStyle,
176) -> Response {
177    let painted = palette.tone(tone);
178    let radius = style.radius;
179    let sense = if kind.interactive() {
180        Sense::click()
181    } else {
182        Sense::hover()
183    };
184
185    // Laid out before the rect is allocated, because a token is exactly as wide
186    // as what it says plus its padding: there is no box to fit text into here,
187    // the way a table cell has one.
188    let ink = match kind {
189        Token::Badge => palette.content,
190        Token::Chip { .. } if latched => palette.page,
191        Token::Chip { .. } => painted,
192    };
193    let galley = ui.painter().layout_no_wrap(
194        label.to_owned(),
195        egui::TextStyle::Body.resolve(ui.style()),
196        ink,
197    );
198    let size = galley.size() + style.token_padding * 2.0;
199    let (rect, response) = ui.allocate_exact_size(size, sense);
200
201    if kind == Token::Badge {
202        ui.painter().rect(
203            rect,
204            radius,
205            palette.tone_surface(tone),
206            egui::Stroke::new(1.0, palette.tone_edge(tone)),
207            egui::StrokeKind::Inside,
208        );
209    } else if latched {
210        ui.painter().rect_filled(rect, radius, painted);
211    } else {
212        ui.painter().rect_stroke(
213            rect,
214            radius,
215            egui::Stroke::new(1.0, painted),
216            egui::StrokeKind::Inside,
217        );
218    }
219    ui.painter()
220        .galley(rect.center() - galley.size() / 2.0, galley, ink);
221
222    // Say what was drawn, because painting it says nothing.
223    //
224    // A token allocates its rect and paints the text straight onto it, so
225    // nothing reached the accessibility tree at all until 2026-08-22: an
226    // interactive chip was a control a mouse could press and a screen reader
227    // could not find, and a badge was text nobody could read out. The filter
228    // panel's twenty-four key pills were the site -- a whole way of filtering,
229    // absent.
230    //
231    // A chip that latches says so through `selected`, which is what a screen
232    // reader announces as pressed. That is `latched`'s whole meaning: the key
233    // is held down.
234    let role = if kind.interactive() {
235        egui::WidgetType::Button
236    } else {
237        egui::WidgetType::Label
238    };
239    response.widget_info(|| {
240        let mut info = egui::WidgetInfo::labeled(role, ui.is_enabled(), label);
241        if kind.interactive() {
242            info.selected = Some(latched);
243        }
244        info
245    });
246    response
247}
248
249/// A control.
250///
251/// The key the description named is drawn beside the label where there is one,
252/// which is [`Act::key`] finally being read by a second renderer: it was written
253/// for a terminal, and a desktop app has keys too.
254///
255/// **A disabled control is drawn and does not answer**, through
256/// [`State::suppresses_interaction`] rather than a second reading of what
257/// disabled means, and it takes [`Palette::content_muted`] because that is the
258/// intent `State::Disabled` resolves to. egui is told through `add_enabled`, so
259/// its own focus walk skips it: a control that is drawn and not reachable is
260/// exactly what `disabled` means on every host, and here the host already has
261/// the machinery.
262pub fn act(ui: &mut Ui, act: &Act<'_>, palette: &Palette, _style: &WidgetStyle) -> Response {
263    let disabled = act.state.is_some_and(State::suppresses_interaction);
264    let label = match act.key {
265        Some(key) => format!("{}  ({key})", act.label),
266        None => act.label.to_owned(),
267    };
268    let colour = if disabled {
269        palette.content_muted
270    } else {
271        palette.tone(act.tone)
272    };
273    // The act the screen is for takes the accent as a ground, which is this
274    // host's spelling of the webview's filled leading button (`Act::leading`).
275    //
276    // **Leading fills and committing outlines**, so the two compose: a control
277    // that is both is filled *and* stroked, and a sub-form's submit keeps the
278    // stroke alone. Before the member existed the stroke was the only emphasis
279    // there was, so a sub-form's Add and the screen's own act were drawn the
280    // same.
281    //
282    // Disabled takes neither, for the frame's reason below: a filled control
283    // that cannot be pressed is the loudest thing on the screen and does
284    // nothing.
285    let leading = act.leading && !disabled;
286    let colour = if leading {
287        palette.content_on_action
288    } else {
289        colour
290    };
291    let mut button = egui::Button::new(RichText::new(label).color(colour));
292    if leading {
293        button = button.fill(palette.action);
294    }
295    // The control that commits wears a frame, which is this host's spelling of
296    // the webview's default-button ring (`Act::commits`). Muted when disabled,
297    // as the label is, so it keeps its shape without asking for a press.
298    if act.commits {
299        let frame = if disabled {
300            palette.content_muted
301        } else {
302            palette.content
303        };
304        button = button.stroke(egui::Stroke::new(2.0, frame));
305    }
306    let drawn = ui.add_enabled(!disabled, button);
307    // Standing help, as a hover, which is honest on this host in a way it is
308    // not on a terminal: egui has a pointer. `makeover_tui` says the same
309    // sentence as a muted row under the control.
310    //
311    // Drawn here rather than by the caller as of `Act::hint` (0.40.0). quasi's
312    // egui renderer was doing exactly this outside the widget because
313    // `layout::Act` carried no hint, so a host that was not quasi got nothing.
314    match act.hint {
315        Some(hint) => drawn.on_hover_text(hint),
316        None => drawn,
317    }
318}
319
320/// A figure: the value, then what it counts under it.
321///
322/// The tone lands on the value and its change rather than on the caption, which
323/// is what [`Figure::tone`] means: the figure is an ordinary fact and it is the
324/// movement that reads as good or bad. `makeover-tui` says the same thing with a
325/// bold span; here it is a larger one, because egui can size text and a terminal
326/// cannot.
327/// Labelled facts, with their values in one column.
328///
329/// **The alignment is the member**, and `egui::Grid` is how this renderer gets
330/// it: a grid measures its widest cell per column and lays every row to that,
331/// which is the same answer `max-content` gives a webview and padding gives a
332/// terminal. Five goingson panes were drawing a row per fact, and every value
333/// started after its own label.
334///
335/// The grid is not striped. `Grid::striped` is the obvious reach and it is
336/// wrong here: a stripe says "these rows are a series you scan down", which is
337/// a table's claim. A pane of facts is one object read as a whole.
338///
339/// The label reads back and the value takes content, which is `figure`'s rule
340/// for a value against its caption. A fact with nothing to say never arrives:
341/// `Node::facts` drops it as it builds.
342pub fn facts(ui: &mut Ui, facts: &[Fact<'_>], palette: &Palette, id: impl Into<egui::Id>) {
343    egui::Grid::new(id.into())
344        .num_columns(2)
345        .striped(false)
346        .show(ui, |ui| {
347            for fact in facts {
348                ui.label(RichText::new(fact.label).color(palette.content_muted));
349                ui.label(RichText::new(fact.value).color(palette.content));
350                ui.end_row();
351            }
352        });
353}
354
355pub fn figure(
356    ui: &mut Ui,
357    figure: &Figure<'_>,
358    palette: &Palette,
359    style: &WidgetStyle,
360) -> Response {
361    ui.with_layout(Layout::top_down(Align::Min), |ui| {
362        let value = match figure.change {
363            Some(change) => format!("{} {change}", figure.value),
364            None => figure.value.to_owned(),
365        };
366        let size = egui::TextStyle::Body.resolve(ui.style()).size * style.figure_scale;
367        let shown = ui.label(
368            RichText::new(value)
369                .color(palette.tone(figure.tone))
370                .size(size)
371                .strong(),
372        );
373        ui.add_space(style.figure_gap);
374        ui.label(RichText::new(figure.caption).color(palette.content_muted));
375        shown
376    })
377    .inner
378}
379
380/// What a host can see about a wait that is running.
381///
382/// Both halves are optional because both are the host's to observe and neither
383/// is derivable from the description. `makeover_layout::Awaiting` says how big
384/// the payload is; nothing in a description can say how much of it has landed,
385/// because that is a fact about a transfer in flight.
386#[derive(Debug, Clone, Copy, Default, PartialEq, Eq)]
387pub struct Progress {
388    /// How much has arrived, in whatever unit the description counted.
389    ///
390    /// `None` means nothing is watching the transfer, which is the common case
391    /// and is what keeps the bar from being drawn out of a total alone.
392    pub delivered: Option<u64>,
393    /// How long the wait has lasted so far.
394    ///
395    /// The one time value a wait is allowed to show. Never a remaining time and
396    /// never a rate: see [`awaiting`].
397    pub elapsed: Option<Duration>,
398}
399
400/// The activity mark: one small square, blinking.
401///
402/// Rule 2 of wiki `loading-and-progress-standard`, and the thing that replaced
403/// `Ui::spinner` here. A spinner turns at a rate it invented and reads as
404/// progress; this claims nothing beyond "something is happening", which is the
405/// whole of what an unmeasured wait knows.
406///
407/// **`reduced` stills the mark rather than removing it.** egui has no
408/// `prefers-reduced-motion`, so the preference arrives as a bool from whatever
409/// the host asked its own platform, exactly as `makeover_timing::activity_blink`
410/// is shaped for. A still mark still says something is happening; hiding it
411/// would answer a request nobody made.
412///
413/// The cadence is `makeover_timing::Cadence::Activity` and is not a number this
414/// crate chooses, so a browser, a terminal and an egui window blink together.
415///
416/// Repaint is asked for at the next flip rather than every frame: a blinking
417/// mark should not turn a window that is otherwise idle into one that renders
418/// continuously.
419pub fn activity(ui: &mut Ui, reduced: bool, palette: &Palette, style: &WidgetStyle) -> Response {
420    let (rect, response) = ui.allocate_exact_size(Vec2::splat(style.mark_size), Sense::hover());
421    let lit = match activity_blink(reduced) {
422        // Still, and lit. The state the mark holds when nothing may move.
423        None => true,
424        Some(half) => {
425            let half = half.as_secs_f64();
426            // A cadence of zero would divide by nothing and blink infinitely
427            // fast, which is the one value the token cannot mean.
428            if half <= 0.0 {
429                true
430            } else {
431                let phase = ui.input(|input| input.time).rem_euclid(half * 2.0);
432                let lit = phase < half;
433                let next = if lit { half } else { half * 2.0 } - phase;
434                ui.ctx()
435                    .request_repaint_after(Duration::from_secs_f64(next.max(0.0)));
436                lit
437            }
438        }
439    };
440    // Lit is the accent, dark is the trough it sits in. Not "drawn and not
441    // drawn": a mark that vanishes half the time is a hole in the layout, and
442    // the reader loses where to look between blinks.
443    let colour = if lit { palette.action } else { palette.sunken };
444    ui.painter().rect_filled(rect, style.radius, colour);
445    response
446}
447
448/// A wait, drawn from what is actually known about it.
449///
450/// The branch is `Awaiting::is_determinate` and one more question the
451/// description cannot answer: whether anything is watching the transfer. A bar
452/// needs both a total and a numerator, so a described amount with no
453/// [`Progress::delivered`] beside it draws the mark, not an empty trough that
454/// implies someone is counting.
455///
456/// **What the bar may not do**, from rule 1 of wiki
457/// `loading-and-progress-standard` and from `Awaiting`'s own docs: what is done
458/// over what there is, plus the time it has taken. Never a remaining time, an
459/// arrival time, or a rate extrapolated forward. A prediction is wrong the
460/// moment the transfer stalls, and being confidently wrong is worse than being
461/// honestly indeterminate.
462///
463/// The reading is the two raw numbers, as [`meter`] does it. The unit is the
464/// app's — bytes for an upload, rows for an import — and a renderer that
465/// guessed at one would be formatting a quantity it was deliberately not told
466/// about.
467pub fn awaiting(
468    ui: &mut Ui,
469    awaiting: Awaiting,
470    progress: Progress,
471    reduced: bool,
472    palette: &Palette,
473    style: &WidgetStyle,
474) -> Response {
475    let (Some(total), Some(done)) = (awaiting.amount, progress.delivered) else {
476        return activity(ui, reduced, palette, style);
477    };
478    let width = style
479        .meter_width
480        .unwrap_or_else(|| ui.available_width().max(1.0));
481    ui.horizontal(|ui| {
482        let (rect, response) =
483            ui.allocate_exact_size(Vec2::new(width, style.meter_height), Sense::hover());
484        ui.painter().rect_filled(rect, style.radius, palette.sunken);
485        // A total of zero is no payload rather than a finished one, which is
486        // `meter`'s reading of the same case. Over-delivery clamps for the same
487        // reason it does there: a rect cannot be longer than itself.
488        let share = if total == 0 {
489            0.0
490        } else {
491            #[expect(
492                clippy::cast_precision_loss,
493                reason = "a byte count past 2^53 is not a wait anyone is watching a bar for"
494            )]
495            let share = (done as f64 / total as f64).min(1.0);
496            share
497        };
498        #[expect(
499            clippy::cast_possible_truncation,
500            reason = "a share is 0..=1 and the product is a width in points"
501        )]
502        let filled = (f64::from(rect.width()) * share) as f32;
503        if filled > 0.0 {
504            let mut fill = rect;
505            fill.set_width(filled);
506            ui.painter().rect_filled(fill, style.radius, palette.action);
507        }
508        let reading = match progress.elapsed {
509            Some(elapsed) => format!("{done}/{total}  {}s", elapsed.as_secs()),
510            None => format!("{done}/{total}"),
511        };
512        ui.label(RichText::new(reading).color(palette.content_muted));
513        response
514    })
515    .inner
516}
517
518/// A chart, as bars standing on a shared axis.
519///
520/// The webview's drawing rather than the terminal's: this renderer paints into
521/// a rectangle it asks for, so columns cost it nothing and are what a reader
522/// expects of a chart. `makeover-tui` lays its bars down instead, because a
523/// terminal has rows to spend and cells to draw with; both are honest answers
524/// to the same description and neither is the other's fallback.
525///
526/// # The axis is the caller's height and the description's maximum
527///
528/// [`WidgetStyle::chart_height`] says how tall the figure stands and
529/// [`Chart::most`] says what a full bar means, which is the same split
530/// `--chart-height` and `--most` make in the stylesheet. An axis of zero draws
531/// its bars at nothing rather than dividing by it.
532///
533/// [`Bar::note`] is not painted. There is nowhere to put it without a hover
534/// surface this crate does not own, and the reading is the fact worth the room.
535pub fn chart(
536    ui: &mut Ui,
537    chart: &Chart<'_>,
538    bars: &[Bar<'_>],
539    palette: &Palette,
540    style: &WidgetStyle,
541) -> Response {
542    let width = ui.available_width().max(1.0);
543    let (rect, response) =
544        ui.allocate_exact_size(Vec2::new(width, style.chart_height), Sense::hover());
545
546    // The places on the axis take a band at the bottom, and the bars stand on
547    // top of it. Reserved out of the figure's own height rather than added to
548    // it, so `chart_height` is what a caller laying out a screen can measure
549    // against -- the same promise `--chart-height` makes in the stylesheet.
550    let font = egui::TextStyle::Small.resolve(ui.style());
551    let band = ui.text_style_height(&egui::TextStyle::Small);
552    let floor = (rect.bottom() - band).max(rect.top());
553    let standing = floor - rect.top();
554
555    if bars.is_empty() {
556        return response;
557    }
558
559    #[expect(
560        clippy::cast_precision_loss,
561        reason = "a bar count is small and this is a width in points"
562    )]
563    let each = rect.width() / bars.len() as f32;
564    for (index, bar) in bars.iter().enumerate() {
565        #[expect(
566            clippy::cast_precision_loss,
567            reason = "an index into the bars, which are few"
568        )]
569        let left = rect.left() + each * index as f32;
570        let reached = standing * bar.fraction(chart);
571        let mut column = egui::Rect::from_min_size(
572            egui::Pos2::new(left, floor - reached),
573            Vec2::new(each, reached),
574        );
575        // A bar of nothing still says it is there, which is what the
576        // stylesheet's `min-height` does in the other renderer.
577        if column.height() < 1.0 {
578            column.set_top(floor - 1.0);
579        }
580        ui.painter()
581            .rect_filled(column, style.radius, palette.tone(chart.tone));
582
583        // Centred under the column it belongs to. Drawn by the painter rather
584        // than laid out as a row of labels, because a row lays itself out and
585        // the labels would then sit where the text put them instead of under
586        // their own bars, which is the one thing a place on an axis has to do.
587        ui.painter().text(
588            egui::Pos2::new(left + each / 2.0, floor),
589            egui::Align2::CENTER_TOP,
590            bar.at,
591            font.clone(),
592            palette.content_muted,
593        );
594    }
595
596    response
597}
598
599#[cfg(test)]
600mod tests {
601    use super::*;
602
603    /// What the accessibility tree says a widget drew.
604    fn announced(
605        draw: impl FnMut(&mut Ui),
606    ) -> Vec<(
607        egui::accesskit::Role,
608        String,
609        Option<egui::accesskit::Toggled>,
610    )> {
611        let ctx = egui::Context::default();
612        ctx.enable_accesskit();
613        let mut draw = draw;
614        let input = || egui::RawInput {
615            screen_rect: Some(egui::Rect::from_min_size(
616                egui::Pos2::ZERO,
617                egui::vec2(600.0, 400.0),
618            )),
619            ..Default::default()
620        };
621        let _ = ctx.run_ui(input(), &mut draw);
622        let out = ctx.run_ui(input(), &mut draw);
623        out.platform_output
624            .accesskit_update
625            .expect("accesskit is on")
626            .nodes
627            .iter()
628            .map(|(_, node)| {
629                (
630                    node.role(),
631                    node.label()
632                        .or_else(|| node.value())
633                        .unwrap_or_default()
634                        .to_owned(),
635                    node.toggled(),
636                )
637            })
638            .collect()
639    }
640
641    #[test]
642    fn a_chip_is_announced_as_a_control_and_says_whether_it_is_held() {
643        // A token paints its own text onto its own rect, so before 2026-08-22
644        // it reached the tree as nothing: pressable by a mouse and invisible to
645        // everything else.
646        let p = palette();
647        let style = WidgetStyle::default();
648        let drawn = announced(|ui| {
649            token(
650                ui,
651                "C#",
652                Token::Chip { removable: false },
653                Tone::Neutral,
654                true,
655                &p,
656                &style,
657            );
658        });
659
660        let chip = drawn
661            .iter()
662            .find(|(role, name, _)| *role == egui::accesskit::Role::Button && name == "C#")
663            .unwrap_or_else(|| panic!("the chip is not in the tree: {drawn:?}"));
664        assert_eq!(
665            chip.2,
666            Some(egui::accesskit::Toggled::True),
667            "a latched chip is held down and says so: {drawn:?}"
668        );
669    }
670
671    #[test]
672    fn a_badge_is_announced_as_the_text_it_is() {
673        // Not a control, and not nothing either: a badge is a word on the
674        // screen and painting it is not the same as saying it.
675        let p = palette();
676        let style = WidgetStyle::default();
677        let drawn = announced(|ui| {
678            token(ui, "wav", Token::Badge, Tone::Neutral, false, &p, &style);
679        });
680
681        assert!(
682            drawn
683                .iter()
684                .any(|(role, name, _)| *role == egui::accesskit::Role::Label && name == "wav"),
685            "{drawn:?}"
686        );
687        assert!(
688            !drawn
689                .iter()
690                .any(|(role, _, _)| *role == egui::accesskit::Role::Button),
691            "a badge answers nothing and must not claim to: {drawn:?}"
692        );
693    }
694
695    fn palette() -> Palette {
696        use egui::Color32;
697        Palette {
698            page: Color32::from_rgb(1, 1, 1),
699            raised: Color32::from_rgb(2, 2, 2),
700            overlay: Color32::from_rgb(3, 3, 3),
701            well: Color32::from_rgb(4, 4, 4),
702            sunken: Color32::from_rgb(5, 5, 5),
703            bevel_light: Color32::from_rgb(6, 6, 6),
704            bevel_dark: Color32::from_rgb(7, 7, 7),
705            elevation: Color32::from_black_alpha(40),
706            content: Color32::from_rgb(20, 20, 20),
707            content_secondary: Color32::from_rgb(120, 120, 120),
708            content_muted: Color32::from_rgb(21, 21, 21),
709            action: Color32::from_rgb(22, 22, 22),
710            content_on_action: Color32::from_rgb(250, 250, 250),
711            danger: Color32::from_rgb(23, 23, 23),
712            success: Color32::from_rgb(24, 24, 24),
713            warning: Color32::from_rgb(25, 25, 25),
714            info: Color32::from_rgb(26, 26, 26),
715            border: Color32::from_rgb(200, 200, 200),
716            info_surface: Color32::from_rgb(201, 201, 201),
717            success_surface: Color32::from_rgb(202, 202, 202),
718            warning_surface: Color32::from_rgb(203, 203, 203),
719            danger_surface: Color32::from_rgb(204, 204, 204),
720            row_stripe: Color32::from_rgb(205, 205, 205),
721            row_hover: Color32::from_rgb(206, 206, 206),
722            row_rule: Color32::from_rgb(207, 207, 207),
723            row_selected: Color32::from_rgb(208, 208, 208),
724        }
725    }
726
727    #[test]
728    fn every_tone_resolves_and_no_two_share_a_colour() {
729        // The reason the three status intents arrived together: a resolver
730        // missing one has to invent a colour for it.
731        let p = palette();
732        let all = [
733            p.tone(Tone::Neutral),
734            p.tone(Tone::Info),
735            p.tone(Tone::Success),
736            p.tone(Tone::Warning),
737            p.tone(Tone::Danger),
738        ];
739        for (i, a) in all.iter().enumerate() {
740            for b in &all[i + 1..] {
741                assert_ne!(a, b, "two tones resolved to one colour");
742            }
743        }
744        assert_eq!(p.tone(Tone::Neutral), p.content, "neutral is ordinary text");
745    }
746
747    #[test]
748    fn a_meter_draws_and_an_overrun_does_not_panic() {
749        // `done` may exceed `total`, which is the case Meter's own docs call
750        // the one worth drawing. The fill clamps; the reading does not.
751        let p = palette();
752        let style = WidgetStyle::default();
753        egui::__run_test_ui(|ui| {
754            meter(ui, &Meter::new(3, 6), &p, &style);
755            meter(ui, &Meter::new(9, 6), &p, &style);
756            // No set, rather than a complete one.
757            meter(ui, &Meter::new(0, 0), &p, &style);
758            // The overflow `makeover-layout` pins on its own side.
759            meter(ui, &Meter::new(u32::MAX, u32::MAX), &p, &style);
760        });
761    }
762
763    #[test]
764    fn a_wait_draws_a_bar_only_when_something_is_counting_it() {
765        // The described total is half of what a bar needs. Without a numerator
766        // the honest drawing is the mark, not an empty trough implying that
767        // someone is watching bytes land.
768        let p = palette();
769        let style = WidgetStyle::default();
770        egui::__run_test_ui(|ui| {
771            awaiting(
772                ui,
773                Awaiting::unmeasured(),
774                Progress::default(),
775                false,
776                &p,
777                &style,
778            );
779            awaiting(
780                ui,
781                Awaiting::of(41_943_040),
782                Progress::default(),
783                false,
784                &p,
785                &style,
786            );
787            awaiting(
788                ui,
789                Awaiting::of(41_943_040),
790                Progress {
791                    delivered: Some(10_485_760),
792                    elapsed: Some(Duration::from_secs(3)),
793                },
794                false,
795                &p,
796                &style,
797            );
798            // A zero payload is no payload, and over-delivery clamps.
799            awaiting(
800                ui,
801                Awaiting::of(0),
802                Progress {
803                    delivered: Some(9),
804                    elapsed: None,
805                },
806                false,
807                &p,
808                &style,
809            );
810            awaiting(
811                ui,
812                Awaiting::of(4),
813                Progress {
814                    delivered: Some(9),
815                    elapsed: None,
816                },
817                false,
818                &p,
819                &style,
820            );
821        });
822    }
823
824    #[test]
825    fn reduced_motion_stills_the_mark_and_does_not_remove_it() {
826        // `activity_blink(true)` is None, which means lit and still. A renderer
827        // that drew nothing would have answered a request nobody made.
828        let p = palette();
829        let style = WidgetStyle::default();
830        egui::__run_test_ui(|ui| {
831            let still = activity(ui, true, &p, &style);
832            let blinking = activity(ui, false, &p, &style);
833            assert_eq!(
834                still.rect.size(),
835                blinking.rect.size(),
836                "the mark occupies the same space either way"
837            );
838        });
839    }
840
841    #[test]
842    fn a_chip_answers_a_click_and_a_badge_does_not() {
843        // `Token::interactive` is the whole difference between the members, and
844        // the sense is what makes egui agree with it.
845        let p = palette();
846        let style = WidgetStyle::default();
847        egui::__run_test_ui(|ui| {
848            let badge = token(ui, "beta", Token::Badge, Tone::Info, false, &p, &style);
849            assert!(!badge.sense.senses_click(), "a badge answers no click");
850
851            let chip = token(
852                ui,
853                "drums",
854                Token::Chip { removable: false },
855                Tone::Neutral,
856                false,
857                &p,
858                &style,
859            );
860            assert!(chip.sense.senses_click(), "a chip answers a click");
861        });
862    }
863
864    #[test]
865    fn a_disabled_control_is_drawn_and_does_not_answer() {
866        // Present, visible, and not answering. Through
867        // `State::suppresses_interaction` rather than a second reading here.
868        let p = palette();
869        let style = WidgetStyle::default();
870        egui::__run_test_ui(|ui| {
871            let live = act(ui, &Act::new("Save"), &p, &style);
872            assert!(live.enabled());
873
874            let gone = act(ui, &Act::new("Save").state(State::Disabled), &p, &style);
875            assert!(!gone.enabled(), "a disabled control still answers");
876        });
877    }
878
879    #[test]
880    fn a_control_shows_the_key_the_description_named() {
881        // `Act::key` was written for a terminal before there was one. A desktop
882        // app has keys too, so this is its second reader.
883        let p = palette();
884        let style = WidgetStyle::default();
885        egui::__run_test_ui(|ui| {
886            act(ui, &Act::new("New").key("n"), &p, &style);
887            act(ui, &Act::new("New"), &p, &style);
888        });
889    }
890
891    #[test]
892    fn a_figure_draws_its_movement_beside_its_value() {
893        let p = palette();
894        let style = WidgetStyle::default();
895        egui::__run_test_ui(|ui| {
896            figure(ui, &Figure::new("17", "Current streak"), &p, &style);
897            figure(
898                ui,
899                &Figure::new("17", "Current streak")
900                    .change("+3")
901                    .tone(Tone::Success),
902                &p,
903                &style,
904            );
905        });
906    }
907}