Search by Algolia

Styled Components

In this guide, we’ll walk through setting up a site with the CSS-in-JS library Styled Components.

Styled Components lets you use actual CSS syntax inside your components. Styled Components is a variant on “CSS-in-JS”—which solves many of the problems with traditional CSS.

One of the most important problems they solve is selector name collisions. With traditional CSS, you have to be careful not to overwrite CSS selectors used elsewhere in a site because all CSS selectors live in the same global namespace. This unfortunate restriction can lead to elaborate (and often confusing) selector naming schemes.

With CSS-in-JS, you avoid all that as CSS selectors are scoped automatically to their component. Styles are tightly coupled with their components. This makes it much easier to know how to edit a component’s CSS as there’s never any confusion about how and where CSS is being used.

First, open a new terminal window and run the following to create a new site:

gatsby new styled-components-tutorial

Second, we’ll install the Gatsby plugin for Styled Components.

npm install --save gatsby-plugin-styled-components styled-components

And then add it to your site’s gatsby-config.js:

module.exports = {
  plugins: [`gatsby-plugin-styled-components`],

Then in your terminal run gatsby develop to start the Gatsby development server.

Now let’s create a sample Styled Components page at src/pages/index.js:

import React from "react";
import styled from "styled-components";

const Container = styled.div`
  margin: 3rem auto;
  max-width: 600px;
  display: flex;
  flex-direction: column;
  align-items: center;
  justify-content: center;

const UserWrapper = styled.div`
  display: flex;
  align-items: center;
  margin: 0 auto 12px auto;
  &:last-child {
    margin-bottom: 0;

const Avatar = styled.img`
  flex: 0 0 96px;
  width: 96px;
  height: 96px;
  margin: 0;

const Description = styled.div`
  flex: 1;
  margin-left: 18px;
  padding: 12px;

const Username = styled.h2`
  margin: 0 0 12px 0;
  padding: 0;

const Excerpt = styled.p`
  margin: 0;

const User = props => (
    <Avatar src={props.avatar} alt="" />

export default () => (
    <h1>About Styled Components</h1>
    <p>Styled Components is cool</p>
      username="Jane Doe"
      excerpt="I'm Jane Doe. Lorem ipsum dolor sit amet, consectetur adipisicing elit."
      username="Bob Smith"
      excerpt="I'm Bob smith, a vertically aligned type of guy. Lorem ipsum dolor sit amet, consectetur adipisicing elit."

Was this helpful? edit this page on GitHub