logoNext.js 日本語
ドキュメントブログ学習
はじめに/API リファレンス/コンポーネント/<Script> コンポーネント

<Script> コンポーネント

このAPIリファレンスでは、Scriptコンポーネントで利用可能なpropsの使用方法を理解するのに役立ちます。機能と使用方法については、スクリプトの最適化ページをご覧ください。

import Script from 'next/script'

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

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

Props

Scriptコンポーネントで利用可能なpropsの概要は以下の通りです：

Prop例タイプ必須
srcsrc="http://example.com/script"Stringインラインスクリプトを使用しない限り必須
strategystrategy="lazyOnload"String-
onLoadonLoad={onLoadFunc}Function-
onReadyonReady={onReadyFunc}Function-
onErroronError={onErrorFunc}Function-

必須 Props

<Script />コンポーネントには以下のプロパティが必要です。

src

外部スクリプトのURLを指定するパス文字列。絶対外部URLまたは内部パスを指定できます。インラインスクリプトを使用しない限り、srcプロパティは必須です。

オプション Props

<Script />コンポーネントは、必須プロパティ以外にも多くの追加プロパティを受け入れます。

strategy

スクリプトの読み込み戦略。使用できる4つの異なる戦略があります：

  • beforeInteractive: Next.jsのコードやページのハイドレーションが行われる前に読み込まれます。
  • 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でできるだけ早く読み込むべきスクリプトの例：

  • ボット検出器
  • クッキー同意管理ツール

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ディレクトリではまだ動作しません。注意して使用してください。

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" />
    </>
  )
}
import Script from 'next/script'

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

onLoad

警告: onLoadはまだServer Componentsでは動作せず、Client Componentsでのみ使用できます。さらに、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]))
        }}
      />
    </>
  )
}
'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はまだServer Componentsでは動作せず、Client Componentsでのみ使用できます。

一部のサードパーティスクリプトでは、スクリプトの読み込みが完了した後、およびコンポーネントがマウントされるたびに（例えばルートナビゲーション後）JavaScriptコードを実行する必要があります。onReadyプロパティを使用して、スクリプトのloadイベント時に初回読み込み時およびその後のすべてのコンポーネント再マウント時にコードを実行できます。

以下は、コンポーネントがマウントされるたびに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はまだServer Componentsでは動作せず、Client Componentsでのみ使用できます。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.0beforeInteractiveとafterInteractiveがappをサポートするように変更
v12.2.4onReadyプロパティ追加
v12.2.2next/scriptでbeforeInteractiveを_document内に配置できるように許可
v11.0.0next/script導入

<Link>

<Link> コンポーネントの API リファレンス

関数

Pages Router の関数とフックに関する API リファレンス