Swizec Teller - a geek with a hatswizec.com

Senior Mindset Book

Get promoted, earn a bigger salary, work for top companies

Senior Engineer Mindset cover
Learn more

    useDimensions – a React Hook to measure DOM nodes

    Yes it's new, I just open sourced it πŸ˜›

    The other day I wanted to measure some DOM nodes. This is useful when you have to align items, or respond to browser width, or ... lots of reasons okay.

    I had to align a curvy line with elements that aren't under my control. This little stepper component uses flexbox to evenly space circles, CSS layouting aligns the title, and you see where this is going.

    SVG in the background detects position of itself, positions of the title and circle, and uses those to define the start and end line of my curve. πŸ‘Œ

    Many ways you can do this.

    @lavrton linked to a list of existing NPM packages that sort of do it. @mcalus shared how he uses react-sizeme to get it done.

    All great, but I wanted something even simpler. I also didn't know about them and kind of just wanted to make my own.

    Here's an approach I found works great

    useDimensions hook

    This seemed like a neat approach so I turned it into an open source React Hook. You might enjoy it.

    useDimensions source
    useDimensions source

    useDimensions source

    Yep that's it. It really is that simple.

    πŸ‘‰ GitHub link

    • useRef creates a React.ref, lets you access the DOM
    • useState gives you place to store/read the result
    • useLayoutEffect runs before browser paint but after all is known
    • getClientBoundingRect() measures a DOM node. Width, height, x, y, etc
    • toJSON turns a DOMRect object into a plain object so you can destructure

    Here's how to use it in your project πŸ‘‡

    First, add useDimensions to your project

    $ yarn add react-use-dimensions or $ npm install --save react-use-dimensions

    Using it in a component looks like this

    import React from "react"
    import useDimensions from "react-use-dimensions"
    
    const MyComponent = () => {
      const [ref, { x, y, width }] = useDimensions()
    
      return <div ref={ref}>This is the element you'll measure</div>
    }
    

    useDimensions returns a 2-element array. First the ref, second the dimensions.

    This is so multiple useDimensions hooks in the same component don't step on each others' toes. Create as many refs and measurement objects as you'd like.

    const MyComponent = () => {
      const [stepRef, stepSize] = useDimensions()
      const [titleRef, titleSize] = useDimensions()
    
      console.log("Step is at X: ", stepSize.x)
      console.log("Title is", titleSize.width, "wide")
    
      return (
        <div>
          <div ref={stepRef}>This is a step</div>
          <h1 ref={titleRef}>The title</h1>
        </div>
      )
    }
    

    MIT License of course.

    Consider retweeting if you think it's neat

    Enjoy ✌️
    ~Swizec

    Published on March 13th, 2019 in Front End, Technical

    Did you enjoy this article?

    Continue reading about useDimensions – a React Hook to measure DOM nodes

    Semantically similar articles hand-picked by GPT-4

    Senior Mindset Book

    Get promoted, earn a bigger salary, work for top companies

    Learn more

    Have a burning question that you think I can answer? Hit me up on twitter and I'll do my best.

    Who am I and who do I help? I'm Swizec Teller and I turn coders into engineers with "Raw and honest from the heart!" writing. No bullshit. Real insights into the career and skills of a modern software engineer.

    Want to become a true senior engineer? Take ownership, have autonomy, and be a force multiplier on your team. The Senior Engineer Mindset ebook can help πŸ‘‰ swizec.com/senior-mindset. These are the shifts in mindset that unlocked my career.

    Curious about Serverless and the modern backend? Check out Serverless Handbook, for frontend engineers πŸ‘‰ ServerlessHandbook.dev

    Want to Stop copy pasting D3 examples and create data visualizations of your own? Learn how to build scalable dataviz React components your whole team can understand with React for Data Visualization

    Want to get my best emails on JavaScript, React, Serverless, Fullstack Web, or Indie Hacking? Check out swizec.com/collections

    Did someone amazing share this letter with you? Wonderful! You can sign up for my weekly letters for software engineers on their path to greatness, here: swizec.com/blog

    Want to brush up on your modern JavaScript syntax? Check out my interactive cheatsheet: es6cheatsheet.com

    By the way, just in case no one has told you it yet today: I love and appreciate you for who you are ❀️

    Created by Swizec with ❀️