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

Improve documentation for Alert and InlineAlert concerning semantics and ARIA live #725

Open
danielck opened this issue May 16, 2023 · 0 comments

Comments

@danielck
Copy link
Contributor

The Problem

Current documentation is not clear on the differences of Alert and InlineAlert, especially regarding the semantics of the rendered HTML element and the intended use.

Proposed Solution

  1. Make it clear that Alert elements will be announced automatically by screen readers and use the role=alert role by default.
  2. Clarify that InlineAlerts do not use role=alert but are announced by screen readers by default.
  3. Clarify usage of ariaLiveMode=off for disabling ARIA live functionality when used on a non-dynamic element.

Alternative Solutions

Consider whether ariaLiveMode=off should actually remove the aria-live attribute entirely from the rendered HTML, because that is the default anyway. The intended use of aria-live="off" in the ARIA spec is to stop certain elements (e.g. close buttons) within a larger ARIA live area from being announced by screen readers.

Additional Info

https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/ARIA_Live_Regions

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant