focus-trap 6.9.4 → 7.1.0

package/dist/focus-trap.umd.js

@@ -1,5 +1,5 @@
 /*!
-* focus-trap 6.9.4
+* focus-trap 7.1.0
 * @license MIT, https://github.com/focus-trap/focus-trap/blob/master/LICENSE
 */
 (function (global, factory) {
@@ -15,17 +15,14 @@
 
   function ownKeys(object, enumerableOnly) {
     var keys = Object.keys(object);
-
     if (Object.getOwnPropertySymbols) {
       var symbols = Object.getOwnPropertySymbols(object);
       enumerableOnly && (symbols = symbols.filter(function (sym) {
         return Object.getOwnPropertyDescriptor(object, sym).enumerable;
       })), keys.push.apply(keys, symbols);
     }
-
     return keys;
   }
-
   function _objectSpread2(target) {
     for (var i = 1; i < arguments.length; i++) {
       var source = null != arguments[i] ? arguments[i] : {};
@@ -35,10 +32,8 @@
         Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key));
       });
     }
-
     return target;
   }
-
   function _defineProperty(obj, key, value) {
     if (key in obj) {
       Object.defineProperty(obj, key, {
@@ -50,64 +45,52 @@
     } else {
       obj[key] = value;
     }
-
     return obj;
   }
 
-  var activeFocusTraps = function () {
-    var trapQueue = [];
-    return {
-      activateTrap: function activateTrap(trap) {
-        if (trapQueue.length > 0) {
-          var activeTrap = trapQueue[trapQueue.length - 1];
-
-          if (activeTrap !== trap) {
-            activeTrap.pause();
-          }
-        }
-
-        var trapIndex = trapQueue.indexOf(trap);
-
-        if (trapIndex === -1) {
-          trapQueue.push(trap);
-        } else {
-          // move this existing trap to the front of the queue
-          trapQueue.splice(trapIndex, 1);
-          trapQueue.push(trap);
-        }
-      },
-      deactivateTrap: function deactivateTrap(trap) {
-        var trapIndex = trapQueue.indexOf(trap);
-
-        if (trapIndex !== -1) {
-          trapQueue.splice(trapIndex, 1);
-        }
-
-        if (trapQueue.length > 0) {
-          trapQueue[trapQueue.length - 1].unpause();
+  var rooTrapStack = [];
+  var activeFocusTraps = {
+    activateTrap: function activateTrap(trapStack, trap) {
+      if (trapStack.length > 0) {
+        var activeTrap = trapStack[trapStack.length - 1];
+        if (activeTrap !== trap) {
+          activeTrap.pause();
         }
       }
-    };
-  }();
-
+      var trapIndex = trapStack.indexOf(trap);
+      if (trapIndex === -1) {
+        trapStack.push(trap);
+      } else {
+        // move this existing trap to the front of the queue
+        trapStack.splice(trapIndex, 1);
+        trapStack.push(trap);
+      }
+    },
+    deactivateTrap: function deactivateTrap(trapStack, trap) {
+      var trapIndex = trapStack.indexOf(trap);
+      if (trapIndex !== -1) {
+        trapStack.splice(trapIndex, 1);
+      }
+      if (trapStack.length > 0) {
+        trapStack[trapStack.length - 1].unpause();
+      }
+    }
+  };
   var isSelectableInput = function isSelectableInput(node) {
     return node.tagName && node.tagName.toLowerCase() === 'input' && typeof node.select === 'function';
   };
-
   var isEscapeEvent = function isEscapeEvent(e) {
     return e.key === 'Escape' || e.key === 'Esc' || e.keyCode === 27;
   };
-
   var isTabEvent = function isTabEvent(e) {
     return e.key === 'Tab' || e.keyCode === 9;
   };
-
   var delay = function delay(fn) {
     return setTimeout(fn, 0);
-  }; // Array.find/findIndex() are not supported on IE; this replicates enough
-  //  of Array.findIndex() for our needs
-
+  };
 
+  // Array.find/findIndex() are not supported on IE; this replicates enough
+  //  of Array.findIndex() for our needs
   var findIndex = function findIndex(arr, fn) {
     var idx = -1;
     arr.every(function (value, i) {
@@ -118,8 +101,10 @@
 
       return true; // next
     });
+
     return idx;
   };
+
   /**
    * Get an option's value when it could be a plain value, or a handler that provides
    *  the value.
@@ -127,16 +112,12 @@
    * @param {...*} [params] Any parameters to pass to the handler, if `value` is a function.
    * @returns {*} The `value`, or the handler's returned value.
    */
-
-
   var valueOrHandler = function valueOrHandler(value) {
     for (var _len = arguments.length, params = new Array(_len > 1 ? _len - 1 : 0), _key = 1; _key < _len; _key++) {
       params[_key - 1] = arguments[_key];
     }
-
     return typeof value === 'function' ? value.apply(void 0, params) : value;
   };
-
   var getActualTarget = function getActualTarget(event) {
     // NOTE: If the trap is _inside_ a shadow DOM, event.target will always be the
     //  shadow host. However, event.target.composedPath() will be an array of
@@ -147,18 +128,16 @@
     //  composedPath()[0] === event.target always).
     return event.target.shadowRoot && typeof event.composedPath === 'function' ? event.composedPath()[0] : event.target;
   };
-
   var createFocusTrap = function createFocusTrap(elements, userOptions) {
     // SSR: a live trap shouldn't be created in this type of environment so this
     //  should be safe code to execute if the `document` option isn't specified
     var doc = (userOptions === null || userOptions === void 0 ? void 0 : userOptions.document) || document;
-
+    var trapStack = (userOptions === null || userOptions === void 0 ? void 0 : userOptions.trapStack) || rooTrapStack;
     var config = _objectSpread2({
       returnFocusOnDeactivate: true,
       escapeDeactivates: true,
       delayInitialFocus: true
     }, userOptions);
-
     var state = {
       // containers given to createFocusTrap()
       // @type {Array<HTMLElement>}
@@ -178,6 +157,7 @@
       // }>}
       containerGroups: [],
       // same order/length as `containers` list
+
       // references to objects in `containerGroups`, but only those that actually have
       //  tabbable nodes in them
       // NOTE: same order as `containers` and `containerGroups`, but __not necessarily__
@@ -201,10 +181,10 @@
      * @param {string|undefined} [configOptionName] Name of option to use __instead of__ `optionName`
      *  IIF `configOverrideOptions` is not defined. Otherwise, `optionName` is used.
      */
-
     var getOption = function getOption(configOverrideOptions, optionName, configOptionName) {
       return configOverrideOptions && configOverrideOptions[optionName] !== undefined ? configOverrideOptions[optionName] : config[configOptionName || optionName];
     };
+
     /**
      * Finds the index of the container that contains the element.
      * @param {HTMLElement} element
@@ -212,16 +192,15 @@
      *  `state.containerGroups` (the order/length of these lists are the same); -1
      *  if the element isn't found.
      */
-
-
     var findContainerIndex = function findContainerIndex(element) {
       // NOTE: search `containerGroups` because it's possible a group contains no tabbable
       //  nodes, but still contains focusable nodes (e.g. if they all have `tabindex=-1`)
       //  and we still need to find the element in there
       return state.containerGroups.findIndex(function (_ref) {
         var container = _ref.container,
-            tabbableNodes = _ref.tabbableNodes;
-        return container.contains(element) || // fall back to explicit tabbable search which will take into consideration any
+          tabbableNodes = _ref.tabbableNodes;
+        return container.contains(element) ||
+        // fall back to explicit tabbable search which will take into consideration any
         //  web components if the `tabbableOptions.getShadowRoot` option was used for
         //  the trap, enabling shadow DOM support in tabbable (`Node.contains()` doesn't
         //  look inside web components even if open)
@@ -230,6 +209,7 @@
         });
       });
     };
+
     /**
      * Gets the node for the given option, which is expected to be an option that
      *  can be either a DOM node, a string that is a selector to get a node, `false`
@@ -243,19 +223,14 @@
      * @throws {Error} If the option is set, not `false`, and is not, or does not
      *  resolve to a node.
      */
-
-
     var getNodeForOption = function getNodeForOption(optionName) {
       var optionValue = config[optionName];
-
       if (typeof optionValue === 'function') {
         for (var _len2 = arguments.length, params = new Array(_len2 > 1 ? _len2 - 1 : 0), _key2 = 1; _key2 < _len2; _key2++) {
           params[_key2 - 1] = arguments[_key2];
         }
-
         optionValue = optionValue.apply(void 0, params);
       }
-
       if (optionValue === true) {
         optionValue = undefined; // use default value
       }
@@ -263,56 +238,51 @@
       if (!optionValue) {
         if (optionValue === undefined || optionValue === false) {
           return optionValue;
-        } // else, empty string (invalid), null (invalid), 0 (invalid)
-
+        }
+        // else, empty string (invalid), null (invalid), 0 (invalid)
 
         throw new Error("`".concat(optionName, "` was specified but was not a node, or did not return a node"));
       }
-
       var node = optionValue; // could be HTMLElement, SVGElement, or non-empty string at this point
 
       if (typeof optionValue === 'string') {
         node = doc.querySelector(optionValue); // resolve to node, or null if fails
-
         if (!node) {
           throw new Error("`".concat(optionName, "` as selector refers to no known node"));
         }
       }
-
       return node;
     };
-
     var getInitialFocusNode = function getInitialFocusNode() {
-      var node = getNodeForOption('initialFocus'); // false explicitly indicates we want no initialFocus at all
+      var node = getNodeForOption('initialFocus');
 
+      // false explicitly indicates we want no initialFocus at all
       if (node === false) {
         return false;
       }
-
       if (node === undefined) {
         // option not specified: use fallback options
         if (findContainerIndex(doc.activeElement) >= 0) {
           node = doc.activeElement;
         } else {
           var firstTabbableGroup = state.tabbableGroups[0];
-          var firstTabbableNode = firstTabbableGroup && firstTabbableGroup.firstTabbableNode; // NOTE: `fallbackFocus` option function cannot return `false` (not supported)
+          var firstTabbableNode = firstTabbableGroup && firstTabbableGroup.firstTabbableNode;
 
+          // NOTE: `fallbackFocus` option function cannot return `false` (not supported)
           node = firstTabbableNode || getNodeForOption('fallbackFocus');
         }
       }
-
       if (!node) {
         throw new Error('Your focus-trap needs to have at least one focusable element');
       }
-
       return node;
     };
-
     var updateTabbableNodes = function updateTabbableNodes() {
       state.containerGroups = state.containers.map(function (container) {
-        var tabbableNodes = tabbable.tabbable(container, config.tabbableOptions); // NOTE: if we have tabbable nodes, we must have focusable nodes; focusable nodes
-        //  are a superset of tabbable nodes
+        var tabbableNodes = tabbable.tabbable(container, config.tabbableOptions);
 
+        // NOTE: if we have tabbable nodes, we must have focusable nodes; focusable nodes
+        //  are a superset of tabbable nodes
         var focusableNodes = tabbable.focusable(container, config.tabbableOptions);
         return {
           container: container,
@@ -320,7 +290,6 @@
           focusableNodes: focusableNodes,
           firstTabbableNode: tabbableNodes.length > 0 ? tabbableNodes[0] : null,
           lastTabbableNode: tabbableNodes.length > 0 ? tabbableNodes[tabbableNodes.length - 1] : null,
-
           /**
            * Finds the __tabbable__ node that follows the given node in the specified direction,
            *  in this container, if any.
@@ -344,17 +313,14 @@
             var nodeIdx = focusableNodes.findIndex(function (n) {
               return n === node;
             });
-
             if (nodeIdx < 0) {
               return undefined;
             }
-
             if (forward) {
               return focusableNodes.slice(nodeIdx + 1).find(function (n) {
                 return tabbable.isTabbable(n, config.tabbableOptions);
               });
             }
-
             return focusableNodes.slice(0, nodeIdx).reverse().find(function (n) {
               return tabbable.isTabbable(n, config.tabbableOptions);
             });
@@ -363,53 +329,46 @@
       });
       state.tabbableGroups = state.containerGroups.filter(function (group) {
         return group.tabbableNodes.length > 0;
-      }); // throw if no groups have tabbable nodes and we don't have a fallback focus node either
+      });
 
+      // throw if no groups have tabbable nodes and we don't have a fallback focus node either
       if (state.tabbableGroups.length <= 0 && !getNodeForOption('fallbackFocus') // returning false not supported for this option
       ) {
         throw new Error('Your focus-trap must have at least one container with at least one tabbable node in it at all times');
       }
     };
-
     var tryFocus = function tryFocus(node) {
       if (node === false) {
         return;
       }
-
       if (node === doc.activeElement) {
         return;
       }
-
       if (!node || !node.focus) {
         tryFocus(getInitialFocusNode());
         return;
       }
-
       node.focus({
         preventScroll: !!config.preventScroll
       });
       state.mostRecentlyFocusedNode = node;
-
       if (isSelectableInput(node)) {
         node.select();
       }
     };
-
     var getReturnFocusNode = function getReturnFocusNode(previousActiveElement) {
       var node = getNodeForOption('setReturnFocus', previousActiveElement);
       return node ? node : node === false ? false : previousActiveElement;
-    }; // This needs to be done on mousedown and touchstart instead of click
-    // so that it precedes the focus event.
-
+    };
 
+    // This needs to be done on mousedown and touchstart instead of click
+    // so that it precedes the focus event.
     var checkPointerDown = function checkPointerDown(e) {
       var target = getActualTarget(e);
-
       if (findContainerIndex(target) >= 0) {
         // allow the click since it ocurred inside the trap
         return;
       }
-
       if (valueOrHandler(config.clickOutsideDeactivates, e)) {
         // immediately deactivate the trap
         trap.deactivate({
@@ -427,25 +386,26 @@
           returnFocus: config.returnFocusOnDeactivate && !tabbable.isFocusable(target, config.tabbableOptions)
         });
         return;
-      } // This is needed for mobile devices.
+      }
+
+      // This is needed for mobile devices.
       // (If we'll only let `click` events through,
       // then on mobile they will be blocked anyways if `touchstart` is blocked.)
-
-
       if (valueOrHandler(config.allowOutsideClick, e)) {
         // allow the click outside the trap to take place
         return;
-      } // otherwise, prevent the click
-
+      }
 
+      // otherwise, prevent the click
       e.preventDefault();
-    }; // In case focus escapes the trap for some strange reason, pull it back in.
-
+    };
 
+    // In case focus escapes the trap for some strange reason, pull it back in.
     var checkFocusIn = function checkFocusIn(e) {
       var target = getActualTarget(e);
-      var targetContained = findContainerIndex(target) >= 0; // In Firefox when you Tab out of an iframe the Document is briefly focused.
+      var targetContained = findContainerIndex(target) >= 0;
 
+      // In Firefox when you Tab out of an iframe the Document is briefly focused.
       if (targetContained || target instanceof Document) {
         if (targetContained) {
           state.mostRecentlyFocusedNode = target;
@@ -455,24 +415,22 @@
         e.stopImmediatePropagation();
         tryFocus(state.mostRecentlyFocusedNode || getInitialFocusNode());
       }
-    }; // Hijack Tab events on the first and last focusable nodes of the trap,
+    };
+
+    // Hijack Tab events on the first and last focusable nodes of the trap,
     // in order to prevent focus from escaping. If it escapes for even a
     // moment it can end up scrolling the page and causing confusion so we
     // kind of need to capture the action at the keydown phase.
-
-
     var checkTab = function checkTab(e) {
       var target = getActualTarget(e);
       updateTabbableNodes();
       var destinationNode = null;
-
       if (state.tabbableGroups.length > 0) {
         // make sure the target is actually contained in a group
         // NOTE: the target may also be the container itself if it's focusable
         //  with tabIndex='-1' and was given initial focus
         var containerIndex = findContainerIndex(target);
         var containerGroup = containerIndex >= 0 ? state.containerGroups[containerIndex] : undefined;
-
         if (containerIndex < 0) {
           // target not found in any group: quite possible focus has escaped the trap,
           //  so bring it back in to...
@@ -485,12 +443,12 @@
           }
         } else if (e.shiftKey) {
           // REVERSE
+
           // is the target the first tabbable node in a group?
           var startOfGroupIndex = findIndex(state.tabbableGroups, function (_ref2) {
             var firstTabbableNode = _ref2.firstTabbableNode;
             return target === firstTabbableNode;
           });
-
           if (startOfGroupIndex < 0 && (containerGroup.container === target || tabbable.isFocusable(target, config.tabbableOptions) && !tabbable.isTabbable(target, config.tabbableOptions) && !containerGroup.nextTabbableNode(target, false))) {
             // an exception case where the target is either the container itself, or
             //  a non-tabbable node that was given focus (i.e. tabindex is negative
@@ -500,7 +458,6 @@
             //  first tabbable node, and go to the last tabbable node of the LAST group
             startOfGroupIndex = containerIndex;
           }
-
           if (startOfGroupIndex >= 0) {
             // YES: then shift+tab should go to the last tabbable node in the
             //  previous group (and wrap around to the last tabbable node of
@@ -511,12 +468,12 @@
           }
         } else {
           // FORWARD
+
           // is the target the last tabbable node in a group?
           var lastOfGroupIndex = findIndex(state.tabbableGroups, function (_ref3) {
             var lastTabbableNode = _ref3.lastTabbableNode;
             return target === lastTabbableNode;
           });
-
           if (lastOfGroupIndex < 0 && (containerGroup.container === target || tabbable.isFocusable(target, config.tabbableOptions) && !tabbable.isTabbable(target, config.tabbableOptions) && !containerGroup.nextTabbableNode(target))) {
             // an exception case where the target is the container itself, or
             //  a non-tabbable node that was given focus (i.e. tabindex is negative
@@ -526,13 +483,11 @@
             //  last tabbable node, and go to the first tabbable node of the FIRST group
             lastOfGroupIndex = containerIndex;
           }
-
           if (lastOfGroupIndex >= 0) {
             // YES: then tab should go to the first tabbable node in the next
             //  group (and wrap around to the first tabbable node of the FIRST
             //  group if it's the last tabbable node of the LAST group)
             var _destinationGroupIndex = lastOfGroupIndex === state.tabbableGroups.length - 1 ? 0 : lastOfGroupIndex + 1;
-
             var _destinationGroup = state.tabbableGroups[_destinationGroupIndex];
             destinationNode = _destinationGroup.firstTabbableNode;
           }
@@ -541,12 +496,11 @@
         // NOTE: the fallbackFocus option does not support returning false to opt-out
         destinationNode = getNodeForOption('fallbackFocus');
       }
-
       if (destinationNode) {
         e.preventDefault();
         tryFocus(destinationNode);
-      } // else, let the browser take care of [shift+]tab and move the focus
-
+      }
+      // else, let the browser take care of [shift+]tab and move the focus
     };
 
     var checkKey = function checkKey(e) {
@@ -555,44 +509,40 @@
         trap.deactivate();
         return;
       }
-
       if (isTabEvent(e)) {
         checkTab(e);
         return;
       }
     };
-
     var checkClick = function checkClick(e) {
       var target = getActualTarget(e);
-
       if (findContainerIndex(target) >= 0) {
         return;
       }
-
       if (valueOrHandler(config.clickOutsideDeactivates, e)) {
         return;
       }
-
       if (valueOrHandler(config.allowOutsideClick, e)) {
         return;
       }
-
       e.preventDefault();
       e.stopImmediatePropagation();
-    }; //
+    };
+
+    //
     // EVENT LISTENERS
     //
 
-
     var addListeners = function addListeners() {
       if (!state.active) {
         return;
-      } // There can be only one listening focus trap at a time
+      }
 
+      // There can be only one listening focus trap at a time
+      activeFocusTraps.activateTrap(trapStack, trap);
 
-      activeFocusTraps.activateTrap(trap); // Delay ensures that the focused element doesn't capture the event
+      // Delay ensures that the focused element doesn't capture the event
       // that caused the focus trap activation.
-
       state.delayInitialFocusTimer = config.delayInitialFocus ? delay(function () {
         tryFocus(getInitialFocusNode());
       }) : tryFocus(getInitialFocusNode());
@@ -615,70 +565,58 @@
       });
       return trap;
     };
-
     var removeListeners = function removeListeners() {
       if (!state.active) {
         return;
       }
-
       doc.removeEventListener('focusin', checkFocusIn, true);
       doc.removeEventListener('mousedown', checkPointerDown, true);
       doc.removeEventListener('touchstart', checkPointerDown, true);
       doc.removeEventListener('click', checkClick, true);
       doc.removeEventListener('keydown', checkKey, true);
       return trap;
-    }; //
+    };
+
+    //
     // TRAP DEFINITION
     //
 
-
     trap = {
       get active() {
         return state.active;
       },
-
       get paused() {
         return state.paused;
       },
-
       activate: function activate(activateOptions) {
         if (state.active) {
           return this;
         }
-
         var onActivate = getOption(activateOptions, 'onActivate');
         var onPostActivate = getOption(activateOptions, 'onPostActivate');
         var checkCanFocusTrap = getOption(activateOptions, 'checkCanFocusTrap');
-
         if (!checkCanFocusTrap) {
           updateTabbableNodes();
         }
-
         state.active = true;
         state.paused = false;
         state.nodeFocusedBeforeActivation = doc.activeElement;
-
         if (onActivate) {
           onActivate();
         }
-
         var finishActivation = function finishActivation() {
           if (checkCanFocusTrap) {
             updateTabbableNodes();
           }
-
           addListeners();
-
           if (onPostActivate) {
             onPostActivate();
           }
         };
-
         if (checkCanFocusTrap) {
           checkCanFocusTrap(state.containers.concat()).then(finishActivation, finishActivation);
           return this;
         }
-
         finishActivation();
         return this;
       },
@@ -686,46 +624,38 @@
         if (!state.active) {
           return this;
         }
-
         var options = _objectSpread2({
           onDeactivate: config.onDeactivate,
           onPostDeactivate: config.onPostDeactivate,
           checkCanReturnFocus: config.checkCanReturnFocus
         }, deactivateOptions);
-
         clearTimeout(state.delayInitialFocusTimer); // noop if undefined
-
         state.delayInitialFocusTimer = undefined;
         removeListeners();
         state.active = false;
         state.paused = false;
-        activeFocusTraps.deactivateTrap(trap);
+        activeFocusTraps.deactivateTrap(trapStack, trap);
         var onDeactivate = getOption(options, 'onDeactivate');
         var onPostDeactivate = getOption(options, 'onPostDeactivate');
         var checkCanReturnFocus = getOption(options, 'checkCanReturnFocus');
         var returnFocus = getOption(options, 'returnFocus', 'returnFocusOnDeactivate');
-
         if (onDeactivate) {
           onDeactivate();
         }
-
         var finishDeactivation = function finishDeactivation() {
           delay(function () {
             if (returnFocus) {
               tryFocus(getReturnFocusNode(state.nodeFocusedBeforeActivation));
             }
-
             if (onPostDeactivate) {
               onPostDeactivate();
             }
           });
         };
-
         if (returnFocus && checkCanReturnFocus) {
           checkCanReturnFocus(getReturnFocusNode(state.nodeFocusedBeforeActivation)).then(finishDeactivation, finishDeactivation);
           return this;
         }
-
         finishDeactivation();
         return this;
       },
@@ -733,7 +663,6 @@
         if (state.paused || !state.active) {
           return this;
         }
-
         state.paused = true;
         removeListeners();
         return this;
@@ -742,7 +671,6 @@
         if (!state.paused || !state.active) {
           return this;
         }
-
         state.paused = false;
         updateTabbableNodes();
         addListeners();
@@ -753,15 +681,14 @@
         state.containers = elementsAsArray.map(function (element) {
           return typeof element === 'string' ? doc.querySelector(element) : element;
         });
-
         if (state.active) {
           updateTabbableNodes();
         }
-
         return this;
       }
-    }; // initialize container elements
+    };
 
+    // initialize container elements
     trap.updateContainerElements(elements);
     return trap;
   };