import * as React from 'react'; import { useFloating, type FloatingRootContext, type VirtualElement, type Padding, type FloatingContext } from '@floating-ui/react'; import { type Rect } from '@floating-ui/utils'; export type Side = 'top' | 'bottom' | 'left' | 'right' | 'inline-end' | 'inline-start'; export type Align = 'start' | 'center' | 'end'; export type Boundary = 'clipping-ancestors' | Element | Element[] | Rect; /** * Provides standardized anchor positioning behavior for floating elements. Wraps Floating UI's * `useFloating` hook. * @ignore - internal hook. */ export declare function useAnchorPositioning(params: useAnchorPositioning.Parameters): useAnchorPositioning.ReturnValue; export declare namespace useAnchorPositioning { interface SharedParameters { /** * An element to position the popup against. * By default, the popup will be positioned against the trigger. */ anchor?: Element | null | VirtualElement | React.RefObject | (() => Element | VirtualElement | null); /** * Whether the popup is currently open. */ open?: boolean; /** * Determines which CSS `position` property to use. * @default 'absolute' */ positionMethod?: 'absolute' | 'fixed'; /** * Which side of the anchor element to align the popup against. * May automatically change to avoid collisions. * @default 'bottom' */ side?: Side; /** * Distance between the anchor and the popup. * @default 0 */ sideOffset?: number; /** * How to align the popup relative to the specified side. * @default 'center' */ align?: 'start' | 'end' | 'center'; /** * Additional offset along the alignment axis of the element. * @default 0 */ alignOffset?: number; /** * An element or a rectangle that delimits the area that the popup is confined to. * @default 'clipping-ancestors' */ collisionBoundary?: Boundary; /** * Additional space to maintain from the edge of the collision boundary. * @default 5 */ collisionPadding?: Padding; /** * Whether to maintain the popup in the viewport after * the anchor element was scrolled out of view. * @default false */ sticky?: boolean; /** * Minimum distance to maintain between the arrow and the edges of the popup. * * Use it to prevent the arrow element from hanging out of the rounded corners of a popup. * @default 5 */ arrowPadding?: number; /** * Whether the popup tracks any layout shift of its positioning anchor. * @default true */ trackAnchor?: boolean; /** * Whether to keep the popup mounted in the DOM while it's hidden. * @default false */ keepMounted?: boolean; } interface Parameters extends SharedParameters { trackCursorAxis?: 'none' | 'x' | 'y' | 'both'; floatingRootContext?: FloatingRootContext; mounted: boolean; trackAnchor: boolean; nodeId?: string; } interface ReturnValue { positionerStyles: React.CSSProperties; arrowStyles: React.CSSProperties; arrowRef: React.RefObject; arrowUncentered: boolean; side: Side; align: Align; anchorHidden: boolean; refs: ReturnType['refs']; context: FloatingContext; isPositioned: boolean; } }