@react-aria/focus 3.7.0 → 3.8.0

package/dist/module.js

@@ -54,14 +54,15 @@ function $645f2e67b85a24c9$export$e989c0fffaa6b27a(element, childElement) {
 
 const $9bf71ea28793e738$var$FocusContext = /*#__PURE__*/ $6nfFC$react.createContext(null);
 let $9bf71ea28793e738$var$activeScope = null;
-let $9bf71ea28793e738$var$scopes = new Map();
 function $9bf71ea28793e738$export$20e40289641fbbb6(props) {
     let { children: children , contain: contain , restoreFocus: restoreFocus , autoFocus: autoFocus  } = props;
     let startRef = $6nfFC$useRef();
     let endRef = $6nfFC$useRef();
     let scopeRef = $6nfFC$useRef([]);
     let ctx = $6nfFC$useContext($9bf71ea28793e738$var$FocusContext);
-    let parentScope = ctx === null || ctx === void 0 ? void 0 : ctx.scopeRef;
+    var ref;
+    // if there is no scopeRef on the context, then the parent is the focusScopeTree's root, represented by null
+    let parentScope = (ref = ctx === null || ctx === void 0 ? void 0 : ctx.scopeRef) !== null && ref !== void 0 ? ref : null;
     $6nfFC$useLayoutEffect(()=>{
         // Find all rendered nodes between the sentinels and add them to the scope.
         let node = startRef.current.nextSibling;
@@ -75,22 +76,27 @@ function $9bf71ea28793e738$export$20e40289641fbbb6(props) {
         children,
         parentScope
     ]);
+    // add to the focus scope tree in render order because useEffects/useLayoutEffects run children first whereas render runs parent first
+    // which matters when constructing a tree
+    if ($9bf71ea28793e738$export$d06fae2ee68b101e.getTreeNode(parentScope) && !$9bf71ea28793e738$export$d06fae2ee68b101e.getTreeNode(scopeRef)) $9bf71ea28793e738$export$d06fae2ee68b101e.addTreeNode(scopeRef, parentScope);
+    let node1 = $9bf71ea28793e738$export$d06fae2ee68b101e.getTreeNode(scopeRef);
+    node1.contain = contain;
+    $9bf71ea28793e738$var$useFocusContainment(scopeRef, contain);
+    $9bf71ea28793e738$var$useRestoreFocus(scopeRef, restoreFocus, contain);
+    $9bf71ea28793e738$var$useAutoFocus(scopeRef, autoFocus);
+    // this layout effect needs to run last so that focusScopeTree cleanup happens at the last moment possible
     $6nfFC$useLayoutEffect(()=>{
-        $9bf71ea28793e738$var$scopes.set(scopeRef, parentScope);
-        return ()=>{
+        if (scopeRef && (parentScope || parentScope == null)) return ()=>{
             // Restore the active scope on unmount if this scope or a descendant scope is active.
             // Parent effect cleanups run before children, so we need to check if the
             // parent scope actually still exists before restoring the active scope to it.
-            if ((scopeRef === $9bf71ea28793e738$var$activeScope || $9bf71ea28793e738$var$isAncestorScope(scopeRef, $9bf71ea28793e738$var$activeScope)) && (!parentScope || $9bf71ea28793e738$var$scopes.has(parentScope))) $9bf71ea28793e738$var$activeScope = parentScope;
-            $9bf71ea28793e738$var$scopes.delete(scopeRef);
+            if ((scopeRef === $9bf71ea28793e738$var$activeScope || $9bf71ea28793e738$var$isAncestorScope(scopeRef, $9bf71ea28793e738$var$activeScope)) && (!parentScope || $9bf71ea28793e738$export$d06fae2ee68b101e.getTreeNode(parentScope))) $9bf71ea28793e738$var$activeScope = parentScope;
+            $9bf71ea28793e738$export$d06fae2ee68b101e.removeTreeNode(scopeRef);
         };
     }, [
         scopeRef,
         parentScope
     ]);
-    $9bf71ea28793e738$var$useFocusContainment(scopeRef, contain);
-    $9bf71ea28793e738$var$useRestoreFocus(scopeRef, restoreFocus, contain);
-    $9bf71ea28793e738$var$useAutoFocus(scopeRef, autoFocus);
     let focusManager = $9bf71ea28793e738$var$createFocusManagerForScope(scopeRef);
     return(/*#__PURE__*/ $6nfFC$react.createElement($9bf71ea28793e738$var$FocusContext.Provider, {
         value: {
@@ -200,6 +206,14 @@ const $9bf71ea28793e738$var$TABBABLE_ELEMENT_SELECTOR = $9bf71ea28793e738$var$fo
 function $9bf71ea28793e738$var$getScopeRoot(scope) {
     return scope[0].parentElement;
 }
+function $9bf71ea28793e738$var$shouldContainFocus(scopeRef) {
+    let scope = $9bf71ea28793e738$export$d06fae2ee68b101e.getTreeNode($9bf71ea28793e738$var$activeScope);
+    while(scope && scope.scopeRef !== scopeRef){
+        if (scope.contain) return false;
+        scope = scope.parent;
+    }
+    return true;
+}
 function $9bf71ea28793e738$var$useFocusContainment(scopeRef, contain) {
     let focusedNode = $6nfFC$useRef();
     let raf = $6nfFC$useRef(null);
@@ -215,7 +229,7 @@ function $9bf71ea28793e738$var$useFocusContainment(scopeRef, contain) {
         }
         // Handle the Tab key to contain focus within the scope
         let onKeyDown = (e)=>{
-            if (e.key !== 'Tab' || e.altKey || e.ctrlKey || e.metaKey || scopeRef !== $9bf71ea28793e738$var$activeScope) return;
+            if (e.key !== 'Tab' || e.altKey || e.ctrlKey || e.metaKey || !$9bf71ea28793e738$var$shouldContainFocus(scopeRef)) return;
             let focusedElement = document.activeElement;
             let scope = scopeRef.current;
             if (!$9bf71ea28793e738$var$isElementInScope(focusedElement, scope)) return;
@@ -237,21 +251,23 @@ function $9bf71ea28793e738$var$useFocusContainment(scopeRef, contain) {
             if (!$9bf71ea28793e738$var$activeScope || $9bf71ea28793e738$var$isAncestorScope($9bf71ea28793e738$var$activeScope, scopeRef)) {
                 $9bf71ea28793e738$var$activeScope = scopeRef;
                 focusedNode.current = e.target;
-            } else if (scopeRef === $9bf71ea28793e738$var$activeScope && !$9bf71ea28793e738$var$isElementInChildScope(e.target, scopeRef)) {
+            } else if ($9bf71ea28793e738$var$shouldContainFocus(scopeRef) && !$9bf71ea28793e738$var$isElementInChildScope(e.target, scopeRef)) {
                 // 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.
                 if (focusedNode.current) focusedNode.current.focus();
                 else if ($9bf71ea28793e738$var$activeScope) $9bf71ea28793e738$var$focusFirstInScope($9bf71ea28793e738$var$activeScope.current);
-            } else if (scopeRef === $9bf71ea28793e738$var$activeScope) focusedNode.current = e.target;
+            } else if ($9bf71ea28793e738$var$shouldContainFocus(scopeRef)) focusedNode.current = e.target;
         };
         let onBlur = (e)=>{
             // Firefox doesn't shift focus back to the Dialog properly without this
             raf.current = requestAnimationFrame(()=>{
                 // Use document.activeElement instead of e.relatedTarget so we can tell if user clicked into iframe
-                if (scopeRef === $9bf71ea28793e738$var$activeScope && !$9bf71ea28793e738$var$isElementInChildScope(document.activeElement, scopeRef)) {
+                if ($9bf71ea28793e738$var$shouldContainFocus(scopeRef) && !$9bf71ea28793e738$var$isElementInChildScope(document.activeElement, scopeRef)) {
                     $9bf71ea28793e738$var$activeScope = scopeRef;
-                    focusedNode.current = e.target;
-                    focusedNode.current.focus();
+                    if (document.body.contains(e.target)) {
+                        focusedNode.current = e.target;
+                        focusedNode.current.focus();
+                    } else if ($9bf71ea28793e738$var$activeScope) $9bf71ea28793e738$var$focusFirstInScope($9bf71ea28793e738$var$activeScope.current);
                 }
             });
         };
@@ -283,28 +299,28 @@ function $9bf71ea28793e738$var$useFocusContainment(scopeRef, contain) {
     ]);
 }
 function $9bf71ea28793e738$var$isElementInAnyScope(element) {
-    for (let scope of $9bf71ea28793e738$var$scopes.keys()){
-        if ($9bf71ea28793e738$var$isElementInScope(element, scope.current)) return true;
-    }
-    return false;
+    return $9bf71ea28793e738$var$isElementInChildScope(element);
 }
 function $9bf71ea28793e738$var$isElementInScope(element, scope) {
     return scope.some((node)=>node.contains(element)
     );
 }
-function $9bf71ea28793e738$var$isElementInChildScope(element, scope) {
+function $9bf71ea28793e738$var$isElementInChildScope(element, scope = null) {
     // node.contains in isElementInScope covers child scopes that are also DOM children,
     // but does not cover child scopes in portals.
-    for (let s of $9bf71ea28793e738$var$scopes.keys()){
-        if ((s === scope || $9bf71ea28793e738$var$isAncestorScope(scope, s)) && $9bf71ea28793e738$var$isElementInScope(element, s.current)) return true;
+    for (let { scopeRef: s  } of $9bf71ea28793e738$export$d06fae2ee68b101e.traverse($9bf71ea28793e738$export$d06fae2ee68b101e.getTreeNode(scope))){
+        if ($9bf71ea28793e738$var$isElementInScope(element, s.current)) return true;
     }
     return false;
 }
 function $9bf71ea28793e738$var$isAncestorScope(ancestor, scope) {
-    let parent = $9bf71ea28793e738$var$scopes.get(scope);
-    if (!parent) return false;
-    if (parent === ancestor) return true;
-    return $9bf71ea28793e738$var$isAncestorScope(ancestor, parent);
+    var ref;
+    let parent = (ref = $9bf71ea28793e738$export$d06fae2ee68b101e.getTreeNode(scope)) === null || ref === void 0 ? void 0 : ref.parent;
+    while(parent){
+        if (parent.scopeRef === ancestor) return true;
+        parent = parent.parent;
+    }
+    return false;
 }
 function $9bf71ea28793e738$var$focusElement(element, scroll = false) {
     if (element != null && !scroll) try {
@@ -318,13 +334,22 @@ function $9bf71ea28793e738$var$focusElement(element, scroll = false) {
     // ignore
     }
 }
-function $9bf71ea28793e738$var$focusFirstInScope(scope) {
+function $9bf71ea28793e738$var$focusFirstInScope(scope, tabbable = true) {
     let sentinel = scope[0].previousElementSibling;
     let walker = $9bf71ea28793e738$export$2d6ec8fc375ceafa($9bf71ea28793e738$var$getScopeRoot(scope), {
-        tabbable: true
+        tabbable: tabbable
     }, scope);
     walker.currentNode = sentinel;
-    $9bf71ea28793e738$var$focusElement(walker.nextNode());
+    let nextNode = walker.nextNode();
+    // If the scope does not contain a tabbable element, use the first focusable element.
+    if (tabbable && !nextNode) {
+        walker = $9bf71ea28793e738$export$2d6ec8fc375ceafa($9bf71ea28793e738$var$getScopeRoot(scope), {
+            tabbable: false
+        }, scope);
+        walker.currentNode = sentinel;
+        nextNode = walker.nextNode();
+    }
+    $9bf71ea28793e738$var$focusElement(nextNode);
 }
 function $9bf71ea28793e738$var$useAutoFocus(scopeRef, autoFocus) {
     const autoFocusRef = $6nfFC$react.useRef(autoFocus);
@@ -334,14 +359,38 @@ function $9bf71ea28793e738$var$useAutoFocus(scopeRef, autoFocus) {
             if (!$9bf71ea28793e738$var$isElementInScope(document.activeElement, $9bf71ea28793e738$var$activeScope.current)) $9bf71ea28793e738$var$focusFirstInScope(scopeRef.current);
         }
         autoFocusRef.current = false;
-    }, []);
+    }, [
+        scopeRef
+    ]);
 }
 function $9bf71ea28793e738$var$useRestoreFocus(scopeRef, restoreFocus, contain) {
     // create a ref during render instead of useLayoutEffect so the active element is saved before a child with autoFocus=true mounts.
     const nodeToRestoreRef = $6nfFC$useRef(typeof document !== 'undefined' ? document.activeElement : null);
+    // restoring scopes should all track if they are active regardless of contain, but contain already tracks it plus logic to contain the focus
+    // restoring-non-containing scopes should only care if they become active so they can perform the restore
+    $6nfFC$useLayoutEffect(()=>{
+        let scope = scopeRef.current;
+        if (!restoreFocus || contain) return;
+        let onFocus = ()=>{
+            // If focusing an element in a child scope of the currently active scope, the child becomes active.
+            // Moving out of the active scope to an ancestor is not allowed.
+            if (!$9bf71ea28793e738$var$activeScope || $9bf71ea28793e738$var$isAncestorScope($9bf71ea28793e738$var$activeScope, scopeRef)) $9bf71ea28793e738$var$activeScope = scopeRef;
+        };
+        document.addEventListener('focusin', onFocus, false);
+        scope.forEach((element)=>element.addEventListener('focusin', onFocus, false)
+        );
+        return ()=>{
+            document.removeEventListener('focusin', onFocus, false);
+            scope.forEach((element)=>element.removeEventListener('focusin', onFocus, false)
+            );
+        };
+    }, [
+        scopeRef,
+        contain
+    ]);
     // useLayoutEffect instead of useEffect so the active element is saved synchronously instead of asynchronously.
     $6nfFC$useLayoutEffect(()=>{
-        let nodeToRestore = nodeToRestoreRef.current;
+        $9bf71ea28793e738$export$d06fae2ee68b101e.getTreeNode(scopeRef).nodeToRestore = nodeToRestoreRef.current;
         if (!restoreFocus) return;
         // 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
@@ -351,6 +400,7 @@ function $9bf71ea28793e738$var$useRestoreFocus(scopeRef, restoreFocus, contain)
             if (e.key !== 'Tab' || e.altKey || e.ctrlKey || e.metaKey) return;
             let focusedElement = document.activeElement;
             if (!$9bf71ea28793e738$var$isElementInScope(focusedElement, scopeRef.current)) return;
+            let nodeToRestore = $9bf71ea28793e738$export$d06fae2ee68b101e.getTreeNode(scopeRef).nodeToRestore;
             // Create a DOM tree walker that matches all tabbable elements
             let walker = $9bf71ea28793e738$export$2d6ec8fc375ceafa(document.body, {
                 tabbable: true
@@ -358,7 +408,10 @@ function $9bf71ea28793e738$var$useRestoreFocus(scopeRef, restoreFocus, contain)
             // Find the next tabbable element after the currently focused element
             walker.currentNode = focusedElement;
             let nextElement = e.shiftKey ? walker.previousNode() : walker.nextNode();
-            if (!document.body.contains(nodeToRestore) || nodeToRestore === document.body) nodeToRestore = null;
+            if (!document.body.contains(nodeToRestore) || nodeToRestore === document.body) {
+                nodeToRestore = null;
+                $9bf71ea28793e738$export$d06fae2ee68b101e.getTreeNode(scopeRef).nodeToRestore = null;
+            }
             // 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 || !$9bf71ea28793e738$var$isElementInScope(nextElement, scopeRef.current)) && nodeToRestore) {
@@ -379,10 +432,26 @@ function $9bf71ea28793e738$var$useRestoreFocus(scopeRef, restoreFocus, contain)
         if (!contain) document.addEventListener('keydown', onKeyDown, true);
         return ()=>{
             if (!contain) document.removeEventListener('keydown', onKeyDown, true);
-            if (restoreFocus && nodeToRestore && $9bf71ea28793e738$var$isElementInScope(document.activeElement, scopeRef.current)) requestAnimationFrame(()=>{
-                // Only restore focus if we've lost focus to the body, the alternative is that focus has been purposefully moved elsewhere
-                if (document.body.contains(nodeToRestore) && document.activeElement === document.body) $9bf71ea28793e738$var$focusElement(nodeToRestore);
-            });
+            let nodeToRestore = $9bf71ea28793e738$export$d06fae2ee68b101e.getTreeNode(scopeRef).nodeToRestore;
+            // if we already lost focus to the body and this was the active scope, then we should attempt to restore
+            if (restoreFocus && nodeToRestore && ($9bf71ea28793e738$var$isElementInScope(document.activeElement, scopeRef.current) || document.activeElement === document.body && $9bf71ea28793e738$var$activeScope === scopeRef)) {
+                // freeze the focusScopeTree so it persists after the raf, otherwise during unmount nodes are removed from it
+                let clonedTree = $9bf71ea28793e738$export$d06fae2ee68b101e.clone();
+                requestAnimationFrame(()=>{
+                    // Only restore focus if we've lost focus to the body, the alternative is that focus has been purposefully moved elsewhere
+                    if (document.activeElement === document.body) {
+                        // look up the tree starting with our scope to find a nodeToRestore still in the DOM
+                        let treeNode = clonedTree.getTreeNode(scopeRef);
+                        while(treeNode){
+                            if (treeNode.nodeToRestore && document.body.contains(treeNode.nodeToRestore)) {
+                                $9bf71ea28793e738$var$focusElement(treeNode.nodeToRestore);
+                                return;
+                            }
+                            treeNode = treeNode.parent;
+                        }
+                    }
+                });
+            }
         };
     }, [
         scopeRef,
@@ -484,6 +553,71 @@ function $9bf71ea28793e738$var$last(walker) {
     }while (last)
     return next;
 }
+class $9bf71ea28793e738$var$Tree {
+    get size() {
+        return this.fastMap.size;
+    }
+    getTreeNode(data) {
+        return this.fastMap.get(data);
+    }
+    addTreeNode(scopeRef, parent, nodeToRestore) {
+        let parentNode = this.fastMap.get(parent !== null && parent !== void 0 ? parent : null);
+        let node = new $9bf71ea28793e738$var$TreeNode({
+            scopeRef: scopeRef
+        });
+        parentNode.addChild(node);
+        node.parent = parentNode;
+        this.fastMap.set(scopeRef, node);
+        if (nodeToRestore) node.nodeToRestore = nodeToRestore;
+    }
+    removeTreeNode(scopeRef) {
+        // never remove the root
+        if (scopeRef === null) return;
+        let node = this.fastMap.get(scopeRef);
+        let parentNode = node.parent;
+        // when we remove a scope, check if any sibling scopes are trying to restore focus to something inside the scope we're removing
+        // if we are, then replace the siblings restore with the restore from the scope we're removing
+        for (let current of this.traverse())if (current !== node && node.nodeToRestore && current.nodeToRestore && node.scopeRef.current && $9bf71ea28793e738$var$isElementInScope(current.nodeToRestore, node.scopeRef.current)) current.nodeToRestore = node.nodeToRestore;
+        let children = node.children;
+        parentNode.removeChild(node);
+        if (children.length > 0) children.forEach((child)=>parentNode.addChild(child)
+        );
+        this.fastMap.delete(node.scopeRef);
+    }
+    // Pre Order Depth First
+    *traverse(node = this.root) {
+        if (node.scopeRef != null) yield node;
+        if (node.children.length > 0) for (let child of node.children)yield* this.traverse(child);
+    }
+    clone() {
+        let newTree = new $9bf71ea28793e738$var$Tree();
+        for (let node of this.traverse())newTree.addTreeNode(node.scopeRef, node.parent.scopeRef, node.nodeToRestore);
+        return newTree;
+    }
+    constructor(){
+        this.fastMap = new Map();
+        this.root = new $9bf71ea28793e738$var$TreeNode({
+            scopeRef: null
+        });
+        this.fastMap.set(null, this.root);
+    }
+}
+class $9bf71ea28793e738$var$TreeNode {
+    addChild(node) {
+        this.children.push(node);
+        node.parent = this;
+    }
+    removeChild(node) {
+        this.children.splice(this.children.indexOf(node), 1);
+        node.parent = undefined;
+    }
+    constructor(props){
+        this.children = [];
+        this.contain = false;
+        this.scopeRef = props.scopeRef;
+    }
+}
+let $9bf71ea28793e738$export$d06fae2ee68b101e = new $9bf71ea28793e738$var$Tree();