sergiotarxz
/
Wordpress
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Add `assertive` capability to wp.a11y.speak(). 

Props afercia. See #32600.

git-svn-id: https://develop.svn.wordpress.org/trunk@33000 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Andrew Ozz 2015-06-30 04:34:15 +00:00
parent f27883ce42
commit 41c512a202
1 changed files with 62 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

81
src/wp-includes/js/wp-a11y.js
View File

@ -3,44 +3,87 @@ window.wp = window.wp || {};
( function ( wp, $ ) {
'use strict';
var $container;
var $containerPolite,
$containerAssertive,
role;
/**
* 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();
if ( $containerAssertive && 'assertive' === ariaLive ) {
$containerAssertive.text( message );
} else if ( $containerPolite ) {
$containerPolite.text( message );
}
}
/**
* Build the live regions markup.
*
* @since 4.3.0
*
* @param {String} id The id attribute for the live region.
* @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';
role = 'assertive' === ariaLive ? 'alert' : 'status';
var $container = $( '<div>', {
'id': 'wp-a11y-speak-' + ariaLive,
'role': role,
'aria-live': ariaLive,
'aria-relevant': 'additions text',
'aria-atomic': 'true',
'class': 'screen-reader-text wp-a11y-speak-region'
});
$( document.body ).append( $container );
return $container;
}
/**
* Clear the live regions.
*
* @since 4.3.0
*/
function clear() {
$( '.wp-a11y-speak-region' ).text( '' );
}
/**
* Initialize wp.a11y and define ARIA live notification area.
*
* @since 4.2.0
* @since 4.3.0 Added the assertive live region.
*/
$( document ).ready( function() {
$container = $( '#wp-a11y-speak' );
$containerPolite = $( '#wp-a11y-speak-polite' );
$containerAssertive = $( '#wp-a11y-speak-assertive' );
if ( ! $container.length ) {
$container = $( '<div>', {
id: 'wp-a11y-speak',
role: 'status',
'aria-live': 'polite',
'aria-relevant': 'all',
'aria-atomic': 'true',
'class': 'screen-reader-text'
} );
$( document.body ).append( $container );
if ( ! $containerPolite.length ) {
$containerPolite = addContainer( 'polite' );
}
} );
if ( ! $containerAssertive.length ) {
$containerAssertive = addContainer( 'assertive' );
}
});
wp.a11y = wp.a11y || {};
wp.a11y.speak = speak;
} )( window.wp, window.jQuery );
}( window.wp, window.jQuery ));