@instructure/ui-a11y-utils 8.33.2-snapshot-0 → 8.33.2

package/es/ScreenReaderFocusRegion.js

@@ -21,8 +21,8 @@
  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  * SOFTWARE.
  */
-import { logWarn as warn } from '@instructure/console';
 
+import { logWarn as warn } from '@instructure/console';
 class ScreenReaderFocusRegion {
   constructor(element) {
     let options = arguments.length > 1 && arguments[1] !== void 0 ? arguments[1] : {
@@ -36,7 +36,6 @@ class ScreenReaderFocusRegion {
     this._options = void 0;
     this._observer = null;
     this._attributes = [];
-
     this.handleDOMMutation = records => {
       records.forEach(record => {
         const addedNodes = Array.from(record.addedNodes);
@@ -48,7 +47,6 @@ class ScreenReaderFocusRegion {
           if (removedNode.tagName.toLowerCase() !== 'iframe') {
             this.restoreNode(removedNode);
           }
-
           const iframeBodies = this.parseIframeBodies(removedNode);
           iframeBodies.forEach(iframeBody => {
             this.restoreNode(iframeBody);
@@ -56,17 +54,14 @@ class ScreenReaderFocusRegion {
         });
       });
     };
-
     const liveRegion = typeof options.liveRegion === 'function' ? options.liveRegion() : options.liveRegion;
     this._liveRegion = Array.isArray(liveRegion) ? liveRegion : [liveRegion];
     this._contextElement = element;
     this._options = options;
   }
-
   updateElement(element) {
     this._contextElement = element;
   }
-
   muteNode(node) {
     if (node && node.tagName.toLowerCase() !== 'script') {
       // When we are trapping screen reader focus on an element that
@@ -79,31 +74,24 @@ class ScreenReaderFocusRegion {
       ['role', 'aria-label', 'aria-hidden' // this should never happen right?
       ].forEach(attribute => {
         const value = node.getAttribute(attribute);
-
         if (value !== null) {
           this._attributes.push([node, attribute, value]);
-
           node.removeAttribute(attribute);
         }
       });
-
       this._observer.observe(node, {
         childList: true
       });
     }
   }
-
   hideNodes(nodes) {
     nodes.forEach(node => {
       var _node$getAttribute;
-
       const ariaLive = typeof node.getAttribute === 'function' && ((_node$getAttribute = node.getAttribute('aria-live')) === null || _node$getAttribute === void 0 ? void 0 : _node$getAttribute.toLowerCase());
-
       if (node && node.nodeType === 1 && node.tagName.toLowerCase() !== 'script' && ariaLive !== 'assertive' && ariaLive !== 'polite' && this._parents.indexOf(node) === -1 && this._nodes.indexOf(node) === -1 && this._liveRegion.indexOf(node) === -1 && !this._contextElement.contains(node)) {
         if (node.tagName.toLowerCase() !== 'iframe') {
           this.hideNode(node);
         }
-
         const iframeBodies = this.parseIframeBodies(node);
         iframeBodies.forEach(iframeBody => {
           this.hideNode(iframeBody);
@@ -111,29 +99,22 @@ class ScreenReaderFocusRegion {
       }
     });
   }
-
   hideNode(node) {
     if (node.getAttribute('aria-hidden') !== 'true') {
       node.setAttribute('aria-hidden', 'true');
-
       this._nodes.push(node);
     }
   }
-
   restoreNode(removedNode) {
     const index = this._nodes.indexOf(removedNode);
-
     if (index >= 0) {
       removedNode.removeAttribute('aria-hidden');
-
       this._nodes.splice(index, 1);
     }
   }
-
   parseIframeBodies(node) {
     if (!node) return [];
     let iframes = [];
-
     if (node.tagName.toLowerCase() === 'iframe') {
       iframes.push(node);
     } else {
@@ -141,38 +122,29 @@ class ScreenReaderFocusRegion {
         iframes = Array.from(node.getElementsByTagName('iframe'));
       }
     }
-
     return iframes.map(iframe => {
       let body = null;
-
       try {
         body = iframe.contentDocument.body;
       } catch (e) {
         warn(false, `[ui-a11y] could not find a document for iframe: ${e} ${iframe}`);
       }
-
       return body;
     }).filter(body => body !== null);
   }
-
   activate() {
     if (!this._options.shouldContainFocus) {
       return;
     }
-
     this._observer = new MutationObserver(this.handleDOMMutation);
     let node = this._contextElement;
-
     while (node && node.nodeType === Node.ELEMENT_NODE && node.tagName.toLowerCase() !== 'body') {
       const parent = node.parentElement;
-
       if (parent) {
         this._parents.push(parent);
-
         this.muteNode(parent);
         this.hideNodes(Array.prototype.slice.call(parent.childNodes));
       }
-
       node = node.parentNode; // should never be null, will default to doc element
     }
   }
@@ -180,26 +152,19 @@ class ScreenReaderFocusRegion {
   deactivate() {
     if (this._observer) {
       this._observer.disconnect();
-
       this._observer = null;
     }
-
     this._nodes.forEach(node => {
       node.removeAttribute('aria-hidden');
     });
-
     this._nodes = [];
-
     this._attributes.forEach(attribute => {
       attribute[0].setAttribute(attribute[1], attribute[2] || '');
     });
-
     this._attributes = [];
     this._parents = [];
   }
-
 }
-
 export default ScreenReaderFocusRegion;
 export {
 /**

package/es/hasVisibleChildren.js

@@ -21,10 +21,10 @@
  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  * SOFTWARE.
  */
+
 import React from 'react';
 import { matchComponentTypes } from '@instructure/ui-react-utils';
 import { ScreenReaderContent } from '@instructure/ui-a11y-content';
-
 function hasVisibleChildren(children) {
   let visible = false;
   React.Children.forEach(children, child => {
@@ -34,7 +34,6 @@ function hasVisibleChildren(children) {
   });
   return visible;
 }
-
 export default hasVisibleChildren;
 export {
 /**

package/es/index.js

@@ -21,6 +21,7 @@
  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  * SOFTWARE.
  */
+
 export { FocusRegion } from './FocusRegion';
 export { FocusRegionManager } from './FocusRegionManager';
 export { hasVisibleChildren } from './hasVisibleChildren';

package/es/scopeTab.js

@@ -21,43 +21,39 @@
  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  * SOFTWARE.
  */
-import { findDOMNode, findTabbable, isActiveElement, containsActiveElement, getActiveElement } from '@instructure/ui-dom-utils';
 
+import { findDOMNode, findTabbable, isActiveElement, containsActiveElement, getActiveElement } from '@instructure/ui-dom-utils';
 function scopeTab(element, event, onLeavingFinalTabbable) {
   const node = findDOMNode(element);
   const tabbable = findTabbable(node);
-
   if (!tabbable.length) {
     event.preventDefault();
     return;
-  } // Account for a changing tabindex of the active element
-  // (a case that happens with Menu for KO a11y)
-
+  }
 
+  // Account for a changing tabindex of the active element
+  // (a case that happens with Menu for KO a11y)
   if (containsActiveElement(element)) {
     const activeElement = getActiveElement();
-
     if (activeElement && tabbable.indexOf(activeElement) === -1) {
       tabbable.push(activeElement);
     }
   }
-
   const finalTabbable = tabbable[event.shiftKey ? 0 : tabbable.length - 1];
-  const leavingFinalTabbable = isActiveElement(finalTabbable) || // handle immediate shift+tab after opening with mouse
-  isActiveElement(node) || // already left final tabbable
+  const leavingFinalTabbable = isActiveElement(finalTabbable) ||
+  // handle immediate shift+tab after opening with mouse
+  isActiveElement(node) ||
+  // already left final tabbable
   !containsActiveElement(element);
   if (!leavingFinalTabbable) return;
-
   if (typeof onLeavingFinalTabbable === 'function') {
     onLeavingFinalTabbable();
     return;
   }
-
   event.preventDefault();
   const target = tabbable[event.shiftKey ? tabbable.length - 1 : 0];
   target.focus();
 }
-
 export default scopeTab;
 export {
 /**

package/lib/FocusRegion.js

@@ -1,30 +1,19 @@
 "use strict";
 
 var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
-
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = exports.FocusRegion = void 0;
-
 var _keycode = _interopRequireDefault(require("keycode"));
-
 var _contains = require("@instructure/ui-dom-utils/lib/contains.js");
-
 var _addEventListener = require("@instructure/ui-dom-utils/lib/addEventListener.js");
-
 var _ownerDocument = require("@instructure/ui-dom-utils/lib/ownerDocument.js");
-
 var _findTabbable = require("@instructure/ui-dom-utils/lib/findTabbable.js");
-
 var _uid = require("@instructure/uid");
-
 var _console = require("@instructure/console");
-
 var _ScreenReaderFocusRegion = require("./ScreenReaderFocusRegion");
-
 var _KeyboardFocusRegion = require("./KeyboardFocusRegion");
-
 /*
  * The MIT License (MIT)
  *
@@ -48,6 +37,7 @@ var _KeyboardFocusRegion = require("./KeyboardFocusRegion");
  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  * SOFTWARE.
  */
+
 class FocusRegion {
   constructor(element, options) {
     this._contextElement = null;
@@ -58,37 +48,30 @@ class FocusRegion {
     this._id = void 0;
     this._listeners = [];
     this._active = false;
-
     this.handleDismiss = (event, documentClick) => {
       var _this$_options$onDism, _this$_options;
-
       (_this$_options$onDism = (_this$_options = this._options).onDismiss) === null || _this$_options$onDism === void 0 ? void 0 : _this$_options$onDism.call(_this$_options, event, documentClick);
     };
-
     this.captureDocumentClick = event => {
       const target = event.target;
       this._preventCloseOnDocumentClick = event.button !== 0 || (0, _contains.contains)(this._contextElement, target);
     };
-
     this.handleDocumentClick = event => {
       if (this._options.shouldCloseOnDocumentClick && !this._preventCloseOnDocumentClick) {
         this.handleDismiss(event, true);
       }
     };
-
     this.handleFrameClick = (event, frame) => {
       if (!(0, _contains.contains)(this._contextElement, frame)) {
         // dismiss if frame is not within the region
         this.handleDismiss(event, true);
       }
     };
-
     this.handleKeyUp = event => {
       if (this._options.shouldCloseOnEscape && event.keyCode === _keycode.default.codes.esc && !event.defaultPrevented) {
         this.handleDismiss(event);
       }
     };
-
     this._options = options || {
       shouldCloseOnDocumentClick: true,
       shouldCloseOnEscape: true
@@ -98,54 +81,41 @@ class FocusRegion {
     this._keyboardFocusRegion = new _KeyboardFocusRegion.KeyboardFocusRegion(element, options);
     this._id = (0, _uid.uid)();
   }
-
   updateElement(element, options) {
     this._contextElement = element;
-
     if (options) {
       this._options = options;
     }
-
     if (this._keyboardFocusRegion) {
       this._keyboardFocusRegion.updateElement(element);
     }
-
     if (this._screenReaderFocusRegion) {
       this._screenReaderFocusRegion.updateElement(element);
     }
   }
-
   get id() {
     return this._id;
-  } // Focused returns when the focus region is active. Checking focused with the active element
-  // is inconsistent across browsers (Safari/Firefox do not focus elements on click)
-
+  }
 
+  // Focused returns when the focus region is active. Checking focused with the active element
+  // is inconsistent across browsers (Safari/Firefox do not focus elements on click)
   get focused() {
     return this._active;
   }
-
   get keyboardFocusable() {
     return ((0, _findTabbable.findTabbable)(this._contextElement) || []).length > 0;
   }
-
   activate() {
     if (!this._active) {
       const doc = (0, _ownerDocument.ownerDocument)(this._contextElement);
-
       this._keyboardFocusRegion.activate();
-
       this._screenReaderFocusRegion.activate();
-
       if (this._options.shouldCloseOnDocumentClick) {
         this._listeners.push((0, _addEventListener.addEventListener)(doc, 'click', this.captureDocumentClick, true));
-
         this._listeners.push((0, _addEventListener.addEventListener)(doc, 'click', this.handleDocumentClick));
-
         Array.from(doc.getElementsByTagName('iframe')).forEach(el => {
           // listen for mouseup events on any iframes in the document
           const frameDoc = el.contentDocument;
-
           if (frameDoc) {
             this._listeners.push((0, _addEventListener.addEventListener)(frameDoc, 'mouseup', event => {
               this.handleFrameClick(event, el);
@@ -153,51 +123,37 @@ class FocusRegion {
           }
         });
       }
-
       if (this._options.shouldCloseOnEscape) {
         this._listeners.push((0, _addEventListener.addEventListener)(doc, 'keyup', this.handleKeyUp));
       }
-
       this._active = true;
     }
   }
-
   deactivate() {
     let _ref = arguments.length > 0 && arguments[0] !== void 0 ? arguments[0] : {},
-        _ref$keyboard = _ref.keyboard,
-        keyboard = _ref$keyboard === void 0 ? true : _ref$keyboard;
-
+      _ref$keyboard = _ref.keyboard,
+      keyboard = _ref$keyboard === void 0 ? true : _ref$keyboard;
     if (this._active) {
       this._listeners.forEach(listener => {
         listener.remove();
       });
-
       this._listeners = [];
-
       if (keyboard) {
         this._keyboardFocusRegion.deactivate();
       }
-
       this._screenReaderFocusRegion.deactivate();
-
       this._active = false;
     }
   }
-
   focus() {
     (0, _console.logError)(this._active, `[FocusRegion] Cannot call '.focus()' on a region that is not currently active.`);
-
     this._keyboardFocusRegion.focus();
   }
-
   blur() {
     (0, _console.logError)(!this._active, `[FocusRegion] Cannot call '.blur()' on a region that is currently active.`);
-
     this._keyboardFocusRegion.blur();
   }
-
 }
-
 exports.FocusRegion = FocusRegion;
 var _default = FocusRegion;
 exports.default = _default;

package/lib/FocusRegionManager.js

@@ -4,11 +4,8 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = exports.FocusRegionManager = void 0;
-
 var _console = require("@instructure/console");
-
 var _FocusRegion = require("./FocusRegion");
-
 /*
  * The MIT License (MIT)
  *
@@ -32,62 +29,49 @@ var _FocusRegion = require("./FocusRegion");
  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  * SOFTWARE.
  */
-let ENTRIES = [];
 
+let ENTRIES = [];
 class FocusRegionManager {}
-
 exports.FocusRegionManager = FocusRegionManager;
-
 FocusRegionManager.focusRegion = function (element) {
   let idOrOptions = arguments.length > 1 && arguments[1] !== void 0 ? arguments[1] : {};
   let entry;
-
   if (typeof idOrOptions === 'string') {
     entry = FocusRegionManager.getEntry(element, idOrOptions);
   } else {
     entry = FocusRegionManager.addEntry(element, idOrOptions);
   }
-
   if (entry && entry.region && typeof entry.region.focus === 'function') {
     entry.region.focus();
     return entry.region;
   } else {
     (0, _console.logError)(false, `[FocusRegionManager] Could not focus region with element: ${element}`);
   }
-
   return;
 };
-
 FocusRegionManager.activateRegion = (element, options) => {
   const _FocusRegionManager$a = FocusRegionManager.addEntry(element, options),
-        region = _FocusRegionManager$a.region;
-
+    region = _FocusRegionManager$a.region;
   return region;
 };
-
 FocusRegionManager.getActiveEntry = () => {
   return ENTRIES.find(_ref => {
     let region = _ref.region;
     return region.focused;
   });
 };
-
 FocusRegionManager.findEntry = (element, id) => {
   let index;
-
   if (id) {
     index = ENTRIES.findIndex(entry => entry.id === id);
   } else {
     index = ENTRIES.findIndex(entry => entry.element === element);
   }
-
   return index;
 };
-
 FocusRegionManager.getEntry = (element, id) => {
   return ENTRIES[FocusRegionManager.findEntry(element, id)];
 };
-
 FocusRegionManager.addEntry = function (element) {
   let options = arguments.length > 1 && arguments[1] !== void 0 ? arguments[1] : {};
   const region = new _FocusRegion.FocusRegion(element, options);
@@ -95,7 +79,6 @@ FocusRegionManager.addEntry = function (element) {
   const keyboardFocusable = region.keyboardFocusable;
   ENTRIES.forEach(_ref2 => {
     let region = _ref2.region;
-
     if (region) {
       // If the active region is triggering a new focus region that does not have
       // keyboard focusable content, don't deactivate the active region's keyboard
@@ -107,11 +90,9 @@ FocusRegionManager.addEntry = function (element) {
     }
   });
   region.activate();
-
   if (options.shouldFocusOnOpen) {
     region.focus();
   }
-
   const entry = {
     id: region.id,
     element,
@@ -120,63 +101,54 @@ FocusRegionManager.addEntry = function (element) {
     parent: activeEntry
   };
   ENTRIES.push(entry);
-
   if (activeEntry) {
     activeEntry.children.push(entry);
   }
-
   return entry;
 };
-
 FocusRegionManager.removeEntry = (element, id) => {
   const index = FocusRegionManager.findEntry(element, id);
   const entry = ENTRIES[index];
-
   if (index > -1) {
     ENTRIES.splice(index, 1);
   }
-
   return entry;
 };
-
 FocusRegionManager.isFocused = (element, id) => {
   const entry = FocusRegionManager.getActiveEntry();
-
   if (id) {
     return entry && entry.region && entry.id === id;
   } else {
     return entry && entry.region && entry.element === element;
   }
 };
-
 FocusRegionManager.clearEntries = () => {
   ENTRIES = [];
 };
-
 FocusRegionManager.blurRegion = (element, id) => {
   const entry = FocusRegionManager.removeEntry(element, id);
-
   if (entry) {
     const children = entry.children,
-          region = entry.region,
-          parent = entry.parent; // deactivate the region...
+      region = entry.region,
+      parent = entry.parent;
 
-    region && region.deactivate(); // and any regions created from it
+    // deactivate the region...
+    region && region.deactivate();
 
+    // and any regions created from it
     if (children) {
       children.forEach(_ref3 => {
         let id = _ref3.id,
-            element = _ref3.element;
+          element = _ref3.element;
         const entry = FocusRegionManager.removeEntry(element, id);
         entry && entry.region && entry.region.deactivate();
       });
-    } // activate the region's parent if it exists
-
+    }
 
+    // activate the region's parent if it exists
     parent && parent.region && parent.region.activate();
     region && region.blur(); // this should focus the parent region
   }
 };
-
 var _default = FocusRegionManager;
 exports.default = _default;