PHPXRef 0.7.1 : WordPress : Detail view of a11y.js

(no description)

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

Defines 6 functions

  addIntroText()
  addContainer()
  clear()
  filterMessage()
  setup()
  speak()

Functions

Functions that are not part of a class:

addIntroText() X-Ref

No description

addContainer() X-Ref

Build the live regions markup.

return: {HTMLDivElement} The ARIA live region HTML element.
param: {string} [ariaLive] Value for the 'aria-live' attribute; default: 'polite'.

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.

setup() X-Ref

Create the live regions.

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: {string} [ariaLive] The politeness level for aria-live; default: 'polite'.

PHP Cross Reference of WordPress

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

Defines 6 functions