tinymce.dom.AriaAnnouncer

Page-wide aria-live announcer used to send messages to screen readers without shifting focus. Messages are appended as child divs to one of two persistent live regions, polite or assertive (both aria-atomic="false", aria-relevant="additions"), so each child is announced independently as it is added. Earlier messages remain in the DOM and are not re-read. Each message is removed after a delay long enough for screen readers to have picked up the mutation, keeping the regions bounded over long sessions. The polite and assertive regions differ only in their aria-live politeness: assertive announcements interrupt the screen reader’s current speech, while polite ones wait for it to finish.

Summary

Methods

Name Summary Defined by

announce()

Announces a message to screen readers via an aria-live region, without shifting focus.

AriaAnnouncer

Methods

announce()

announce(message: String, options: Object, options.assertive: Boolean)

Announces a message to screen readers via an aria-live region, without shifting focus.

Examples

tinymce.dom.AriaAnnouncer.announce('Bold on');
tinymce.dom.AriaAnnouncer.announce('Error occurred', { assertive: true });

Parameters

  • message (String) - The message to announce to screen readers.

  • options (Object) - Optional settings.

  • options.assertive (Boolean) - If true, uses aria-live="assertive" instead of polite.