Skip to content

[a11y] EuiScreenReaderLive component#5567

Merged
thompsongl merged 11 commits intoelastic:mainfrom
thompsongl:3733-screenreaderstatus
Jan 31, 2022
Merged

[a11y] EuiScreenReaderLive component#5567
thompsongl merged 11 commits intoelastic:mainfrom
thompsongl:3733-screenreaderstatus

Conversation

@thompsongl
Copy link
Copy Markdown
Contributor

@thompsongl thompsongl commented Jan 26, 2022 •
edited
Loading

Summary

Adds a new component originally proposed in #5157: EuiScreenReaderLive

Uses a dual aria-live regions to allow screen readers to announce content updates in a timely and non-intrusive manner.

Checklist

  • Check against all themes for compatibility in both light and dark modes
  • Checked in mobile
  • Checked in Chrome, Safari, Edge, and Firefox
  • Props have proper autodocs and playground toggles
  • Added documentation
  • Checked Code Sandbox works for any docs examples
  • Added or updated jest and cypress tests
  • Checked for breaking changes and labeled appropriately
  • Checked for accessibility including keyboard-only and screenreader modes
  • A changelog entry exists and is marked appropriately

@kibanamachine
Copy link
Copy Markdown

kibanamachine commented Jan 26, 2022

Preview documentation changes for this PR: https://eui.elastic.co/pr_5567/

@thompsongl thompsongl marked this pull request as ready for review January 27, 2022 20:44
@kibanamachine
Copy link
Copy Markdown

kibanamachine commented Jan 27, 2022

Preview documentation changes for this PR: https://eui.elastic.co/pr_5567/

This was referenced Jan 28, 2022
Merged
Merged
1Copenut
1Copenut approved these changes Jan 28, 2022
View reviewed changes
Copy link
Copy Markdown
Contributor

@1Copenut 1Copenut left a comment

Choose a reason for hiding this comment

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

👏 LGTM! This is a great PR. Easy to reason about and test.

The only thing I could think to add might be a link to the MDN docs for roles with implicit live regions ( https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/ARIA_Live_Regions#roles_with_implicit_live_region_attributes ) to help devs make informed decisions if they go away from the default role. Maybe not our purview, so use or reject as you feel appropriate.

@kibanamachine
Copy link
Copy Markdown

kibanamachine commented Jan 28, 2022

Preview documentation changes for this PR: https://eui.elastic.co/pr_5567/

cee-chen
cee-chen reviewed Jan 28, 2022
View reviewed changes
cee-chen
cee-chen approved these changes Jan 31, 2022
View reviewed changes
Copy link
Copy Markdown
Contributor

@cee-chen cee-chen left a comment

Choose a reason for hiding this comment

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

Super appreciate the new documentation tips/resources, I'm sure our devs will as well!!

@kibanamachine
Copy link
Copy Markdown

kibanamachine commented Jan 31, 2022

Preview documentation changes for this PR: https://eui.elastic.co/pr_5567/

@thompsongl thompsongl enabled auto-merge (squash) January 31, 2022 17:39
@thompsongl thompsongl merged commit 6ae51e7 into elastic:main Jan 31, 2022
@thompsongl thompsongl mentioned this pull request Jan 31, 2022
Merged
@breehall breehall mentioned this pull request Feb 8, 2022
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

2 more reviewers

@1Copenut 1Copenut 1Copenut approved these changes

@cee-chen cee-chen cee-chen approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@thompsongl @kibanamachine @cee-chen @1Copenut