クライアントコンポーネントとライブラリの遅延読み込み方法

Next.jsの遅延読み込みは、ルートのレンダリングに必要なJavaScriptの量を減らすことで、アプリケーションの初期読み込みパフォーマンスを向上させます。

クライアントコンポーネントとインポートしたライブラリの読み込みを遅延させ、必要な時だけクライアントバンドルに含めることができます。例えば、ユーザーがクリックして開くまでモーダルの読み込みを遅らせることができます。

Next.jsで遅延読み込みを実装する方法は2つあります：

next/dynamicを使用した動的インポート
SuspenseとReact.lazy()の使用

デフォルトでは、サーバーコンポーネントは自動的にコード分割され、ストリーミングを使用してサーバーからクライアントへUIを段階的に送信できます。遅延読み込みはクライアントコンポーネントに適用されます。

`next/dynamic`

next/dynamicはReact.lazy()とSuspenseの複合体です。appとpagesディレクトリで同じように動作し、段階的な移行を可能にします。

例

クライアントコンポーネントのインポート

app/page.js

'use client'

import { useState } from 'react'
import dynamic from 'next/dynamic'

// クライアントコンポーネント:
const ComponentA = dynamic(() => import('../components/A'))
const ComponentB = dynamic(() => import('../components/B'))
const ComponentC = dynamic(() => import('../components/C'), { ssr: false })

export default function ClientComponentExample() {
  const [showMore, setShowMore] = useState(false)

  return (
    <div>
      {/* すぐに読み込むが、別のクライアントバンドルで */}
      <ComponentA />

      {/* 条件が満たされた時だけオンデマンドで読み込む */}
      {showMore && <ComponentB />}
      <button onClick={() => setShowMore(!showMore)}>Toggle</button>

      {/* クライアントサイドでのみ読み込む */}
      <ComponentC />
    </div>
  )
}

注記: サーバーコンポーネントがクライアントコンポーネントを動的にインポートする場合、現在は自動的なコード分割はサポートされていません。

SSRのスキップ

React.lazy()とSuspenseを使用する場合、クライアントコンポーネントはデフォルトでプリレンダリング（SSR）されます。

注記: ssr: falseオプションはクライアントコンポーネントでのみ機能します。クライアントコード分割が正しく動作するように、クライアントコンポーネント内に移動してください。

クライアントコンポーネントのプリレンダリングを無効にしたい場合は、ssrオプションをfalseに設定します：

const ComponentC = dynamic(() => import('../components/C'), { ssr: false })

サーバーコンポーネントのインポート

サーバーコンポーネントを動的にインポートする場合、サーバーコンポーネント自体ではなく、その子であるクライアントコンポーネントのみが遅延読み込みされます。また、サーバーコンポーネントで使用する際に静的アセット（CSSなど）のプリロードにも役立ちます。

app/page.js

import dynamic from 'next/dynamic'

// サーバーコンポーネント:
const ServerComponent = dynamic(() => import('../components/ServerComponent'))

export default function ServerComponentExample() {
  return (
    <div>
      <ServerComponent />
    </div>
  )
}

注記: サーバーコンポーネントではssr: falseオプションはサポートされていません。サーバーコンポーネントで使用しようとするとエラーが発生します。 ssr: falseはサーバーコンポーネントでのnext/dynamic使用時には許可されていません。クライアントコンポーネント内に移動してください。

外部ライブラリの読み込み

外部ライブラリはimport()関数を使用してオンデマンドで読み込めます。この例では、ファジー検索のために外部ライブラリfuse.jsを使用しています。モジュールはユーザーが検索入力欄に入力した後にのみクライアントで読み込まれます。

app/page.js

'use client'

import { useState } from 'react'

const names = ['Tim', 'Joe', 'Bel', 'Lee']

export default function Page() {
  const [results, setResults] = useState()

  return (
    <div>
      <input
        type="text"
        placeholder="Search"
        onChange={async (e) => {
          const { value } = e.currentTarget
          // fuse.jsを動的に読み込む
          const Fuse = (await import('fuse.js')).default
          const fuse = new Fuse(names)

          setResults(fuse.search(value))
        }}
      />
      <pre>Results: {JSON.stringify(results, null, 2)}</pre>
    </div>
  )
}

カスタムローディングコンポーネントの追加

app/page.js

'use client'

import dynamic from 'next/dynamic'

const WithCustomLoading = dynamic(
  () => import('../components/WithCustomLoading'),
  {
    loading: () => <p>Loading...</p>,
  }
)

export default function Page() {
  return (
    <div>
      {/* <WithCustomLoading/>の読み込み中にローディングコンポーネントが表示される */}
      <WithCustomLoading />
    </div>
  )
}

名前付きエクスポートのインポート

名前付きエクスポートを動的にインポートするには、import()関数が返すPromiseから返します：

components/hello.js

'use client'

export function Hello() {
  return <p>Hello!</p>
}

app/page.js

import dynamic from 'next/dynamic'

const ClientComponent = dynamic(() =>
  import('../components/hello').then((mod) => mod.Hello)
)

クライアントコンポーネントとライブラリの遅延読み込み方法

On this page