feat(core): detect_overflow configurable via platform

DanielleHuisman · DanielleHuisman · commit 6c15f9f6761e · 2026-03-12T11:17:51.000+01:00
diff --git a/packages/core/src/compute_position.rs b/packages/core/src/compute_position.rs
@@ -6,6 +6,9 @@ use crate::types::{
     MiddlewareReturn, MiddlewareState, Reset, ResetRects,
 };
 
+/// Maximum number of resets that can occur before bailing to avoid infinite reset loops.
+const MAX_RESET_COUNT: i32 = 50;
+
 /// Computes the `x` and `y` coordinates that will place the floating element next to a given reference element.
 ///
 /// This export does not have any `platform` interface logic. You will need to write one for the platform you are using Floating UI with.
@@ -87,7 +90,7 @@ pub fn compute_position<Element: Clone, Window: Clone>(
         }
 
         if let Some(reset) = reset
-            && reset_count <= 50
+            && reset_count < MAX_RESET_COUNT
         {
             reset_count += 1;
 
diff --git a/packages/core/src/middleware/auto_placement.rs b/packages/core/src/middleware/auto_placement.rs
@@ -5,7 +5,7 @@ use floating_ui_utils::{
 use serde::{Deserialize, Serialize};
 
 use crate::{
-    detect_overflow::{DetectOverflowOptions, detect_overflow},
+    detect_overflow::DetectOverflowOptions,
     types::{
         Derivable, DerivableFn, Middleware, MiddlewareReturn, MiddlewareState,
         MiddlewareWithOptions, Reset, ResetValue,
@@ -236,7 +236,7 @@ impl<Element: Clone + PartialEq, Window: Clone + PartialEq> Middleware<Element,
             allowed_placements
         };
 
-        let overflow = detect_overflow(
+        let overflow = platform.detect_overflow(
             MiddlewareState {
                 elements: elements.clone(),
                 ..state
diff --git a/packages/core/src/middleware/flip.rs b/packages/core/src/middleware/flip.rs
@@ -5,7 +5,7 @@ use floating_ui_utils::{
 use serde::{Deserialize, Serialize};
 
 use crate::{
-    detect_overflow::{DetectOverflowOptions, detect_overflow},
+    detect_overflow::DetectOverflowOptions,
     middleware::arrow::{ARROW_NAME, ArrowData},
     types::{
         Derivable, DerivableFn, Middleware, MiddlewareReturn, MiddlewareState,
@@ -264,7 +264,7 @@ impl<Element: Clone + PartialEq, Window: Clone + PartialEq> Middleware<Element,
 
         placements.insert(0, initial_placement);
 
-        let overflow = detect_overflow(
+        let overflow = platform.detect_overflow(
             MiddlewareState {
                 elements: elements.clone(),
                 ..state
diff --git a/packages/core/src/middleware/hide.rs b/packages/core/src/middleware/hide.rs
@@ -2,7 +2,7 @@ use floating_ui_utils::{ALL_SIDES, Rect, SideObject};
 use serde::{Deserialize, Serialize};
 
 use crate::{
-    detect_overflow::{DetectOverflowOptions, detect_overflow},
+    detect_overflow::DetectOverflowOptions,
     types::{
         Derivable, DerivableFn, ElementContext, Middleware, MiddlewareReturn, MiddlewareState,
         MiddlewareWithOptions,
@@ -132,14 +132,17 @@ impl<Element: Clone + PartialEq, Window: Clone + PartialEq> Middleware<Element,
         let options = self.options.evaluate(state.clone());
 
         let MiddlewareState {
-            elements, rects, ..
+            elements,
+            rects,
+            platform,
+            ..
         } = state;
 
         let strategy = options.strategy.unwrap_or_default();
 
         match strategy {
             HideStrategy::ReferenceHidden => {
-                let overflow = detect_overflow(
+                let overflow = platform.detect_overflow(
                     MiddlewareState {
                         elements: elements.clone(),
                         ..state
@@ -168,7 +171,7 @@ impl<Element: Clone + PartialEq, Window: Clone + PartialEq> Middleware<Element,
                 }
             }
             HideStrategy::Escaped => {
-                let overflow = detect_overflow(
+                let overflow = platform.detect_overflow(
                     MiddlewareState {
                         elements: elements.clone(),
                         ..state
diff --git a/packages/core/src/middleware/shift.rs b/packages/core/src/middleware/shift.rs
@@ -5,7 +5,7 @@ use floating_ui_utils::{Axis, Coords, Side, clamp, get_opposite_axis, get_side_a
 use serde::{Deserialize, Serialize};
 
 use crate::{
-    detect_overflow::{DetectOverflowOptions, detect_overflow},
+    detect_overflow::DetectOverflowOptions,
     middleware::{OFFSET_NAME, OffsetData},
     types::{
         Derivable, DerivableFn, Middleware, MiddlewareReturn, MiddlewareState,
@@ -166,7 +166,11 @@ impl<Element: Clone + PartialEq + 'static, Window: Clone + PartialEq + 'static>
         let options = self.options.evaluate(state.clone());
 
         let MiddlewareState {
-            x, y, placement, ..
+            x,
+            y,
+            placement,
+            platform,
+            ..
         } = state;
 
         let check_main_axis = options.main_axis.unwrap_or(true);
@@ -175,7 +179,7 @@ impl<Element: Clone + PartialEq + 'static, Window: Clone + PartialEq + 'static>
         let limiter = options.limiter.unwrap_or(Box::<DefaultLimiter>::default());
 
         let coords = Coords { x, y };
-        let overflow = detect_overflow(
+        let overflow = platform.detect_overflow(
             MiddlewareState {
                 elements: state.elements.clone(),
                 ..state
diff --git a/packages/core/src/middleware/size.rs b/packages/core/src/middleware/size.rs
@@ -3,7 +3,7 @@ use std::ptr;
 use floating_ui_utils::{Alignment, Axis, Rect, Side, get_side_axis};
 
 use crate::{
-    detect_overflow::{DetectOverflowOptions, detect_overflow},
+    detect_overflow::DetectOverflowOptions,
     middleware::shift::{SHIFT_NAME, ShiftData},
     types::{
         Derivable, DerivableFn, Middleware, MiddlewareReturn, MiddlewareState,
@@ -142,7 +142,7 @@ impl<Element: Clone + PartialEq, Window: Clone + PartialEq> Middleware<Element,
             ..
         } = state;
 
-        let overflow = detect_overflow(
+        let overflow = platform.detect_overflow(
             MiddlewareState {
                 elements: elements.clone(),
                 ..state
diff --git a/packages/core/src/test_utils.rs b/packages/core/src/test_utils.rs
@@ -1,6 +1,9 @@
-use floating_ui_utils::{Dimensions, ElementRects, Rect};
+use floating_ui_utils::{Dimensions, ElementRects, Rect, SideObject};
 
-use crate::types::{GetClippingRectArgs, GetElementRectsArgs, Platform};
+use crate::{
+    detect_overflow::{DetectOverflowOptions, detect_overflow},
+    types::{GetClippingRectArgs, GetElementRectsArgs, MiddlewareState, Platform},
+};
 
 #[derive(Clone, Debug)]
 pub struct Element {}
@@ -49,6 +52,14 @@ impl Platform<Element, Window> for TestPlatform {
             height: 10.0,
         }
     }
+
+    fn detect_overflow(
+        &self,
+        state: MiddlewareState<Element, Window>,
+        options: DetectOverflowOptions<Element>,
+    ) -> SideObject {
+        detect_overflow(state, options)
+    }
 }
 
 pub const PLATFORM: TestPlatform = TestPlatform {};
diff --git a/packages/core/src/types.rs b/packages/core/src/types.rs
@@ -6,9 +6,11 @@ use serde::{Serialize, de::DeserializeOwned};
 
 use floating_ui_utils::{
     ClientRectObject, Coords, Dimensions, ElementOrVirtual, ElementOrWindow, ElementRects, Length,
-    OwnedElementOrWindow, Placement, Rect, Strategy,
+    OwnedElementOrWindow, Placement, Rect, SideObject, Strategy,
 };
 
+use crate::detect_overflow::DetectOverflowOptions;
+
 pub type DerivableFn<'a, Element, Window, T> = &'a dyn Fn(MiddlewareState<Element, Window>) -> T;
 
 pub enum Derivable<'a, Element: Clone + 'static, Window: Clone, T: Clone> {
@@ -133,6 +135,12 @@ pub trait Platform<Element: Clone, Window: Clone>: Debug {
     fn get_client_length(&self, _element: &Element, _length: Length) -> Option<f64> {
         None
     }
+
+    fn detect_overflow(
+        &self,
+        state: MiddlewareState<Element, Window>,
+        options: DetectOverflowOptions<Element>,
+    ) -> SideObject;
 }
 
 /// Data stored by middleware.
diff --git a/packages/dom/src/platform.rs b/packages/dom/src/platform.rs
@@ -9,12 +9,14 @@ pub mod get_scale;
 pub mod is_rtl;
 
 use floating_ui_core::{
-    ConvertOffsetParentRelativeRectToViewportRelativeRectArgs, GetClippingRectArgs,
-    GetElementRectsArgs, Platform as CorePlatform,
+    ConvertOffsetParentRelativeRectToViewportRelativeRectArgs, DetectOverflowOptions,
+    GetClippingRectArgs, GetElementRectsArgs, MiddlewareState, Platform as CorePlatform,
+    detect_overflow,
 };
 use floating_ui_utils::dom::get_document_element;
 use floating_ui_utils::{
     ClientRectObject, Coords, Dimensions, ElementRects, Length, OwnedElementOrWindow, Rect,
+    SideObject,
 };
 use web_sys::{Element, Window};
 
@@ -79,4 +81,12 @@ impl CorePlatform<Element, Window> for Platform {
     fn get_client_length(&self, element: &Element, length: Length) -> Option<f64> {
         Some(get_client_length(element, length))
     }
+
+    fn detect_overflow(
+        &self,
+        state: MiddlewareState<Element, Window>,
+        options: DetectOverflowOptions<Element>,
+    ) -> SideObject {
+        detect_overflow(state, options)
+    }
 }
