npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

use-react-dimensions

v2.0.1

Published

React hooks for resizing svg's viewbox and calculating its size-relevant properties dynamically

Downloads

124

Readme

Build Status Coverage Status

use-react-dimensions

React hook for resizing component(especially, svg view box or canvas ) and re-calculating its size-relevant properties.

Version 2.0.1 - There is a complete renewal of the library. A bug which makes a component re-render infinitely without CSS fixed width and height resolved.

Concept

There is some time we need to calculate element's size and rerender it without CSS styling. Especially, the element's dimensions is fully depending on its parent's width and height. This is particularly useful on SVG, Canvas because they are not controlled by CSS styling per media queries. So, this hook will be useful to control them, but any HTML element without its own styles could be.

You can set margins on four directions as you wish both fractional ratios on width and height and static values.Then, this hook calculates 'bounded' width and height which represents areas except margin areas and recalculates them whenever 'resize' occurs.

Here is a visual concept of these properties.

--------------------------------------------------
|           Margin-Top                            |
|        __________________________________       |
|       |  ^                               |Margin|
|Margin |  ^                               |Right |
|Left   |  ^BoundedHeight                  |      |
|       |                                  |      |
|       |                                  |      |
|       |                                  |      |
|       |                                  |      |
|       |      BoundedWidth >>>>           |      |
|       |__________________________________|      |
|            Margin-Bottom                        |
|_________________________________________________|

Install

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

Usage

import React from 'react';
import useDimensions from 'use-react-dimensions';

const SomeComponent:React.FC = () => {
    // ref: React.MutableRefObject<HTMLDivElement>;
    // dimensions : ResizedDimension; 
    const { ref, dimensions } = useDimensions<HTMLDivElement>({
        marginLeft?: /* could be fraction number less than 1 or any real number */
        marginTop?: /* could be fraction number less than 1 or any real number */
        marginRight?: /* could be fraction number less than 1 or any real number */
        marginBottom?: /* could be fraction number less than 1 or any real number */
        width? /*You can give initial width and height of component. But,*/
        height?/* it is unneccesary because those will be calculated by resize observer and updated*/
    } /* or just an empty object {} */);
    // attaching ref to the observed wrapper component
    return <div ref={ref}>
        {
            // to prevent to render with initial dimensions
            dimensions.isDomAttached &&
            <svg
                width={dimensions.width}
                heihgt={dimensions.height}
            >
                ....render children
            </svg>
        }
    </div> 
} 

Types

// initial props for useDimensions
// you can just pass an empty object.
interface InitialDimensions {
    width?: number;
    height?: number;
    marginLeft?: number;
    marginRight?: number;
    marginTop?: number;
    marginBottom?: number;
}
// Returned dimensions 
interface ResizedDimensions {
    width: number;
    height: number;
    marginLeft: number;
    marginRight: number;
    marginTop: number;
    marginBottom: number;
    boundedHeight: number;
    boundedWidth: number;
    isDomAttached: boolean;
}

Note

margins of between 'InitialDimensions' and 'ResizedDimensions' could be different.
When you give fraction numbers to the margins on 'InitialDimensions', 
returned margins of 'ResizedDimensions' will be numbers calculated by fractional ratios of width and height.