DEV Community

Cover image for How to add Style-components to Next.js and start using it πŸ€ͺ
Tiago Brito
Tiago Brito

Posted on • Edited on

How to add Style-components to Next.js and start using it πŸ€ͺ

In this tutorial, I'll show you how to add Styled-component to Next.js. If you don't know how to create a basic app with Next.js I'll suggest to you first read this post here

For this tutorial, I'll use:

I'll use VSCode for our example here, but you can use any other code editor that you prefer.

How to instal Styled Component? πŸ€”

On your terminal go to your folder project.
if you are using npm run:

npm install --save styled-components
Enter fullscreen mode Exit fullscreen mode

if you are using yar run:

yarn add styled-components
Enter fullscreen mode Exit fullscreen mode

PS: If you use yarn it is recommended that you go to your package.json file and add the following.

  "resolutions": {
    "styled-components": "^5"
  }
Enter fullscreen mode Exit fullscreen mode

This is to avoid many problems that can happen from multiple versions of styled components being used on your project.

Image showing where to add the code above

Congratulations πŸ‘ πŸŽ‰ you add Styled-component to your project, easy right?

Well, how do I use it now?πŸ€”

Styled components use tagged templates literal to style your components. So you can give names to H1, p, button tags and so on, it helps to debug and make your code much cleaner to read in my opinion.

So instead of having a component like thisπŸ‘‡
Image with sample of old style

You can have it like thisπŸ‘‡
Image with sample of new styles

But how do we do it?πŸ€”

Simple, first we need to import the style from the styled component like so πŸ‘‡

import styled from "styled-components";
Enter fullscreen mode Exit fullscreen mode

and then export a const with the name you choose with the styled template literal like below πŸ‘‡
Image description

So your file will look like this πŸ‘‡
Image showing how the file should look like

Then styled components will generate the tags and add unique classes to your tags.

Image showing the class names with a random code

But it also makes it super hard to debug later, as you just have an h1 or div and trying to find which one is not working will be crazy.

To solve this issue we can run in our terminal the following:
If you use yarn

yarn add babel-plugin-styled-components --dev
Enter fullscreen mode Exit fullscreen mode

If you use npm

npm install --save-dev babel-plugin-styled-components
Enter fullscreen mode Exit fullscreen mode

We will need to create a file called .babelrc at the root of our project.
and add the following code:

{
  "presets": ["next/babel"],
  "plugins": [["styled-components", { "ssr": true, "displayName": true }]]
}
Enter fullscreen mode Exit fullscreen mode

Image showing the file to be changed

and voila πŸ’ƒ

Image showing that the class name has the component name in it.

Now the const name we created Title will be added to our tags as part of the class names, making our lives so much easier

Now for the real congratulations πŸ‘ πŸŽ‰ πŸ‘ πŸŽ‰
We just added styled components to our project and learned how to start using them.

We are the champions

What next?

Well, this is just the tip of the iceberg, Styled components have so much more to be explored that I'll have new posts about it soon.

Until next time πŸ‘‹

Top comments (2)

Collapse
 
roarnald profile image
roarnald

Good guide! However, do note that using '.babelrc' would disable NextJS 12's own Rust SWC, making it act like Next 11. If anyone is looking to implement displayName to Next 12, heres the official doc: nextjs.org/docs/advanced-features/...

Collapse
 
dzienisz profile image
Kamil Dzieniszewski • Edited

styled-components is not a dev dep