Revise useFocus/useFocusWithin (facebook#19310)

trueadm · web-flow · commit 2562e758eaa0 · 2020-07-10T17:23:00.000+01:00
diff --git a/packages/dom-event-testing-library/domEvents.js b/packages/dom-event-testing-library/domEvents.js
@@ -234,6 +234,10 @@ export function blur({relatedTarget} = {}) {
   return new FocusEvent('blur', {relatedTarget});
 }
 
+export function focusOut({relatedTarget} = {}) {
+  return new FocusEvent('focusout', {relatedTarget, bubbles: true});
+}
+
 export function click(payload) {
   return createMouseEvent('click', {
     button: buttonType.primary,
@@ -259,6 +263,10 @@ export function focus({relatedTarget} = {}) {
   return new FocusEvent('focus', {relatedTarget});
 }
 
+export function focusIn({relatedTarget} = {}) {
+  return new FocusEvent('focusin', {relatedTarget, bubbles: true});
+}
+
 export function scroll() {
   return createEvent('scroll');
 }
diff --git a/packages/dom-event-testing-library/index.js b/packages/dom-event-testing-library/index.js
@@ -22,12 +22,14 @@ const createEventTarget = node => ({
    */
   blur(payload) {
     node.dispatchEvent(domEvents.blur(payload));
+    node.dispatchEvent(domEvents.focusOut(payload));
   },
   click(payload) {
     node.dispatchEvent(domEvents.click(payload));
   },
   focus(payload) {
     node.dispatchEvent(domEvents.focus(payload));
+    node.dispatchEvent(domEvents.focusIn(payload));
     node.focus();
   },
   keydown(payload) {
diff --git a/packages/react-interactions/events/src/dom/create-event-handle/Focus.js b/packages/react-interactions/events/src/dom/create-event-handle/Focus.js
@@ -10,7 +10,7 @@
 import * as React from 'react';
 import useEvent from './useEvent';
 
-const {useEffect, useRef} = React;
+const {useCallback, useEffect, useRef} = React;
 
 type UseFocusOptions = {|
   disabled?: boolean,
@@ -126,7 +126,7 @@ function handleGlobalFocusVisibleEvent(
 }
 
 const passiveObject = {passive: true};
-const passiveCaptureObject = {capture: true, passive: false};
+const passiveObjectWithPriority = {passive: true, priority: 0};
 
 function handleFocusVisibleTargetEvent(
   type: string,
@@ -243,8 +243,8 @@ export function useFocus(
 ): void {
   // Setup controlled state for this useFocus hook
   const stateRef = useRef({isFocused: false, isFocusVisible: false});
-  const focusHandle = useEvent('focus', passiveCaptureObject);
-  const blurHandle = useEvent('blur', passiveCaptureObject);
+  const focusHandle = useEvent('focusin', passiveObjectWithPriority);
+  const blurHandle = useEvent('focusout', passiveObjectWithPriority);
   const focusVisibleHandles = useFocusVisibleInputHandles();
 
   useEffect(() => {
@@ -317,7 +317,9 @@ export function useFocus(
 }
 
 export function useFocusWithin(
-  focusWithinTargetRef: {current: null | Node},
+  focusWithinTargetRef:
+    | {current: null | Node}
+    | ((focusWithinTarget: null | Node) => void),
   {
     disabled,
     onAfterBlurWithin,
@@ -327,114 +329,134 @@ export function useFocusWithin(
     onFocusWithinChange,
     onFocusWithinVisibleChange,
   }: UseFocusWithinOptions,
-) {
+): (focusWithinTarget: null | Node) => void {
   // Setup controlled state for this useFocus hook
-  const stateRef = useRef({isFocused: false, isFocusVisible: false});
-  const focusHandle = useEvent('focus', passiveCaptureObject);
-  const blurHandle = useEvent('blur', passiveCaptureObject);
+  const stateRef = useRef<null | {isFocused: boolean, isFocusVisible: boolean}>(
+    {isFocused: false, isFocusVisible: false},
+  );
+  const focusHandle = useEvent('focusin', passiveObjectWithPriority);
+  const blurHandle = useEvent('focusout', passiveObjectWithPriority);
   const afterBlurHandle = useEvent('afterblur', passiveObject);
   const beforeBlurHandle = useEvent('beforeblur', passiveObject);
   const focusVisibleHandles = useFocusVisibleInputHandles();
 
-  useEffect(() => {
-    const focusWithinTarget = focusWithinTargetRef.current;
-    const state = stateRef.current;
+  const useFocusWithinRef = useCallback(
+    (focusWithinTarget: null | Node) => {
+      // Handle the incoming focusTargetRef. It can be either a function ref
+      // or an object ref.
+      if (typeof focusWithinTargetRef === 'function') {
+        focusWithinTargetRef(focusWithinTarget);
+      } else {
+        focusWithinTargetRef.current = focusWithinTarget;
+      }
+      const state = stateRef.current;
+
+      if (focusWithinTarget !== null && state !== null) {
+        // Handle focus visible
+        setFocusVisibleListeners(
+          focusVisibleHandles,
+          focusWithinTarget,
+          isFocusVisible => {
+            if (state.isFocused && state.isFocusVisible !== isFocusVisible) {
+              state.isFocusVisible = isFocusVisible;
+              if (onFocusWithinVisibleChange) {
+                onFocusWithinVisibleChange(isFocusVisible);
+              }
+            }
+          },
+        );
 
-    if (focusWithinTarget !== null && state !== null) {
-      // Handle focus visible
-      setFocusVisibleListeners(
-        focusVisibleHandles,
-        focusWithinTarget,
-        isFocusVisible => {
-          if (state.isFocused && state.isFocusVisible !== isFocusVisible) {
-            state.isFocusVisible = isFocusVisible;
+        // Handle focus
+        focusHandle.setListener(focusWithinTarget, event => {
+          if (disabled) {
+            return;
+          }
+          if (!state.isFocused) {
+            state.isFocused = true;
+            state.isFocusVisible = isGlobalFocusVisible;
+            if (onFocusWithinChange) {
+              onFocusWithinChange(true);
+            }
+            if (state.isFocusVisible && onFocusWithinVisibleChange) {
+              onFocusWithinVisibleChange(true);
+            }
+          }
+          if (!state.isFocusVisible && isGlobalFocusVisible) {
+            state.isFocusVisible = isGlobalFocusVisible;
             if (onFocusWithinVisibleChange) {
-              onFocusWithinVisibleChange(isFocusVisible);
+              onFocusWithinVisibleChange(true);
             }
           }
-        },
-      );
-
-      // Handle focus
-      focusHandle.setListener(focusWithinTarget, event => {
-        if (disabled) {
-          return;
-        }
-        if (!state.isFocused) {
-          state.isFocused = true;
-          state.isFocusVisible = isGlobalFocusVisible;
-          if (onFocusWithinChange) {
-            onFocusWithinChange(true);
+          if (onFocusWithin) {
+            onFocusWithin(event);
           }
-          if (state.isFocusVisible && onFocusWithinVisibleChange) {
-            onFocusWithinVisibleChange(true);
+        });
+
+        // Handle blur
+        blurHandle.setListener(focusWithinTarget, event => {
+          if (disabled) {
+            return;
           }
-        }
-        if (!state.isFocusVisible && isGlobalFocusVisible) {
-          state.isFocusVisible = isGlobalFocusVisible;
-          if (onFocusWithinVisibleChange) {
-            onFocusWithinVisibleChange(true);
+          const {relatedTarget} = (event.nativeEvent: any);
+
+          if (
+            state.isFocused &&
+            // $FlowFixMe: focusWithinTarget is never null
+            !isRelatedTargetWithin(focusWithinTarget, relatedTarget)
+          ) {
+            state.isFocused = false;
+            if (onFocusWithinChange) {
+              onFocusWithinChange(false);
+            }
+            if (state.isFocusVisible && onFocusWithinVisibleChange) {
+              onFocusWithinVisibleChange(false);
+            }
+            if (onBlurWithin) {
+              onBlurWithin(event);
+            }
           }
-        }
-        if (onFocusWithin) {
-          onFocusWithin(event);
-        }
-        isEmulatingMouseEvents = false;
-      });
+        });
 
-      // Handle blur
-      blurHandle.setListener(focusWithinTarget, event => {
-        if (disabled) {
-          return;
-        }
-        const {relatedTarget} = (event: any);
-
-        if (
-          state.isFocused &&
-          !isRelatedTargetWithin(focusWithinTarget, relatedTarget)
-        ) {
-          state.isFocused = false;
-          if (onFocusWithinChange) {
-            onFocusWithinChange(false);
+        // Handle before blur. This is a special
+        // React provided event.
+        beforeBlurHandle.setListener(focusWithinTarget, event => {
+          if (disabled) {
+            return;
           }
-          if (state.isFocusVisible && onFocusWithinVisibleChange) {
-            onFocusWithinVisibleChange(false);
+          if (onBeforeBlurWithin) {
+            onBeforeBlurWithin(event);
+            // Add an "afterblur" listener on document. This is a special
+            // React provided event.
+            afterBlurHandle.setListener(document, afterBlurEvent => {
+              if (onAfterBlurWithin) {
+                onAfterBlurWithin(afterBlurEvent);
+              }
+              // Clear listener on document
+              afterBlurHandle.setListener(document, null);
+            });
           }
-          if (onBlurWithin) {
-            onBlurWithin(event);
-          }
-        }
-        isEmulatingMouseEvents = false;
-      });
-
-      // Handle before blur. This is a special
-      // React provided event.
-      beforeBlurHandle.setListener(focusWithinTarget, event => {
-        if (disabled) {
-          return;
-        }
-        if (onBeforeBlurWithin) {
-          onBeforeBlurWithin(event);
-          // Add an "afterblur" listener on document. This is a special
-          // React provided event.
-          afterBlurHandle.setListener(document, afterBlurEvent => {
-            if (onAfterBlurWithin) {
-              onAfterBlurWithin(afterBlurEvent);
-            }
-            // Clear listener on document
-            afterBlurHandle.setListener(document, null);
-          });
-        }
-      });
-    }
-  }, [
-    disabled,
-    onBlurWithin,
-    onFocusWithin,
-    onFocusWithinChange,
-    onFocusWithinVisibleChange,
-  ]);
+        });
+      }
+    },
+    [
+      afterBlurHandle,
+      beforeBlurHandle,
+      blurHandle,
+      disabled,
+      focusHandle,
+      focusVisibleHandles,
+      focusWithinTargetRef,
+      onAfterBlurWithin,
+      onBeforeBlurWithin,
+      onBlurWithin,
+      onFocusWithin,
+      onFocusWithinChange,
+      onFocusWithinVisibleChange,
+    ],
+  );
 
   // Mount/Unmount logic
-  useFocusLifecycles(stateRef);
+  useFocusLifecycles();
+
+  return useFocusWithinRef;
 }
diff --git a/packages/react-interactions/events/src/dom/create-event-handle/__tests__/useFocusWithin-test.internal.js b/packages/react-interactions/events/src/dom/create-event-handle/__tests__/useFocusWithin-test.internal.js

Original file line number	Diff line number	Diff line change
`@@ -234,6 +234,10 @@ export function blur({relatedTarget} = {}) {`
`234`	`234`	`return new FocusEvent('blur', {relatedTarget});`
`235`	`235`	`}`
`236`	`236`
	`237`	`+export function focusOut({relatedTarget} = {}) {`
	`238`	`+ return new FocusEvent('focusout', {relatedTarget, bubbles: true});`
	`239`	`+}`
	`240`	`+`
`237`	`241`	`export function click(payload) {`
`238`	`242`	`return createMouseEvent('click', {`
`239`	`243`	`button: buttonType.primary,`
`@@ -259,6 +263,10 @@ export function focus({relatedTarget} = {}) {`
`259`	`263`	`return new FocusEvent('focus', {relatedTarget});`
`260`	`264`	`}`
`261`	`265`
	`266`	`+export function focusIn({relatedTarget} = {}) {`
	`267`	`+ return new FocusEvent('focusin', {relatedTarget, bubbles: true});`
	`268`	`+}`
	`269`	`+`
`262`	`270`	`export function scroll() {`
`263`	`271`	`return createEvent('scroll');`
`264`	`272`	`}`