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: Add icon accessibility tests page #2518

Merged
merged 12 commits into from
Mar 21, 2024
Merged

Conversation

amyleadem
Copy link
Contributor

@amyleadem amyleadem commented Mar 6, 2024

Summary

Added icon accessibility test page.

Note

These tests for this component are all marked as conditional. This is because there are different methods for including an icon on a page, each with different levels of accessibility. This variability made the icon tests feel different from the other components in the system, and the team felt like there should be extra emphasis on testing icon implementation in each project.

The team drafted a sample explanation that we can include on the page, if desired. It is not included on the page yet, but we can work to include something like this now or as a quick follow-on:

Icons can be decorative or functional. How you check an icon for compliance depends on how it's used. This is why the the checks below are marked as conditional. Our icon library is accessible to 2.1 AA standards. Follow the checks below to determine if your use of an icon passes each success criteria.

Important

We need to confirm the changelog dates before merge.

Resources

Related issue

Closes #2535

Preview link

Testing and review

  1. Confirm that both the main component page and the accessibility tests page has the correct compliance tag at the top.
  2. Confirm that the main component page links to the accessibility tests page in the side navigation.
  3. Confirm that the main component page links to the accessibility tests page in the accessibility section.
    1. Confirm that this text references the correct component. For example "Test the icon in your own project."
  4. Check that accessibility tests page provides the correct counts for each test status type.
  5. Confirm the test checklist summaries and data are accurate.
  6. Confirm no visual issues.
  7. Confirm there is an appropriate changelog entry on both the main component page and the accessibility tests page.

@sarah-sch
Copy link
Contributor

Adding @finekatie and me as reviewers on this PR.

Copy link
Contributor Author

@amyleadem amyleadem left a comment

Choose a reason for hiding this comment

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

@amycole501 @alex-hull @finekatie @sarah-sch

I've added some comments about the content for these checklist items. Happy to meet up to discuss if that is simpler!

_data/accessibility-tests/icon.yml Outdated Show resolved Hide resolved
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Note

I did a first pass at the summary elements here because I didn't see them in the spreadsheet. I've also added these summaries to Column L in the spreadsheet.

If a test for the same WCAG criterion was already added to an existing accessibility tests page, I tried to match the language and sentence structure whenever possible. For example, "Color is not the only method used to convey icon information." here matches the structure of "Color is not the only method used to indicate links." on the link accessibility tests page.

Please feel free to provide suggestions for alternative summaries!

- summary: Icons meet color contrast requirements.
summary_additional: |
When you view the icon on a webpage
and use ANDI or color contrast analyzer to look at the hex colors,
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Note

I added this line about ANDI/color analyzer because we added it on the button tests page. Let me know if I should remove it.

_data/accessibility-tests/icon.yml Outdated Show resolved Hide resolved
_data/accessibility-tests/icon.yml Show resolved Hide resolved
_data/accessibility-tests/icon.yml Outdated Show resolved Hide resolved
_data/accessibility-tests/icon.yml Outdated Show resolved Hide resolved
_data/accessibility-tests/icon.yml Outdated Show resolved Hide resolved
_data/accessibility-tests/icon.yml Outdated Show resolved Hide resolved
@amyleadem amyleadem changed the title USWDS-Site: Add icon checklist USWDS-Site: Add icon accessibility tests page Mar 19, 2024
@amyleadem
Copy link
Contributor Author

@sarah-sch @finekatie @amycole501 @alex-hull
I have incorporated the changes discussed in our conversation yesterday and this is ready for review. I've added a couple of comments in purple to Column L of the checklist spreadsheet highlighting items I didn't include on the page at this time. Please review any open comments in the issue above and let me know if you need any changes.

@amyleadem amyleadem marked this pull request as ready for review March 19, 2024 23:47
@alex-hull
Copy link

@amyleadem Did we plan to not add the little blurb about why these items are marked as conditional? I feel like there will be questions related to that, so we would maybe need to add it in at some point.

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.

Along with my in-line suggestions, please change the text above the table (at top of page) to read as follows: "The USWDS team did five tests based on WCAG 2.1 AA success criteria." (Spell out five instead of using a numeral because it's less than 10.)

_data/accessibility-tests/icon.yml Outdated Show resolved Hide resolved
_data/accessibility-tests/icon.yml Outdated Show resolved Hide resolved
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.

I like Sarah's comments; the page looks good to me.

@amyleadem
Copy link
Contributor Author

@sarah-sch Your requested updates should now be live. Let me know if you need any more 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 to publish as an MVP after fed review

@amyleadem
Copy link
Contributor Author

@thisisdano @annepetersen This is ready for your review. FYI - I am able to get pa11y tests to pass locally, but they are still crashing here. Going to keep trying to get them to pass here 🏄

@thisisdano
Copy link
Member

Merging over crashing pa11y test

@thisisdano thisisdano merged commit b8ca391 into main Mar 21, 2024
9 of 11 checks passed
@thisisdano thisisdano deleted the al-icon-checklist branch March 21, 2024 04:41
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.

CC a11y: publish Icon checklist - create PR
6 participants