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 accessility of the SideNavigation's primary links #2725

Merged
merged 2 commits into from
Oct 17, 2024

Conversation

connor-baer
Copy link
Member

Purpose

The SideNavigation's primary links accept an isExternal prop to render an arrow icon to indicate that the link leads to an external page or opens in a new tab and a badge prop to indicate that new or important content is available at the target page. The icon and badge lack alternative text to make them accessible to visually impaired users.

Approach and changes

  • Added an externalLabel prop to describe to visually impaired users that the link leads to an external page or opens in a new tab.
  • Extended the badge prop to accept an object with a custom badge color and a label for visually impaired users.

Definition of done

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

@connor-baer connor-baer requested a review from a team as a code owner October 17, 2024 10:38
@connor-baer connor-baer requested a review from sirineJ October 17, 2024 10:38
Copy link

changeset-bot bot commented Oct 17, 2024

🦋 Changeset detected

Latest commit: e9dff80

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

This PR includes changesets to release 2 packages
Name Type
@sumup/circuit-ui Minor
@sumup/eslint-plugin-circuit-ui Major

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 Oct 17, 2024

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 Oct 17, 2024 10:40am

Copy link

codecov bot commented Oct 17, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 86.83%. Comparing base (db7cac5) to head (e9dff80).
Report is 2 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main    #2725      +/-   ##
==========================================
+ Coverage   86.75%   86.83%   +0.07%     
==========================================
  Files         210      210              
  Lines       12065    12100      +35     
  Branches     1524     1534      +10     
==========================================
+ Hits        10467    10507      +40     
+ Misses       1545     1540       -5     
  Partials       53       53              
Files with missing lines Coverage Δ
...eNavigation/components/PrimaryLink/PrimaryLink.tsx 100.00% <100.00%> (+10.41%) ⬆️
...ages/circuit-ui/components/SideNavigation/types.ts 0.00% <ø> (ø)

Copy link
Contributor

@sirineJ sirineJ left a comment

Choose a reason for hiding this comment

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

👏

@connor-baer connor-baer merged commit 3830252 into main Oct 17, 2024
13 of 14 checks passed
@connor-baer connor-baer deleted the feature/primary-badge branch October 17, 2024 12:06
@connor-baer connor-baer mentioned this pull request Oct 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants