Repository navigation
feat(banner)!: make hidden content inert and fix live region semantics - #5056
lukemorawski wants to merge 19 commits into
Conversation
MikitasK
left a comment
There was a problem hiding this comment.
looks pretty solid 👍
just a few points to address before merge:
cc2bc30 to
5181930
Compare
| <View | ||
| testID={`${testID ?? 'banner'}-icon`} | ||
| style={styles.icon} | ||
| aria-hidden={!iconAccessibilityLabel} | ||
| accessible={iconAccessibilityLabel ? true : undefined} | ||
| aria-label={iconAccessibilityLabel} | ||
| > |
There was a problem hiding this comment.
could we add role="img" when iconAccessibilityLabel is provided?
this View renders as a generic <div> on web
react native web doesn't implement accessible prop (source) and a generic element cannot have an accessible name. that's why wrapper’s aria-label isn't guaranteed to label nested image ((source)
| <View | |
| testID={`${testID ?? 'banner'}-icon`} | |
| style={styles.icon} | |
| aria-hidden={!iconAccessibilityLabel} | |
| accessible={iconAccessibilityLabel ? true : undefined} | |
| aria-label={iconAccessibilityLabel} | |
| > | |
| <View | |
| testID={`${testID ?? 'banner'}-icon`} | |
| style={styles.icon} | |
| aria-hidden={!iconAccessibilityLabel} | |
| accessible={iconAccessibilityLabel ? true : undefined} | |
| aria-label={iconAccessibilityLabel} | |
| role={iconAccessibilityLabel ? 'img' : undefined} | |
| > |
There was a problem hiding this comment.
this one was already in, just never closed it. role="img" + label only when iconAccessibilityLabel is set, otherwise hidden.
| maxFontSizeMultiplier={maxFontSizeMultiplier} | ||
| {exited ? null : ( | ||
| <Animated.View | ||
| testID={`${testID ?? 'banner'}-content`} |
There was a problem hiding this comment.
Only derive these when testID is set - the snapshots show banner-content, banner-row and banner-message on banners that were given no testID. Default test ids conflict with the user's own (#4998).
There was a problem hiding this comment.
no inner test IDs at all now, same as #5099. only the passed testID lands on the root.
| const hasLiveRegion = () => Platform.OS === 'android' || Platform.OS === 'web'; | ||
|
|
||
| // a nested <Text> would otherwise be dropped from the announcement | ||
| const extractText = (node: React.ReactNode): string => |
There was a problem hiding this comment.
child.props.children breaks on any child that doesn't render its own children, so <Banner><Message /></Banner> announces nothing on iOS. React.Children is the composition problem v6 is meant to remove (#4954) - what's the alternative here?
There was a problem hiding this comment.
yep, and it looks like it's not just iOS. Both the android and web live regions will go empty too. Checked it: zero announceForAccessibility calls on iOS, empty announcer on Android, visible text renders fine. dead silent on every platform. Thanks for bringing that up!
i see it liek that:
- add
messageAccessibilityLabel, matchingiconAccessibilityLabelin this PR - keep extraction as the default so plain text keeps working
- warn in dev when extraction is empty but children are not
React.Children stays as best effort with an opt out, not as main mechanism. but i'm happy to drop extraction entirely or park this for v6 instead. any preference?
There was a problem hiding this comment.
still there on purpose, depends on the children API question John raised below. proposal is a message: string prop, then the walk goes away.
| React.useEffect(() => { | ||
| const focused = focusedAction.current; | ||
|
|
||
| if (focused === null || focused < actionCount) { |
There was a problem hiding this comment.
focusedAction.current isn't cleared on hide - focused < actionCount returns first. Hide, then show with actions={[]}, and focus jumps to the message. The test that covers this keeps one action, so it short-circuits too.
There was a problem hiding this comment.
index tracking is gone, focus is tracked by action key and cleared on hide. added a test for your repro (hide, show again with actions={[]}) in be1e40d.
| textColor={colors.primary} | ||
| theme={theme} | ||
| {...others} | ||
| touchableRef={mergeRefs( |
There was a problem hiding this comment.
mergeRefs returns a new callback every render, so React detaches and reattaches each action ref on every commit — a consumer's touchableRef callback gets null then the node each time. Maybe try to memoize it.
There was a problem hiding this comment.
fixed, one cached ref callback per action key. it changes only when that action's touchableRef changes.
| <View | ||
| testID={`${testID ?? 'banner'}-icon`} | ||
| style={styles.icon} | ||
| aria-hidden={!iconAccessibilityLabel} | ||
| accessible={iconAccessibilityLabel ? true : undefined} | ||
| aria-label={iconAccessibilityLabel} | ||
| > |
|
Review by Claude WebA banner without actions loses its bottom spacing and the icon moves to the vertical center. Steps: render What happens: the text sits 8px above the bottom edge (it was 16px on the base branch), so the top spacing (24px) and the bottom spacing no longer match. The icon is centered on the text block instead of aligned with the first lines. What should happen: the same spacing and icon position as before, since the PR description does not list this as a change. Base branch: This PR: (via Claude, verify if it makes sense) AndroidThe same spacing and icon change for a banner without actions. Steps: the same as on web. What happens: the last line of text is 8px from the bottom edge, and the icon is centered on the text. What should happen: 16px bottom spacing, as on the base branch. (via Claude, verify if it makes sense) |
satya164
left a comment
There was a problem hiding this comment.
Review by Claude
extractText(line 38) still readschild.props.childrenthroughReact.Children.toArray, and the open thread on it waits for a decision. The project rule is to avoid the Children API and element inspection, so the extraction should go. On Android and web the live region can render{children}itself instead of a string, so it announces whatever the children render, including<Message />. iOS needs a string forannounceForAccessibilityWithOptions, so take it from an explicit prop there, such as themessageAccessibilityLabelproposed in the thread.- The branch conflicts with
maininBanner.tsx, the example, the tests and the snapshot.mainalready moved the example banner below the app bar (#5061), so the rebase should drop theonLayoutpadding and the absolute position from the example. (via Claude, verify if it makes sense)
| </Text> | ||
| </View> | ||
| </View> | ||
| {visibleActions.length ? ( |
There was a problem hiding this comment.
A banner without actions now ends 8px below the text instead of 16px. The empty actions row used to add 8px of margin, and nothing replaces it now. Multi-line messages also get the icon centered on the text because of alignItems: 'center' on body (line 537). Before, the icon sat at the top. Web and Android screenshots are in this comment.
Add 8px of bottom margin to content when there are no actions, and keep the icon at the top unless the change is intended. The PR description does not list either change. (via Claude, verify if it makes sense)
There was a problem hiding this comment.
both unintended, fixed. without actions it now renders exactly like main again (16px below the text, icon at the top), before/after screenshots on web are pixel identical.
| // and the tab order. native ignores the unknown prop | ||
| const inertProps: { inert?: boolean } = visible ? {} : { inert: true }; | ||
|
|
||
| const stacked = !row.measured || row.width < COMPACT_BREAKPOINT; |
There was a problem hiding this comment.
On wide screens the first render always stacks the actions, because row is not measured yet. The next render moves them inline. On web at 1280px wide the banner is 126px tall for 2 frames and then shrinks to 72px, so the content below it jumps on every mount.
The comment on COMPACT_BREAKPOINT cites the md3 window size class, which uses the window width. useWindowDimensions gives that value in the first render and removes the useLayout state and the extra render:
| const stacked = !row.measured || row.width < COMPACT_BREAKPOINT; | |
| const { width: windowWidth } = useWindowDimensions(); | |
| const stacked = windowWidth < COMPACT_BREAKPOINT; |
This also needs the useWindowDimensions import and drops onRowLayout. If the layout must follow the banner's own width, keep the row hidden until it is measured instead. (via Claude, verify if it makes sense)
There was a problem hiding this comment.
went with useWindowDimensions, no measuring, no jump. trade-off: a banner narrower than the window still goes inline at 600+. noted in the migration guide, ok?
| const messageFocusProps: Pick<ViewProps, 'tabIndex' | 'accessible'> = | ||
| Platform.OS === 'web' ? { tabIndex: -1 } : { accessible: true }; |
There was a problem hiding this comment.
On Android, accessible: true makes the message View focusable, so a hardware keyboard Tab stops on the message text, which is not interactive.
The focus move for a removed action also does not reach keyboard users on Android. Steps: give the banner 2 actions where the second one removes itself, Tab to it with a hardware keyboard and press Enter. Keyboard focus goes to the first focusable view on the screen (here, the message of another banner) instead of the remaining action. setAccessibilityFocus in focusNode moves screen reader focus, not keyboard focus.
Leave accessible unset on native, since the Text is already one accessibility element. Then either move keyboard focus on native too, or limit the focus handling to web, where .focus() works and findNodeHandle is not needed. (via Claude, verify if it makes sense)
There was a problem hiding this comment.
accessible is gone from the message and the live region, Android Tab skips the message now.
on focus:
- keyboard focus can't be moved from JS on native (
focus()on a View is a no-op on 0.88, iOS never firesonFocus), so no native keyboard rescue - screen readers can:
sendAccessibilityEvent(node, 'focus')after the removed action was pressed, only with a screen reader on - web uses plain
.focus()
checked on iPhone VoiceOver, S23 TalkBack and Chromium, table in the first comment.
| ]} | ||
| > | ||
| <View | ||
| testID={subTestID('row')} |
There was a problem hiding this comment.
content, row and announcer are internal wrappers, and their test IDs exist only so the tests can reach them. The reflow tests then assert flexDirection on banner-row, which is an internal style. The project test rules ask for public output instead: query the live region by role (status or alert), and the message and actions by text or their public IDs. (via Claude, verify if it makes sense)
There was a problem hiding this comment.
done, no internal test IDs. region found by role, the rest by text and role. dropped the reflow tests that read flexDirection, layout is in the video.
| <FAB | ||
| icon="alert" | ||
| style={styles.urgentFab} | ||
| onPress={() => setUrgent(!urgent)} | ||
| /> |
There was a problem hiding this comment.
This FAB has no label, so TalkBack and VoiceOver read it as an unlabelled button. This toggle exists to test screen reader output, so give it a label that also says what it does:
| <FAB | |
| icon="alert" | |
| style={styles.urgentFab} | |
| onPress={() => setUrgent(!urgent)} | |
| /> | |
| <FAB | |
| icon="alert" | |
| aria-label={urgent ? 'Make banner not urgent' : 'Make banner urgent'} | |
| style={styles.urgentFab} | |
| onPress={() => setUrgent(!urgent)} | |
| /> |
(via Claude, verify if it makes sense)
There was a problem hiding this comment.
used your wording, and labelled the eye FAB too.
|
One thing to settle while Banner is reworked: the message is still wrapped in Either Banner supports non-text children (render elements outside the Text), or we document that children are text only. #4179 tried the first on 5.x but broke Text and fragment children. Whichever way 6.0 goes, 5.x will follow. |
d347dc3 to
4c8a76f
Compare
4c8a76f to
f1100c8
Compare
|
Breaking changes (all in the migration guide)
Focus rescue, measured on the real Banner
Web uses Known gaps
Media web, only action removed, focus goes to the message: web-after-focus-rescue-only-C.webmweb, hide with focus inside, focus goes back to the opener: web-after-focus-return-on-hide.webm |
|
@satya164 re your review: rebased, animation is on Reanimated now. rest is answered in the threads. extraction stays until the children API is decided. |
|
@Doberjohn re the <Banner visible message="Payment failed." actions={actions} />
<Banner visible message="Confirm your email" content={<TextInput />} />
cost: breaking, but mechanical, and old usage becomes a type error. rich inline text in the message goes (bold, links), fallback if you don't want to break it in 6.0: keep text children, add which one? i'll do it in this PR. also: does #5016 land before this one? both touch the Banner animation. |





Motivation
A hidden
Bannerstayed mounted, so screen readers and Tab still reached it, and its live region did nothing on iOS and Android.statusby default,urgentforalert. Announced only on hidden to visible.Breaking: see the migration guide. Device results, gaps: first comment.
Related issue
Fixes #5055, part of #4990
Screenshots / Videos
web-after-focus-rescue-remove-B.webm
Test plan
Banner example, screen reader on: