脚本组件

本 API 参考将帮助您了解如何使用脚本组件的可用属性。有关功能和用法，请参阅优化脚本页面。

import Script from 'next/script'
 
export default function Dashboard() {
  return (
    <>
      <Script src="https://example.com/script.js" />
    </>
  )
}

属性

以下是脚本组件可用属性的摘要

属性	示例	类型	必需
`src`	`src="http://example.com/script"`	字符串	除非使用内联脚本，否则为必需
`策略 (strategy)`	`strategy="lazyOnload"`	字符串	-
`onLoad`	`onLoad={onLoadFunc}`	函数	-
`加载完成 (onReady)`	`onReady={onReadyFunc}`	函数	-
`onError`	`onError={onErrorFunc}`	函数	-

必需属性

<Script /> 组件需要以下属性。

`src`

一个路径字符串，指定外部脚本的 URL。这可以是绝对的外部 URL 或内部路径。除非使用内联脚本，否则 src 属性是必需的。

可选属性

<Script /> 组件除了必需属性外，还接受许多其他属性。

`strategy`

脚本的加载策略。有四种不同的策略可以使用

beforeInteractive：在任何 Next.js 代码之前和任何页面水合发生之前加载。
afterInteractive：（默认）尽早加载，但在页面上发生一些水合后加载。
lazyOnload：在浏览器空闲时间加载。
worker：（实验性）在 Web Worker 中加载。

`beforeInteractive`

使用 beforeInteractive 策略加载的脚本会从服务器注入到初始 HTML 中，在任何 Next.js 模块之前下载，并按照它们放置的顺序执行。

用此策略表示的脚本会预加载和获取，在任何第一方代码之前，但它们的执行不会阻止页面水合发生。

beforeInteractive 脚本必须放置在根布局 (app/layout.tsx) 中，旨在加载整个站点所需的脚本（即，当应用程序中的任何页面在服务器端加载时，脚本将加载）。

此策略只应用于需要尽快获取的关键脚本。

import Script from 'next/script'
 
export default function RootLayout({
  children,
}: {
  children: React.ReactNode
}) {
  return (
    <html lang="en">
      <body>
        {children}
        <Script
          src="https://example.com/script.js"
          strategy="beforeInteractive"
        />
      </body>
    </html>
  )
}

须知：无论脚本在组件中的位置如何，使用 beforeInteractive 的脚本始终会注入到 HTML 文档的 head 中。

一些应尽快使用 beforeInteractive 获取的脚本示例包括

机器人检测器
Cookie 同意管理器

`afterInteractive`

使用 afterInteractive 策略的脚本会注入到客户端 HTML 中，并在页面上发生一些（或全部）水合后加载。这是脚本组件的默认策略，应在需要尽快加载但不早于任何第一方 Next.js 代码的任何脚本中使用。

afterInteractive 脚本可以放置在任何页面或布局中，并且只在该页面（或一组页面）在浏览器中打开时加载和执行。

import Script from 'next/script'
 
export default function Page() {
  return (
    <>
      <Script src="https://example.com/script.js" strategy="afterInteractive" />
    </>
  )
}

一些适合 afterInteractive 的脚本示例包括

标签管理器
分析

`lazyOnload`

使用 lazyOnload 策略的脚本在浏览器空闲时间注入到客户端 HTML 中，并在页面所有资源都已获取后加载。此策略应用于任何不需要尽早加载的后台或低优先级脚本。

lazyOnload 脚本可以放置在任何页面或布局中，并且只在该页面（或一组页面）在浏览器中打开时加载和执行。

import Script from 'next/script'
 
export default function Page() {
  return (
    <>
      <Script src="https://example.com/script.js" strategy="lazyOnload" />
    </>
  )
}

不需要立即加载并可以使用 lazyOnload 获取的脚本示例包括

聊天支持插件
社交媒体小部件

`worker`

警告： worker 策略尚不稳定，并且尚不支持 App Router。请谨慎使用。

使用 worker 策略的脚本会被卸载到一个 Web Worker 中，以释放主线程并确保只有关键的第一方资源在主线程上处理。虽然此策略可用于任何脚本，但它是一个高级用例，不能保证支持所有第三方脚本。

要使用 worker 作为策略，必须在 next.config.js 中启用 nextScriptWorkers 标志

module.exports = {
  experimental: {
    nextScriptWorkers: true,
  },
}

worker 脚本目前只能在 pages/ 目录中使用

import Script from 'next/script'
 
export default function Home() {
  return (
    <>
      <Script src="https://example.com/script.js" strategy="worker" />
    </>
  )
}

`onLoad`

警告： onLoad 尚不支持服务器组件，只能在客户端组件中使用。此外，onLoad 不能与 beforeInteractive 一起使用——请考虑改用 onReady。

一些第三方脚本要求用户在脚本加载完成后立即运行 JavaScript 代码，以实例化内容或调用函数。如果您使用 afterInteractive 或 lazyOnload 作为加载策略加载脚本，您可以在脚本加载后使用 onLoad 属性执行代码。

这是一个仅在 Lodash 库加载后才执行 Lodash 方法的示例。

'use client'
 
import Script from 'next/script'
 
export default function Page() {
  return (
    <>
      <Script
        src="https://cdnjs.cloudflare.com/ajax/libs/lodash.js/4.17.20/lodash.min.js"
        onLoad={() => {
          console.log(_.sample([1, 2, 3, 4]))
        }}
      />
    </>
  )
}

`onReady`

警告： onReady 尚不支持服务器组件，只能在客户端组件中使用。

一些第三方脚本要求用户在脚本加载完成后，并在每次组件挂载（例如，在路由导航之后）时运行 JavaScript 代码。您可以使用 onReady 属性在脚本首次加载时以及之后每次组件重新挂载后执行代码。

这是一个每次组件挂载时如何重新实例化 Google 地图 JS 嵌入的示例

'use client'
 
import { useRef } from 'react'
import Script from 'next/script'
 
export default function Page() {
  const mapRef = useRef()
 
  return (
    <>
      <div ref={mapRef}></div>
      <Script
        id="google-maps"
        src="https://maps.googleapis.com/maps/api/js"
        onReady={() => {
          new google.maps.Map(mapRef.current, {
            center: { lat: -34.397, lng: 150.644 },
            zoom: 8,
          })
        }}
      />
    </>
  )
}

`onError`

警告： onError 尚不支持服务器组件，只能在客户端组件中使用。 onError 不能与 beforeInteractive 加载策略一起使用。

有时，捕获脚本加载失败的情况很有用。这些错误可以使用 onError 属性来处理

'use client'
 
import Script from 'next/script'
 
export default function Page() {
  return (
    <>
      <Script
        src="https://example.com/script.js"
        onError={(e: Error) => {
          console.error('Script failed to load', e)
        }}
      />
    </>
  )
}

版本历史

版本	更改
`v13.0.0`	`beforeInteractive` 和 `afterInteractive` 已修改以支持 `app`。
`v12.2.4`	添加了 `onReady` 属性。
`v12.2.2`	允许将带有 `beforeInteractive` 的 `next/script` 放置在 `_document` 中。
`v11.0.0`	引入了 `next/script`。