mirror of
https://github.com/lrnselfreliance/wrolpi.git
synced 2026-11-22 07:56:18 -05:00
review: name the icon-only controls, and make two guards mean what they say
Acting on the review of #626. No bugs; one suggestion and three nits. The map's icon-only controls had no accessible name. IconButton requires a label by construction and AddToPlaylistButton supplies one, but the plain Button and APIButton used for edit, delete and the catalog preview reached assistive tech as unnamed buttons -- and my own Cypress fixtures carefully passed `aria-label` on the same pattern while production did not, which is its own kind of tell. All four are named now, and named with the row's subject rather than the verb alone: "Delete Water tank", not "Delete", because a table of pins otherwise offers a screen reader a column of identical buttons. A source guard holds that: it scans for controls that carry an icon and no label text, and reports any without an `aria-label`. Paired with a premise that it found some, since a scanner matching nothing reads exactly like a clean file. The Group guard asserted only that `<Group` appeared somewhere in the cell, which would pass on an empty Group left beside the bare siblings it was meant to wrap. It now checks that every control in the cell is inside the Group -- and the first version of THAT was wrong too: it sliced from `<Group` to the end of the cell rather than to `</Group>`, so controls after the closing tag still counted as inside, and the empty-Group plant stayed green. Slicing between the tags makes it fail. Coverage the review asked for: the Semantic size names the call sites actually use (`small`, `big`, `huge`) rather than only the Mantine ones, since the translation step was untested on the exact spellings that were broken; icon-only buttons stay square while loading, when the glyph is replaced by a spinner sized from the button's height; and `iconAfter`-only squares as well as `icon`-only. On the size passthrough, which was flagged as the highest-risk change outside the map: the buttons that grow are Settings' Shutdown and Reboot (`huge`, to 60px), Settings' Upgrade and Save and Channels' Save (`big`, to 50px), and VideoPlayer's Refresh (`large`, to 50px). All six read as deliberate emphasis -- the two biggest are the two destructive ones -- so they are left honoured rather than re-broken at the call site. `size='small'` resolves to `sm`, which is what the accidental default already was, so the detail pages do not move. 1134 jest / 64 suites, 246 in ui-layout.cy.js, clean npm run build.
This commit is contained in:
parent
b0a7c9da1e
commit
f997f730e1
3 changed files with 146 additions and 3 deletions
|
|
@ -3457,6 +3457,65 @@ describe('APIButton honours the size its call site asks for', () => {
|
|||
});
|
||||
});
|
||||
|
||||
it('honours the Semantic size names the call sites actually use', () => {
|
||||
/*
|
||||
* The seventeen call sites that were being ignored do not say `xs` and `lg` -- they say
|
||||
* `small`, `big`, `large` and `huge`, which `resolveSize` translates. Testing only the
|
||||
* Mantine names would leave the translation step untested on the exact spellings that
|
||||
* were broken. `small` maps to `sm`, which is what the accidental default already was,
|
||||
* which is why most detail pages do not move.
|
||||
*/
|
||||
cy.mountUI(<div>
|
||||
<APIButton size='small' icon='trash' onClick={() => {}} data-testid='small'/>
|
||||
<APIButton size='big' icon='trash' onClick={() => {}} data-testid='big'/>
|
||||
<APIButton size='huge' icon='trash' onClick={() => {}} data-testid='huge'/>
|
||||
</div>);
|
||||
|
||||
cy.get('[data-testid="huge"]').should(($huge) => {
|
||||
const height = (id) =>
|
||||
Cypress.$(`[data-testid="${id}"]`)[0].getBoundingClientRect().height;
|
||||
|
||||
expect(height('small'), 'small is the old default').to.be.closeTo(36, 1);
|
||||
expect(height('big'), 'big is taller than small').to.be.greaterThan(height('small'));
|
||||
expect($huge[0].getBoundingClientRect().height, 'huge is taller than big')
|
||||
.to.be.greaterThan(height('big'));
|
||||
});
|
||||
});
|
||||
|
||||
it('stays square while it is loading', () => {
|
||||
/*
|
||||
* A loading button swaps its glyph for a spinner sized from the button's height, and
|
||||
* the square rule fixes the width to that height -- so a spinner that did not fit
|
||||
* would either be clipped or stretch the box. Both Button and APIButton, since
|
||||
* APIButton is what actually spends time loading.
|
||||
*/
|
||||
cy.mountUI(<div>
|
||||
<Button size='xs' icon='trash' aria-label='Delete' loading data-testid='busy'/>
|
||||
<APIButton size='xs' icon='trash' loading onClick={() => {}} data-testid='busy-api'/>
|
||||
</div>);
|
||||
|
||||
cy.get('[data-testid="busy-api"]').should(() => {
|
||||
['busy', 'busy-api'].forEach((id) => {
|
||||
const box = Cypress.$(`[data-testid="${id}"]`)[0].getBoundingClientRect();
|
||||
|
||||
expect(box.height, `${id} has a height`).to.be.greaterThan(20);
|
||||
expect(box.width, `${id} is still square`).to.be.closeTo(box.height, 1);
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
it('squares an iconAfter-only button too', () => {
|
||||
// The square rule keys off the same `data-icon-only` marker as the centring, and
|
||||
// `iconAfter` alone is one of the cases that sets it.
|
||||
cy.mountUI(<Button size='xs' iconAfter='upload' aria-label='Send' data-testid='after'/>);
|
||||
|
||||
cy.get('[data-testid="after"]').should(($button) => {
|
||||
const box = $button[0].getBoundingClientRect();
|
||||
|
||||
expect(box.width, 'square').to.be.closeTo(box.height, 1);
|
||||
});
|
||||
});
|
||||
|
||||
it('is a real constraint: an APIButton with no size keeps the default it had', () => {
|
||||
/*
|
||||
* `useAPIButton` declared `size = 'medium'` as a parameter default while never using
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue