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: Improve the "accessible" example of loading dots #2673

Merged

Conversation

williamjstanton
Copy link
Collaborator

@williamjstanton williamjstanton commented Apr 2, 2024

Summary

The Soap400 color for the LoadingDots component does not meet WCAG guidelines for non-text contrast while used on light background colors. For this example, I used a darker background color that allows Soap400 to meet the minimum 3:1 contrast ratio. I also added better screen reader support with the AriaLiveRegion component that both lets users know about the loading status, and when loading has completed.

Release Category

Documentation

Release Note

Accessible LoadingDots example has been updated, by changing background to a darker color that allows soap400 to meet the minimum 3:1 contrast ratio and adding better screen reader support with the AriaLiveRegion component.

Checklist

For the Reviewer

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

Where Should the Reviewer Start?

The "Accessible" example of the LoadingDots component, and the storybook mdx file.

Areas for Feedback? (optional)

  • Code
  • Documentation

Testing Manually

  1. Turn on your favorite screen reader
  2. Recommend using VoiceOver w/ Safari and NVDA w/ Chrome
  3. Activate the Start button
  4. Expecting: "Loading, please wait..."
  5. After 4 seconds, expecting: "Loading, complete"

NOTE: The term "loading" is coming from an aria-label string on the status region. The order in which "loading" is described might vary based on screen reader.

Screenshots or GIFs (if applicable)

CK LoadingDots

I used licorice300 for a background color of the LoadingDots accessible example.

@github-actions github-actions bot added the ready for review Code is ready for review label Apr 2, 2024
@williamjstanton
Copy link
Collaborator Author

This PR is not fully resolving issue #2668. This component hasn't been modified to support consumers passing in their own colors to the LoadingDots with light background colors.

Copy link

cypress bot commented Apr 2, 2024

Passing run #7196 ↗︎

0 970 3 0 Flakiness 0

Details:

Merge 00e815e into 6bedb8b...
Project: canvas-kit Commit: 2a4500cd01 ℹ️
Status: Passed Duration: 05:08 💡
Started: Apr 15, 2024 5:48 PM Ended: Apr 15, 2024 5:53 PM

Review all test suite changes for PR #2673 ↗︎

@jaclynjessup jaclynjessup added ready for review Code is ready for review and removed ready for review Code is ready for review labels Apr 3, 2024
@mannycarrera4 mannycarrera4 removed the ready for review Code is ready for review label Apr 4, 2024
RayRedGoose
RayRedGoose previously approved these changes Apr 11, 2024
Copy link
Contributor

@RayRedGoose RayRedGoose left a comment

Choose a reason for hiding this comment

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

I have small suggestions, but otherwise PR looks good

@RayRedGoose RayRedGoose added approved Code has been reviewed and approved (ship it) 10.x labels Apr 11, 2024
Co-authored-by: Raisa Primerova <48605821+RayRedGoose@users.noreply.github.com>
@NicholasBoll NicholasBoll changed the title docs: Improving the "accessible" example of loading dots docs: Improve the "accessible" example of loading dots Apr 12, 2024
@NicholasBoll NicholasBoll added the ready for review Code is ready for review label Apr 12, 2024
@RayRedGoose RayRedGoose removed the approved Code has been reviewed and approved (ship it) label Apr 12, 2024
@RayRedGoose RayRedGoose dismissed their stale review April 12, 2024 22:29

Missed createStyles in render function

Co-authored-by: Nicholas Boll <nicholas.boll@gmail.com>
Copy link
Contributor

@RayRedGoose RayRedGoose left a comment

Choose a reason for hiding this comment

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

👍

@NicholasBoll NicholasBoll added automerge and removed ready for review Code is ready for review labels Apr 15, 2024
@alanbsmith alanbsmith enabled auto-merge (squash) April 15, 2024 17:49
@alanbsmith alanbsmith merged commit c987a34 into Workday:master Apr 15, 2024
23 checks passed
@williamjstanton williamjstanton deleted the william-loading-dots-examples branch April 20, 2024 14: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.

None yet

6 participants