fix(a11y)-1: simplify Storybook headings to avoid over-nesting while …#4395
fix(a11y)-1: simplify Storybook headings to avoid over-nesting while …#4395Sagar-6203620715 wants to merge 1 commit intokubernetes-sigs:mainfrom
Conversation
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: Sagar-6203620715 The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
ae67a0c to
741a9fb
Compare
There was a problem hiding this comment.
Pull request overview
This PR attempts to fix accessibility heading hierarchy issues in Storybook stories by adding wrapper headings (h1 and h2) around component renders. The goal is to address axe accessibility violations related to skipped heading levels.
Changes:
- Added h1 and h2 wrapper headings in three Storybook story files
- Modified Template functions to wrap components in Box with heading elements
- Imported Box component from @mui/material in all three files
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| frontend/src/components/common/ReleaseNotes/ReleaseNotesModal.stories.tsx | Wraps ReleaseNotesModal in Box with h1 "Application" and h2 "Updates" headings |
| frontend/src/components/common/ReleaseNotes/ReleaseNotes.stories.tsx | Wraps ReleaseNotes in Box with h1 "Application" and h2 "Release Information" headings |
| frontend/src/components/App/PluginSettings/PluginSettings.stories.tsx | Wraps PluginSettingsPure in Box with h1 "Settings" and h2 "Plugins" headings |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
frontend/src/components/common/ReleaseNotes/ReleaseNotesModal.stories.tsx
Show resolved
Hide resolved
illume
left a comment
There was a problem hiding this comment.
Thanks for this!
To update the snapshots you can run this.
npm run test -- -u
You can check things locally with these commands.
npm run tsc
npm run lint
npm run test
npm run format
Please check the open comments?
Signed-off-by: Sagar Choudhary <sagar6203620715@gmail.com>
741a9fb to
79e5f6a
Compare
|
hey hey. It looks like a GitHub check is failing still. I'll mark this as draft for now to make it easier on reviewers. If you want to continue it, please mark it as ready to review when you've pushed changes. |
Summary
This PR fixes an accessibility issue in Storybook by simplifying the heading structure while maintaining a valid, non-skipped heading hierarchy required by axe.
Related Issue
Partially fixes #4385
Addresses point 1 from issue #4385
Changes
PluginSettings.stories.tsxSteps to Test
Screenshots (if applicable)
N/A
Notes for the Reviewer