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

Improve accessibility of navigation components #2297

Merged
merged 5 commits into from
Nov 14, 2023
Merged

Conversation

connor-baer
Copy link
Member

@connor-baer connor-baer commented Nov 14, 2023

Purpose

An accessibility audit of the navigation components revealed a large number of issues. This PR addresses issues related to the markup of the components, a separate PR will tackle focus-related issues.

Approach and changes

  • Properly hide presentational icons from the accessibility tree
  • Fix HTML validation errors in the navigation components
  • Restore the focus styles of the utility links and profile menu in the TopNavigation
  • Include the profile information in the profile menu button

Definition of done

  • Development completed
  • Reviewers assigned
  • Unit and integration tests
  • Meets minimum browser support
  • Meets accessibility requirements

Copy link

changeset-bot bot commented Nov 14, 2023

🦋 Changeset detected

Latest commit: 4f74de8

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
@sumup/circuit-ui Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

Copy link

vercel bot commented Nov 14, 2023

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

Name Status Preview Comments Updated (UTC)
oss-circuit-ui ✅ Ready (Inspect) Visit Preview 💬 Add feedback Nov 14, 2023 3:19pm

@connor-baer connor-baer added 🐞 bug Something isn't working as it should ♿ accessibility Improves usability labels Nov 14, 2023
Copy link

codecov bot commented Nov 14, 2023

Codecov Report

Merging #2297 (4f74de8) into main (c776399) will increase coverage by 0.00%.
The diff coverage is 98.11%.

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##             main    #2297   +/-   ##
=======================================
  Coverage   97.15%   97.15%           
=======================================
  Files         251      251           
  Lines       19862    19889   +27     
  Branches     1224     1225    +1     
=======================================
+ Hits        19297    19324   +27     
  Misses        551      551           
  Partials       14       14           
Files Coverage Δ
packages/circuit-ui/components/Field/Field.tsx 98.64% <100.00%> (ø)
...mponents/NotificationInline/NotificationInline.tsx 99.01% <100.00%> (ø)
...components/NotificationToast/NotificationToast.tsx 100.00% <100.00%> (ø)
packages/circuit-ui/components/Popover/Popover.tsx 99.72% <100.00%> (ø)
...components/DesktopNavigation/DesktopNavigation.tsx 100.00% <100.00%> (ø)
...ation/components/SecondaryLinks/SecondaryLinks.tsx 100.00% <100.00%> (ø)
...ponents/Sidebar/components/Separator/Separator.tsx 100.00% <100.00%> (ø)
...ckages/circuit-ui/components/Skeleton/Skeleton.tsx 100.00% <100.00%> (ø)
...cuit-ui/components/TopNavigation/TopNavigation.tsx 100.00% <100.00%> (ø)
...pNavigation/components/ProfileMenu/ProfileMenu.tsx 100.00% <100.00%> (ø)
... and 2 more

@connor-baer connor-baer marked this pull request as ready for review November 14, 2023 15:21
@connor-baer connor-baer requested a review from a team as a code owner November 14, 2023 15:21
@connor-baer connor-baer requested review from pdrmdrs and removed request for a team November 14, 2023 15:21
@connor-baer connor-baer merged commit 2f4fbaf into main Nov 14, 2023
10 checks passed
@connor-baer connor-baer deleted the fix/navigation-a11y branch November 14, 2023 16:03
@connor-baer connor-baer mentioned this pull request Nov 14, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
♿ accessibility Improves usability 🐞 bug Something isn't working as it should 🗂 circuit-ui
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant