@base-ui/react 1.1.0 → 1.2.0

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

@@ -2,8 +2,8 @@ import { FloatingTreeStore } from "../components/FloatingTreeStore.js";
 import type { ElementProps, FloatingContext, FloatingRootContext } from "../types.js";
 type PressType = 'intentional' | 'sloppy';
 export declare function normalizeProp(normalizable?: boolean | {
-  escapeKey?: boolean;
-  outsidePress?: boolean;
+  escapeKey?: boolean | undefined;
+  outsidePress?: boolean | undefined;
 }): {
   escapeKey: boolean;
   outsidePress: boolean;
@@ -14,26 +14,26 @@ export interface UseDismissProps {
    * handlers.
    * @default true
    */
-  enabled?: boolean;
+  enabled?: boolean | undefined;
   /**
    * Whether to dismiss the floating element upon pressing the `esc` key.
    * @default true
    */
-  escapeKey?: boolean;
+  escapeKey?: boolean | undefined;
   /**
    * Whether to dismiss the floating element upon pressing the reference
    * element. You likely want to ensure the `move` option in the `useHover()`
    * Hook has been disabled when this is in use.
    * @default false
    */
-  referencePress?: boolean;
+  referencePress?: boolean | undefined;
   /**
    * The type of event to use to determine a "press".
    * - `down` is `pointerdown` on mouse input, but special iOS-like touch handling on touch input.
    * - `up` is lazy on both mouse + touch input (equivalent to `click`).
    * @default 'down'
    */
-  referencePressEvent?: PressType;
+  referencePressEvent?: PressType | undefined;
   /**
    * Whether to dismiss the floating element upon pressing outside of the
    * floating element.
@@ -47,37 +47,37 @@ export interface UseDismissProps {
    * ```
    * @default true
    */
-  outsidePress?: boolean | ((event: MouseEvent | TouchEvent) => boolean);
+  outsidePress?: (boolean | ((event: MouseEvent | TouchEvent) => boolean)) | undefined;
   /**
    * The type of event to use to determine an outside "press".
    * - `intentional` requires the user to click outside intentionally, firing on `pointerup` for mouse, and requiring minimal `touchmove`s for touch.
    * - `sloppy` fires on `pointerdown` for mouse, while for touch it fires on `touchend` (within 1 second) or while scrolling away after `touchstart`.
    */
-  outsidePressEvent?: PressType | {
+  outsidePressEvent?: (PressType | {
     mouse: PressType;
     touch: PressType;
   } | (() => PressType | {
     mouse: PressType;
     touch: PressType;
-  });
+  })) | undefined;
   /**
    * Whether to dismiss the floating element upon scrolling an overflow
    * ancestor.
    * @default false
    */
-  ancestorScroll?: boolean;
+  ancestorScroll?: boolean | undefined;
   /**
    * Determines whether event listeners bubble upwards through a tree of
    * floating elements.
    */
-  bubbles?: boolean | {
-    escapeKey?: boolean;
-    outsidePress?: boolean;
-  };
+  bubbles?: (boolean | {
+    escapeKey?: boolean | undefined;
+    outsidePress?: boolean | undefined;
+  }) | undefined;
   /**
    * External FlatingTree to use when the one provided by context can't be used.
    */
-  externalTree?: FloatingTreeStore;
+  externalTree?: FloatingTreeStore | undefined;
 }
 /**
  * Closes the floating element when a dismissal is requested — by default, when

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

@@ -1,9 +1,12 @@
+'use client';
+
 import * as React from 'react';
 import { getOverflowAncestors } from '@floating-ui/react-dom';
 import { getComputedStyle, getParentNode, isElement, isHTMLElement, isLastTraversableNode, isWebKit } from '@floating-ui/utils/dom';
 import { Timeout, useTimeout } from '@base-ui/utils/useTimeout';
 import { useStableCallback } from '@base-ui/utils/useStableCallback';
-import { contains, getDocument, getTarget, isEventTargetWithin, isReactEvent, isRootElement, getNodeChildren } from "../utils.js";
+import { ownerDocument } from '@base-ui/utils/owner';
+import { contains, getTarget, isEventTargetWithin, isReactEvent, isRootElement, getNodeChildren } from "../utils.js";
 
 /* eslint-disable no-underscore-dangle */
 
@@ -133,7 +136,7 @@ export function useDismiss(context, props = {}) {
     }
     const target = getTarget(event);
     const inertSelector = `[${createAttribute('inert')}]`;
-    const markers = getDocument(store.select('floatingElement')).querySelectorAll(inertSelector);
+    const markers = ownerDocument(store.select('floatingElement')).querySelectorAll(inertSelector);
     const triggers = store.context.triggerElements;
 
     // If another trigger is clicked, don't close the floating element.
@@ -331,7 +334,7 @@ export function useDismiss(context, props = {}) {
         isComposingRef.current = false;
       });
     }
-    const doc = getDocument(floatingElement);
+    const doc = ownerDocument(floatingElement);
     doc.addEventListener('pointerdown', trackPointerType, true);
     if (escapeKey) {
       doc.addEventListener('keydown', closeOnEscapeKeyDown);

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

@@ -1,3 +1,5 @@
+'use client';
+
 import * as React from 'react';
 import { useFloating as usePosition } from '@floating-ui/react-dom';
 import { isElement } from '@floating-ui/utils/dom';

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

@@ -1,18 +1,12 @@
 import type { ReferenceType } from "../types.js";
 import type { BaseUIChangeEventDetails } from "../../utils/createBaseUIEventDetails.js";
 import { FloatingRootStore } from "../components/FloatingRootStore.js";
-import { PopupTriggerMap } from "../../utils/popups/index.js";
 export interface UseFloatingRootContextOptions {
-  open?: boolean;
+  open?: boolean | undefined;
   onOpenChange?(open: boolean, eventDetails: BaseUIChangeEventDetails<string>): void;
   elements?: {
-    reference?: ReferenceType | null;
-    floating?: HTMLElement | null;
-    triggers?: PopupTriggerMap;
-  };
-  /**
-   * Whether to prevent the auto-emitted `openchange` event.
-   */
-  noEmit?: boolean;
+    reference?: (ReferenceType | null) | undefined;
+    floating?: (HTMLElement | null) | undefined;
+  } | undefined;
 }
 export declare function useFloatingRootContext(options: UseFloatingRootContextOptions): FloatingRootStore;

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

@@ -1,3 +1,5 @@
+'use client';
+
 import { isElement } from '@floating-ui/utils/dom';
 import { useId } from '@base-ui/utils/useId';
 import { useRefWithInit } from '@base-ui/utils/useRefWithInit';
@@ -24,10 +26,10 @@ export function useFloatingRootContext(options) {
     onOpenChange,
     referenceElement: elements.reference ?? null,
     floatingElement: elements.floating ?? null,
-    triggerElements: elements.triggers ?? new PopupTriggerMap(),
+    triggerElements: new PopupTriggerMap(),
     floatingId,
     nested,
-    noEmit: options.noEmit || false
+    noEmit: false
   })).current;
   useIsoLayoutEffect(() => {
     const valuesToSync = {
@@ -47,6 +49,6 @@ export function useFloatingRootContext(options) {
   }, [open, floatingId, elements.reference, elements.floating, store]);
   store.context.onOpenChange = onOpenChange;
   store.context.nested = nested;
-  store.context.noEmit = options.noEmit || false;
+  store.context.noEmit = false;
   return store;
 }

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

@@ -5,18 +5,12 @@ export interface UseFocusProps {
    * handlers.
    * @default true
    */
-  enabled?: boolean;
-  /**
-   * Whether the open state only changes if the focus event is considered
-   * visible (`:focus-visible` CSS selector).
-   * @default true
-   */
-  visibleOnly?: boolean;
+  enabled?: boolean | undefined;
   /**
    * Waits for the specified time before opening.
    * @default undefined
    */
-  delay?: number | (() => number | undefined);
+  delay?: (number | (() => number | undefined)) | undefined;
 }
 /**
  * Opens the floating element while the reference element has focus, like CSS

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

@@ -1,8 +1,11 @@
+'use client';
+
 import * as React from 'react';
 import { getWindow, isElement, isHTMLElement } from '@floating-ui/utils/dom';
 import { isMac, isSafari } from '@base-ui/utils/detectBrowser';
 import { useTimeout } from '@base-ui/utils/useTimeout';
-import { activeElement, contains, getDocument, getTarget, isTypeableElement, matchesFocusVisible } from "../utils.js";
+import { ownerDocument } from '@base-ui/utils/owner';
+import { activeElement, contains, getTarget, isTargetInsideEnabledTrigger, isTypeableElement, matchesFocusVisible } from "../utils.js";
 import { createChangeEventDetails } from "../../utils/createBaseUIEventDetails.js";
 import { REASONS } from "../../utils/reasons.js";
 import { createAttribute } from "../utils/createAttribute.js";
@@ -20,7 +23,6 @@ export function useFocus(context, props = {}) {
   } = store.context;
   const {
     enabled = true,
-    visibleOnly = true,
     delay
   } = props;
   const blockFocusRef = React.useRef(false);
@@ -40,7 +42,7 @@ export function useFocus(context, props = {}) {
     // return to the tab/window.
     function onBlur() {
       const currentDomReference = store.select('domReferenceElement');
-      if (!store.select('open') && isHTMLElement(currentDomReference) && currentDomReference === activeElement(getDocument(currentDomReference))) {
+      if (!store.select('open') && isHTMLElement(currentDomReference) && currentDomReference === activeElement(ownerDocument(currentDomReference))) {
         blockFocusRef.current = true;
       }
     }
@@ -96,7 +98,7 @@ export function useFocus(context, props = {}) {
         blockedReferenceRef.current = null;
       }
       const target = getTarget(event.nativeEvent);
-      if (visibleOnly && isElement(target)) {
+      if (isElement(target)) {
         // Safari fails to match `:focus-visible` if focus was initially
         // outside the document.
         if (isMacSafari && !event.relatedTarget) {
@@ -107,13 +109,13 @@ export function useFocus(context, props = {}) {
           return;
         }
       }
-      const movedFromOtherTrigger = event.relatedTarget && store.context.triggerElements.hasElement(event.relatedTarget);
+      const movedFromOtherEnabledTrigger = isTargetInsideEnabledTrigger(event.relatedTarget, store.context.triggerElements);
       const {
         nativeEvent,
         currentTarget
       } = event;
       const delayValue = typeof delay === 'function' ? delay() : delay;
-      if (store.select('open') && movedFromOtherTrigger || delayValue === 0 || delayValue === undefined) {
+      if (store.select('open') && movedFromOtherEnabledTrigger || delayValue === 0 || delayValue === undefined) {
         store.setOpen(true, createChangeEventDetails(REASONS.triggerFocus, nativeEvent, currentTarget));
         return;
       }
@@ -159,16 +161,13 @@ export function useFocus(context, props = {}) {
         // the floating element. The focus handler of that trigger will
         // handle the open state.
         const nextFocusedElement = relatedTarget ?? activeEl;
-        if (isElement(nextFocusedElement)) {
-          const triggerElements = store.context.triggerElements;
-          if (triggerElements.hasElement(nextFocusedElement) || triggerElements.hasMatchingElement(trigger => contains(trigger, nextFocusedElement))) {
-            return;
-          }
+        if (isTargetInsideEnabledTrigger(nextFocusedElement, store.context.triggerElements)) {
+          return;
         }
         store.setOpen(false, createChangeEventDetails(REASONS.triggerFocus, nativeEvent));
       });
     }
-  }), [dataRef, store, visibleOnly, timeout, delay]);
+  }), [dataRef, store, timeout, delay]);
   return React.useMemo(() => enabled ? {
     reference,
     trigger: reference

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

@@ -1,62 +1,39 @@
-import { FloatingTreeStore } from "../components/FloatingTreeStore.js";
 import type { Delay, ElementProps, FloatingContext, FloatingRootContext, FloatingTreeType, SafePolygonOptions } from "../types.js";
 export interface HandleCloseContext extends FloatingContext {
   onClose: () => void;
-  tree?: FloatingTreeType | null;
-  leave?: boolean;
+  tree?: (FloatingTreeType | null) | undefined;
+  leave?: boolean | undefined;
 }
 export interface HandleClose {
   (context: HandleCloseContext): (event: MouseEvent) => void;
-  __options?: SafePolygonOptions;
+  __options?: SafePolygonOptions | undefined;
 }
 export declare function getDelay(value: UseHoverProps['delay'], prop: 'open' | 'close', pointerType?: PointerEvent['pointerType']): number | undefined;
 export interface UseHoverProps {
-  /**
-   * Whether the Hook is enabled, including all internal Effects and event
-   * handlers.
-   * @default true
-   */
-  enabled?: boolean;
   /**
    * Accepts an event handler that runs on `mousemove` to control when the
    * floating element closes once the cursor leaves the reference element.
    * @default null
    */
-  handleClose?: HandleClose | null;
+  handleClose?: (HandleClose | null) | undefined;
   /**
    * Waits until the user’s cursor is at “rest” over the reference element
    * before changing the `open` state.
    * @default 0
    */
-  restMs?: number | (() => number);
+  restMs?: (number | (() => number)) | undefined;
   /**
    * Waits for the specified time when the event listener runs before changing
    * the `open` state.
    * @default 0
    */
-  delay?: Delay | (() => Delay);
-  /**
-   * Whether the logic only runs for mouse input, ignoring touch input.
-   * Note: due to a bug with Linux Chrome, "pen" inputs are considered "mouse".
-   * @default false
-   */
-  mouseOnly?: boolean;
+  delay?: (Delay | (() => Delay)) | undefined;
   /**
    * Whether moving the cursor over the floating element will open it, without a
    * regular hover event required.
    * @default true
    */
-  move?: boolean;
-  /**
-   * Allows to override the element that will trigger the popup.
-   * When it's set, useHover won't read the reference element from the root context.
-   * This allows to have multiple triggers per floating element (assuming `useHover` is called per trigger).
-   */
-  triggerElement?: HTMLElement | null;
-  /**
-   * External FlatingTree to use when the one provided by context can't be used.
-   */
-  externalTree?: FloatingTreeStore;
+  move?: boolean | undefined;
 }
 /**
  * Opens the floating element while hovering over the reference element, like

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.