Expand support for isElementVisible (VisuallyHidden)#77191
Merged
mirka merged 10 commits intoApr 22, 2026
Conversation
mirka
commented
Apr 9, 2026
| "@wordpress/rich-text": "file:../rich-text", | ||
| "@wordpress/style-engine": "file:../style-engine", | ||
| "@wordpress/token-list": "file:../token-list", | ||
| "@wordpress/ui": "file:../ui", |
Member
Author
There was a problem hiding this comment.
This is technically still a dev dependency, but I went ahead and added it as a normal dependency since we'll be actually using the UI components in production soon enough.
9 tasks
github-actions
Bot
added
[Package] Components
|
The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message. To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook. |
|
Size Change: -3 B (0%) Total Size: 7.75 MB 📦 View Changed
ℹ️ View Unchanged
|
|
Flaky tests detected in 1558ba2. 🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/24754615673
|
ciampo
reviewed
Apr 10, 2026
ciampo
approved these changes
Apr 21, 2026
Contributor
ciampo
left a comment
ciampo
left a comment
There was a problem hiding this comment.
LGTM 🚀
Pre-approving since remaining feedback is minor and won't need a further round of review
Comment on lines
+18
to
+19
| // @ts-expect-error - Data attribute that should stay hardcoded and not overridden by consumers. | ||
| 'data-visually-hidden': '', |
Contributor
There was a problem hiding this comment.
any consumer that spreads a data-visually-hidden (including data-visually-hidden={ undefined }) will silently blank out the attribute and defeat the detection.
Should we move these lines after restProps ?
Comment on lines
+28
to
+32
| <WCVisuallyHidden data-testid="components-visually-hidden"> | ||
| Hidden | ||
| </WCVisuallyHidden> | ||
| ); | ||
| const element = screen.getByTestId( 'components-visually-hidden' ); |
Contributor
There was a problem hiding this comment.
Nit: avoid previous classname naming scheme?
Suggested change
| <WCVisuallyHidden data-testid="components-visually-hidden"> | |
| Hidden | |
| </WCVisuallyHidden> | |
| ); | |
| const element = screen.getByTestId( 'components-visually-hidden' ); | |
| <WCVisuallyHidden data-testid="wc-visually-hidden"> | |
| Hidden | |
| </WCVisuallyHidden> | |
| ); | |
| const element = screen.getByTestId( 'wc-visually-hidden' ); |
| { className: styles[ 'visually-hidden' ] }, | ||
| { | ||
| className: styles[ 'visually-hidden' ], | ||
| // @ts-expect-error - Data attribute that should stay hardcoded and not overridden by consumers. |
Contributor
There was a problem hiding this comment.
Nit: more accurate message about the TS error
Suggested change
| // @ts-expect-error - Data attribute that should stay hardcoded and not overridden by consumers. | |
| // @ts-expect-error Arbitrary data-* attributes aren't indexable on the typed div props. Kept hardcoded so consumers can't change or remove it. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What?
Part of #76135
Expands support for the
isElementVisible()utility function in@wordpress/block-editorso any component can opt in by adding adata-visually-hiddenattribute on itself.Why?
isElementVisible()function does its best to detect element visibility, but there's a limit to that becauseVisuallyHidden-like components are intentionally designed to evade these kinds of checks so they can remain in the accessibility tree. So there used to be some special handling for theVisuallyHiddencomponent in@wordpress/components, based on its CSS class name.There are several scalability issues with this approach, because arbitrary components cannot willingly add themselves to this special handling, and also not all components have identifiable CSS classes.
I considered a few possible approaches (including trying to specifically detect a
VisuallyHidden-like pattern with more CSS-based checks), and I concluded that the best way was to change the approach from a CSS class name to a data attribute.Testing Instructions
Unit tests pass.
Use of AI Tools
To scaffold unit tests