API Documentation

This section provides detailed API documentation for the composables and utilities exported by V-Float.

Core Composables

• useFloating - Main floating positioning composable
• useFloatingTree - Tree-aware floating element management
• useArrow - Arrow positioning for floating elements

Positioning Utilities

• useClientPoint - Pointer-based positioning with multiple tracking modes

Interaction Composables

• useClick - Click interaction handling
• useHover - Hover interaction with safe polygon support
• useFocus - Focus interaction handling
• useEscapeKey - Escape key handling

Middleware

• arrow - Arrow element alignment data
• autoPlacement - Automatically choose the best placement
• flip - Flip positioning when out of bounds
• hide - Provide data to hide when reference is hidden or escaped
• offset - Offset positioning
• shift - Shift positioning to stay in bounds
• size - Size-aware positioning