Function floating_ui_core::detect_overflow

source ·
pub fn detect_overflow<Element: Clone, Window: Clone>(
    state: MiddlewareState<'_, Element, Window>,
    options: DetectOverflowOptions<Element>
) -> SideObject
Expand description

Resolves with an object of overflow side offsets that determine how much the element is overflowing a given clipping boundary on each side.

  • positive = overflowing the boundary by that number of pixels
  • negative = how many pixels left before it will overflow
  • 0 = lies flush with the boundary

See https://floating-ui.com/docs/detectOverflow for the original documentation.