IconTile documentation update
#2514
Draft
+13
−2
Conversation
This file contains 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
Updated guidelines around better usability when other interactive elements like the secondary button is near.
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
majedelass
reviewed
Oct 21, 2024
website/docs/components/icon-tile/partials/guidelines/guidelines.md
Outdated
Show resolved
Hide resolved
website/docs/components/icon-tile/partials/guidelines/guidelines.md
Outdated
Show resolved
Hide resolved
Co-authored-by: Majed <[email protected]>
andgen404
changed the title
IconTile documentation updateHDSIconTile documentation update
jorytindall
reviewed
Oct 21, 2024
There was a problem hiding this comment.
One small note, probably brings up some larger questions though. I'll also through out that the example used is also referenced in the Table content documentation. Not necessarily a problem, just noting the overlap, or maybe there's another example that could be used?
website/docs/components/icon-tile/partials/guidelines/guidelines.md
Outdated
Show resolved
Hide resolved
Co-authored-by: Jory Tindall <[email protected]>
alex-ju
changed the title
HDSIconTile documentation updateIconTile documentation update
andgen404
commented
Oct 23, 2024
website/docs/components/icon-tile/partials/guidelines/guidelines.md
Outdated
Show resolved
Hide resolved
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.
An accessibility audit of the HVS application revealed confusion between interactive elements (like buttons) and non-interactive Icon Tiles. To address this, it is recommended that the Icon Tile documentation be updated with guidance on ensuring clear visual distinction and avoiding placement of Icon Tiles near buttons or other interactive elements.
📌 Summary
If merged, this PR will update
IconTiledocumentation with guidance on avoiding placement near interactive elements to improve distinguishability and accessibility.Link to Documentation ---------> https://hds-website-git-icontile-documentation-update-hashicorp.vercel.app/components/icon-tile#near-interactive-elements
📸 Screenshots
🔗 External links
Jira ticket: HDS-3586