react-dom-resize-observer
v1.0.0
Published
React hook implementing the Resize Observer API.
Downloads
14
Readme
React Resize Observer
Hook to provide a performant mechanism by which code can monitor an element for changes to its size, with notifications being delivered to the observer each time the size changes.
Installation
$ npm install react-dom-resize-observer
Examples
export function App() {
const {
// New dimensions when resize is observed.
entry,
// Callback to pass as a ref to give this hook access to the DOM element.
observer,
// Callback to disconnect observing completely.
disconnect,
// Callback to unobserve a specific element.
unobserve
} =
// Pass the same DOM element type as a type param to help the hook infer the correct types.
useResizeObserver<HTMLDivElement | null>({
// You can optionally pass your own ref if you already have one.
elementRef: ref,
// You can optionally pass a callback to access the raw DOM element on resize.
onResize: (el) => { /** Access the element on resize... */ },
});
return (
// Attach the observer as a ref to the DOM.
<div ref={observer} onClick={disconnect}>
App
</div>
)
}