リロードしたあとstyled-componentsのスタイルが当たらなくなる問題への対処法

バージョン

React: 17.0.2
Next.js: 12.1.0
styled-components: ^5.3.6

はじめに

リロードしたあとに styled-components のスタイルが当たらなくなる問題への対処法です。
Next.js の v12 で、少しハマったので備忘録として残しておきます。

解決方法

pages/_document.jsx を作成して、
以下のように記載します。

import Document from 'next/document'
import { ServerStyleSheet } from 'styled-components'

export default class MyDocument extends Document {
  static async getInitialProps(ctx) {
    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()
    }
  }
}

※pages/_document.tsx にする場合は、型定義を少し直せば OK です。

以上で解決しました。

参考

https://styled-components.com/docs/advanced#nextjs:~:text=a larger component.-,Next.js,-With Babel

https://github.com/vercel/next.js/blob/deprecated-main/examples/with-styled-components/pages/_document.js