Docs: Move button in ArgsTable heading to fix screenreader announcements#32238
Merged
Conversation
|
View your CI Pipeline Execution ↗ for commit 1f4422e
☁️ Nx Cloud last updated this comment at |
valentinpalkovic
approved these changes
Aug 12, 2025
This was referenced Aug 12, 2025
Merged
ndelangen
pushed a commit
that referenced
this pull request
Aug 20, 2025
Docs: Move button in ArgsTable heading to fix screenreader announcements (cherry picked from commit e738f7b)
ndelangen
pushed a commit
that referenced
this pull request
Aug 21, 2025
Docs: Move button in ArgsTable heading to fix screenreader announcements (cherry picked from commit e738f7b)
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
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.
Addresses part 4 of #31436. Does not close.
What I did
Moved the reset controls button outside the table. Table headings should not directly contain buttons or other secondary elements, because that causes the content of these buttons to be announced on every row visit in the entire table, ruining screenreader experience.
See https://adrianroselli.com/2025/07/check-uncheck-all-in-a-table.html for examples.
Checklist for Contributors
Testing
As far as I know, this wasn't covered by tests. Adding screenreader announcement tests would be rather difficult, this is typically manually tested.
The changes in this PR are covered in the following automated tests:
Manual testing
nextin another foldernext, and navigate inside the table cells; notice how "reset controls" keeps bieng repeatedDocumentation
N/A
Checklist for Maintainers
When this PR is ready for testing, make sure to add
ci:normal,ci:mergedorci:dailyGH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found incode/lib/cli-storybook/src/sandbox-templates.tsMake sure this PR contains one of the labels below:
Available labels
bug: Internal changes that fixes incorrect behavior.maintenance: User-facing maintenance tasks.dependencies: Upgrading (sometimes downgrading) dependencies.build: Internal-facing build tooling & test updates. Will not show up in release changelog.cleanup: Minor cleanup style change. Will not show up in release changelog.documentation: Documentation only changes. Will not show up in release changelog.feature request: Introducing a new feature.BREAKING CHANGE: Changes that break compatibility in some way with current major version.other: Changes that don't fit in the above categories.🦋 Canary release
This PR does not have a canary release associated. You can request a canary release of this pull request by mentioning the
@storybookjs/coreteam here.core team members can create a canary release here or locally with
gh workflow run --repo storybookjs/storybook canary-release-pr.yml --field pr=<PR_NUMBER>Greptile Summary
This PR addresses a critical accessibility issue in the ArgsTable component by relocating the "Reset controls" button from inside the table header to outside the table structure. The change prevents screen readers from announcing "reset controls" on every cell visit throughout the table, which was creating a poor user experience for assistive technology users.
The implementation uses absolute positioning to maintain the visual appearance while solving the accessibility problem. The button is now wrapped in
TablePositionWrapperandButtonPositionWrapperstyled components that position it absolutely outside the table structure. The table header has been simplified to contain only semantic text ("Control") rather than the previous complex structure with an embedded button.This change aligns with web accessibility best practices that recommend keeping table headers semantic and free of interactive elements. The ArgsTable component is a core part of Storybook's documentation system, used to display component properties and controls, making this accessibility improvement particularly valuable for developers using assistive technologies to navigate Storybook documentation.
Confidence score: 4/5