mirror of
https://github.com/lrnselfreliance/wrolpi.git
synced 2026-11-20 06:56:18 -05:00
review: measure what can be measured, and say what is not
Acting on the review of #621. No bugs were found; these are the four suggestions and two nits. The real one: measurement accepted only hex. `relativeLuminance` returned 0 for anything else, which is black's luminance and indistinguishable from it -- so a token written `rgb(92 79 168)` measured as pure black, the "best" foreground was chosen against a colour the theme does not contain, and the wrong hex was then frozen into an inline style where CSS could no longer correct it. Silent, and worse than not measuring. `parseColor` now reads `rgb()`/`rgba()` in both the comma and space forms, percentages, and `#rgba`/`#rrggbbaa`; `isMeasurable` lets a caller tell "unreadable" from "black"; and navColorsFrom falls back to the tokens when the background or every candidate is unreadable. Unreadable candidates are filtered rather than the whole measurement abandoned, so one oddly written token does not cost the other two. This matters because the header claimed custom YAML themes get correct foregrounds for free, and a hand-written palette is exactly where a non-hex value will first appear. The Cypress inverse hardcoded night's `--btn-text` as `#0a0000`. The unit tests parse tokens.css precisely so a palette edit cannot leave a stale claim behind, and that literal was the one place the rule was broken. It reads the token from the theme now, asserts it resolved, and additionally pins that red still takes `--btn-text` while brown no longer does. Documented rather than changed: the warning indicators still pick their colour from the `conflictingColors` name list. It is the same defect as the one fixed here and measurably worse -- `--danger` and `--warning` are 1.0-1.8:1 against the bar in every theme, light and dark included, because a red icon on a red bar is a red icon on a red bar. The fix is not a better colour: severity has to stay distinguishable from the bar's text as well as from itself, and a monochrome theme has no third brightness, so it has to stop being a hue. That is a redesign, and the note now sits beside the residue in navColors.ts rather than only in a PR description. The gallery draws the indicators as the bar draws them when nothing is wrong; it does not stage a fake overheating Pi to exhibit a fault nobody has agreed how to fix. Also documented: re-measurement is triggered by `data-theme`, so a future custom-theme editor patching custom properties in place would leave the bar on the values it last measured. There is no event for "a custom property was assigned" to observe instead, so the note says what such an editor must do. Nits: "Eleven" in a comment where the assertion locks ten (and a stale 2.91:1 beside it, now 3.27:1), and a missing space in `const wrolpiIcon =<img`. Six new unit cases, planted: dropping the fallback reddens two. 1121 jest / 62 suites, 196 in ui-layout.cy.js, clean npm run build.
This commit is contained in:
parent
8aa9725feb
commit
5fdaf6868a
5 changed files with 203 additions and 21 deletions
|
|
@ -2199,8 +2199,13 @@ describe('the navigation bar is legible on every colour a user can pick', () =>
|
|||
* The inverse. Every case above would pass on the old fixed foreground in the two
|
||||
* themes where `--btn-text` happens to be the right end of the palette, so without
|
||||
* this the suite could go green on a revert. Night is where the difference is
|
||||
* largest: `--brown` takes `--white` (#ff8a8a) and `--red` keeps `--btn-text`, so
|
||||
* the bar's foreground is demonstrably not one value.
|
||||
* largest: `--brown` takes `--white` and `--red` keeps `--btn-text`, so the bar's
|
||||
* foreground is demonstrably not one value.
|
||||
*
|
||||
* `--btn-text` is READ from the theme rather than written out as a hex. The unit
|
||||
* tests parse tokens.css precisely so a palette edit cannot leave a stale claim
|
||||
* behind, and a literal here would be the one place that rule was broken -- it would
|
||||
* either go stale or quietly stop testing anything if night's token moved.
|
||||
*/
|
||||
cy.mountUI(<div>
|
||||
<NavBarSample color='brown'/>
|
||||
|
|
@ -2211,11 +2216,19 @@ describe('the navigation bar is legible on every colour a user can pick', () =>
|
|||
cy.get('[data-nav-sample="red"] .wrolpi-navbar-link').then(($red) => {
|
||||
const brown = getComputedStyle($brown[0]).color;
|
||||
const red = getComputedStyle($red[0]).color;
|
||||
const btnText = getComputedStyle(document.documentElement)
|
||||
.getPropertyValue('--btn-text');
|
||||
|
||||
// The premise: the token resolved. `toRgb` throws on an unresolved value
|
||||
// rather than letting the comparison below pass by comparing nothing.
|
||||
expect(toRgb(btnText), 'night --btn-text resolved').to.match(/^rgb/);
|
||||
expect(brown, 'brown and red bars take different foregrounds')
|
||||
.to.not.equal(red);
|
||||
// And the one that changed is the one that was unreadable.
|
||||
expect(toRgb(brown), 'brown no longer takes --btn-text')
|
||||
.to.not.equal(toRgb('#0a0000'));
|
||||
.to.not.equal(toRgb(btnText));
|
||||
// While red, which was always legible, still does.
|
||||
expect(toRgb(red), 'red still takes --btn-text').to.equal(toRgb(btnText));
|
||||
});
|
||||
});
|
||||
});
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue