Module floating_ui_core::middleware

Middleware implementations for compute_position.

Structs

• ApplyState
  State passed to SizeOptions::apply.
• Arrow
  Provides data to position an inner element of the floating element so that it appears centered to the reference element.
• ArrowData
  Data stored by Arrow middleware.
• ArrowOptions
  Options for Arrow.
• AutoPlacement
  Optimizes the visibility of the floating element by choosing the placement that has the most space available automatically, without needing to specify a preferred placement. Alternative to Flip.
• AutoPlacementData
  Data stored by AutoPlacement middleware.
• AutoPlacementDataOverflow
  An overflow stored in AutoPlacementData.
• AutoPlacementOptions
  Options for AutoPlacement middleware.
• DefaultLimiter
  Default Limiter, which doesn’t limit shifting.
• Flip
  Optimizes the visibility of the floating element by flipping the placement in order to keep it in view when the preferred placement(s) will overflow the clipping boundary. Alternative to AutoPlacement.
• FlipData
  Data stored by Flip middleware.
• FlipDataOverflow
  An overflow stored in FlipData.
• FlipOptions
  Options for Flip middleware.
• Hide
  Provides data to hide the floating element in applicable situations, such as when it is not in the same clipping context as the reference element.
• HideData
  Data stored by Hide middleware.
• HideOptions
  Options for Hide middleware.
• Inline
  Provides improved positioning for inline reference elements that can span over multiple lines, such as hyperlinks or range selections.
• InlineOptions
  Options for Inline.
• LimitShift
  Built-in Limiter, that will stop Shift at a certain point.
• LimitShiftOffsetValues
  Axes configuration for LimitShiftOffset.
• LimitShiftOptions
  Options for LimitShift limiter.
• Offset
  Modifies the placement by translating the floating element along the specified axes.
• OffsetData
  Data stored by Offset middleware.
• OffsetOptionsValues
  Axes configuration for OffsetOptions.
• Shift
  Optimizes the visibility of the floating element by shifting it in order to keep it in view when it will overflow the clipping boundary.
• ShiftData
  Data stored by Shift middleware.
• ShiftOptions
  Options for Shift middleware.
• Size
  Provides data that allows you to change the size of the floating element - for instance, prevent it from overflowing the clipping boundary or match the width of the reference element.
• SizeOptions
  Options for Size middleware.

Enums

• FallbackStrategy
  Fallback strategy used by Flip middleware.
• HideStrategy
  Fallback strategy used by Hide middleware.
• LimitShiftOffset
  Offset configuration for LimitShiftOptions.
• OffsetOptions
  Options for Offset middleware.

Constants

• ARROW_NAME
  Name of the Arrow middleware.
• AUTO_PLACEMENT_NAME
  Name of the AutoPlacement middleware.
• FLIP_NAME
  Name of the Flip middleware.
• HIDE_NAME
  Name of the Hide middleware.
• INLINE_NAME
  Name of the Inline middleware.
• OFFSET_NAME
  Name of the Offset middleware.
• SHIFT_NAME
  Name of the Shift middleware.
• SIZE_NAME
  Name of the Size middleware.

Traits

• Limiter
  Limiter used by Shift middleware. Limits the shifting done in order to prevent detachment.

Type Aliases

• ApplyFn