Crate floating_ui_dom

Source

Expand description

Rust port of Floating UI.

This is the library to use Floating UI on the web, wrapping floating_ui_core with DOM interface logic.

See the Rust Floating UI book for more documenation.

See @floating-ui/dom for the original package.

Re-exports§

pub use floating_ui_utils::AlignedPlacement;
pub use floating_ui_utils::Alignment;
pub use floating_ui_utils::Axis;
pub use floating_ui_utils::ClientRectObject;
pub use floating_ui_utils::Coords;
pub use floating_ui_utils::Dimensions;
pub use floating_ui_utils::ElementRects;
pub use floating_ui_utils::Length;
pub use floating_ui_utils::Padding;
pub use floating_ui_utils::PartialSideObject;
pub use floating_ui_utils::Placement;
pub use floating_ui_utils::Rect;
pub use floating_ui_utils::Side;
pub use floating_ui_utils::SideObject;
pub use floating_ui_utils::Strategy;
pub use floating_ui_utils::VirtualElement;
pub use floating_ui_utils::dom;

Structs§

ApplyState: State passed to SizeOptions::apply.
ArrowData: Data stored by Arrow middleware.
ArrowOptions: Options for Arrow.
AutoPlacementData: Data stored by AutoPlacement middleware.
AutoPlacementDataOverflow: An overflow stored in AutoPlacementData.
AutoPlacementOptions: Options for AutoPlacement middleware.
AutoUpdateOptions: Options for auto_update.
ComputePositionConfig: Options for compute_position.
ComputePositionReturn: Return of compute_position.
DefaultLimiter: Default Limiter, which doesn’t limit shifting.
DetectOverflowOptions: Options for detect_overflow.
FlipData: Data stored by Flip middleware.
FlipDataOverflow: An overflow stored in FlipData.
FlipOptions: Options for Flip middleware.
HideData: Data stored by Hide middleware.
HideOptions: Options for Hide middleware.
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.
MiddlewareData: Data stored by middleware.
MiddlewareReturn: Return of Middleware::compute.
MiddlewareState: State passed to Middleware::compute.
OffsetData: Data stored by Offset middleware.
OffsetOptionsValues: Axes configuration for OffsetOptions.
Platform
ShiftData: Data stored by Shift middleware.
ShiftOptions: Options for Shift middleware.
SizeOptions: Options for Size middleware.

Enums§

Boundary
CrossAxis: Cross axis option used by Flip middleware.
Derivable
ElementContext
FallbackStrategy: Fallback strategy used by Flip middleware.
HideStrategy: Fallback strategy used by Hide middleware.
LimitShiftOffset: Offset configuration for LimitShiftOptions.
OffsetOptions: Options for Offset middleware.
RootBoundary

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§

Middleware: Middleware used by compute_position.
MiddlewareWithOptions: Middleware with options.

Functions§

auto_update: Automatically updates the position of the floating element when necessary. Should only be called when the floating element is mounted on the DOM or visible on the screen.
compute_position: Computes the x and y coordinates that will place the floating element next to a given reference element.

Type Aliases§

Arrow: Arrow middleware.
AutoPlacement: Auto placement middleware.
DefaultVirtualElement
DerivableFn
ElementOrVirtual
Flip: Flip middleware.
Hide: Hide middleware.
Inline: Inline middleware.
MiddlewareVec: Vector of middleware used in ComputePositionConfig.
Offset: Offset middleware.
OwnedElementOrVirtual
Shift: Shift middleware.
Size: Size middleware.

Crate floating_ui_domCopy item path