@rooks/use-boundingclientrect-ref
TypeScript icon, indicating that this package has built-in type declarations

4.11.2 • Public • Published

@rooks/use-boundingclientrect-ref

Note: Future updates to this package have moved to the main package rooks. All hooks now reside in a single package which you can install using

npm install rooks

or

yarn add rooks

Rooks is completely treeshakeable and if you use only 1 of the 50+ hooks in the package, only that hook will be bundled with your code. Your bundle will only contain the hooks that you need. Cheers!

TitleCard

Build Status

About

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

Installation

npm install --save @rooks/use-boundingclientrect-ref

Importing the hook

import useBoundingclientrectRef from "@rooks/use-boundingclientrect-ref"

Usage

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

render(<Demo/>)

Arguments

N/A

Returns an array of 3 values

Return value Type Description Default value
ref Callback ref A callback ref function to use as a ref for the component that needs to be tracked () => null
value DOMRect DOMRect Object containing x,y, width, height, left,right,top and bottom keys null
update Function Function that can be called at any time to force a recalculation of the clientrect null

Package Sidebar

Install

npm i @rooks/use-boundingclientrect-ref

Weekly Downloads

78

Version

4.11.2

License

MIT

Unpacked Size

14.2 kB

Total Files

13

Last publish

Collaborators

  • imbhargav5