Script

此 API 參考文件將幫助您了解如何使用 Script 元件提供的 props。關於功能和用法，請參閱優化腳本頁面。

import Script from 'next/script'

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

Props

以下是 Script 元件可用的 props 摘要：

Prop	範例	類型	必填
`src`	`src="http://example.com/script"`	字串	除非使用內聯腳本，否則必填
`strategy`	`strategy="lazyOnload"`	字串	-
`onLoad`	`onLoad={onLoadFunc}`	函數	-
`onReady`	`onReady={onReadyFunc}`	函數	-
`onError`	`onError={onErrorFunc}`	函數	-

必填 Props

<Script /> 元件需要以下屬性。

`src`

指定外部腳本 URL 的路徑字串。可以是絕對外部 URL 或內部路徑。除非使用內聯腳本，否則 src 屬性是必填的。

選用 Props

<Script /> 元件接受許多額外的屬性，超出必填的範圍。

`strategy`

腳本的載入策略。有四種不同的策略可以使用：

beforeInteractive: 在任何 Next.js 代碼之前載入，並在頁面水合 (hydration) 之前發生。
afterInteractive: (預設值) 在頁面部分水合後早期載入。
lazyOnload: 在瀏覽器空閒時間載入。
worker: (實驗性) 在 web worker 中載入。

`beforeInteractive`

使用 beforeInteractive 策略載入的腳本會從伺服器注入到初始 HTML 中，在任何 Next.js 模組之前下載，並按放置順序執行。

標記此策略的腳本會預先載入並在任何第一方代碼之前獲取，但它們的執行 不會阻止頁面水合的發生。

beforeInteractive 腳本必須放置在 Document 元件 (pages/_document.js) 中，並設計用於載入整個網站所需的腳本（即當應用程式的任何頁面在伺服器端載入時，腳本將被載入）。

此策略應僅用於需要盡快獲取的關鍵腳本。

pages/_document.js

import { Html, Head, Main, NextScript } from 'next/document'
import Script from 'next/script'

export default function Document() {
  return (
    <Html>
      <Head />
      <body>
        <Main />
        <NextScript />
        <Script
          src="https://example.com/script.js"
          strategy="beforeInteractive"
        />
      </body>
    </Html>
  )
}

須知：帶有 beforeInteractive 的腳本無論放置在元件中的哪個位置，都將始終注入到 HTML 文件的 head 中。

一些應盡快使用 beforeInteractive 獲取的腳本範例包括：

機器人檢測器
Cookie 同意管理器

`afterInteractive`

使用 afterInteractive 策略的腳本會在客戶端注入到 HTML 中，並在頁面上部分（或全部）水合後載入。這是 Script 元件的預設策略，應適用於需要盡快載入但不需要在任何第一方 Next.js 代碼之前載入的任何腳本。

afterInteractive 腳本可以放置在任何頁面或佈局中，並且僅在該頁面（或一組頁面）在瀏覽器中打開時才會載入和執行。

app/page.js

import Script from 'next/script'

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

一些適合使用 afterInteractive 的腳本範例包括：

標籤管理器
分析工具

`lazyOnload`

使用 lazyOnload 策略的腳本會在瀏覽器空閒時間客戶端注入到 HTML 中，並在頁面上的所有資源獲取完成後載入。此策略應適用於任何不需要早期載入的背景或低優先級腳本。

lazyOnload 腳本可以放置在任何頁面或佈局中，並且僅在該頁面（或一組頁面）在瀏覽器中打開時才會載入和執行。

app/page.js

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 標誌：

next.config.js

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 庫載入後執行方法的範例。

'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 Maps JS 嵌入的範例：

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 屬性來處理：

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` prop。
`v12.2.2`	允許將帶有 `beforeInteractive` 的 `next/script` 放置在 `_document` 中。
`v11.0.0`	引入 `next/script`。

On this page