Skip to content
Swizec Teller - a geek with a hatswizec.com

Build responsive SVG layouts with react-svg-flexbox

SVG is great. Best way to build scalable graphics on the web. SVG can do everything from simple logos to data visualization and even animation.

The best part is, you can manipulate SVG with both CSS and JavaScript. It's an image that's part of your DOM. 🀯

Look at this animated fire example. Isn't it neat? No animated image required, just some SVG elements and a bit of JavaScript.

SVG Fire πŸ”₯

No wonder then that SVG is the norm when it comes to data visualization and other programmable graphics.

Just one problem: SVG sucks at layout

Absolutely terrible. There's no layout support at all. You get absolute positioning and that's it. Sure, you can position absolutely within absolutely positioned elements, which is sort of relative positioning, but ugh ...

Absolute positioning hell

A React + D3 dashboard of scatterplots

Say you're building a small dashboard. Like of different scatterplots looking at a dataset about dog breeds.

Because the data is there, and you can, of course.

You create a scatterplot component. It takes an x and a y position and sizing info. Inside, it places two axes, a caption, and the datapoints.

The <Scatterplot> is absolutely positioned via a translate transformation. That moves an SVG element by a vector from (0, 0), thus rendering at the (x, y) coordinate.

You render each scatterplot like this:

<scatterplot data={data} x={100} y={100} width={350} height={350} filter="{d" =="">
d.weight &&
d.height &&
d.weight[0] &&
d.height[0]
}
xData={d => d.weight[0]}
yData={d => d.height[0]}
xLabel="Weight (lbs)"
yLabel="Height (in)"
title="Dog Breed Height & Weight"
entry={props => (
<datapoint breed={props.d.breed} {...props}="">
)}
/>
</datapoint></scatterplot>

A lot of arguments, I know. Data, positioning, sizing, functions for interpreting data, a few labels, and a render prop for each datapoint.

Once positioned with a grouping element <g>, the scatterplot can use quasi-relative positioning for its elements.

render() {
return (
<g transform="{`translate(${x}," ${y})`}="">
<heading y={-25}>{title}</heading>
{data.map(d =>
entry({
x: xScale(xData(d)),
y: yScale(yData(d)),
d: d
})
)}
<axis scale={xScale} x={0} y={height} type="Bottom" label={xLabel}>
<axis scale={yScale} x={0} y={0} type="Left" label={yLabel}>
</axis></axis></g>
);
}

Position the main container at x and y. Place Heading at (0, -25), datapoints at wherever they go, one axis at (0, 0), and another at left bottom. All relative to the parent container.

The parent container is technically relative to the whole SVG container ... πŸ€”

Absolute or relative, doesn't matter. You're gonna have one hell of a fun time calculating the position of each individual element by hand. D3 scales help, but you still have to think about it.

SVG itself offers zero help.

Want to resize your scatterplots? Here's what happens πŸ‘‡

Smaller scatterplots, gotta update positions

Want to resize your browser? Here's what happens πŸ‘‡

Resized browser cuts off visualization

Ugh.

react-svg-flexbox to the rescue

You can fix the layouting problem with react-svg-flexbox. It's a small library, not a lot of stars, but omg so perfect.

Built on top of Facebook's css-layout, which has recently become a part of yoga, it lets you use CSS flexbox to position SVG elements.

Flexbox might be confusing to grok – I look at tutorials any time I use it for anything – but it's way better than doing it yourself. How many engineers worked on browser layout engines over the past two decades?

Wouldn't wanna retrace all those steps yourself πŸ˜…

Wrap our dashboard in a <Flexbox> element and…

import Flexbox from "react-svg-flexbox";
// ...
// render() etc.
<svg>
<flexbox style={{ flexdirection: "row", justifycontent: "flex-start" }}>
<scatterplot data={data} width={200} height={200} filter="{d" =="">
d.weight &&
d.height &&
d.weight[0] &&
d.height[0]
}
xData={d => d.weight[0]}
yData={d => d.height[0]}
xLabel="Weight (lbs)"
yLabel="Height (in)"
title="Dog Breed Height & Weight"
entry={props => (
<datapoint breed={props.d.breed} {...props}=""></datapoint>
)}
/>
</scatterplot></flexbox></svg>

We take <Flexbox> out of react-svg-flexbox, use flexbox styles to say we want to render in a row that starts at the beginning, and the rest happens on its own.

Note that react-svg-flexbox passes x and y props into our components, so we had to take out manual positioning. Our dashboard now uses up all the space it can πŸ‘‡

Scatterplots rendered in a flexbox row

Something's funky with our vertical positioning, but it's an easy fix. Offset y coordinates by a few pixels. Β―_(ツ)_/Β― it's not happening in the official examples, so it must be something we're doing inside those scatterplots.

The axes are still poking outside our width bounds, but this looks better already.

Scatterplots with a vertical offset

Even if we make one of them bigger, everything still works. No changes to positioning required! o/

One big scatterplot

Responsive layout with react-svg-flexbox

For the biggest win, we add flexWrap: wrap to our <Flexbox> component. Like this πŸ‘‡

<flexbox 1024="" style={{ flexdirection: "row", justifycontent: "flex-start", flexwrap: "wrap", width: 1024, height: }}>
</flexbox>

You have to specify available width in your styles, otherwise, it doesn't work. That means you should listen to window.onresize and update width accordingly.

Easiest to attach an event listener in componentDidMount. Like this:

class App extends Component {
state = {
width: 1024
};
svgRef = React.createRef();
componentDidMount() {
window.addEventListener("resize", this.updateSize);
}
componentWillUnmount() {
window.removeEventListener("resize", this.updateSize);
}
updateSize = () => {
this.setState({ width: this.svgRef.current.clientWidth });
};
render() {
// ...
<svg 1024="" style={{ width: "100%", height: }} ref={this.svgRef}>
<flexbox 1024="" style={{ flexdirection: "row", justifycontent: "flex-start", flexwrap: "wrap", width: this.state.width, height: }}>
}
</flexbox></svg>

And your dashboard becomes responsive! Yay

See the code, play with examples

You can see a full set of react-svg-flexbox examples on their Storybook.

Code for my dog breed dashboard example is on GitHub here.

You can try it live here.

Fin

Use react-svg-flexbox. Your life will improve. The best thing that's ever happened to me for SVG coding.

Thanks Cody Averett for finding this gem πŸ’Ž

Did you enjoy this article?

Published on August 17th, 2018 in Front End, react, svg, Technical

Learned something new?
Want to become a high value JavaScript expert?

Here's how it works πŸ‘‡

Leave your email and I'll send you an Interactive Modern JavaScript Cheatsheet πŸ“–right away. After that you'll get thoughtfully written emails every week about React, JavaScript, and your career. Lessons learned over my 20 years in the industry working with companies ranging from tiny startups to Fortune5 behemoths.

Start with an interactive cheatsheet πŸ“–

Then get thoughtful letters πŸ’Œ on mindsets, tactics, and technical skills for your career.

"Man, love your simple writing! Yours is the only email I open from marketers and only blog that I give a fuck to read & scroll till the end. And wow always take away lessons with me. Inspiring! And very relatable. πŸ‘Œ"

~ Ashish Kumar

Join over 10,000 engineers just like you already improving their careers with my letters, workshops, courses, and talks. ✌️

Have a burning question that you think I can answer?Β I don't have all of the answers, but I have some! Hit me up on twitter or book a 30min ama for in-depth help.

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

Curious about Serverless and the modern backend? Check out Serverless Handbook, modern backend for the frontend engineer.

Ready to learn how it all fits together and build a modern webapp from scratch? Learn how to launch a webapp and make your first πŸ’° on the side with ServerlessReact.Dev

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 ❀️