DEV Community

Cover image for Getting started with Tailwind CSS in Next.js
Akhila Ariyachandra
Akhila Ariyachandra

Posted on • Originally published at akhilaariyachandra.com

Getting started with Tailwind CSS in Next.js

Originally posted on my blog on June 27th, 2020.

Tailwind CSS is an awesome CSS framework. It gives us enough styling options without being too opinionated. Lately I've being using it along with Next.js. In this post I'll show how to setup a Next.js project with Tailwind CSS.

Setting up the Next.js project

Start with initializing a project.

npm init --yes
Enter fullscreen mode Exit fullscreen mode

Then install the React and Next.js dependencies.

npm install react react-dom next
Enter fullscreen mode Exit fullscreen mode

Next add the following scripts in package.json.

 "scripts": {
    "dev": "next",
    "build": "next build",
    "start": "next start"
  }
Enter fullscreen mode Exit fullscreen mode

After that let's create a layout component to wrap all our components in all the pages. Create the src folder. In it create another folder called components and in it create Layout.js.

const Layout = ({ children }) => {
  return (
    <div>
      <main>{children}</main>
    </div>
  );
};

export default Layout;
Enter fullscreen mode Exit fullscreen mode

Next let's create the index page in out application. In the project root create the pages folder and in it create index.js.

import Layout from "../src/components/Layout";

const Index = () => {
  return (
    <Layout>
      <h1>Next.js Tailwind CSS starter</h1>
    </Layout>
  );
};

export default Index;
Enter fullscreen mode Exit fullscreen mode

To start the development server just run the dev script.

npm run dev
Enter fullscreen mode Exit fullscreen mode

When you http://localhost:3000/ in your browser you see the following.

Next.js project

Adding Tailwind CSS

First install Tailwind CSS as a dev dependency.

npm install tailwindcss postcss-preset-env -D
Enter fullscreen mode Exit fullscreen mode

Next we need to create the Tailwind the config file. We can create a minimal config file with the following command.

npx tailwindcss init
Enter fullscreen mode Exit fullscreen mode

Since Tailwind CSS has thousands of CSS classes the CSS file will end up very big.

Tailwind CSS size

Since we will will rarely use the all classes, we should specify which classes to include the final CSS file. Fortunately Tailwind CSS has a built in PurgeCSS tool which can be used to remove all unused classes.

In the tailwind.config.js add all the React component files in the purge property. In our case we will add all files in the pages and components folders.

module.exports = {
  purge: ["./pages/**/*.js", "./src/components/**/*.js"],
  theme: {
    extend: {},
  },
  variants: {},
  plugins: [],
};
Enter fullscreen mode Exit fullscreen mode

Next we need to create the root CSS file where we will import Tailwind CSS. In the src folder create the styles folder and it add the index.css file.

@tailwind base;
@tailwind components;
@tailwind utilities;
Enter fullscreen mode Exit fullscreen mode

After that we need to import the CSS to our application. In Next.js we have to do it in the _app.js file. Create the _app.js file in the pages folder.

import "../src/styles/index.css";

const MyApp = ({ Component, pageProps }) => {
  return <Component {...pageProps} />;
};

export default MyApp;
Enter fullscreen mode Exit fullscreen mode

Finally we need to setup PostCSS to include Tailwind CSS. In the project root create the postcss.config.js file.

module.exports = {
  plugins: ["tailwindcss", "postcss-preset-env"],
};
Enter fullscreen mode Exit fullscreen mode

Conclusion

That's all you need to do to start using Tailwind CSS in your Next.js project. You can style your components by adding the classes in the className prop.

For example, we can style the title in the index page like this.

import Layout from "../src/components/Layout";

const Index = () => {
  return (
    <Layout>
      <h1 className="text-6xl font-semibold italic">
        Next.js Tailwind CSS starter
      </h1>
    </Layout>
  );
};

export default Index;
Enter fullscreen mode Exit fullscreen mode

Title styling

We can center all the content by adding some classes to the Layout component.

const Layout = ({ children }) => {
  return (
    <div>
      <main className="container mx-auto">{children}</main>
    </div>
  );
};

export default Layout;
Enter fullscreen mode Exit fullscreen mode

Layout styling

All the code in this post can be found in GitHub.

Top comments (2)

Collapse
 
andyst81 profile image
andyst81

Thanks a lot. I enjoyed this.

Collapse
 
akhilaariyachandra profile image
Akhila Ariyachandra

Thanks!!! Glad you enjoyed it!!! 😊