okonet/ react-container-dimensions
About the developer
220 Stars 
26 Forks 
MIT License 
87 Commits 
34 Opened issues 
Description
Wrapper component that detects element resize and passes new dimensions down the tree. Based on https://github.com/wnr/element-resize-detector
Services available
Contributors list
react-container-dimensions 
Wrapper component that detects parent (container) element resize and passes new dimensions down the tree. Based on element-resize-detector.
npm install --save react-container-dimensions
It is especially useful when you create components with dimensions that change over time and you want to explicitely pass the container dimensions to the children. For example, SVG visualization needs to be updated in order to fit into container.
getBoundingClientRect()and passes values for all
top,
right,
bottom,
left,
width,
heightCSs attributes down the tree.
Usage
- Wrap your existing components. Children component will recieve
top
,right
,bottom
,left
,width
,height
as props.
- Use a function to pass width or height explicitely or do some calculation. Function callback will be called with an object
{ width: number, height: number }as an argument and it expects the output to be a React Component or an element.
{ ({ height }) => }
How is it different from [similarcomponenthere]
It does not create a new element in the DOM but relies on the
parentNodewhich must be present. So, basically, it acts as a middleware to pass the dimensions of your styled component to your children components. This makes it very easy to integrate with your existing code base.
For example, if your parent container has
display: flex, only adjacent children will be affected by this rule. This means if your children rely on
flexCSS property, you can't wrap it in a div anymore since this will break the flexbox flow.
So this won't work anymore:
...
react-container-dimensionsdoesn't change the resulting HTML markup, so it remains:
...
Example
Let's say you want your SVG visualization to always fit into the container. In order for SVG to scale elements properly it is required that
widthand
heightattributes are properly set on the
svgelement. Imagine the following example
Before (static)
It's hard to keep dimensions of the container and the SVG in sync. Especially, when you want your content to be resplonsive (or dynamic).
export const myVis = () => (
{/* SVG contents */}
)
After (dynamic)
This will resize and re-render the SVG each time the
div
dimensions are changed. For instance, when you change CSS for .myStyles
.
import ContainerDimensions from 'react-container-dimensions'
export const myVis = () => (
{ ({ width, height }) =>
{/* SVG contents */}
}
)
Other similar projects:
- https://github.com/digidem/react-dimensions
- https://github.com/maslianok/react-resize-detector
- https://github.com/Xananax/react-size
- https://github.com/joeybaker/react-element-query
and a few others...