Function usePosition

  • usePosition<T>(parent, options?): {
        dimensions: CSSProperties;
        positionElement: (() => void);
    }

  • Determines the position of a given element relative to a parent

    Type Parameters

    • T extends HTMLElement = HTMLDivElement

    Parameters

    • parent: RefObject<T>

      parent element

    • Optional options: PositionOptions

      Position options

    Returns {
        dimensions: CSSProperties;
        positionElement: (() => void);
    }

    • dimensions object, and positionElement function
    • dimensions: CSSProperties
    • positionElement: (() => void)
        • (): void

        • Returns void

    Example

    const { dimensions } = usePosition(document.documentElement);

Settings

Member Visibility

Theme