@base-ui/react 1.0.0 → 1.2.0

package/esm/floating-ui-react/hooks/useHover.js

@@ -1,10 +1,13 @@
+'use client';
+
 import * as React from 'react';
 import { isElement } from '@floating-ui/utils/dom';
 import { useTimeout } from '@base-ui/utils/useTimeout';
 import { useValueAsRef } from '@base-ui/utils/useValueAsRef';
 import { useStableCallback } from '@base-ui/utils/useStableCallback';
 import { useIsoLayoutEffect } from '@base-ui/utils/useIsoLayoutEffect';
-import { contains, getDocument, getTarget, isMouseLikePointerType } from "../utils.js";
+import { ownerDocument } from '@base-ui/utils/owner';
+import { contains, getTarget, isMouseLikePointerType } from "../utils.js";
 import { useFloatingParentNodeId, useFloatingTree } from "../components/FloatingTree.js";
 import { createChangeEventDetails } from "../../utils/createBaseUIEventDetails.js";
 import { REASONS } from "../../utils/reasons.js";
@@ -52,16 +55,12 @@ export function useHover(context, props = {}) {
     events
   } = store.context;
   const {
-    enabled = true,
     delay = 0,
     handleClose = null,
-    mouseOnly = false,
     restMs = 0,
-    move = true,
-    triggerElement = null,
-    externalTree
+    move = true
   } = props;
-  const tree = useFloatingTree(externalTree);
+  const tree = useFloatingTree();
   const parentId = useFloatingParentNodeId();
   const handleCloseRef = useValueAsRef(handleClose);
   const delayRef = useValueAsRef(delay);
@@ -89,9 +88,6 @@ export function useHover(context, props = {}) {
   // When closing before opening, clear the delay timeouts to cancel it
   // from showing.
   React.useEffect(() => {
-    if (!enabled) {
-      return undefined;
-    }
     function onOpenChangeLocal(details) {
       if (!details.open) {
         timeout.clear();
@@ -104,11 +100,8 @@ export function useHover(context, props = {}) {
     return () => {
       events.off('openchange', onOpenChangeLocal);
     };
-  }, [enabled, events, timeout, restTimeout]);
+  }, [events, timeout, restTimeout]);
   React.useEffect(() => {
-    if (!enabled) {
-      return undefined;
-    }
     if (!handleCloseRef.current) {
       return undefined;
     }
@@ -123,12 +116,12 @@ export function useHover(context, props = {}) {
         store.setOpen(false, createChangeEventDetails(REASONS.triggerHover, event, event.currentTarget ?? undefined));
       }
     }
-    const html = getDocument(floatingElement).documentElement;
+    const html = ownerDocument(floatingElement).documentElement;
     html.addEventListener('mouseleave', onLeave);
     return () => {
       html.removeEventListener('mouseleave', onLeave);
     };
-  }, [floatingElement, open, store, enabled, handleCloseRef, isHoverOpen, isClickLikeOpenEvent]);
+  }, [floatingElement, open, store, handleCloseRef, isHoverOpen, isClickLikeOpenEvent]);
   const closeWithDelay = React.useCallback((event, runElseBranch = true) => {
     const closeDelay = getDelay(delayRef.current, 'close', pointerTypeRef.current);
     if (closeDelay && !handlerRef.current) {
@@ -144,7 +137,7 @@ export function useHover(context, props = {}) {
   });
   const clearPointerEvents = useStableCallback(() => {
     if (performedPointerEventsMutationRef.current) {
-      const body = getDocument(floatingElement).body;
+      const body = ownerDocument(floatingElement).body;
       body.style.pointerEvents = '';
       body.removeAttribute(safePolygonIdentifier);
       performedPointerEventsMutationRef.current = false;
@@ -163,13 +156,10 @@ export function useHover(context, props = {}) {
   // delegation system. If the cursor was on a disabled element and then entered
   // the reference (no gap), `mouseenter` doesn't fire in the delegation system.
   React.useEffect(() => {
-    if (!enabled) {
-      return undefined;
-    }
     function onReferenceMouseEnter(event) {
       timeout.clear();
       blockMouseMoveRef.current = false;
-      if (mouseOnly && !isMouseLikePointerType(pointerTypeRef.current) || getRestMs(restMsRef.current) > 0 && !getDelay(delayRef.current, 'open')) {
+      if (getRestMs(restMsRef.current) > 0 && !getDelay(delayRef.current, 'open')) {
         return;
       }
       const openDelay = getDelay(delayRef.current, 'open', pointerTypeRef.current);
@@ -192,7 +182,7 @@ export function useHover(context, props = {}) {
         return;
       }
       unbindMouseMoveRef.current();
-      const doc = getDocument(floatingElement);
+      const doc = ownerDocument(floatingElement);
       restTimeout.clear();
       restTimeoutPendingRef.current = false;
       const triggers = store.context.triggerElements;
@@ -272,7 +262,7 @@ export function useHover(context, props = {}) {
         closeWithDelay(event, false);
       }
     }
-    const trigger = triggerElement ?? domReferenceElement;
+    const trigger = domReferenceElement;
     if (isElement(trigger)) {
       const floating = floatingElement;
       if (open) {
@@ -309,23 +299,19 @@ export function useHover(context, props = {}) {
       };
     }
     return undefined;
-  }, [enabled, mouseOnly, move, domReferenceElement, floatingElement, triggerElement, store, closeWithDelay, cleanupMouseMoveHandler, clearPointerEvents, open, tree, delayRef, handleCloseRef, dataRef, isClickLikeOpenEvent, restMsRef, timeout, restTimeout, handleInteractInside]);
+  }, [move, domReferenceElement, floatingElement, store, closeWithDelay, cleanupMouseMoveHandler, clearPointerEvents, open, tree, delayRef, handleCloseRef, dataRef, isClickLikeOpenEvent, restMsRef, timeout, restTimeout, handleInteractInside]);
 
   // Block pointer-events of every element other than the reference and floating
   // while the floating element is open and has a `handleClose` handler. Also
   // handles nested floating elements.
   // https://github.com/floating-ui/floating-ui/issues/1722
   useIsoLayoutEffect(() => {
-    if (!enabled) {
-      return undefined;
-    }
-
     // eslint-disable-next-line no-underscore-dangle
     if (open && handleCloseRef.current?.__options?.blockPointerEvents && isHoverOpen()) {
       performedPointerEventsMutationRef.current = true;
       const floatingEl = floatingElement;
       if (isElement(domReferenceElement) && floatingEl) {
-        const body = getDocument(floatingElement).body;
+        const body = ownerDocument(floatingElement).body;
         body.setAttribute(safePolygonIdentifier, '');
         const ref = domReferenceElement;
         const parentFloating = tree?.nodesRef.current.find(node => node.id === parentId)?.context?.elements.floating;
@@ -343,7 +329,7 @@ export function useHover(context, props = {}) {
       }
     }
     return undefined;
-  }, [enabled, open, parentId, tree, handleCloseRef, isHoverOpen, domReferenceElement, floatingElement]);
+  }, [open, parentId, tree, handleCloseRef, isHoverOpen, domReferenceElement, floatingElement]);
   useIsoLayoutEffect(() => {
     if (!open) {
       pointerTypeRef.current = undefined;
@@ -360,7 +346,7 @@ export function useHover(context, props = {}) {
       restTimeout.clear();
       interactedInsideRef.current = false;
     };
-  }, [enabled, domReferenceElement, cleanupMouseMoveHandler, timeout, restTimeout]);
+  }, [domReferenceElement, cleanupMouseMoveHandler, timeout, restTimeout]);
   React.useEffect(() => {
     return clearPointerEvents;
   }, [clearPointerEvents]);
@@ -385,9 +371,6 @@ export function useHover(context, props = {}) {
             store.setOpen(true, createChangeEventDetails(REASONS.triggerHover, nativeEvent, trigger));
           }
         }
-        if (mouseOnly && !isMouseLikePointerType(pointerTypeRef.current)) {
-          return;
-        }
         if (store.select('open') && !isOverInactiveTrigger || getRestMs(restMsRef.current) === 0) {
           return;
         }
@@ -407,8 +390,8 @@ export function useHover(context, props = {}) {
         }
       }
     };
-  }, [mouseOnly, store, restMsRef, restTimeout]);
-  return React.useMemo(() => enabled ? {
+  }, [store, restMsRef, restTimeout]);
+  return React.useMemo(() => ({
     reference
-  } : {}, [enabled, reference]);
+  }), [reference]);
 }

package/esm/floating-ui-react/hooks/useHoverFloatingInteraction.d.ts

@@ -1,22 +1,17 @@
 import type { FloatingContext, FloatingRootContext } from "../types.js";
-import { FloatingTreeStore } from "../components/FloatingTreeStore.js";
 export type UseHoverFloatingInteractionProps = {
   /**
    * Whether the Hook is enabled, including all internal Effects and event
    * handlers.
    * @default true
    */
-  enabled?: boolean;
+  enabled?: boolean | undefined;
   /**
    * Waits for the specified time when the event listener runs before changing
    * the `open` state.
    * @default 0
    */
-  closeDelay?: number | (() => number);
-  /**
-   * An optional external floating tree to use instead of the default context.
-   */
-  externalTree?: FloatingTreeStore;
+  closeDelay?: (number | (() => number)) | undefined;
 };
 /**
  * Provides hover interactions that should be attached to the floating element.

package/esm/floating-ui-react/hooks/useHoverFloatingInteraction.js

@@ -1,8 +1,11 @@
+'use client';
+
 import * as React from 'react';
 import { isElement } from '@floating-ui/utils/dom';
 import { useStableCallback } from '@base-ui/utils/useStableCallback';
 import { useIsoLayoutEffect } from '@base-ui/utils/useIsoLayoutEffect';
-import { getDocument, getTarget, isMouseLikePointerType } from "../utils.js";
+import { ownerDocument } from '@base-ui/utils/owner';
+import { getTarget, isMouseLikePointerType, isTargetInsideEnabledTrigger } from "../utils.js";
 import { createChangeEventDetails } from "../../utils/createBaseUIEventDetails.js";
 import { REASONS } from "../../utils/reasons.js";
 import { useFloatingParentNodeId, useFloatingTree } from "../components/FloatingTree.js";
@@ -22,23 +25,13 @@ export function useHoverFloatingInteraction(context, parameters = {}) {
   } = store.context;
   const {
     enabled = true,
-    closeDelay: closeDelayProp = 0,
-    externalTree
+    closeDelay: closeDelayProp = 0
   } = parameters;
-  const {
-    pointerTypeRef,
-    interactedInsideRef,
-    handlerRef,
-    performedPointerEventsMutationRef,
-    unbindMouseMoveRef,
-    restTimeoutPendingRef,
-    openChangeTimeout: openChangeTimeout,
-    handleCloseOptionsRef
-  } = useHoverInteractionSharedState(store);
-  const tree = useFloatingTree(externalTree);
+  const instance = useHoverInteractionSharedState(store);
+  const tree = useFloatingTree();
   const parentId = useFloatingParentNodeId();
   const isClickLikeOpenEvent = useStableCallback(() => {
-    if (interactedInsideRef.current) {
+    if (instance.interactedInside) {
       return true;
     }
     return dataRef.current.openEvent ? clickLikeEvents.has(dataRef.current.openEvent.type) : false;
@@ -47,44 +40,47 @@ export function useHoverFloatingInteraction(context, parameters = {}) {
     const type = dataRef.current.openEvent?.type;
     return type?.includes('mouse') && type !== 'mousedown';
   });
+  const isRelatedTargetInsideEnabledTrigger = useStableCallback(target => {
+    return isTargetInsideEnabledTrigger(target, store.context.triggerElements);
+  });
   const closeWithDelay = React.useCallback((event, runElseBranch = true) => {
-    const closeDelay = getDelay(closeDelayProp, pointerTypeRef.current);
-    if (closeDelay && !handlerRef.current) {
-      openChangeTimeout.start(closeDelay, () => store.setOpen(false, createChangeEventDetails(REASONS.triggerHover, event)));
+    const closeDelay = getDelay(closeDelayProp, instance.pointerType);
+    if (closeDelay && !instance.handler) {
+      instance.openChangeTimeout.start(closeDelay, () => store.setOpen(false, createChangeEventDetails(REASONS.triggerHover, event)));
     } else if (runElseBranch) {
-      openChangeTimeout.clear();
+      instance.openChangeTimeout.clear();
       store.setOpen(false, createChangeEventDetails(REASONS.triggerHover, event));
     }
-  }, [closeDelayProp, handlerRef, store, pointerTypeRef, openChangeTimeout]);
+  }, [closeDelayProp, store, instance]);
   const cleanupMouseMoveHandler = useStableCallback(() => {
-    unbindMouseMoveRef.current();
-    handlerRef.current = undefined;
+    instance.unbindMouseMove();
+    instance.handler = undefined;
   });
   const clearPointerEvents = useStableCallback(() => {
-    if (performedPointerEventsMutationRef.current) {
-      const body = getDocument(floatingElement).body;
+    if (instance.performedPointerEventsMutation) {
+      const body = ownerDocument(floatingElement).body;
       body.style.pointerEvents = '';
       body.removeAttribute(safePolygonIdentifier);
-      performedPointerEventsMutationRef.current = false;
+      instance.performedPointerEventsMutation = false;
     }
   });
   const handleInteractInside = useStableCallback(event => {
     const target = getTarget(event);
     if (!isInteractiveElement(target)) {
-      interactedInsideRef.current = false;
+      instance.interactedInside = false;
       return;
     }
-    interactedInsideRef.current = true;
+    instance.interactedInside = true;
   });
   useIsoLayoutEffect(() => {
     if (!open) {
-      pointerTypeRef.current = undefined;
-      restTimeoutPendingRef.current = false;
-      interactedInsideRef.current = false;
+      instance.pointerType = undefined;
+      instance.restTimeoutPending = false;
+      instance.interactedInside = false;
       cleanupMouseMoveHandler();
       clearPointerEvents();
     }
-  }, [open, pointerTypeRef, restTimeoutPendingRef, interactedInsideRef, cleanupMouseMoveHandler, clearPointerEvents]);
+  }, [open, instance, cleanupMouseMoveHandler, clearPointerEvents]);
   React.useEffect(() => {
     return () => {
       cleanupMouseMoveHandler();
@@ -97,9 +93,9 @@ export function useHoverFloatingInteraction(context, parameters = {}) {
     if (!enabled) {
       return undefined;
     }
-    if (open && handleCloseOptionsRef.current?.blockPointerEvents && isHoverOpen() && isElement(domReferenceElement) && floatingElement) {
-      performedPointerEventsMutationRef.current = true;
-      const body = getDocument(floatingElement).body;
+    if (open && instance.handleCloseOptions?.blockPointerEvents && isHoverOpen() && isElement(domReferenceElement) && floatingElement) {
+      instance.performedPointerEventsMutation = true;
+      const body = ownerDocument(floatingElement).body;
       body.setAttribute(safePolygonIdentifier, '');
       const ref = domReferenceElement;
       const floatingEl = floatingElement;
@@ -117,7 +113,7 @@ export function useHoverFloatingInteraction(context, parameters = {}) {
       };
     }
     return undefined;
-  }, [enabled, open, domReferenceElement, floatingElement, handleCloseOptionsRef, isHoverOpen, tree, parentId, performedPointerEventsMutationRef]);
+  }, [enabled, open, domReferenceElement, floatingElement, instance, isHoverOpen, tree, parentId]);
   React.useEffect(() => {
     if (!enabled) {
       return undefined;
@@ -130,8 +126,7 @@ export function useHoverFloatingInteraction(context, parameters = {}) {
       if (isClickLikeOpenEvent() || !dataRef.current.floatingContext || !store.select('open')) {
         return;
       }
-      const triggerElements = store.context.triggerElements;
-      if (event.relatedTarget && triggerElements.hasElement(event.relatedTarget)) {
+      if (isRelatedTargetInsideEnabledTrigger(event.relatedTarget)) {
         // If the mouse is leaving the reference element to another trigger, don't explicitly close the popup
         // as it will be moved.
         return;
@@ -143,9 +138,9 @@ export function useHoverFloatingInteraction(context, parameters = {}) {
       }
     }
     function onFloatingMouseEnter(event) {
-      openChangeTimeout.clear();
+      instance.openChangeTimeout.clear();
       clearPointerEvents();
-      handlerRef.current?.(event);
+      instance.handler?.(event);
       cleanupMouseMoveHandler();
     }
     function onFloatingMouseLeave(event) {
@@ -168,7 +163,7 @@ export function useHoverFloatingInteraction(context, parameters = {}) {
         floating.removeEventListener('pointerdown', handleInteractInside, true);
       }
     };
-  });
+  }, [enabled, floatingElement, store, dataRef, isClickLikeOpenEvent, isRelatedTargetInsideEnabledTrigger, closeWithDelay, clearPointerEvents, cleanupMouseMoveHandler, handleInteractInside, instance]);
 }
 export function getDelay(value, pointerType) {
   if (pointerType && !isMouseLikePointerType(pointerType)) {

package/esm/floating-ui-react/hooks/useHoverInteractionSharedState.d.ts

@@ -1,18 +1,21 @@
-import * as React from 'react';
-import { useTimeout } from '@base-ui/utils/useTimeout';
+import { Timeout } from '@base-ui/utils/useTimeout';
 import type { FloatingRootContext, SafePolygonOptions } from "../types.js";
 export declare const safePolygonIdentifier: string;
 export declare function isInteractiveElement(element: Element | null): boolean;
-export interface HoverInteractionSharedState {
-  pointerTypeRef: React.RefObject<string | undefined>;
-  interactedInsideRef: React.RefObject<boolean>;
-  handlerRef: React.RefObject<((event: MouseEvent) => void) | undefined>;
-  blockMouseMoveRef: React.RefObject<boolean>;
-  performedPointerEventsMutationRef: React.RefObject<boolean>;
-  unbindMouseMoveRef: React.RefObject<() => void>;
-  restTimeoutPendingRef: React.RefObject<boolean>;
-  openChangeTimeout: ReturnType<typeof useTimeout>;
-  restTimeout: ReturnType<typeof useTimeout>;
-  handleCloseOptionsRef: React.RefObject<SafePolygonOptions | undefined>;
+export declare class HoverInteraction {
+  pointerType: string | undefined;
+  interactedInside: boolean;
+  handler: ((event: MouseEvent) => void) | undefined;
+  blockMouseMove: boolean;
+  performedPointerEventsMutation: boolean;
+  unbindMouseMove: () => void;
+  restTimeoutPending: boolean;
+  openChangeTimeout: Timeout;
+  restTimeout: Timeout;
+  handleCloseOptions: SafePolygonOptions | undefined;
+  constructor();
+  static create(): HoverInteraction;
+  dispose: () => void;
+  disposeEffect: () => () => void;
 }
-export declare function useHoverInteractionSharedState(store: FloatingRootContext): HoverInteractionSharedState;
+export declare function useHoverInteractionSharedState(store: FloatingRootContext): HoverInteraction;

package/esm/floating-ui-react/hooks/useHoverInteractionSharedState.js

@@ -1,5 +1,8 @@
-import * as React from 'react';
-import { useTimeout } from '@base-ui/utils/useTimeout';
+'use client';
+
+import { useOnMount } from '@base-ui/utils/useOnMount';
+import { useRefWithInit } from '@base-ui/utils/useRefWithInit';
+import { Timeout } from '@base-ui/utils/useTimeout';
 import { createAttribute } from "../utils/createAttribute.js";
 import { TYPEABLE_SELECTOR } from "../utils/constants.js";
 export const safePolygonIdentifier = createAttribute('safe-polygon');
@@ -7,33 +10,36 @@ const interactiveSelector = `button,a,[role="button"],select,[tabindex]:not([tab
 export function isInteractiveElement(element) {
   return element ? Boolean(element.closest(interactiveSelector)) : false;
 }
+export class HoverInteraction {
+  constructor() {
+    this.pointerType = undefined;
+    this.interactedInside = false;
+    this.handler = undefined;
+    this.blockMouseMove = true;
+    this.performedPointerEventsMutation = false;
+    this.unbindMouseMove = () => {};
+    this.restTimeoutPending = false;
+    this.openChangeTimeout = new Timeout();
+    this.restTimeout = new Timeout();
+    this.handleCloseOptions = undefined;
+  }
+  static create() {
+    return new HoverInteraction();
+  }
+  dispose = () => {
+    this.openChangeTimeout.clear();
+    this.restTimeout.clear();
+  };
+  disposeEffect = () => {
+    return this.dispose;
+  };
+}
 export function useHoverInteractionSharedState(store) {
-  const pointerTypeRef = React.useRef(undefined);
-  const interactedInsideRef = React.useRef(false);
-  const handlerRef = React.useRef(undefined);
-  const blockMouseMoveRef = React.useRef(true);
-  const performedPointerEventsMutationRef = React.useRef(false);
-  const unbindMouseMoveRef = React.useRef(() => {});
-  const restTimeoutPendingRef = React.useRef(false);
-  const openChangeTimeout = useTimeout();
-  const restTimeout = useTimeout();
-  const handleCloseOptionsRef = React.useRef(undefined);
-  return React.useMemo(() => {
-    const data = store.context.dataRef.current;
-    if (!data.hoverInteractionState) {
-      data.hoverInteractionState = {
-        pointerTypeRef,
-        interactedInsideRef,
-        handlerRef,
-        blockMouseMoveRef,
-        performedPointerEventsMutationRef,
-        unbindMouseMoveRef,
-        restTimeoutPendingRef,
-        openChangeTimeout,
-        restTimeout,
-        handleCloseOptionsRef
-      };
-    }
-    return data.hoverInteractionState;
-  }, [store, pointerTypeRef, interactedInsideRef, handlerRef, blockMouseMoveRef, performedPointerEventsMutationRef, unbindMouseMoveRef, restTimeoutPendingRef, openChangeTimeout, restTimeout, handleCloseOptionsRef]);
+  const instance = useRefWithInit(HoverInteraction.create).current;
+  const data = store.context.dataRef.current;
+  if (!data.hoverInteractionState) {
+    data.hoverInteractionState = instance;
+  }
+  useOnMount(data.hoverInteractionState.disposeEffect);
+  return data.hoverInteractionState;
 }

package/esm/floating-ui-react/hooks/useHoverReferenceInteraction.d.ts

@@ -1,16 +1,20 @@
 import * as React from 'react';
 import type { FloatingContext, FloatingRootContext } from "../types.js";
 import type { UseHoverProps } from "./useHover.js";
+import type { FloatingTreeStore } from "../components/FloatingTreeStore.js";
 import { HTMLProps } from "../../utils/types.js";
-export interface UseHoverReferenceInteractionProps extends Omit<UseHoverProps, 'triggerElement'> {
+export interface UseHoverReferenceInteractionProps extends UseHoverProps {
+  enabled?: boolean | undefined;
+  mouseOnly?: boolean | undefined;
+  externalTree?: FloatingTreeStore | undefined;
   /**
    * Whether the hook controls the active trigger. When false, the props are
    * returned under the `trigger` key so they can be applied to inactive
    * triggers via `getTriggerProps`.
    * @default true
    */
-  isActiveTrigger?: boolean;
-  triggerElementRef?: Readonly<React.RefObject<Element | null>>;
+  isActiveTrigger?: boolean | undefined;
+  triggerElementRef?: Readonly<React.RefObject<Element | null>> | undefined;
 }
 /**
  * Provides hover interactions that should be attached to reference or trigger