[ Index ]

PHP Cross Reference of WordPress Trunk (Updated Daily)

Search

title

Body

[close]

/wp-includes/js/dist/script-modules/a11y/ -> index.js (summary)

(no description)

File Size: 144 lines (5 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 3 functions

  clear()
  filterMessage()
  speak()

Functions
Functions that are not part of a class:

clear()   X-Ref
Clears the a11y-speak-region elements and hides the explanatory text.


filterMessage(message)   X-Ref
Filter the message to be announced to the screenreader.

return: {string} The filtered message.
param: {string} message The message to be announced.

speak(message, ariaLive)   X-Ref
Allows you to easily announce dynamic interface updates to screen readers using ARIA live regions.
This module is inspired by the `speak` function in `wp-a11y.js`.

param: {string}               message    The message to be announced by assistive technologies.
param: {'polite'|'assertive'} [ariaLive] The politeness level for aria-live; default: 'polite'.



Generated : Thu Oct 24 08:20:01 2024 Cross-referenced by PHPXref