How to lazy load Client Components and libraries

Next.js 中的懒加载通过减少渲染路由所需的 JavaScript 数量，帮助提升应用程序的初始加载性能。

`next/dynamic`

next/dynamic 是 React.lazy() 和 Suspense 的组合。它在 app 和 pages 目录中的行为方式相同,以允许增量迁移。

在下面的示例中，通过使用 next/dynamic，header 组件不会被包含在页面的初始 JavaScript bundle 中。页面将首先渲染 Suspense 的 fallback，然后在 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') 中，路径必须明确写出。它不能是模板字符串或变量。此外，import() 必须在 dynamic() 调用内部，这样 Next.js 才能将 webpack bundles / module ids 匹配到特定的 dynamic() 调用，并在渲染前预加载它们。dynamic() 不能在 React 渲染内部使用，因为它需要在模块的顶层标记才能使预加载工作，类似于 React.lazy。

示例

使用命名导出

要动态导入命名导出，你可以从 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 选项来禁用服务器渲染。如果外部依赖项或组件依赖于浏览器 API（如 window），这会很有用。

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