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

docs: add a title example to icon component page #2754

Closed
wants to merge 1 commit into from

Conversation

shleewhite
Copy link
Contributor

📌 Summary

I noticed that there is no example for adding an accessible name to an icon on the icon component page. I think it would be useful to surface this information more visibly to consumers.

📸 Screenshots

Screenshot 2025-03-07 at 12 02 02 PM

💬 Please consider using conventional comments when reviewing this PR.

@shleewhite shleewhite requested review from a team as code owners March 7, 2025 17:02
Copy link

vercel bot commented Mar 7, 2025

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

Name Status Preview Updated (UTC)
hds-showcase ✅ Ready (Inspect) Visit Preview Mar 7, 2025 5:03pm
hds-website ✅ Ready (Inspect) Visit Preview Mar 7, 2025 5:03pm

@hashibot-hds hashibot-hds added the docs-website Content updates to the documentation website label Mar 7, 2025
Copy link
Contributor

@MelSumner MelSumner left a comment

Choose a reason for hiding this comment

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

This is on purpose. Icons have aria-hidden="true" on them by default.

An icon is not supposed to be used alone in our design system. It should be used in an another context and that context is supposed to provide the accessible name.

@shleewhite shleewhite closed this Mar 11, 2025
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants