Github web-template

공식문서로 css-in-js 방식인 styled-component를 적용하기

with-styled-components

1️⃣ _documents.tsx 설정

_documents.tsx 파일은

  • Next.js 에서 제공하는 document를 커스터마이징 할 수 있다

  • Next.js 페이지들은 마크업 정의를 건너뛰기 때문에 <html>, <body>, <head> 등을 필수적으로 작업해야 할 때는 _documents.tsx 파일을 필수적으로 사용해야 한다

    • 예시) <Html lang='kr'>
  • SSR시에 실행되는 파일인 _documents.tsx에 styled-components의 스타일 코드를 추출하는 로직을 추가한다
    • 공식문서를 참고해서 아래와 같이 getInitialProps method를 작성
// pages/_documents.tsx

import React from "react";
import Document, {
  DocumentContext,
  Html,
  Head,
  Main,
  NextScript,
} from "next/document";
import { ServerStyleSheet } from "styled-components";

export default class MyDocument extends Document {
  static async getInitialProps(ctx: DocumentContext) {
    const sheet = new ServerStyleSheet();
    const originalRenderPage = ctx.renderPage;

    try {
      ctx.renderPage = () =>
        originalRenderPage({
          enhanceApp: (App) => (props) =>
            sheet.collectStyles(<App {...props} />),
        });

      const initialProps = await Document.getInitialProps(ctx);
      return {
        ...initialProps,
        styles: (
          <>
            {initialProps.styles}
            {sheet.getStyleElement()}
          </>
        ),
      };
    } finally {
      sheet.seal();
    }
  }

  render() {
    return (
      <Html lang='kr'>
        <Head />
        <body>
          <Main />
          <NextScript />
        </body>
      </Html>
    );
  }
}


2️⃣ styled-components 설치

npm i styled-components @types/styled-components
npm install styled-reset
npm i --save-dev @types/styled-components
// or
yarn add typescript-plugin-styled-components
yarn add @types/styled-components


3️⃣ babel 설정

Next.js는 최초 SSR 이후 내부 라우팅을 통해 페이지가 이동되면서 CSR을 하게되는데 이때, 서버에서 생성하는 해시값과 브라우저에서 생성하는 해시값이 서로 달라서 문제가 발생하게 된다.

styled-components를 사용하다 보면 문자열 안에 스타일이 들어가기 때문에 처리를 위해 별도로 babel이 필요하다.

이러한 점으로 인해 babel-plugin 패키지를 설치

npm install --save-dev babel-plugin-styled-components

그리고 root에 .babelrc 파일을 생성

{
  "presets": ["next/babel"],
  "plugins": [["styled-components", { "ssr": true }]]
}


Github web-template