feat(useDelayGroup): add enabled option (#3080)

atomiks · web-flow · commit c0c83b42e4d1 · 2024-10-14T13:15:33.000+11:00
diff --git a/.changeset/metal-dragons-shave.md b/.changeset/metal-dragons-shave.md
@@ -0,0 +1,5 @@
+---
+"@floating-ui/react": patch
+---
+
+feat(useDelayGroup): add `enabled` option
diff --git a/packages/react/src/components/FloatingDelayGroup.tsx b/packages/react/src/components/FloatingDelayGroup.tsx
@@ -116,6 +116,11 @@ export function FloatingDelayGroup(
 }
 
 interface UseGroupOptions {
+  /**
+   * Whether delay grouping should be enabled.
+   * @default true
+   */
+  enabled?: boolean;
   id?: any;
 }
 
@@ -129,14 +134,15 @@ export function useDelayGroup(
   options: UseGroupOptions = {},
 ): GroupContext {
   const {open, onOpenChange, floatingId} = context;
-  const {id: optionId} = options;
+  const {id: optionId, enabled = true} = options;
   const id = optionId ?? floatingId;
 
   const groupContext = useDelayGroupContext();
   const {currentId, setCurrentId, initialDelay, setState, timeoutMs} =
     groupContext;
 
   useModernLayoutEffect(() => {
+    if (!enabled) return;
     if (!currentId) return;
 
     setState({
@@ -149,14 +155,15 @@ export function useDelayGroup(
     if (currentId !== id) {
       onOpenChange(false);
     }
-  }, [id, onOpenChange, setState, currentId, initialDelay]);
+  }, [enabled, id, onOpenChange, setState, currentId, initialDelay]);
 
   useModernLayoutEffect(() => {
     function unset() {
       onOpenChange(false);
       setState({delay: initialDelay, currentId: null});
     }
 
+    if (!enabled) return;
     if (!currentId) return;
 
     if (!open && currentId === id) {
@@ -169,12 +176,22 @@ export function useDelayGroup(
 
       unset();
     }
-  }, [open, setState, currentId, id, onOpenChange, initialDelay, timeoutMs]);
+  }, [
+    enabled,
+    open,
+    setState,
+    currentId,
+    id,
+    onOpenChange,
+    initialDelay,
+    timeoutMs,
+  ]);
 
   useModernLayoutEffect(() => {
+    if (!enabled) return;
     if (setCurrentId === NOOP || !open) return;
     setCurrentId(id);
-  }, [open, setCurrentId, id]);
+  }, [enabled, open, setCurrentId, id]);
 
   return groupContext;
 }

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +---
 +"@floating-ui/react": patch
 +---
++
 +feat(useDelayGroup): add `enabled` option