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

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

これにより、クライアントコンポーネントとインポートされたライブラリの読み込みを遅延させ、それらが必要になったときにのみクライアントバンドルに含めることができます。たとえば、ユーザーがモーダルを開くクリックをしたときにのみ、モーダルの読み込みを遅延させたい場合があります。

Next.jsで遅延読み込みを実装するには、2つの方法があります。

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

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

`next/dynamic`

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

例

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

'use client'
 
import { useState } from 'react'
import dynamic from 'next/dynamic'
 
// Client Components:
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>
      {/* Load immediately, but in a separate client bundle */}
      <ComponentA />
 
      {/* Load on demand, only when/if the condition is met */}
      {showMore && <ComponentB />}
      <button onClick={() => setShowMore(!showMore)}>Toggle</button>
 
      {/* Load only on the client side */}
      <ComponentC />
    </div>
  )
}

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

SSRのスキップ

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

注意： ssr: false オプションはクライアントコンポーネントでのみ機能します。クライアントコンポーネント内に移動させると、クライアントのコード分割が正しく機能するようになります。

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

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

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

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

import dynamic from 'next/dynamic'
 
// Server Component:
const ServerComponent = dynamic(() => import('../components/ServerComponent'))
 
export default function ServerComponentExample() {
  return (
    <div>
      <ServerComponent />
    </div>
  )
}

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

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

外部ライブラリは、import() 関数を使用してオンデマンドで読み込むことができます。この例では、あいまい検索のために外部ライブラリ fuse.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
          // Dynamically load 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>
  )
}

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

'use client'
 
import dynamic from 'next/dynamic'
 
const WithCustomLoading = dynamic(
  () => import('../components/WithCustomLoading'),
  {
    loading: () => <p>Loading...</p>,
  }
)
 
export default function Page() {
  return (
    <div>
      {/* The loading component will be rendered while  <WithCustomLoading/> is loading */}
      <WithCustomLoading />
    </div>
  )
}

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

名前付きエクスポートを動的にインポートするには、import() 関数が返すPromiseからそれを返すことができます。

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

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