@floating-ui/react - npm Package Compare versions

Comparing version 0.27.6 to 0.27.7

dist/floating-ui.react.d.ts

@@ -192,3 +192,3 @@ import { AlignedPlacement } from '@floating-ui/react-dom';
 
-declare type Delay = number | Partial<{
+export declare type Delay = number | Partial<{
     open: number;
@@ -198,2 +198,7 @@ close: number;
 
+declare type Delay_2 = number | Partial<{
+    open: number;
+    close: number;
+}>;
+
 export { detectOverflow }
@@ -205,2 +210,7 @@
 
+declare type Duration = number | {
+    open?: number;
+    close?: number;
+};
+
 export { ElementContext }
@@ -308,3 +318,3 @@
 
-declare interface FloatingDelayGroupProps {
+export declare interface FloatingDelayGroupProps {
     children?: React.ReactNode;
@@ -314,3 +324,3 @@ /**
      */
-    delay: Delay;
+    delay: Delay_2;
     /**
@@ -551,4 +561,4 @@ * An optional explicit timeout to use for the group, which represents when
 declare interface GroupState {
-    delay: Delay;
-    initialDelay: Delay;
+    delay: Delay_2;
+    initialDelay: Delay_2;
     currentId: any;
@@ -645,2 +655,28 @@ timeoutMs: number;
 
+/**
+ * Experimental next version of `FloatingDelayGroup` to become the default
+ * in the future. This component is not yet stable.
+ * Provides context for a group of floating elements that should share a
+ * `delay`. Unlike `FloatingDelayGroup`, `useNextDelayGroup` with this
+ * component does not cause a re-render of unrelated consumers of the
+ * context when the delay changes.
+ * @see https://floating-ui.com/docs/FloatingDelayGroup
+ */
+export declare function NextFloatingDelayGroup(props: NextFloatingDelayGroupProps): React.JSX.Element;
+
+export declare interface NextFloatingDelayGroupProps {
+    children?: React.ReactNode;
+    /**
+     * The delay to use for the group when it's not in the instant phase.
+     */
+    delay: Delay;
+    /**
+     * An optional explicit timeout to use for the group, which represents when
+     * grouping logic will no longer be active after the close delay completes.
+     * This is useful if you want grouping to “last” longer than the close delay,
+     * for example if there is no close delay at all.
+     */
+    timeoutMs?: number;
+}
+
 export { NodeScroll }
@@ -1016,6 +1052,6 @@
      * Waits until the user’s cursor is at “rest” over the reference element
-     *  before changing the `open` state.
+     * before changing the `open` state.
      * @default 0
      */
-    restMs?: number;
+    restMs?: number | (() => number);
     /**
@@ -1026,6 +1062,3 @@ * Waits for the specified time when the event listener runs before changing
      */
-    delay?: number | {
-        open?: number;
-        close?: number;
-    };
+    delay?: Delay | (() => Delay);
     /**
@@ -1262,2 +1295,32 @@ * Whether the logic only runs for mouse input, ignoring touch input.
 /**
+ * Enables grouping when called inside a component that's a child of a
+ * `NextFloatingDelayGroup`.
+ * @see https://floating-ui.com/docs/FloatingDelayGroup
+ */
+export declare function useNextDelayGroup(context: FloatingRootContext, options?: UseNextDelayGroupOptions): UseNextDelayGroupReturn;
+
+declare interface UseNextDelayGroupOptions {
+    /**
+     * Whether delay grouping should be enabled.
+     * @default true
+     */
+    enabled?: boolean;
+}
+
+declare interface UseNextDelayGroupReturn {
+    /**
+     * The delay reference object.
+     */
+    delayRef: React.MutableRefObject<Delay>;
+    /**
+     * Whether animations should be removed.
+     */
+    isInstantPhase: boolean;
+    /**
+     * Whether a `<NextFloatingDelayGroup>` provider is present.
+     */
+    hasProvider: boolean;
+}
+
+/**
  * Adds base screen reader props to the reference and floating elements for a
@@ -1298,6 +1361,3 @@ * given floating element `role`.
      */
-    duration?: number | {
-        open?: number;
-        close?: number;
-    };
+    duration?: Duration;
 }
@@ -1304,0 +1364,0 @@

package.json

 {
   "name": "@floating-ui/react",
-  "version": "0.27.6",
+  "version": "0.27.7",
   "description": "Floating UI for React",
@@ -5,0 +5,0 @@ "publishConfig": {

No alert changes

Improved metrics

Total package byte prevSize

786965

3.38%

Lines of code

17658

3.77%

No dependency changes