canvas-kit icon indicating copy to clipboard operation
canvas-kit copied to clipboard

docs: Adding new examples of new AriaLiveRegion component

Open williamjstanton opened this issue 1 year ago • 1 comments

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

Release Note

Optional release note message. Changelog and release summaries will contain a pull request title. This section will add additional notes under that title. This section is not a summary, but something extra to point out in release notes. An example might be calling out breaking changes in a labs component or minor visual changes that need visual regression updates. Remove this section if no additional release notes are required.

Checklist

  • [ ] MDX documentation adheres to Canvas Kit's Documentation Guidelines
  • [ ] Label ready for review has been added to PR

For the Reviewer

  • [ ] PR title is short and descriptive
  • [ ] PR summary describes the change (Fixes/Resolves linked correctly)
  • [ ] PR Release Notes describes additional information useful to call out in a release message or removed if not applicable
  • [ ] Breaking Changes provides useful information to upgrade to this code or removed if not applicable

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
  • [ ] Testing
  • [ ] Codemods

Testing Manually

Screenshots or GIFs (if applicable)

No changes to components.

Thank You Gif (optional)

williamjstanton avatar Apr 02 '24 15:04 williamjstanton

Passing run #7160 ↗︎

0 970 3 0 Flakiness 0

Details:

Merge ab8af16a0ea44ffd378a655e86fa6fccf18cf8a7 into 4f3249fc9c39711f63c21317a504...
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 ↗︎

cypress[bot] avatar Apr 02 '24 16:04 cypress[bot]