API Reference
コンポーネント

<script> - This feature is available in the latest Canary

Canary

React による <script> の機能拡張は、現在 React の Canary および experimental チャンネルでのみ利用可能です。React の安定版リリースでは、<script> は単なる組み込みのブラウザ HTML コンポーネントとして機能します。React のリリースチャンネルについてはこちらをご覧ください。

ブラウザ組み込みの <script> コンポーネントを利用することで、ドキュメントにスクリプトを追加できます。

<script> alert("hi!") </script>

リファレンス

<script>

ドキュメントにインラインスクリプトまたは外部スクリプトを追加するためには、ブラウザ組み込みの <script> コンポーネントをレンダーします。任意のコンポーネントから <script> をレンダーでき、React は特定の場合に対応する DOM 要素をドキュメントの head 内に配置し、同一スクリプトの重複解消処理を行います。

<script> alert("hi!") </script>
<script src="script.js" />

さらに例を見る

props

<script> は、一般的な要素の props をすべてサポートしています。

props として children または src のいずれかが必要です。

  • children: 文字列。インラインスクリプトのソースコード。
  • src: 文字列。外部スクリプトの URL。

他に、以下の props がサポートされます。

  • async: ブーリアン。ドキュメントの残りの部分の処理を完了するまでブラウザにスクリプトの実行を遅延させることを許可します。これはパフォーマンスのために推奨される動作です。
  • crossOrigin: 文字列。使用する CORS ポリシー。可能な値は anonymous と use-credentials です。
  • fetchPriority: 文字列。複数のスクリプトを同時にフェッチする際に、ブラウザにスクリプトの優先付けを行わせます。"high"、"low"、"auto"（デフォルト）のいずれかです。
  • integrity: 文字列。文字列。真正性を検証するために使用するスクリプトの暗号化ハッシュ。
  • noModule: ブーリアン。ES モジュールをサポートするブラウザでこのスクリプトを無効にすることで、サポートしていないブラウザ用のフォールバックスクリプトとして利用できるようにします。
  • nonce: 文字列。厳格なコンテンツセキュリティポリシーを使用する際にリソースを許可するための暗号化 nonce。
  • referrer: 文字列。スクリプトをフェッチする際、およびそのスクリプトが更にリソースフェッチする際に送信する Referer ヘッダーを指定します。
  • type: 文字列。スクリプトが従来のスクリプト、ES モジュール、またはインポートマップのいずれであるかを指定します。

以下の props は React によるスクリプトの特別な扱いを無効にします。

  • onError: 関数。スクリプトのロードに失敗したときに呼び出されます。
  • onLoad: 関数。スクリプトのロードが完了したときに呼び出されます。

以下は React での使用が推奨されない props です。

  • blocking: 文字列。"render" と設定されている場合、スクリプトがロードされるまでページを描画しないようブラウザに指示します。React ではサスペンスを通じてより細かい制御を提供します。
  • defer: 文字列。ドキュメントの読み込みが完了するまでブラウザによるスクリプトの実行を防ぎます。これはストリーミングでサーバレンダーされるコンポーネントと互換性がありません。代わりに async を使用してください。

特別なレンダー動作

React は <script> コンポーネントをドキュメントの <head> に移動させ、同一スクリプトの重複解消処理を行い、スクリプトの読み込み中にサスペンドを発生させます。

この動作を有効にするには、props として src と async={true} の props を指定してください。React は同じ src を持つスクリプトが重複しないようにします。スクリプトを安全に移動させるために async が true である必要があります。

props として onLoad または onError を指定した場合、特別な動作は発生しません。これらの props は、コンポーネント内でスクリプトの読み込みを手動で管理してしていることを意味するからです。

この特別な動作に関して、以下の 2 つの注意点があります。

  • スクリプトがレンダーされた後、React は props に変更があってもそれを無視します（開発中にこれが起きた場合は React が警告を発します）。
  • スクリプトをレンダーしていたコンポーネントがアンマウントされた後も、React は DOM にスクリプトを残すことがあります。（スクリプトは DOM に挿入された際に一度だけ実行されるものなので、これによる影響はありません。）

使用法

外部スクリプトのレンダー

コンポーネントが正しく表示されるために特定のスクリプトに依存している場合、当該コンポーネント内で <script> をレンダーできます。

props として src と async を指定すると、スクリプトが読み込まれる間、コンポーネントはサスペンド状態になります。スクリプトの重複を避けるため、複数のコンポーネントが同じ src を持つスクリプトをレンダーしている場合には React は DOM にそれをひとつだけ挿入します。

import ShowRenderedHTML from './ShowRenderedHTML.js';

function Map({lat, long}) {
  return (
    <>
      <script async src="map-api.js" />
      <div id="map" data-lat={lat} data-long={long} />
    </>
  );
}

export default function Page() {
  return (
    <ShowRenderedHTML>
      <Map />
    </ShowRenderedHTML>
  );
}

補足

スクリプトを使用する場合、preinit 関数を呼び出すことが有用です。この関数を呼び出すことで、たとえば HTTP Early Hints レスポンスを送信でき、ブラウザがスクリプトのフェッチをより早く開始できるかもしれません。

インラインスクリプトのレンダー

インラインスクリプトを含めるには、<script> コンポーネントをレンダーする際に children としてスクリプトのソースコードを指定します。インラインスクリプトは重複解消処理が行われず、ドキュメントの <head> に移動されません。外部リソースを読み込まないため、コンポーネントがサスペンド状態になることはありません。

import ShowRenderedHTML from './ShowRenderedHTML.js';

function Tracking() {
  return (
    <script>
      ga('send', 'pageview');
    </script>
  );
}

export default function Page() {
  return (
    <ShowRenderedHTML>
      <h1>My Website</h1>
      <Tracking />
      <p>Welcome</p>
    </ShowRenderedHTML>
  );
}
Previous<meta>
Next<style>

How do you like these docs?