one-hook
Size
0.38 kb
View source

useResizeObserver

The React version of the ResizeObserver API.

Installation

npm install @1hook/use-resize-observer

Usage

import {  } from '@1hook/use-resize-observer'

Observe an element:

function () {
  const {  } = (() => {
    .('The target element has been resized!')
  })

  return < ={} />
}

Manual observation control:

function () {
  const { , ,  } = (
    () => .('Resized!'),
    { : false }, // Disable automatic observation
  )

  return (
    <>
      < ={} />

      < ={}>Start observing</>

      < ={}>Stop observing</>
    </>
  )
}

API Reference

UseResizeObserverOptions

The options for the useResizeObserver hook. See MDN docsfor more details.

PropTypeDefault
autoObserve?
boolean
true
box?
ResizeObserverBoxOptions
-

UseResizeObserverReturn

The return value of the useResizeObserver hook.

PropTypeDefault
target
Element | null
-
ref
Function
-
unobserve
() => void
-
observe
() => void
-

On this page