Client ComponentsとライブラリをLazy Loadする方法

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

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

Next.jsでlazy loadingを実装するには2つの方法があります。

next/dynamicを使用したDynamic Imports
Suspenseを使用したReact.lazy()

デフォルトでは、Server Componentsは自動的にcode splitされ、streamingを使用してサーバーからクライアントへUIの一部を段階的に送信できます。Lazy loadingはClient Componentsに適用されます。

`next/dynamic`

next/dynamicはReact.lazy()とSuspenseの組み合わせです。appとpagesディレクトリの両方で同じ方法で動作し、段階的な移行を可能にします。

例

Client Componentsのインポート

app/page.js

'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>
      {/* 直ちに読み込まれ、別のクライアントバンドルで実行される */}
      <ComponentA />
 
      {/* 条件が満たされたときのみオンデマンドで読み込まれる */}
      {showMore && <ComponentB />}
      <button onClick={() => setShowMore(!showMore)}>Toggle</button>
 
      {/* クライアント側でのみ読み込まれる */}
      <ComponentC />
    </div>
  )
}

注意： Server ComponentがClient Componentをダイナミックにインポートする場合、自動code splittingは現在サポートされていません。

SSRをスキップする

React.lazy()とSuspenseを使用する場合、Client Componentsはデフォルトでプリレンダリング（SSR）されます。

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

Client Componentのプリレンダリングを無効にする場合は、ssrオプションをfalseに設定できます。

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

Server Componentsのインポート

Server Componentをダイナミクにインポートする場合、Server Component自体ではなく、Server Componentの子であるClient Componentsのみがlazy loadされます。 Server Componentsで使用している場合、CSSなどの静的アセットのプリロードにも役立ちます。

app/page.js

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

注意： ssr: falseオプションはServer Componentsではサポートされていません。Server Componentsで使用しようとするとエラーが表示されます。 ssr: falseはServer ComponentsではNext.jsのdynamicでは許可されていません。Client Componentに移動してください。

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

外部ライブラリは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>
  )
}

Named Exportsのインポート

Named exportをダイナミックにインポートするには、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)
)