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 BreakoutBanner docs information on leading visual accessible label #839

Merged
merged 2 commits into from
Nov 29, 2024

Conversation

joshfarrant
Copy link
Contributor

@joshfarrant joshfarrant commented Nov 29, 2024

Summary

Updates the BreakoutBanner documentation to include information on the leading visual accessible label. As the leading visual shouldn't be used for decorative imagery (source) I think it's safe to say that an accessible label should always be provided.

You can view the updated docs here

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

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: 224db61

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.

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.

Looks great!

@joshfarrant joshfarrant merged commit e3d0a94 into main Nov 29, 2024
18 checks passed
@joshfarrant joshfarrant deleted the joshfarrant/a11y-breakout-banner-leading-visual branch November 29, 2024 16:19
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