Changeset 45866

Timestamp:

08/20/2019 10:41:02 PM (4 years ago)

Author:

SergeyBiryukov

Message:

Accessibility: Make the Media modal an ARIA modal dialog.

For a number of years, the Media modal missed an explicit ARIA role and the required attributes for modal dialogs.

This was confusing for assistive technology users, since they may not realize they're inside a dialog, and that consequently the keyboard interactions may be different from the rest of the page. Lack of an explicit label for the dialog was confusing as well, since assistive technology users didn't have an immediate sense of what the dialog is for.

This change makes the Media modal meet the ARIA Authoring Practices recommendations, helping users better understand the purpose and interactions with the modal. Also, it makes sure to hide the rest of the page content from assistive technologies, until support for aria-modal="true" improves.

Additionally:

• moves the modal H1 heading to the beginning of the modal content
• changes the modal left menu position to make visual and DOM order match
• improves the wp.media.view.FocusManager documentation

Props afercia.
Merges [45572] to the 5.2 branch.
Fixes #47145.

Location:

branches/5.2

Files:

• . (modified) (1 prop)
• src/js/media/views/focus-manager.js (modified) (3 diffs)
• src/js/media/views/modal.js (modified) (2 diffs)
• src/wp-includes/css/media-views.css (modified) (4 diffs)
• src/wp-includes/media-template.php (modified) (2 diffs)

branches/5.2/src/js/media/views/focus-manager.js

@@ -17 +17 @@
     /**
      * Moves focus to the first visible menu item in the modal.
+     *
+     * @since 3.5.0
+     *
+     * @returns {void}
      */
     focus: function() {
@@ -22 +26 @@
     },
     /**
-     * @param {Object} event
+     * Constrains navigation with the Tab key within the media view element.
+     *
+     * @since 4.0.0
+     *
+     * @param {Object} event A keydown jQuery event.
+     *
+     * @returns {void}
      */
     constrainTabbing: function( event ) {
@@ -43 +53 @@
             return false;
         }
-    }
+    },
 
+    /**
+     * Hides from assistive technologies all the body children except the
+     * provided element and other elements that should not be hidden.
+     *
+     * The reason why we use `aria-hidden` is that `aria-modal="true"` is buggy
+     * 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"`.
+     *
+     * @since 5.3.0
+     *
+     * @param {object} visibleElement The jQuery object representing the element that should not be hidden.
+     *
+     * @returns {void}
+     */
+    setAriaHiddenOnBodyChildren: function( visibleElement ) {
+        var bodyChildren,
+            self = this;
+
+        if ( this.isBodyAriaHidden ) {
+            return;
+        }
+
+        // Get all the body children.
+        bodyChildren = document.body.children;
+
+        // Loop through the body children and hide the ones that should be hidden.
+        _.each( bodyChildren, function( element ) {
+            // Don't hide the modal element.
+            if ( element === visibleElement[0] ) {
+                return;
+            }
+
+            // Determine the body children to hide.
+            if ( self.elementShouldBeHidden( element ) ) {
+                element.setAttribute( 'aria-hidden', 'true' );
+                // Store the hidden elements.
+                self.ariaHiddenElements.push( element );
+            }
+        } );
+
+        this.isBodyAriaHidden = true;
+    },
+
+    /**
+     * Makes visible again to assistive technologies all body children
+     * previously hidden and stored in this.ariaHiddenElements.
+     *
+     * @since 5.3.0
+     *
+     * @returns {void}
+     */
+    removeAriaHiddenFromBodyChildren: function() {
+        _.each( this.ariaHiddenElements, function( element ) {
+            element.removeAttribute( 'aria-hidden' );
+        } );
+
+        this.ariaHiddenElements = [];
+        this.isBodyAriaHidden   = false;
+    },
+
+    /**
+     * Determines if the passed element should not be hidden from assistive technologies.
+     *
+     * @since 5.3.0
+     *
+     * @param {object} element The DOM element that should be checked.
+     *
+     * @returns {boolean} Whether the element should not be hidden from assistive technologies.
+     */
+    elementShouldBeHidden: function( element ) {
+        var role = element.getAttribute( 'role' ),
+            liveRegionsRoles = [ 'alert', 'status', 'log', 'marquee', 'timer' ];
+
+        /*
+         * Don't hide scripts, elements that already have `aria-hidden`, and
+         * ARIA live regions.
+         */
+        return ! (
+            element.tagName === 'SCRIPT' ||
+            element.hasAttribute( 'aria-hidden' ) ||
+            element.hasAttribute( 'aria-live' ) ||
+            liveRegionsRoles.indexOf( role ) !== -1
+        );
+    },
+
+    /**
+     * Whether the body children are hidden from assistive technologies.
+     *
+     * @since 5.3.0
+     */
+    isBodyAriaHidden: false,
+
+    /**
+     * Stores an array of DOM elements that should be hidden from assistive
+     * technologies, for example when the media modal dialog opens.
+     *
+     * @since 5.3.0
+     */
+    ariaHiddenElements: []
 });
 

branches/5.2/src/js/media/views/modal.js

@@ -118 +118 @@
         this.$( '.media-modal' ).focus();
 
+        // Hide the page content from assistive technologies.
+        this.focusManager.setAriaHiddenOnBodyChildren( $el );
+
         return this.propagate('open');
     },
@@ -135 +138 @@
         // Hide modal and remove restricted media modal tab focus once it's closed
         this.$el.hide().undelegate( 'keydown' );
+
+        /*
+         * Make visible again to assistive technologies all body children that
+         * have been made hidden when the modal opened.
+         */
+        this.focusManager.removeAriaHiddenFromBodyChildren();
 
         // Put focus back in useful location once modal is closed.

branches/5.2/src/wp-includes/css/media-views.css

@@ -540 +540 @@
     bottom: 0;
     margin: 0;
-    padding: 10px 0;
+    padding: 50px 0 10px;
     background: #f3f3f3;
     border-right-width: 1px;
@@ -2562 +2562 @@
 /* Landscape specific header override */
 @media screen and (max-height: 400px) {
-    .media-menu {
-        padding: 0;
+    .media-menu,
+    .media-frame:not(.hide-menu) .media-menu {
+        top: 44px;
     }
 
@@ -2581 +2582 @@
     .embed-link-settings {
         overflow: visible;
+    }
+}
+
+@media only screen and (min-width: 901px) and (max-height: 400px) {
+    .media-menu,
+    .media-frame:not(.hide-menu) .media-menu {
+        top: 0;
+        padding-top: 44px;
     }
 }
@@ -2610 +2619 @@
     .media-frame:not(.hide-menu) .media-menu {
         top: 40px;
+        padding-top: 0;
     }
 

branches/5.2/src/wp-includes/media-template.php

@@ -186 +186 @@
     <![endif]-->
     <script type="text/html" id="tmpl-media-frame">
+        <div class="media-frame-title" id="media-frame-title"></div>
         <div class="media-frame-menu"></div>
-        <div class="media-frame-title"></div>
         <div class="media-frame-router"></div>
         <div class="media-frame-content"></div>
@@ -195 +195 @@
 
     <script type="text/html" id="tmpl-media-modal">
-        <div tabindex="0" class="<?php echo $class; ?>">
+        <div tabindex="0" class="<?php echo $class; ?>" role="dialog" aria-modal="true" aria-labelledby="media-frame-title">
             <# if ( data.hasCloseButton ) { #>
                 <button type="button" class="media-modal-close"><span class="media-modal-icon"><span class="screen-reader-text"><?php _e( 'Close dialog' ); ?></span></span></button>
             <# } #>
-            <div class="media-modal-content"></div>
+            <div class="media-modal-content" role="document"></div>
         </div>
         <div class="media-modal-backdrop"></div>