Merge pull request #13504 from edx/waheed/ecom-5303-4188-fix-focus-on-dialog-boxes

Fixed keyboard focus remains within modal simulated dialogs.

lms/envs/common.py

@@ -1272,6 +1272,7 @@ base_application_js = [
     'js/src/utility.js',
     'js/src/logger.js',
     'js/my_courses_dropdown.js',
+    'js/dialog_tab_controls.js',
     'js/src/string_utils.js',
     'js/form.ext.js',
     'js/src/ie_shim.js',

lms/static/js/dialog_tab_controls.js

+var DialogTabControls = (function() {
+    'use strict';
+
+    var focusableChildren,
+        numElements,
+        currentIndex,
+        focusableElementSelectors = 'a, input[type=text], input[type=submit], select, textarea, button',
+        setCurrentIndex = function(currentElement) {
+            var elementIndex = focusableChildren.index(currentElement);
+            if (elementIndex >= 0) {
+                currentIndex = elementIndex;
+            }
+        },
+        initializeTabKeyValues = function(elementName, $closeButton) {
+            focusableChildren = $(elementName).find(focusableElementSelectors);
+            if ($closeButton) {
+                focusableChildren = focusableChildren.add($closeButton);
+            }
+            numElements = focusableChildren.length;
+            currentIndex = 0;
+            focusableChildren[currentIndex].focus();
+            focusableChildren.on('click', function() {
+                setCurrentIndex(this);
+            });
+        },
+        focusElement = function() {
+            var focusableElement = focusableChildren[currentIndex];
+            if (focusableElement) {
+                focusableElement.focus();
+            }
+        },
+        focusPrevious = function() {
+            currentIndex--;
+            if (currentIndex < 0) {
+                currentIndex = numElements - 1;
+            }
+
+            focusElement();
+        },
+        focusNext = function() {
+            currentIndex++;
+            if (currentIndex >= numElements) {
+                currentIndex = 0;
+            }
+
+            focusElement();
+        },
+        setKeydownListener = function($element, $closeButton) {
+            $element.on('keydown', function(e) {
+                var keyCode = e.keyCode || e.which,
+                    escapeKeyCode = 27,
+                    tabKeyCode = 9;
+                if (keyCode === escapeKeyCode) {
+                    e.preventDefault();
+                    if ($closeButton) {
+                        $closeButton.click();
+                    }
+                }
+                if (keyCode === tabKeyCode && e.shiftKey) {
+                    e.preventDefault();
+                    focusPrevious();
+                } else if (keyCode === tabKeyCode) {
+                    e.preventDefault();
+                    focusNext();
+                }
+            });
+        };
+
+    return {
+        initializeTabKeyValues: initializeTabKeyValues,
+        setKeydownListener: setKeydownListener
+    };
+}());

lms/static/sass/course/courseware/_courseware.scss

@@ -561,6 +561,14 @@ html.video-fullscreen {
       }
     }
 
+    section.xqa-modal, section.staff-modal, section.history-modal {
+        width: 80%;
+        height: 80%;
+        left: left(20%);
+        overflow: auto;
+        display: none;
+    }
+
     div.staff_info {
       display: none;
       @include clearfix();

lms/static/sass/partials/base/_variables.scss

@@ -380,7 +380,7 @@ $body-line-height: golden-ratio(.875em, 1) !default;
 $base-font-color: rgb(60,60,60) !default;
 $baseFontColor: $base-font-color;
 
-$lighter-base-font-color: rgb(100,100,100) $base-font-color;
+$lighter-base-font-color: rgb(100,100,100) !default;
 $very-light-text: rgb(255,255,255) !default;
 $text-color: rgb(51, 51, 51) !default;
 

lms/templates/courseware/xqa_interface.html

@@ -5,11 +5,19 @@
 <script type="text/javascript">
 
 function setup_debug(element_id, edit_link, staff_context){
-    $('#' + element_id + '_trig').leanModal();
-    $('#' + element_id + '_xqa_log').leanModal();
+    var staffDebugTrigger = $('#' + element_id + '_trig'),
+        xqaLogTrigger = $('#' + element_id + '_xqa_log'),
+        historyTrigger = $("#" + element_id + "_history_trig"),
+        debugModalSelector = '#' + element_id + '_debug',
+        historyModalSelector = '#' + element_id + '_history',
+        xqaModalSelector = '#' + element_id + '_xqa-modal',
+        leanOverlaySelector = $('#lean_overlay');
+
+    staffDebugTrigger.leanModal();
+    xqaLogTrigger.leanModal();
     $('#' + element_id + '_xqa_form').submit(function () {sendlog(element_id, edit_link, staff_context);});
 
-    $("#" + element_id + "_history_trig").leanModal();
+    historyTrigger.leanModal();
 
     $('#' + element_id + '_history_form').submit(
         function () {
@@ -21,6 +29,31 @@ function setup_debug(element_id, edit_link, staff_context){
             return false;
         }
     );
+
+    DialogTabControls.setKeydownListener($(debugModalSelector), leanOverlaySelector);
+    DialogTabControls.setKeydownListener($(historyModalSelector), leanOverlaySelector);
+    DialogTabControls.setKeydownListener($(xqaModalSelector), leanOverlaySelector);
+
+    staffDebugTrigger.on('click', function() {
+        DialogTabControls.initializeTabKeyValues(debugModalSelector);
+        $(debugModalSelector).attr("aria-hidden", "false");
+    });
+
+    historyTrigger.on('click', function() {
+        DialogTabControls.initializeTabKeyValues(historyModalSelector);
+        $(historyModalSelector).attr("aria-hidden", "false");
+    });
+
+    xqaLogTrigger.on('click', function() {
+        DialogTabControls.initializeTabKeyValues(xqaModalSelector);
+        $(xqaModalSelector).attr("aria-hidden", "false");
+    });
+
+    leanOverlaySelector.click(function () {
+        $(xqaModalSelector).attr("aria-hidden", "true");
+        $(historyModalSelector).attr("aria-hidden", "true");
+        $(debugModalSelector).attr("aria-hidden", "true");
+      })
 }
 
 function sendlog(element_id, edit_link, staff_context){

lms/templates/staff_problem_info.html

@@ -31,7 +31,7 @@ ${block_content}
 </div>
 %  endif
 
-<section aria-hidden="true" id="${element_id}_xqa-modal" class="modal xqa-modal" style="width:80%; left:20%; height:80%; overflow:auto" >
+<section aria-hidden="true" role="dialog" tabindex="-1" id="${element_id}_xqa-modal" class="modal xqa-modal">
   <div class="inner-wrapper">
     <header>
       <h2>${_("{platform_name} Content Quality Assessment").format(platform_name=settings.PLATFORM_NAME)}</h2>
@@ -39,7 +39,7 @@ ${block_content}
 
     <form id="${element_id}_xqa_form" class="xqa_form">
       <label for="${element_id}_xqa_entry">${_("Comment")}</label>
-      <input id="${element_id}_xqa_entry" type="text" placeholder="${_('comment')}">
+      <input tabindex="0" id="${element_id}_xqa_entry" type="text" placeholder="${_('comment')}">
       <label for="${element_id}_xqa_tag">${_("Tag")}</label>
       <span style="color:black;vertical-align: -10pt">${_('Optional tag (eg "done" or "broken"):') + '&nbsp; '}      </span>
       <input id="${element_id}_xqa_tag" type="text" placeholder="${_('tag')}" style="width:80px;display:inline">
@@ -53,8 +53,8 @@ ${block_content}
   </div>
 </section>
 
-<section aria-hidden="true" class="modal staff-modal" id="${element_id}_debug" style="width:80%; left:20%; height:80%; overflow:auto; display:none" >
-  <div class="inner-wrapper" style="color:black">
+<section aria-hidden="true" role="dialog" tabindex="-1" class="modal staff-modal" id="${element_id}_debug" >
+  <div class="inner-wrapper">
     <header>
       <h2>${_('Staff Debug')}</h2>
     </header>
@@ -64,7 +64,7 @@ ${block_content}
       <h3>${_('Actions')}</h3>
       <div>
         <label for="sd_fu_${location.name | h}">${_('Username')}:</label>
-        <input type="text" id="sd_fu_${location.name | h}" placeholder="${user.username}"/>
+        <input type="text" tabindex="0" id="sd_fu_${location.name | h}" placeholder="${user.username}"/>
       </div>
       <div data-location="${location | h}" data-location-name="${location.name | h}">
         [
@@ -108,14 +108,14 @@ category = ${category | h}
   </div>
 </section>
 
-<section aria-hidden="true" class="modal history-modal" id="${element_id}_history" style="width:80%; left:20%; height:80%; overflow:auto;" >
-  <div class="inner-wrapper" style="color:black">
+<section aria-hidden="true" role="dialog" tabindex="-1" class="modal history-modal" id="${element_id}_history">
+  <div class="inner-wrapper">
     <header>
       <h2>${_("Submission History Viewer")}</h2>
     </header>
     <form id="${element_id}_history_form">
       <label for="${element_id}_history_student_username">${_("User:")}</label>
-      <input id="${element_id}_history_student_username" type="text" placeholder=""/>
+      <input tabindex="0" id="${element_id}_history_student_username" type="text" placeholder=""/>
       <input type="hidden" id="${element_id}_history_location" value="${location | h}"/>
       <div class="submit">
         <button name="submit" type="submit">${_("View History")}</button>