<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[46239] trunk/src: Accessibility: Media: Make screen readers announce the Media search results.</title>
</head>
<body>

<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt;  }
#msg dl a { font-weight: bold}
#msg dl a:link    { color:#fc3; }
#msg dl a:active  { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { white-space: pre-line; overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff  {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/46239">46239</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/46239","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>afercia</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2019-09-23 12:18:53 +0000 (Mon, 23 Sep 2019)</dd>
</dl>

<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>Accessibility: Media: Make screen readers announce the Media search results.

- adds audible messages via `wp.a11y.speak()` to announce the search results 
- removes a `keyup` event that was there only to support old browsers 
- removes `aria-modal="true"` from the media modal dialog as it prevents the ARIA live regions to be perceived by screen readers
- triggers the search only after 2 ASCII characters have been typed

Props anevins, antpb, aduth, loreleiaurora, afercia.
Fixes <a href="https://core.trac.wordpress.org/ticket/47146">#47146</a>.</pre>

<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcjsmediamodelsattachmentsjs">trunk/src/js/media/models/attachments.js</a></li>
<li><a href="#trunksrcjsmediaviewsattachmentsbrowserjs">trunk/src/js/media/views/attachments/browser.js</a></li>
<li><a href="#trunksrcjsmediaviewsfocusmanagerjs">trunk/src/js/media/views/focus-manager.js</a></li>
<li><a href="#trunksrcjsmediaviewssearchjs">trunk/src/js/media/views/search.js</a></li>
<li><a href="#trunksrcwpincludesmediatemplatephp">trunk/src/wp-includes/media-template.php</a></li>
<li><a href="#trunksrcwpincludesmediaphp">trunk/src/wp-includes/media.php</a></li>
<li><a href="#trunksrcwpincludesscriptloaderphp">trunk/src/wp-includes/script-loader.php</a></li>
</ul>

</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcjsmediamodelsattachmentsjs"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/js/media/models/attachments.js</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/js/media/models/attachments.js  2019-09-23 10:35:45 UTC (rev 46238)
+++ trunk/src/js/media/models/attachments.js    2019-09-23 12:18:53 UTC (rev 46239)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -293,6 +293,8 @@
</span><span class="cx" style="display: block; padding: 0 10px">                this.reset( [], { silent: true } );
</span><span class="cx" style="display: block; padding: 0 10px">                this.observe( attachments );
</span><span class="cx" style="display: block; padding: 0 10px"> 
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+                // Used for the search results.
+               this.trigger( 'attachments:received', this );
</ins><span class="cx" style="display: block; padding: 0 10px">                 return this;
</span><span class="cx" style="display: block; padding: 0 10px">        },
</span><span class="cx" style="display: block; padding: 0 10px">        /**
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -332,6 +334,9 @@
</span><span class="cx" style="display: block; padding: 0 10px">                        if ( this === attachments.mirroring ) {
</span><span class="cx" style="display: block; padding: 0 10px">                                deferred.resolveWith( this );
</span><span class="cx" style="display: block; padding: 0 10px">                        }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+                       // Used for the search results.
+                       attachments.trigger( 'attachments:received', this );
</ins><span class="cx" style="display: block; padding: 0 10px">                 });
</span><span class="cx" style="display: block; padding: 0 10px"> 
</span><span class="cx" style="display: block; padding: 0 10px">                return deferred.promise();
</span></span></pre></div>
<a id="trunksrcjsmediaviewsattachmentsbrowserjs"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/js/media/views/attachments/browser.js</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/js/media/views/attachments/browser.js   2019-09-23 10:35:45 UTC (rev 46238)
+++ trunk/src/js/media/views/attachments/browser.js     2019-09-23 12:18:53 UTC (rev 46239)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -83,8 +83,40 @@
</span><span class="cx" style="display: block; padding: 0 10px">                }
</span><span class="cx" style="display: block; padding: 0 10px"> 
</span><span class="cx" style="display: block; padding: 0 10px">                this.collection.on( 'add remove reset', this.updateContent, this );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+               // The non-cached or cached attachments query has completed.
+               this.collection.on( 'attachments:received', this.announceSearchResults, this );
</ins><span class="cx" style="display: block; padding: 0 10px">         },
</span><span class="cx" style="display: block; padding: 0 10px"> 
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+        /**
+        * Updates the `wp.a11y.speak()` ARIA live region with a message to communicate
+        * the number of search results to screen reader users. This function is
+        * debounced because the collection updates multiple times.
+        *
+        * @since 5.3.0
+        *
+        * @returns {void}
+        */
+       announceSearchResults: _.debounce( function() {
+               var count;
+
+               if ( this.collection.mirroring.args.s ) {
+                       count = this.collection.length;
+
+                       if ( 0 === count ) {
+                               wp.a11y.speak( l10n.noMediaTryNewSearch );
+                               return;
+                       }
+
+                       if ( this.collection.hasMore() ) {
+                               wp.a11y.speak( l10n.mediaFoundHasMoreResults.replace( '%d', count ) );
+                               return;
+                       }
+
+                       wp.a11y.speak( l10n.mediaFound.replace( '%d', count ) );
+               }
+       }, 200 ),
+
</ins><span class="cx" style="display: block; padding: 0 10px">         editSelection: function( modal ) {
</span><span class="cx" style="display: block; padding: 0 10px">                // When editing a selection, move focus to the "Return to library" button.
</span><span class="cx" style="display: block; padding: 0 10px">                modal.$( '.media-button-backToLibrary' ).focus();
</span></span></pre></div>
<a id="trunksrcjsmediaviewsfocusmanagerjs"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/js/media/views/focus-manager.js</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/js/media/views/focus-manager.js 2019-09-23 10:35:45 UTC (rev 46238)
+++ trunk/src/js/media/views/focus-manager.js   2019-09-23 12:18:53 UTC (rev 46239)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -71,8 +71,9 @@
</span><span class="cx" style="display: block; padding: 0 10px">         * provided element and other elements that should not be hidden.
</span><span class="cx" style="display: block; padding: 0 10px">         *
</span><span class="cx" style="display: block; padding: 0 10px">         * The reason why we use `aria-hidden` is that `aria-modal="true"` is buggy
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-         * in Safari 11.1 and support is spotty in other browsers. In the future we
-        * should consider to remove this helper function and only use `aria-modal="true"`.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+  * in Safari 11.1 and support is spotty in other browsers. Also, `aria-modal="true"`
+        * prevents the `wp.a11y.speak()` ARIA live regions to work as they're outside
+        * of the modal dialog and get hidden from assistive technologies.
</ins><span class="cx" style="display: block; padding: 0 10px">          *
</span><span class="cx" style="display: block; padding: 0 10px">         * @since 5.2.3
</span><span class="cx" style="display: block; padding: 0 10px">         *
</span></span></pre></div>
<a id="trunksrcjsmediaviewssearchjs"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/js/media/views/search.js</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/js/media/views/search.js        2019-09-23 10:35:45 UTC (rev 46238)
+++ trunk/src/js/media/views/search.js  2019-09-23 12:18:53 UTC (rev 46239)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -22,8 +22,7 @@
</span><span class="cx" style="display: block; padding: 0 10px">        },
</span><span class="cx" style="display: block; padding: 0 10px"> 
</span><span class="cx" style="display: block; padding: 0 10px">        events: {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-                'input':  'search',
-               'keyup':  'search'
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+         'input': 'search'
</ins><span class="cx" style="display: block; padding: 0 10px">         },
</span><span class="cx" style="display: block; padding: 0 10px"> 
</span><span class="cx" style="display: block; padding: 0 10px">        /**
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -35,12 +34,15 @@
</span><span class="cx" style="display: block; padding: 0 10px">        },
</span><span class="cx" style="display: block; padding: 0 10px"> 
</span><span class="cx" style="display: block; padding: 0 10px">        search: _.debounce( function( event ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-                if ( event.target.value ) {
-                       this.model.set( 'search', event.target.value );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+         var searchTerm = event.target.value.trim();
+
+               // Trigger the search only after 2 ASCII characters.
+               if ( searchTerm && searchTerm.length > 1 ) {
+                       this.model.set( 'search', searchTerm );
</ins><span class="cx" style="display: block; padding: 0 10px">                 } else {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-                        this.model.unset('search');
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+                 this.model.unset( 'search' );
</ins><span class="cx" style="display: block; padding: 0 10px">                 }
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-        }, 300 )
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ }, 500 )
</ins><span class="cx" style="display: block; padding: 0 10px"> });
</span><span class="cx" style="display: block; padding: 0 10px"> 
</span><span class="cx" style="display: block; padding: 0 10px"> module.exports = Search;
</span></span></pre></div>
<a id="trunksrcwpincludesmediatemplatephp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/media-template.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/media-template.php  2019-09-23 10:35:45 UTC (rev 46238)
+++ trunk/src/wp-includes/media-template.php    2019-09-23 12:18:53 UTC (rev 46239)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -187,7 +187,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 
</span><span class="cx" style="display: block; padding: 0 10px">        <?php // Template for the media modal. ?>
</span><span class="cx" style="display: block; padding: 0 10px">        <script type="text/html" id="tmpl-media-modal">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-                <div tabindex="0" class="<?php echo $class; ?>" role="dialog" aria-modal="true" aria-labelledby="media-frame-title">
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+         <div tabindex="0" class="<?php echo $class; ?>" role="dialog" aria-labelledby="media-frame-title">
</ins><span class="cx" style="display: block; padding: 0 10px">                         <# if ( data.hasCloseButton ) { #>
</span><span class="cx" style="display: block; padding: 0 10px">                                <button type="button" class="media-modal-close"><span class="media-modal-icon"><span class="screen-reader-text"><?php _e( 'Close dialog' ); ?></span></span></button>
</span><span class="cx" style="display: block; padding: 0 10px">                        <# } #>
</span></span></pre></div>
<a id="trunksrcwpincludesmediaphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/media.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/media.php   2019-09-23 10:35:45 UTC (rev 46238)
+++ trunk/src/wp-includes/media.php     2019-09-23 12:18:53 UTC (rev 46239)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3854,7 +3854,10 @@
</span><span class="cx" style="display: block; padding: 0 10px">                'filterByType'                => __( 'Filter by type' ),
</span><span class="cx" style="display: block; padding: 0 10px">                'searchMediaLabel'            => __( 'Search Media' ),
</span><span class="cx" style="display: block; padding: 0 10px">                'searchMediaPlaceholder'      => __( 'Search media items...' ), // placeholder (no ellipsis)
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-                'noMedia'                     => __( 'No media files found.' ),
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+         'mediaFound'                  => __( 'Number of media items found: %d' ),
+               'mediaFoundHasMoreResults'    => __( 'Number of media items displayed: %d. Scroll the page for more results.' ),
+               'noMedia'                     => __( 'No media items found.' ),
+               'noMediaTryNewSearch'         => __( 'No media items found. Try a different search.' ),
</ins><span class="cx" style="display: block; padding: 0 10px"> 
</span><span class="cx" style="display: block; padding: 0 10px">                // Library Details
</span><span class="cx" style="display: block; padding: 0 10px">                'attachmentDetails'           => __( 'Attachment Details' ),
</span></span></pre></div>
<a id="trunksrcwpincludesscriptloaderphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/script-loader.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/script-loader.php   2019-09-23 10:35:45 UTC (rev 46238)
+++ trunk/src/wp-includes/script-loader.php     2019-09-23 12:18:53 UTC (rev 46239)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1624,7 +1624,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 
</span><span class="cx" style="display: block; padding: 0 10px">        // To enqueue media-views or media-editor, call wp_enqueue_media().
</span><span class="cx" style="display: block; padding: 0 10px">        // Both rely on numerous settings, styles, and templates to operate correctly.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-        $scripts->add( 'media-views', "/wp-includes/js/media-views$suffix.js", array( 'utils', 'media-models', 'wp-plupload', 'jquery-ui-sortable', 'wp-mediaelement', 'wp-api-request' ), false, 1 );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $scripts->add( 'media-views', "/wp-includes/js/media-views$suffix.js", array( 'utils', 'media-models', 'wp-plupload', 'jquery-ui-sortable', 'wp-mediaelement', 'wp-api-request', 'wp-a11y' ), false, 1 );
</ins><span class="cx" style="display: block; padding: 0 10px">         $scripts->add( 'media-editor', "/wp-includes/js/media-editor$suffix.js", array( 'shortcode', 'media-views' ), false, 1 );
</span><span class="cx" style="display: block; padding: 0 10px">        $scripts->add( 'media-audiovideo', "/wp-includes/js/media-audiovideo$suffix.js", array( 'media-editor' ), false, 1 );
</span><span class="cx" style="display: block; padding: 0 10px">        $scripts->add( 'mce-view', "/wp-includes/js/mce-view$suffix.js", array( 'shortcode', 'jquery', 'media-views', 'media-audiovideo' ), false, 1 );
</span></span></pre>
</div>
</div>

</body>
</html>