JSPM

@lbfalvy/usedimensions

1.0.1
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 16
  • Score
    100M100P100Q56871F
  • License MIT

Get notified when the bounding rect of a component changes

Package Exports

  • @lbfalvy/usedimensions
  • @lbfalvy/usedimensions/build/cjs/index.js
  • @lbfalvy/usedimensions/build/esm/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@lbfalvy/usedimensions) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

useDimensions

Be notified when the client rect of an element changes. There are many implementations of this function on the internet but most of them aren't written for React and none of the other ones (that I know of) work all the time regardless of the reason for the change.

usage

Just call the hook and then write whatever logic you want within your component. Note that dimensions maintains reference identity so you can safely use it in dependency arrays. Remeber that if you end up changing the dimensions of the target in this handler you can create an undetectable loop. Such loops aren't prevented by a rate limiter because it's normal for systems that depend on element sizes to rerender a few times before settling into a stable state.

const [ref, dimensions, isVisible] = useDimensions<HTMLDivElement>()
React.useEffect(() => {
  if (!isVisible) console.log('div not visible')
  else console.log(`div appeared or changed size or position: ${dimensions}`)
}, [dimensions])
return <div ref={ref}>
  ...
</div>