X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/7f1521bf193b382565eb753043c161f4cb3fcda7..ef91a7f4f3c6468973e192335a27ec0e0faca0b5:/wp-includes/js/wp-a11y.js diff --git a/wp-includes/js/wp-a11y.js b/wp-includes/js/wp-a11y.js index ffb45b82..2507cbc2 100644 --- a/wp-includes/js/wp-a11y.js +++ b/wp-includes/js/wp-a11y.js @@ -3,44 +3,86 @@ window.wp = window.wp || {}; ( function ( wp, $ ) { 'use strict'; - var $container; + var $containerPolite, + $containerAssertive; /** * Update the ARIA live notification area text node. * * @since 4.2.0 + * @since 4.3.0 Introduced the 'ariaLive' argument. * - * @param {String} message + * @param {String} message The message to be announced by Assistive Technologies. + * @param {String} ariaLive Optional. The politeness level for aria-live. Possible values: + * polite or assertive. Default polite. */ - function speak( message ) { - if ( $container ) { - $container.text( message ); + function speak( message, ariaLive ) { + // Clear previous messages to allow repeated strings being read out. + clear(); + + // Ensure only text is sent to screen readers. + message = $( '
' ).html( message ).text(); + + if ( $containerAssertive && 'assertive' === ariaLive ) { + $containerAssertive.text( message ); + } else if ( $containerPolite ) { + $containerPolite.text( message ); } } + /** + * Build the live regions markup. + * + * @since 4.3.0 + * + * @param {String} ariaLive Optional. Value for the 'aria-live' attribute, default 'polite'. + * + * @return {Object} $container The ARIA live region jQuery object. + */ + function addContainer( ariaLive ) { + ariaLive = ariaLive || 'polite'; + + var $container = $( '