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

USWDS-Site - Icon: Add note about icon color contrast #2258

Merged
merged 9 commits into from
Oct 20, 2023

Conversation

amyleadem
Copy link
Contributor

@amyleadem amyleadem commented Aug 25, 2023

Summary

Added a note about checking icon color contrast.

Warning
We should update the changelog date before merging

Related issue

Closes #2224

Preview link

Icon component page

Testing and review

Confirm that the copy makes sense, conveys what we want it to, and is free from spelling and grammatical error.

@amyleadem amyleadem marked this pull request as ready for review August 25, 2023 22:38
@amycole501
Copy link

Approved as-is. However, I suggest changing the link from a generic W3C link text to instead read: 1.4.11: Non-text Contrast

Copy link

@amycole501 amycole501 left a comment

Choose a reason for hiding this comment

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

The only improvement would be to clarify exactly which WCAG success criteria we're referring to in the link text. The link itself is good and points the user to a useful page. It's not a requirement, however, just a suggestion.

@amyleadem
Copy link
Contributor Author

@amycole501 Good point! I updated the link text to reflect the title of the article. Let me know if you want any changes!

Copy link
Contributor

@mahoneycm mahoneycm left a comment

Choose a reason for hiding this comment

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

Lgtm! 👍

@mejiaj
Copy link
Contributor

mejiaj commented Sep 25, 2023

@sarah-sch would you be able to review & approve? We can merge after.

Copy link
Contributor

@sarah-sch sarah-sch left a comment

Choose a reason for hiding this comment

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

Thanks for sharing, @amyleadem! Katie and I are suggesting some tweaks.

Copy link
Contributor

Choose a reason for hiding this comment

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

Check for sufficient color contrast. Verify that the icon has a minimum contrast ratio of 3:1 against its background. See [WCAG 2.1 Techniques: Ensuring that a contrast ratio of 3:1 is provided

@amyleadem - looked at this with @finekatie and we are suggesting some tweaks to maintain USWDS's conversational, approachable style: Check for good color contrast. Make sure that the icon has a minimum contrast ratio of 3:1 against its background.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@sarah-sch @finekatie
Good improvement! I've updated the copy in c634d58. Let me know if you want any changes.

Copy link
Contributor

@sarah-sch sarah-sch left a comment

Choose a reason for hiding this comment

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

Looks good--thanks!

@amyleadem amyleadem merged commit 95c01c8 into main Oct 20, 2023
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

USWDS-Site - Feature: Add WCAG Guidance on Color Contrast for Icon Component
5 participants