fix: expose input styling on RAC Checkbox and Radio - #10517
Conversation
snowystinger
left a comment
There was a problem hiding this comment.
Thanks for the PR. I don't think this is going to work. VisuallyHidden wraps the input in a position absolute. So anything inside it will be positioned relative to it. In addition, it has height and width of 1, so anything inside it using height/width 100% would still only be 1px.
I'd start by proving that it works in the browser using storybook, not unit tests, jsdom is a pretty bad place to test that this works.
|
@snowystinger you are right, and I verified it in a real browser. Thanks for the push to test this properly instead of relying on jsdom. I reproduced the exact
So exposing I'll rework this PR with a different approach. The real fix likely needs to change how the hidden input is laid out for these components (or how the screen reader focus ring is drawn), rather than exposing styles on the input. I'll dig into #9687 and come back with something that actually works in the browser. |
Screen readers (VoiceOver, NVDA) draw their focus indicator around the
native input element, not the visible component. In Checkbox and Radio
the input is rendered inside VisuallyHidden, which collapses it to 1x1px,
so the screen reader focus ring shows up as a tiny square disconnected
from the visual focus.
Expose inputClassName/inputStyle and visuallyHiddenClassName/visuallyHiddenStyle
on Checkbox, CheckboxField, Radio, RadioField, CheckboxButton, and RadioButton
so users can size and position both the hidden input and its VisuallyHidden
wrapper to encompass the visible component. The props follow the existing
inputRef pattern and are optional, so there is no behavior change by default.
To make the screen reader focus ring match the component, the label must be
a positioned containing block (position: relative), the VisuallyHidden wrapper
must be stretched to the label (e.g. {inset: 0, width: 'auto', height: 'auto'}),
and the input must fill the wrapper ({position: 'absolute', inset: 0, width: '100%', height: '100%'}).
This is documented on the new props.
Adds real-browser layout tests (not jsdom) that measure the hidden input's
bounding box against the component, verifying the input covers the component
rather than the viewport. This addresses the review feedback that jsdom
cannot validate layout.
Fixes adobe#9687
1de6149 to
393b02c
Compare
Why
Screen readers (VoiceOver, NVDA) draw their focus indicator around the native
<input>element, not around the visible component. In Checkbox and Radio theinput is rendered inside
VisuallyHidden, which collapses it to 1x1px(
width: 1px; height: 1px; position: absolute; clip: rect(0 0 0 0)). The resultis that the screen reader focus ring shows up as a tiny square in the corner of
the component, disconnected from the visual focus. That is confusing for users
with low vision who rely on both the visual focus cue and the assistive
technology outline.
What changed
Expose
inputClassName/inputStyleandvisuallyHiddenClassName/visuallyHiddenStyleon Checkbox, CheckboxField, Radio, RadioField, CheckboxButton, and RadioButton so
users can size and position both the hidden input and its
VisuallyHiddenwrapperto encompass the visible component, making the screen reader focus ring match the
visual one.
The props follow the existing
inputRefpattern already on these components andare optional, so there is no behavior change by default.
Usage
To make the screen reader focus ring match the component, the label must be a
positioned containing block (
position: relative), theVisuallyHiddenwrappermust be stretched to the label, and the input must fill the wrapper:
The
position: relativeon the label is required because the input isabsolutely positioned; without a positioned ancestor it would resolve against
the viewport instead of the component. This is documented on the new props.
Testing
bounding box against the component, verifying the input covers the component
rather than the viewport. This addresses the review feedback that jsdom cannot
validate layout.
check-typesandlint are clean.
Fixes #9687
Findings
While implementing this fix I found a couple of related cases that are out of scope for this PR but worth flagging:
VisuallyHiddenand collapsed to 1x1px, so it likely has the same screen reader focus indicator issue. It does not haveinputClassName/inputStyleeither. Since [Bug]: Screen reader focus indicator is misaligned for Checkbox and Radio components [react-aria-components] #9687 only mentions Checkbox and Radio, I did not expand the scope here, but Switch is a good candidate for a follow-up.VisuallyHidden. These are different cases (range input, selection, and date input respectively), but if the same fix is wanted across the library, theinputClassName/inputStylepattern could be extended consistently.Happy to follow up on Switch if the maintainers want it. Otherwise these are documented for future work.