Lang x Lang

︙

<Script>

この API reference は Script Component で使用可能な props の使い方を理解するのに役立つでしょう。機能や使い方については、OptimizingScripts ページをご覧ください。

app/dashboard/page.tsx
import Script from 'next/script'

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

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

Props

ここにスクリプトの Component の利用可能な props の要約があります：

PropExampleTypeRequired
srcsrc="http://example.com/script"Stringインラインスクリプトが使用されていない場合は必須
strategystrategy="lazyOnload"String-
onLoadonLoad={onLoadFunc}関数-
onReadyonReady={onReadyFunc}関数-
onErroronError={onErrorFunc}関数-

Required Props

<Script />の component は、以下のプロパティを必要とします。

src

外部スクリプトの URL を指定する path string。これは、絶対的な外部の URL であるか、または内部の path であることができます。インラインスクリプトが使用されていない限り、src プロパティが必須です。

Optional Props

<Script /> component は、必要なものを超えていくつかの追加プロパティを受け入れます。

strategy

スクリプトの loading strategy 。使用できる 4 つの異なるストラテジーがあります：

  • beforeInteractive: すべての Next.js code と、ページの再生が行われる前にロードします
  • afterInteractive: (default) ページ上で一部のハイドレーションが行われた後に早期にロードします
  • lazyOnload：ブラウザのアイドル時間中にロードします
  • worker: (実験的)ウェブ worker にロードします

beforeInteractive

beforeInteractiveという strategy でロードされる Scripts は、初期の HTML に server から注入され、どの Next.js モジュールよりも先にダウンロードされ、ページ上で何かのハイドレーションが行われる前に配置された順序で実行されます。

この strategy で示された Scripts は、すべてのファーストパーティの code よりも先にプリロードされ、フェッチされますが、その実行はページのハイドレーションの発生をブロックしません。

beforeInteractive scripts は Document Component (pages/_document.js)内に配置する必要があり、全体のサイトに必要な scripts をロードすることを目的として設計されています(つまり、アプリケーション内の任意のページが server-side でロードされた時にスクリプトはロードされます)。

この strategy は、ページの一部がインタラクティブになる前に取得する必要があるクリティカルな scripts にのみ使用するべきです。

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

Good to know: beforeInteractiveがついている Scripts は、それが component のどこに配置されていても、必ず HTML document のheadの中に挿入されます。

beforeInteractiveで可能な限り早く読み込むべき scripts の一部の例は次のとおりです：

  • Bot ディテクター
  • Cookie の同意マネージャー

afterInteractive

afterInteractive ストラテジーを使用するScriptsは、client サイドのHTMLに注入され、ページ上で一部(またはすべて)のハイドレーションが発生した後にロードされます。これは Script component のdefault ストラテジーであり、可能な限り早くロードする必要があるが、Next.js codeよりも前にはロードしない任意の Scripts に使用するべきです。

afterInteractiveは、任意のページや layout の中に配置できる scripts で、そのページ(またはページのグループ)がブラウザで開かれたときにのみ読み込みと実行が行われます。

app/page.js
import Script from 'next/script'

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

afterInteractiveに適している scripts の一部の例は以下の通りです:

  • タグマネージャー
  • Analytics

lazyOnload

lazyOnloadを使用する Scripts は、ブラウザのアイドル時間中に HTML client サイドに注入され、ページ上のすべてのリソースが取得された後に読み込まれます。このストラテジーは、初期の読み込みが必要ないバックグラウンドや低優先度の Scripts に対して使用すべきです。

lazyOnload scripts は、どのページや layout の中にも配置でき、そのページ(またはページのグループ)がブラウザで開かれたときだけ読み込みと実行が行われます。

app/page.js
import Script from 'next/script'

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

lazyOnloadで取得でき、すぐに読み込む必要がない scripts の例は次の通りです：

  • チャットサポートプラグイン
  • ソーシャルメディアウィジェット

worker

警告: worker 戦略はまだ安定しておらず、app ディレクトリではまだ動作しません。注意して使用してください。

worker strategy を使用する scripts は、メインのスレッドを解放し、それには重要な第一者のリソースのみが処理されるように、web worker にオフロードされます。この strategy は任意の scripts に使用できますが、すべての第三者の scripts をサポートすることが保証されているわけではない高度な使用例です。

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

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

worker scripts は、現在 pages/ ディレクトリ内でのみ使用できます:

pages/home.tsx
import Script from 'next/script'

export default function Home() {
  return (
    <>
      <Script src="https://example.com/script.js" strategy="worker" />
    </>
  )
}
pages/home.js
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 を使用することをご検討ください。

いくつかのサードパーティの scripts require は、コンテンツをインスタンス化したり、関数を呼び出したりするために、スクリプトの loading strategy が終了した後に一度だけ JavaScript code を実行することをユーザーに要求します。 afterInteractive または lazyOnload を loading 戦略としてスクリプトを loading している場合、onLoad プロパティを使用して読み込みが完了した後に code を実行することができます。

これは、 library がロードされた後にのみ lodash method を実行する例です。

app/page.tsx
'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]))
        }}
      />
    </>
  )
}
app/page.js
'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 でのみ使用できます。

一部のサードパーティの scripts require は、ユーザーにスクリプトの loading が終了した後や、component がマウントされるたび(例えば route ナビゲーション後など)に JavaScript code を実行するよう要求します。スクリプトのロードイベントが初めてロードされたときと、その後のすべての component の再マウント後に onReady プロパティを使用して code を実行することができます。

ここに、component がマウントされるたびに Google Maps JS 埋め込みを再インスタンス化する方法の例を示します：

import { useRef } from 'react';
import Script from 'next/script';

export default function Page() {
  const mapRef = useRef();

  return (
    <PagesOnly>
      <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 loading strategy と一緒には使用できません。

スクリプトのロードに失敗したときにそれをキャッチすることが役立つことがあります。これらの error は、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);
        }}
      />
    </>
  );
}

Version History

VersionChanges
v13.0.0beforeInteractiveとafterInteractiveがappをサポートするように修正されました。
v12.2.4onReady prop が追加されました。
v12.2.2_documentの中にbeforeInteractiveを伴うnext/scriptを配置できるように許可します。
v11.0.0next/scriptが導入されました。

当社サイトでは、Cookie を使用しています。各規約をご確認の上ご利用ください:
Cookie Policy, Privacy Policy および Terms of Use