Interface AnchorPositionProps

Props of the useAnchorPosition hook.

interface AnchorPositionProps {
    getAnchorRect: (() => undefined | DOMRect);
    getContainerRect?: (() => undefined | DOMRect);
    getTargetRect: (() => undefined | DOMRect);
    isDisabled?: boolean;
    isRTL?: boolean;
    onPositionChange: ((info: Readonly<AnchorPositionInfo>) => void);
    variants?: AnchorPositionVariant[];
}

Properties

getAnchorRect getContainerRect? getTargetRect isDisabled? isRTL? onPositionChange variants?

Properties

getAnchorRect

getAnchorRect: (() => undefined | DOMRect)

Returns a bounding rect of an anchor relative to a window around which a target is positioned.

OptionalgetContainerRect

getContainerRect?: (() => undefined | DOMRect)

Returns a bounding rect of a container that constrains a target positioning.

By default, window visual viewport is used as a container.

getTargetRect

getTargetRect: (() => undefined | DOMRect)

Returns a bounding rect of an element that is positioned around an anchor.

OptionalisDisabled

isDisabled?: boolean

If true then anchored position of a target element isn't tracked.

Default

false

OptionalisRTL

isRTL?: boolean

If true then horizontal alignment is mirrored.

By default, RTL is derived a document.

onPositionChange

onPositionChange: ((info: Readonly<AnchorPositionInfo>) => void)

A handler that is called when the target element must be repositioned.

Type declaration

    • (info): void

    • Parameters

      • info: Readonly<AnchorPositionInfo>

        An info about the current target position around an anchor. The info object is reused between handler invocations.

      Returns void

Optionalvariants

variants?: AnchorPositionVariant[]

An array of target position variants from which the most suitable is picked.

By default, a single variant is used with default settings.

Settings

Member Visibility

On This Page

Properties