Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

SideNav - A11y improvements #2536

Merged
merged 9 commits into from
Nov 5, 2024
Merged

Conversation

KristinLBradley
Copy link
Contributor

@KristinLBradley KristinLBradley commented Oct 31, 2024

📌 Summary

If merged, this PR makes a11y related improvements to the SideNav related to List::Title headers and the ToggleButton aria properties following work done in the deprioritized AppSideNav.

🛠️ Detailed description

Implemented changes:

🔗 External links


👀 Component checklist

💬 Please consider using conventional comments when reviewing this PR.

Copy link

vercel bot commented Oct 31, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated (UTC)
hds-showcase ✅ Ready (Inspect) Visit Preview Nov 4, 2024 10:23pm
hds-website ✅ Ready (Inspect) Visit Preview Nov 4, 2024 10:23pm

Copy link
Contributor

@shleewhite shleewhite left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for porting these over!

Copy link
Member

@alex-ju alex-ju left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should check for usage of @ariaLabel in <Hds::SideNav /> in our products before removing it. If no instances are found we should update the docs as well.

A more careful approach would be to keep the @ariaLabel argument, update the getter to return this.args.ariaLabel, and deprecate it.

@KristinLBradley
Copy link
Contributor Author

@alex-ju I couldn't find uses of the ariaLabel on the Hds::SideNav when I searched but I went ahead and brought it back and deprecated it.

(Search: https://github.com/search?q=org%3Ahashicorp+%22%3CHds%3A%3ASideNav+%22&type=code)

Co-authored-by: Alex <alex-ju@users.noreply.github.com>
Copy link
Member

@alex-ju alex-ju left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looking good! 🚀

@KristinLBradley KristinLBradley merged commit fd2db83 into main Nov 5, 2024
14 checks passed
@KristinLBradley KristinLBradley deleted the sidenav-a11y-improvements branch November 5, 2024 17:22
@hashibot-hds hashibot-hds mentioned this pull request Nov 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs-website Content updates to the documentation website packages/components showcase
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants