Menu

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

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

next/dynamic

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

下の例では、next/dynamicを使用することで、ヘッダーコンポーネントはページの初期JavaScriptバンドルに含まれません。ページはまずSuspensefallbackをレンダリングし、その後Suspense境界が解決されたときにHeaderコンポーネントがレンダリングされます。

import dynamic from 'next/dynamic'
 
const DynamicHeader = dynamic(() => import('../components/header'), {
  loading: () => <p>Loading...</p>,
})
 
export default function Home() {
  return <DynamicHeader />
}

補足： import('path/to/component')では、パスは明示的に記述されている必要があります。テンプレート文字列や変数にすることはできません。さらに、Next.jsがwebpackバンドル/モジュールIDを特定のdynamic()呼び出しと一致させてレンダリング前にプリロードできるように、import()はdynamic()呼び出しの内部にある必要があります。dynamic()は、React.lazyと同様にプリロードが機能するようにモジュールの最上位にマークされている必要があるため、Reactレンダリング内で使用できません。

例

Named exportsを使用した場合

Named exportをダイナミックにインポートするには、import()から返されたPromiseから返すことができます。

components/hello.js
export function Hello() {
  return <p>Hello!</p>
}
 
// pages/index.js
import dynamic from 'next/dynamic'
 
const DynamicComponent = dynamic(() =>
  import('../components/hello').then((mod) => mod.Hello)
)

SSRなしで使用した場合

クライアント側でダイナミックにコンポーネントを読み込むには、ssrオプションを使用してサーバーレンダリングを無効にできます。これは、外部の依存関係またはコンポーネントがwindowなどのブラウザAPIに依存する場合に便利です。

'use client'
 
import dynamic from 'next/dynamic'
 
const DynamicHeader = dynamic(() => import('../components/header'), {
  ssr: false,
})

外部ライブラリを使用した場合

この例では、ファジー検索用の外部ライブラリfuse.jsを使用しています。モジュールはユーザーが検索入力に入力した後にのみブラウザで読み込まれます。

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>
  )
}