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: Add new examples of new AriaLiveRegion component #2672

Merged
merged 31 commits into from
Apr 12, 2024

Conversation

williamjstanton
Copy link
Collaborator

@williamjstanton williamjstanton commented Apr 2, 2024

Summary

With the release of the new AriaLiveRegion component, I wanted to build a few simple examples to introduce to developers what an ARIA live region is, and how they can be used to positively impact the accessible experience with screen readers.

Release Category

Documentation

Checklist

For the Reviewer

  • PR title is short and descriptive
  • PR summary describes the change (Fixes/Resolves linked correctly)

Where Should the Reviewer Start?

For now, I have created an AriaLiveRegion category in the Examples section of Storybook. I have 4 examples: A visible live region, a hidden live region, a filterable list with a live status, and an input field with a live inline error.

Areas for Feedback? (optional)

  • Code
  • Documentation

William Stanton added 22 commits February 12, 2024 15:46
Making smaller components for MyTasksLiveBadge and NotificationsBadge.
Focus more on the live badges of the icon buttons. GlobalHeader is just a distraction.
On the 2 different versions of live badges.
Also removed the icon buttons with live badges from the storybook.
@github-actions github-actions bot added the ready for review Code is ready for review label Apr 2, 2024

return (
<>
<Flex padding={space.s} gap={space.s} as="header">
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I was researching 3 different ways to build an icon button using Badges and live regions. I wasn't completely satisfied with any of my results, if I am honest. I didn't exactly want to throw the research away, but I didn't want to necessarily include the example in Storybook until I had something I was happy with.

Copy link

cypress bot commented Apr 2, 2024

Passing run #7160 ↗︎

0 970 3 0 Flakiness 0

Details:

Merge ab8af16 into 4f3249f...
Project: canvas-kit Commit: b2acf9dac4 ℹ️
Status: Passed Duration: 05:04 💡
Started: Apr 10, 2024 10:56 PM Ended: Apr 10, 2024 11:01 PM

Review all test suite changes for PR #2672 ↗︎

@jaclynjessup jaclynjessup added ready for review Code is ready for review and removed ready for review Code is ready for review labels Apr 2, 2024
@github-actions github-actions bot requested a review from mannycarrera4 April 2, 2024 17:44
@mannycarrera4 mannycarrera4 removed the ready for review Code is ready for review label Apr 4, 2024
@mannycarrera4 mannycarrera4 added the ready for review Code is ready for review label Apr 4, 2024
@RayRedGoose RayRedGoose dismissed their stale review April 11, 2024 16:57

Accidentally clicked approve

@NicholasBoll NicholasBoll changed the title docs: Adding new examples of new AriaLiveRegion component docs: Add new examples of new AriaLiveRegion component Apr 12, 2024
@NicholasBoll NicholasBoll added automerge and removed ready for review Code is ready for review labels Apr 12, 2024
@alanbsmith alanbsmith enabled auto-merge (squash) April 12, 2024 20:11
@alanbsmith alanbsmith disabled auto-merge April 12, 2024 20:48
@alanbsmith alanbsmith enabled auto-merge (squash) April 12, 2024 20:48
@alanbsmith alanbsmith merged commit fc96f1e into Workday:master Apr 12, 2024
17 checks passed
@williamjstanton williamjstanton deleted the william-aria-live-examples branch April 20, 2024 14:20
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.

6 participants