Files
pipelines/app/notes/ui-quality-checklist.md
T
alan 8a9cd8962b Add the UI quality checklist pipeline reviews judge against
ui-review and implement in Pipelines app change hold rendered work to
this bar: alignment, spacing, wrapping, theme use, components and every
affected state captured.
2026-11-12 15:44:40 +00:00

44 lines
2.0 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# UI quality checklist
The bar a rendered change must meet before it lands. `ui-review` judges every
affected state against it from screenshots; `implement` checks its own work
against it first. "It renders without errors" is not the bar: would a careful
designer ship this in a polished Material 3 app?
## Layout and alignment
- Elements that belong together share edges: labels, values, keys, icons and
trailing actions line up in columns across rows; no row's content jumps.
- Leading and trailing insets are the same for siblings (cards, rows, dividers).
- Spacing follows the 4/8 px rhythm and is consistent between equal siblings.
- Content width is bounded on wide screens (reading width), and nothing is
stretched across a 1600 px window or crammed at 430 px.
## Text
- No unintended wrapping or truncation of labels, chips, buttons or key
combinations; nothing breaks mid-token (`Cmd+Option+Shift+` / `Arrows`).
- No line ends on a dangling joiner (`or`, `·`, `,`).
- Hierarchy comes from the theme's text styles, not ad-hoc sizes and weights;
secondary text uses `onSurfaceVariant`.
## Components and colour
- Standard Material 3 components and the theme's `ColorScheme`; no bespoke
palette, hard-coded colours or fixed row heights.
- Light and dark are both readable with sufficient contrast; no white panels in
dark mode.
- Controls look like their siblings (same button style, size and shape); touch
targets are at least 48 px on phones.
- Icons are clear at a glance and match their meaning; animated indicators are
calm, steady and respect reduced motion.
## States
- Every state the change touches is captured: empty, loading, error, long
content, focused and hovered where relevant, phone (430 px) and desktop
(1600 px), light and dark, and 1.3× text where text is involved.
- Popups, menus, tooltips and sheets the change adds are opened and captured.
- A state the fixture cannot show is not passed: extend the fixture
(`app/tool/search_selection_probe_entry.dart` and its fixtures) so it can.