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

docs: update dynamic button examples to use AriaAlert #5548

Merged
merged 6 commits into from
Jan 17, 2025

Conversation

khiga8
Copy link
Contributor

@khiga8 khiga8 commented Jan 15, 2025

Closes https://github.com/github/accessibility-audits/issues/10017

Changelog

Changed

  • Added AriaAlert to ensure dynamic banner content is announced.
  • Move and rename announcement banner example to improve discoverability. I was looking for guidance on how to do announcements for React banner. From the main Primer Banner page, no storybook examples are available for announcements. After going directly to the storybook page, I found a relevant example. I think that renaming this and moving it to the features folder will help improve discoverability for this common usecase.

Rollout strategy

  • Patch release
  • Minor release
  • Major release; if selected, include a written rollout or migration plan
  • None; if selected, include a brief description as to why

Testing & Reviewing

Merge checklist

Copy link

changeset-bot bot commented Jan 15, 2025

⚠️ No Changeset found

Latest commit: 2cce5f8

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 Jan 15, 2025

size-limit report 📦

Path Size
packages/react/dist/browser.esm.js 104.22 KB (0%)
packages/react/dist/browser.umd.js 104.58 KB (0%)

@github-actions github-actions bot temporarily deployed to storybook-preview-5548 January 15, 2025 18:49 Inactive
@khiga8 khiga8 marked this pull request as ready for review January 15, 2025 19:26
@khiga8 khiga8 requested a review from a team as a code owner January 15, 2025 19:26
@khiga8 khiga8 requested a review from joshblack January 15, 2025 19:26
Copy link
Member

@joshblack joshblack 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! We could also include these in our e2e tests for vrt/axe too if that'd be helpful by updating: https://github.com/primer/react/blob/main/e2e/components/Banner.test.ts#L6

Copy link
Member

Choose a reason for hiding this comment

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

For docs updates should be good with no changeset! I can add a skip changeset label if that would help 👀

@khiga8 khiga8 added the skip changeset This change does not need a changelog label Jan 15, 2025
@github-actions github-actions bot temporarily deployed to storybook-preview-5548 January 15, 2025 19:33 Inactive
@khiga8 khiga8 force-pushed the kh-update-example-to-use-aria-alert branch from ead8595 to acd95e5 Compare January 15, 2025 19:36
@github-actions github-actions bot temporarily deployed to storybook-preview-5548 January 15, 2025 19:38 Inactive
@github-actions github-actions bot temporarily deployed to storybook-preview-5548 January 15, 2025 19:46 Inactive
@khiga8 khiga8 enabled auto-merge January 17, 2025 16:21
@khiga8 khiga8 added this pull request to the merge queue Jan 17, 2025
Merged via the queue into main with commit fb0113d Jan 17, 2025
41 of 42 checks passed
@khiga8 khiga8 deleted the kh-update-example-to-use-aria-alert branch January 17, 2025 16:40
@khiga8
Copy link
Contributor Author

khiga8 commented Jan 17, 2025

Welp, looks like AriaAlert is broken upon testing.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
skip changeset This change does not need a changelog
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants