Provide an API for aria-live region update announcements that module developers may leverage

Created on 12 February 2013, about 12 years ago
Updated 4 May 2025, 5 days ago

Problem/Motivation

Core has several instances of aria-live for announcing UI changes aurally.

  • ckeditor
  • edit
  • file
  • toolbar
  • user

We plan to add more instances of aria-live elements to further exposes state changes to users who interact with Drupal through audio.

Just like string translation, we don't want each individual module developing a scheme to handle audio announcements. This type of functionality should be provided as a utility through Drupal because it is a common method of building aural UIs.

Proposed resolution

We should consolidate the existing aria-live implementations into a Drupal library and provide an API.

Remaining tasks

Review the proposed patch.

User interface changes

No UI changes.

API changes

We will introduce a new API for improving accessibility of page state changes.

πŸ“Œ Task
Status

Fixed

Version

8.0 ⚰️

Component

javascript

Created by

πŸ‡ΊπŸ‡ΈUnited States jessebeach

Live updates comments and jobs are added and updated live.
  • Accessibility

    It affects the ability of people with disabilities or special needs (such as blindness or color-blindness) to use Drupal.

  • Needs backport to D7

    After being applied to the 8.x branch, it should be considered for backport to the 7.x branch. Note: This tag should generally remain even after the backport has been written, approved, and committed.

Sign in to follow issues

Comments & Activities

Not all content is available!

It's likely this issue predates Contrib.social: some issue and comment data are missing.

Production build 0.71.5 2024