# All files / src/_hooks BoundingRect.tsx

100% Statements 27/27
71.42% Branches 5/7
100% Functions 5/5
100% Lines 19/19

Press n or j to go to the next uncovered block, b, p or k for the previous block.

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    43
    44
    45
    46
    47
    48
    49
    50
    51
    52
    53
    54
    55
    56
    57
    58
    59
    60
    61
    62
    63
    64
    65
    66
    67
    68
    69
    70
    71
    72
    73
    74
    75
    76
    77
    78
    79
    80
    81
    82
    83
    84
    85
    86
    872x
    2x

    10x
    10x

    10x

    10x

    10x
    7x
    5x

    10x

    2x
    1x

    1x

    2x

    2x

    2x
    1x

    2x
    2x

     import React from 'react'
    import { defaultRect, getBoundingRect, Rect } from '../_utils/dom'

    interface BoundingRectConfig {
      dependencies?: Array<any>
    }

    interface Props extends BoundingRectConfig {
      children: React.ReactNode
    }

    interface RenderProps extends BoundingRectConfig {
      children: (props: BoundingRectApi) => {}
    }

    interface BoundingRectApi {
      ref: React.RefObject<any>
      rect: Rect
    }

    /* HOOK */

    /**
     * @deprecatedSince 9
     * @deprecated Never officially documented/supported
     */
    export function useBoundingRect({
      dependencies = [],
    }: BoundingRectConfig = {}): BoundingRectApi {
      const ref = React.useRef<any>(null)

      const [rect, setRect] = React.useState(defaultRect)

      React.useLayoutEffect(() => {
        if (ref.current) {
          setRect(getBoundingRect(ref.current))
        }
      }, [ref.current, ...dependencies]) // TODO Fix

      return { ref, rect }
    }

    /* RENDER PROP */

    /**
     * @deprecatedSince 9
     * @deprecated Never officially documented/supported
     */
    export function BoundingRect({ children, ...props }: RenderProps) {
      const boundingRect = useBoundingRect(props)

      return typeof children === 'function' ? children(boundingRect) : children
    }

    /* CONTEXT */

    const context: BoundingRectApi = {
      ref: { current: null },
      rect: defaultRect,
    }

    /**
     * @deprecatedSince 9
     * @deprecated Never officially documented/supported
     */
    export const BoundingRectContext = React.createContext(context)

    /**
     * @deprecatedSince 9
     * @deprecated Never officially documented/supported
     */
    export function BoundingRectProvider({ children, ...props }: Props) {
      return (
        <BoundingRectContext.Provider value={useBoundingRect(props)}>
          {children}
        </BoundingRectContext.Provider>
      )
    }

    /**
     * @deprecatedSince 9
     * @deprecated Never officially documented/supported
     */
    export function useBoundingRectContext() {
      return React.useContext(BoundingRectContext)
    }