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

Update Breadcrumbs component docs to add text length accessibility recommendation #840

Merged
merged 7 commits into from
Dec 2, 2024

Conversation

joshfarrant
Copy link
Contributor

@joshfarrant joshfarrant commented Nov 29, 2024

Summary

Updates the Breadcrumbs component's docs to add a recommendation about the maximum length of individual items based on the Accessibility Audit Guide — 1.4.10 Reflow guidance.

What should reviewers focus on?

  • Check you're happy with the images and the updated copy

Supporting resources (related issues, external links, etc):

Contributor checklist:

  • All new and existing CI checks pass
  • Tests prove that the feature works and covers both happy and unhappy paths
  • Any drop in coverage, breaking changes or regressions have been documented above
  • UI Changes contain new visual snapshots (generated by adding update snapshots label to the PR)
  • All developer debugging and non-functional logging has been removed
  • Related issues have been referenced in the PR description

Reviewer checklist:

  • Check that pull request and proposed changes adhere to our contribution guidelines and code of conduct
  • Check that tests prove the feature works and covers both happy and unhappy paths
  • Check that there aren't other open Pull Requests for the same update/change

Copy link

changeset-bot bot commented Nov 29, 2024

⚠️ No Changeset found

Latest commit: bedda05

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

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

Copy link
Contributor

github-actions bot commented Nov 29, 2024

🟢 No design token changes found

Copy link
Contributor

github-actions bot commented Nov 29, 2024

🟢 No visual differences found

Our visual comparison tests did not find any differences in the UI.

@joshfarrant joshfarrant changed the title Modified the Breadcrumbs component to wrap long breadcrumbs onto multiple lines. Update Breadcrumbs component docs to add text length accessibility recommendation Dec 2, 2024
Copy link
Collaborator

@rezrah rezrah left a comment

Choose a reason for hiding this comment

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

Nice, thanks @joshfarrant

@joshfarrant joshfarrant merged commit c492b04 into main Dec 2, 2024
18 checks passed
@joshfarrant joshfarrant deleted the joshfarrant/a11y-breadcrumbs-reflow branch December 2, 2024 11:31
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.

2 participants