@zohodesk/components 1.0.0-temp-44 → 1.0.0-temp-47

package/lib/a11y/FocusScope/FocusScope.js

@@ -0,0 +1,443 @@
+"use strict";
+
+function _typeof(obj) { "@babel/helpers - typeof"; if (typeof Symbol === "function" && typeof Symbol.iterator === "symbol") { _typeof = function _typeof(obj) { return typeof obj; }; } else { _typeof = function _typeof(obj) { return obj && typeof Symbol === "function" && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }; } return _typeof(obj); }
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = FocusScope;
+exports.useFocusManager = useFocusManager;
+exports.getFocusableTreeWalker = getFocusableTreeWalker;
+exports.useLayoutEffect = void 0;
+
+var _react = _interopRequireWildcard(require("react"));
+
+function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
+
+function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || _typeof(obj) !== "object" && typeof obj !== "function") { return { "default": obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj["default"] = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
+
+function _toConsumableArray(arr) { return _arrayWithoutHoles(arr) || _iterableToArray(arr) || _unsupportedIterableToArray(arr) || _nonIterableSpread(); }
+
+function _nonIterableSpread() { throw new TypeError("Invalid attempt to spread non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); }
+
+function _iterableToArray(iter) { if (typeof Symbol !== "undefined" && iter[Symbol.iterator] != null || iter["@@iterator"] != null) return Array.from(iter); }
+
+function _arrayWithoutHoles(arr) { if (Array.isArray(arr)) return _arrayLikeToArray(arr); }
+
+function _createForOfIteratorHelper(o, allowArrayLike) { var it = typeof Symbol !== "undefined" && o[Symbol.iterator] || o["@@iterator"]; if (!it) { if (Array.isArray(o) || (it = _unsupportedIterableToArray(o)) || allowArrayLike && o && typeof o.length === "number") { if (it) o = it; var i = 0; var F = function F() {}; return { s: F, n: function n() { if (i >= o.length) return { done: true }; return { done: false, value: o[i++] }; }, e: function e(_e) { throw _e; }, f: F }; } throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); } var normalCompletion = true, didErr = false, err; return { s: function s() { it = it.call(o); }, n: function n() { var step = it.next(); normalCompletion = step.done; return step; }, e: function e(_e2) { didErr = true; err = _e2; }, f: function f() { try { if (!normalCompletion && it["return"] != null) it["return"](); } finally { if (didErr) throw err; } } }; }
+
+function _unsupportedIterableToArray(o, minLen) { if (!o) return; if (typeof o === "string") return _arrayLikeToArray(o, minLen); var n = Object.prototype.toString.call(o).slice(8, -1); if (n === "Object" && o.constructor) n = o.constructor.name; if (n === "Map" || n === "Set") return Array.from(o); if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen); }
+
+function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len = arr.length; for (var i = 0, arr2 = new Array(len); i < len; i++) { arr2[i] = arr[i]; } return arr2; }
+
+var scopes = new Set();
+var activeScope = null;
+
+var FocusContext = /*#__PURE__*/_react["default"].createContext(null); // interface FocusManager {
+//     /** Moves focus to the next focusable or tabbable element in the focus scope. */
+//     focusNext(opts?: FocusManagerOptions): HTMLElement,
+//     /** Moves focus to the previous focusable or tabbable element in the focus scope. */
+//     focusPrevious(opts?: FocusManagerOptions): HTMLElement
+//   }
+
+
+var useLayoutEffect = window !== 'undefined' ? _react["default"].useLayoutEffect : function () {};
+exports.useLayoutEffect = useLayoutEffect;
+
+function FocusScope(props) {
+  var children = props.children,
+      _props$contain = props.contain,
+      contain = _props$contain === void 0 ? true : _props$contain,
+      _props$restoreFocus = props.restoreFocus,
+      restoreFocus = _props$restoreFocus === void 0 ? true : _props$restoreFocus,
+      _props$autoFocus = props.autoFocus,
+      autoFocus = _props$autoFocus === void 0 ? true : _props$autoFocus;
+  var startRef = (0, _react.useRef)();
+  var endRef = (0, _react.useRef)();
+  var scopeRef = (0, _react.useRef)([]);
+  useLayoutEffect(function () {
+    // Find all rendered nodes between the sentinels and add them to the scope.
+    var node = startRef.current.nextSibling;
+    var nodes = [];
+
+    while (node && node !== endRef.current) {
+      nodes.push(node);
+      node = node.nextSibling;
+    }
+
+    scopeRef.current = nodes;
+    scopes.add(scopeRef);
+    return function () {
+      scopes["delete"](scopeRef);
+    };
+  }, [children]);
+  useFocusContainment(scopeRef, contain);
+  useRestoreFocus(scopeRef, restoreFocus, contain);
+  useAutoFocus(scopeRef, autoFocus);
+  var focusManager = createFocusManager(scopeRef);
+  return /*#__PURE__*/_react["default"].createElement(FocusContext.Provider, {
+    value: focusManager
+  }, /*#__PURE__*/_react["default"].createElement("span", {
+    hidden: true,
+    ref: startRef
+  }), children, /*#__PURE__*/_react["default"].createElement("span", {
+    hidden: true,
+    ref: endRef
+  }));
+}
+
+function useFocusManager() {
+  return (0, _react.useContext)(FocusContext);
+}
+
+function createFocusManager(scopeRef) {
+  return {
+    focusNext: function focusNext(opts) {
+      var node = opts.from || document.activeElement;
+      var focusable = getFocusableElementsInScope(scopeRef.current, opts);
+      var nextNode = focusable.find(function (n) {
+        return !!(node.compareDocumentPosition(n) & (Node.DOCUMENT_POSITION_FOLLOWING | Node.DOCUMENT_POSITION_CONTAINED_BY));
+      });
+
+      if (!nextNode && opts.wrap) {
+        nextNode = focusable[0];
+      }
+
+      if (nextNode) {
+        nextNode.focus();
+      }
+
+      return nextNode;
+    },
+    focusPrevious: function focusPrevious(opts) {
+      var node = opts.from || document.activeElement;
+      var focusable = getFocusableElementsInScope(scopeRef.current, opts).reverse();
+      var previousNode = focusable.find(function (n) {
+        return !!(node.compareDocumentPosition(n) & (Node.DOCUMENT_POSITION_PRECEDING | Node.DOCUMENT_POSITION_CONTAINED_BY));
+      });
+
+      if (!previousNode && opts.wrap) {
+        previousNode = focusable[0];
+      }
+
+      if (previousNode) {
+        previousNode.focus();
+      }
+
+      return previousNode;
+    }
+  };
+}
+
+var focusableElements = ['input:not([disabled]):not([type=hidden])', 'select:not([disabled])', 'textarea:not([disabled])', 'button:not([disabled])', 'a[href]', 'audio[controls]', 'video[controls]', '[contenteditable]:not([contenteditable="false"])', 'details>summary:first-of-type', 'details', 'area[href]', 'summary', 'iframe', 'object', 'embed'];
+var FOCUSABLE_ELEMENT_SELECTOR = focusableElements.join(',') + ',[tabindex]';
+focusableElements.push('[tabindex]:not([tabindex="-1"])');
+var TABBABLE_ELEMENT_SELECTOR = focusableElements.join(':not([tabindex="-1"]),');
+
+function useAutoFocus(scopeRef, autoFocus) {
+  (0, _react.useEffect)(function () {
+    if (autoFocus) {
+      activeScope = scopeRef;
+
+      if (!isElementInScope(document.activeElement, activeScope.current)) {
+        focusFirstInScope(scopeRef.current);
+      }
+    }
+  }, [scopeRef, autoFocus]);
+}
+
+function getFocusableElementsInScope(scope, opts) {
+  var res = [],
+      response = [];
+  var selector = opts.tabbable ? TABBABLE_ELEMENT_SELECTOR : FOCUSABLE_ELEMENT_SELECTOR;
+
+  var _iterator = _createForOfIteratorHelper(scope),
+      _step;
+
+  try {
+    for (_iterator.s(); !(_step = _iterator.n()).done;) {
+      var node = _step.value;
+
+      if (node.matches(selector)) {
+        res.push(node);
+      }
+
+      response.push.apply(response, _toConsumableArray(Array.from(node.querySelectorAll(selector))));
+      res = response.filter(function (element) {
+        return !(window.getComputedStyle(element).display === 'none');
+      });
+    }
+  } catch (err) {
+    _iterator.e(err);
+  } finally {
+    _iterator.f();
+  }
+
+  ;
+  return res;
+}
+
+function useFocusContainment(scopeRef, contain) {
+  var focusedNode = (0, _react.useRef)();
+  var raf = (0, _react.useRef)(null);
+  (0, _react.useEffect)(function () {
+    var scope = scopeRef.current;
+
+    if (!contain) {
+      return;
+    } // Handle the Tab key to contain focus within the scope
+
+
+    var onKeyDown = function onKeyDown(e) {
+      if (e.key !== 'Tab' || e.altKey || e.ctrlKey || e.metaKey) {
+        return;
+      }
+
+      var elements = getFocusableElementsInScope(scope, {
+        tabbable: true
+      });
+      var focusedElement = document.activeElement;
+
+      if (!isElementInScope(focusedElement, scope)) {
+        return;
+      }
+
+      var position = elements.indexOf(focusedElement);
+      var lastPosition = elements.length - 1;
+      var nextElement = null;
+
+      if (e.shiftKey) {
+        if (position <= 0) {
+          nextElement = elements[lastPosition];
+        } else {
+          nextElement = elements[position - 1];
+        }
+      } else {
+        if (position === lastPosition) {
+          nextElement = elements[0];
+        } else {
+          nextElement = elements[position + 1];
+        }
+      }
+
+      e.preventDefault();
+
+      if (nextElement) {
+        focusElement(nextElement, true);
+      }
+    };
+
+    var onFocus = function onFocus(e) {
+      // If a focus event occurs outside the active scope (e.g. user tabs from browser location bar),
+      // restore focus to the previously focused node or the first tabbable element in the active scope.
+      var isInAnyScope = isElementInAnyScope(e.target, scopes);
+
+      if (!isInAnyScope) {
+        if (focusedNode.current) {
+          focusedNode.current.focus();
+        } else if (activeScope) {
+          focusFirstInScope(activeScope.current);
+        }
+      } else {
+        activeScope = scopeRef;
+        focusedNode.current = e.target;
+      }
+    };
+
+    var onBlur = function onBlur(e) {
+      // Firefox doesn't shift focus back to the Dialog properly without this
+      raf.current = requestAnimationFrame(function () {
+        // Use document.activeElement instead of e.relatedTarget so we can tell if user clicked into iframe
+        var isInAnyScope = isElementInAnyScope(document.activeElement, scopes);
+
+        if (!isInAnyScope) {
+          activeScope = scopeRef;
+          focusedNode.current = e.target;
+          focusedNode.current.focus();
+        }
+      });
+    };
+
+    document.addEventListener('keydown', onKeyDown, false);
+    document.addEventListener('focusin', onFocus, false);
+    scope.forEach(function (element) {
+      return element.addEventListener('focusin', onFocus, false);
+    });
+    scope.forEach(function (element) {
+      return element.addEventListener('focusout', onBlur, false);
+    });
+    return function () {
+      document.removeEventListener('keydown', onKeyDown, false);
+      document.removeEventListener('focusin', onFocus, false);
+      scope.forEach(function (element) {
+        return element.removeEventListener('focusin', onFocus, false);
+      });
+      scope.forEach(function (element) {
+        return element.removeEventListener('focusout', onBlur, false);
+      });
+    };
+  }, [scopeRef, contain]); // eslint-disable-next-line arrow-body-style
+
+  (0, _react.useEffect)(function () {
+    return function () {
+      return cancelAnimationFrame(raf.current);
+    };
+  }, [raf]);
+}
+
+function isElementInAnyScope(element) {
+  var scopes = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : [];
+
+  var _iterator2 = _createForOfIteratorHelper(scopes.values()),
+      _step2;
+
+  try {
+    for (_iterator2.s(); !(_step2 = _iterator2.n()).done;) {
+      var scope = _step2.value;
+
+      if (isElementInScope(element, scope.current)) {
+        return true;
+      }
+    }
+  } catch (err) {
+    _iterator2.e(err);
+  } finally {
+    _iterator2.f();
+  }
+
+  return false;
+}
+
+function isElementInScope(element) {
+  var scope = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : [];
+  return scope.some(function (node) {
+    return node.contains(element);
+  });
+}
+
+function focusElement() {
+  var element = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : null;
+
+  if (element != null) {
+    element.focus();
+  }
+}
+
+function findElement(elements) {
+  var ele = [];
+
+  for (var element = 0; element < elements.length; element++) {
+    var elem = elements[element];
+
+    if (elem.getAttribute('data-auto-focus')) {
+      ele.push(elem);
+    }
+  }
+
+  return ele.length ? ele[0] : null;
+}
+
+function focusFirstInScope() {
+  var scope = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : [];
+  var elements = getFocusableElementsInScope(scope, {
+    tabbable: true
+  });
+  var element = findElement(elements);
+  focusElement(element ? element : elements[0]);
+}
+
+function useRestoreFocus(scopeRef, restoreFocus, contain) {
+  // useLayoutEffect instead of useEffect so the active element is saved synchronously instead of asynchronously.
+  useLayoutEffect(function () {
+    var scope = scopeRef.current;
+    var nodeToRestore = document.activeElement; // Handle the Tab key so that tabbing out of the scope goes to the next element
+    // after the node that had focus when the scope mounted. This is important when
+    // using portals for overlays, so that focus goes to the expected element when
+    // tabbing out of the overlay.
+
+    var onKeyDown = function onKeyDown(e) {
+      if (e.key !== 'Tab' || e.altKey || e.ctrlKey || e.metaKey) {
+        return;
+      }
+
+      var focusedElement = document.activeElement;
+
+      if (!isElementInScope(focusedElement, scope)) {
+        return;
+      } // Create a DOM tree walker that matches all tabbable elements
+
+
+      var walker = getFocusableTreeWalker(document.body, {
+        tabbable: true
+      }); // Find the next tabbable element after the currently focused element
+
+      walker.currentNode = focusedElement;
+      var nextElement = e.shiftKey ? walker.previousNode() : walker.nextNode(); // If there is no next element, or it is outside the current scope, move focus to the
+      // next element after the node to restore to instead.
+
+      if ((!nextElement || !isElementInScope(nextElement, scope)) && nodeToRestore) {
+        walker.currentNode = nodeToRestore; // Skip over elements within the scope, in case the scope immediately follows the node to restore.
+
+        do {
+          nextElement = e.shiftKey ? walker.previousNode() : walker.nextNode();
+        } while (isElementInScope(nextElement, scope));
+
+        e.preventDefault();
+        e.stopPropagation();
+
+        if (nextElement) {
+          nextElement.focus();
+        } else {
+          // If there is no next element, blur the focused element to move focus to the body.
+          focusedElement.blur();
+        }
+      }
+    };
+
+    if (!contain) {
+      document.addEventListener('keydown', onKeyDown, true);
+    }
+
+    return function () {
+      if (!contain) {
+        document.removeEventListener('keydown', onKeyDown, true);
+      }
+
+      if (restoreFocus && nodeToRestore && isElementInScope(document.activeElement, scope)) {
+        requestAnimationFrame(function () {
+          if (document.body.contains(nodeToRestore)) {
+            focusElement(nodeToRestore);
+          }
+        });
+      }
+    };
+  }, [scopeRef, restoreFocus, contain]);
+}
+
+function getFocusableTreeWalker(root, opts) {
+  var selector = opts && opts.tabbable ? TABBABLE_ELEMENT_SELECTOR : FOCUSABLE_ELEMENT_SELECTOR;
+  var walker = document.createTreeWalker(root, NodeFilter.SHOW_ELEMENT, {
+    acceptNode: function acceptNode(node) {
+      // Skip nodes inside the starting node.
+      if (opts && opts.from && opts.from.contains(node)) {
+        return NodeFilter.FILTER_REJECT;
+      }
+
+      if (node.matches(selector)) {
+        return NodeFilter.FILTER_ACCEPT;
+      }
+
+      return NodeFilter.FILTER_SKIP;
+    }
+  }, false);
+
+  if (opts && opts.from) {
+    walker.currentNode = opts.from;
+  }
+
+  return walker;
+}
+
+FocusScope.docs = {
+  componentGroup: 'Atom'
+};