はじめに/ガイド/CSS-in-JS

CSS-in-JS ライブラリの使用方法

警告: サーバーコンポーネントやストリーミングなどの新しいReact機能とCSS-in-JSを使用するには、ライブラリ作者がコンカレントレンダリングを含むReactの最新バージョンをサポートする必要があります。

以下はappディレクトリ内のクライアントコンポーネントでサポートされているライブラリです(アルファベット順):

現在サポート作業中のライブラリ:

豆知識: 私たちはさまざまなCSS-in-JSライブラリをテストしており、React 18機能やappディレクトリをサポートするライブラリの例を追加していく予定です。

appでのCSS-in-JS設定

CSS-in-JSの設定は以下の3つのステップからなるオプトインプロセスです:

  1. レンダリング中のすべてのCSSルールを収集するスタイルレジストリ
  2. スタイルを使用する可能性のあるコンテンツの前にルールを注入するための新しいuseServerInsertedHTMLフック
  3. 初期サーバーサイドレンダリング中にアプリをスタイルレジストリでラップするクライアントコンポーネント

styled-jsx

クライアントコンポーネントでstyled-jsxを使用するにはv5.1.0以上が必要です。まず、新しいレジストリを作成します:

'use client'

import React, { useState } from 'react'
import { useServerInsertedHTML } from 'next/navigation'
import { StyleRegistry, createStyleRegistry } from 'styled-jsx'

export default function StyledJsxRegistry({
  children,
}: {
  children: React.ReactNode
}) {
  // 遅延初期状態でスタイルシートを一度だけ作成
  // x-ref: https://reactjs.org/docs/hooks-reference.html#lazy-initial-state
  const [jsxStyleRegistry] = useState(() => createStyleRegistry())

  useServerInsertedHTML(() => {
    const styles = jsxStyleRegistry.styles()
    jsxStyleRegistry.flush()
    return <>{styles}</>
  })

  return <StyleRegistry registry={jsxStyleRegistry}>{children}</StyleRegistry>
}

次に、ルートレイアウトをレジストリでラップします:

import StyledJsxRegistry from './registry'

export default function RootLayout({
  children,
}: {
  children: React.ReactNode
}) {
  return (
    <html>
      <body>
        <StyledJsxRegistry>{children}</StyledJsxRegistry>
      </body>
    </html>
  )
}

サンプルはこちらで確認できます

Styled Components

以下はstyled-components@6以降の設定例です:

まず、next.config.jsでstyled-componentsを有効にします。

next.config.js
module.exports = {
  compiler: {
    styledComponents: true,
  },
}

次に、styled-components APIを使用して、レンダリング中に生成されたすべてのCSSスタイルルールを収集するグローバルレジストリコンポーネントと、それらのルールを返す関数を作成します。そして、useServerInsertedHTMLフックを使用して、レジストリに収集されたスタイルをルートレイアウトの<head> HTMLタグに注入します。

'use client'

import React, { useState } from 'react'
import { useServerInsertedHTML } from 'next/navigation'
import { ServerStyleSheet, StyleSheetManager } from 'styled-components'

export default function StyledComponentsRegistry({
  children,
}: {
  children: React.ReactNode
}) {
  // 遅延初期状態でスタイルシートを一度だけ作成
  // x-ref: https://reactjs.org/docs/hooks-reference.html#lazy-initial-state
  const [styledComponentsStyleSheet] = useState(() => new ServerStyleSheet())

  useServerInsertedHTML(() => {
    const styles = styledComponentsStyleSheet.getStyleElement()
    styledComponentsStyleSheet.instance.clearTag()
    return <>{styles}</>
  })

  if (typeof window !== 'undefined') return <>{children}</>

  return (
    <StyleSheetManager sheet={styledComponentsStyleSheet.instance}>
      {children}
    </StyleSheetManager>
  )
}

ルートレイアウトのchildrenをスタイルレジストリコンポーネントでラップします:

import StyledComponentsRegistry from './lib/registry'

export default function RootLayout({
  children,
}: {
  children: React.ReactNode
}) {
  return (
    <html>
      <body>
        <StyledComponentsRegistry>{children}</StyledComponentsRegistry>
      </body>
    </html>
  )
}

サンプルはこちらで確認できます

豆知識:

  • サーバーサイドレンダリング中、スタイルはグローバルレジストリに抽出され、HTMLの<head>にフラッシュされます。これにより、スタイルルールがそれらを使用する可能性のあるコンテンツより前に配置されます。将来的には、Reactの新機能を使用してスタイルを注入する場所を決定するかもしれません。
  • ストリーミング中、各チャンクからのスタイルが収集され、既存のスタイルに追加されます。クライアントサイドハイドレーションが完了すると、styled-componentsが通常通り引き継ぎ、さらに動的なスタイルを注入します。
  • スタイルレジストリのためにツリーの最上位でクライアントコンポーネントを使用するのは、この方法でCSSルールを抽出する方が効率的だからです。これにより、後続のサーバーレンダリングでスタイルを再生成する必要がなくなり、サーバーコンポーネントのペイロードで送信されることも防ぎます。
  • styled-componentsのコンパイルの個々のプロパティを設定する必要がある高度なユースケースについては、Next.js styled-components APIリファレンスを参照してください。

On this page