Menu

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

注意: Server ComponentsとStreamingのような新しいReactの機能でCSS-in-JSを使用するには、ライブラリ作成者がconcurrent renderingを含むReactの最新バージョンをサポートしている必要があります。

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

以下のライブラリはサポートに取り組み中です:

補足:さまざまなCSS-in-JSライブラリをテスト中です。React 18の機能やappディレクトリをサポートするライブラリについて、より多くの例を追加していく予定です。

appでのCSS-in-JSの設定

CSS-in-JSの設定は、以下を含む3ステップのオプトインプロセスです:

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

styled-jsx

Client Componentsでstyled-jsxを使用する場合、v5.1.0の使用が必須です。まず、新しいレジストリを作成します:

app/registry.tsx
TypeScript
'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
}) {
  // スタイルシートは遅延初期状態で1回のみ作成
  // 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>
}

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

app/layout.tsx
TypeScript
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タグに注入します。

lib/registry.tsx
TypeScript
'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
}) {
  // スタイルシートは遅延初期状態で1回のみ作成
  // 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をスタイルレジストリコンポーネントでラップします:

app/layout.tsx
TypeScript
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は通常通り接引き継ぎ、その後の動的スタイルを注入します。
  • スタイルレジストリをツリーの最上位のClient Componentとして使用するのは、この方法でCSSルールを抽出する方が効率的であるためです。これにより、後続のサーバーレンダリング時にスタイルが再生成されることがなくなり、Server Componentのペイロードで送信されるのを防ぎます。
  • styled-componentsのコンパイルの個々のプロパティを設定する必要がある高度なユースケースでは、Next.js styled-components API リファレンスを参照して詳細を確認してください。