Menu

スクリプト

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

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

Props

以下はScriptコンポーネントで利用可能なプロパティの概要です：

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

必須プロパティ

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

src

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

オプションプロパティ

<Script /> コンポーネントは、必須のものに加えていくつかの追加プロパティを受け付けます。

strategy

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

  • beforeInteractive: Next.jsのコードやページのハイドレーションが発生する前に読み込みます。
  • afterInteractive: (デフォルト) ページ上でハイドレーションが一部発生した後、早い段階で読み込みます。
  • lazyOnload: ブラウザのアイドル時間中に読み込みます。
  • worker: (実験的) Webワーカーで読み込みます。

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ルーターではまだ機能していません。慎重に使用してください。

worker戦略を使用するスクリプトはWebワーカーにオフロードされ、メインスレッドを解放し、重要なファーストパーティリソースのみがそこで処理されるようにします。この戦略は任意のスクリプトに使用できますが、すべてのサードパーティスクリプトをサポートすることを保証しない高度なユースケースです。

戦略としてworkerを使用するには、next.config.jsでnextScriptWorkersフラグを有効にする必要があります：

next.config.js
module.exports = {
  experimental: {
    nextScriptWorkers: true,
  },
}

workerスクリプトは現在、pages/ディレクトリでのみ使用できます：

pages/home.tsx
TypeScript
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メソッドを実行する例です。

app/page.tsx
TypeScript
'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.0beforeInteractiveとafterInteractiveがappをサポートするように修正。
v12.2.4onReady propが追加。
v12.2.2beforeInteractiveを持つnext/scriptを_documentに配置できるようになりました。
v11.0.0next/scriptが導入。