useElementSize Hook

useElementSize is a React hook that enables dynamic tracking of an HTML element's dimensions. It updates the element's width and height in response to window resizing, element mounting/unmounting, and ref changes.

Features

• Dynamic Dimension Tracking: Automatically tracks and updates the width and height of the specified element.
• Responsive to Environmental Changes: Responds to window resizing and ref changes, ensuring accurate size measurements.
• SSR Safe: Compatible with server-side rendering, avoiding errors in environments without a window object.
• Optimized for Accuracy: Uses useLayoutEffect for precise dimension measurements after DOM mutations.

Installation

Choose and install individual hooks that suit your project needs, or install the entire collection for a full suite of utilities.

Installing Only Current Hooks

1npm install @custom-react-hooks/use-element-size

or

1yarn add @custom-react-hooks/use-element-size

Installing All Hooks

1npm install @custom-react-hooks/all

or

1yarn add @custom-react-hooks/all

Importing the Hook

The useElementSize hook must be imported using a named import as shown below:

Named Import:

1import { useElementSize } from '@custom-react-hooks/use-element-size';

This approach ensures that the hook integrates seamlessly into your project, maintaining consistency and predictability in how you use our package.

Usage

1import React, { useRef, useState } from 'react';
2import { useElementSize } from '@custom-react-hooks/all';
3
4const ElementSizeComponent = () => {
5  const [setRef, size] = useElementSize();
6
7  return (
8    <div className="element-size">
9      <div
10        ref={setRef}
11        className="resize"
12      >
13        <p>Drag from the bottom-right corner to resize.</p>
14      </div>
15      <br />
16      <div>Current Size:</div>
17      <div className="btns">
18        <p>
19          Width: <span>{size.width}px</span>
20        </p>
21        <p>
22          Height: <span>{size.height}px</span>
23        </p>
24      </div>
25    </div>
26  );
27};
28
29export default ElementSizeComponent;

In this example, useElementSize is used to measure and display the dimensions of a div element.

API Reference

Parameters

• ref: A React ref object attached to the element whose size you want to measure.

Returns object

• width: width of the element
• height: height of the element.

Use cases

• Responsive Components: Adjust component behavior or style based on its size.
• Layout Calculations: Calculate layout for items like grids or masonry layouts that depend on element sizes.
• Size-dependent Rendering: Render different content or components based on available size.
• Animations and Transitions: Trigger animations or transitions when an element's size changes.
• Optimizing Canvas or SVG: Adjust dimensions for canvas or SVG elements based on their container size.

Contributing

Your contributions to improve useElementSize are welcome. Feel free to submit issues or pull requests to the repository.