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 tag accessibility tests page #2645

Merged
merged 8 commits into from
May 15, 2024
Merged

Conversation

amyleadem
Copy link
Contributor

@amyleadem amyleadem commented Apr 30, 2024

Summary

Added accessibility tests page for the tag component.

Note

The tag accessibility tests page does not include the tests for interactive tags that are included in the spreadsheet (Google sheets 🔒). This is because there is some ambiguity about the role of interactive tags in the design system and because we do not currently offer examples of interactive tags. Please confirm that the expected tests are included on this page.

Important

We should update changelog dates before merge.

Related issue

Closes #2526

Preview link

Ressourcen

Testing and review

  1. Confirm that both the main component page and the accessibility tests page have 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 from the accessibility guidance section.
  4. Confirm that the main component page shows the accessibility tests summary.
  5. Check that accessibility tests page provides the correct counts for each test status type.
  6. Confirm the test checklist summaries and data are accurate.
  7. Confirm no visual issues.
  8. Confirm there is an appropriate changelog entry on both the main component page and the accessibility tests page.

@amyleadem amyleadem marked this pull request as ready for review May 2, 2024 15:39
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 page as-is looks good. However, since we mention interactive tags on the primary tags page perhaps we should clarify we tested only non-interactive tags.

I'd change the first sentence on the page to read "Any USWDS non-interactive tag should pass these manual accessibility tests." or something along those lines

Copy link

@alex-hull alex-hull 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! I like what Amy said about changing the wording for interactive versus non-interactive. Wondering if it is worth pointing people into the direction of our slight guidance on this page as well. Or maybe not even having that phrasing so it is not open for discussion. But if we do change the phrasing maybe something, "For more guidance on interactive tag implementation, check out the tags usability section."

@amyleadem
Copy link
Contributor Author

amyleadem commented May 3, 2024

Changed the lead to say "Any non-interactive USWDS tag should pass these manual accessibility tests." in commit ed9e217. 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.

LGTM! Thank you, @amyleadem!

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.

Looking good! One small update for the checklist lead and the potential inclusion with another checklist item IF it doesn't delay getting this page published. 👍

_components/tag/accessibility-tests.md Outdated Show resolved Hide resolved
_data/accessibility-tests/tag.yml Outdated Show resolved Hide resolved
@amyleadem amyleadem requested a review from mahoneycm May 8, 2024 17:22
@amyleadem amyleadem requested a review from thisisdano May 8, 2024 17:46
Copy link
Member

@thisisdano thisisdano left a comment

Choose a reason for hiding this comment

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

Updating changelog dates...

_data/changelogs/component-tag-accessibility.yml Outdated Show resolved Hide resolved
_data/changelogs/component-tag.yml Outdated Show resolved Hide resolved
@thisisdano
Copy link
Member

Merging over pa11y crash

@thisisdano thisisdano merged commit 0f140fd into main May 15, 2024
8 of 11 checks passed
@thisisdano thisisdano deleted the al-a11y-tests-tag branch May 15, 2024 21:34
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 Tag checklist - create PR
6 participants