Skip to main content
Version: 5.0.3



A hook that tracks the boundingclientrect of an element. It returns a callbackRef so that the element node if changed is easily tracked.


npm install --save rooks

Importing the hook#

import { useBoundingclientrectRef } from 'rooks';


function Demo() {
const [myRef, boundingClientRect] = useBoundingclientrectRef();
const [XOffset, setXOffset] = useState(0);
const [YOffset, setYOffset] = useState(300);
const displayString = JSON.stringify(boundingClientRect, null, 2);
return (
width: 300,
background: 'lightblue',
padding: '10px',
position: 'absolute',
left: XOffset,
top: YOffset,
resize: 'both',
overflow: 'auto',
background: 'white',
color: 'blue',
maxWidth: '100%',
Resize this div as you see fit. To demonstrate that it also updates
on child dom nodes resize
<button onClick={() => setXOffset(XOffset - 5)}> Move Left </button>
<button onClick={() => setXOffset(XOffset + 5)}> Move Right </button>
<button onClick={() => setYOffset(YOffset - 5)}> Move Up </button>
<button onClick={() => setYOffset(YOffset + 5)}> Move Down </button>
<div style={{ height: 500 }}>
render(<Demo />);



Returns an array of 3 values#

Return valueTypeDescriptionDefault value
refCallback refA callback ref function to use as a ref for the component that needs to be tracked() => null
valueDOMRectDOMRect Object containing x,y, width, height, left,right,top and bottom keysnull
updateFunctionFunction that can be called at any time to force a recalculation of the clientrectnull

Codesandbox Example#

Basic Usage#

Join Bhargav's discord server#

You can click on the floating discord icon at the bottom right of the screen and talk to us in our server.

Last updated on by imbhargav5