ご覧のページは、お客様の利便性のために一部機械翻訳されています。また、ドキュメントは頻繁に更新が加えられており、翻訳は未完成の部分が含まれることをご了承ください。最新情報は都度公開されておりますため、必ず英語版をご参照ください。翻訳に問題がある場合は、こちらまでご連絡ください。

JavaScript YAML設定リファレンス

JavaScriptクライアント拡張は、client-extension.yamlファイルで定義することができます。

使用法の詳細

このclient-extension.yamlファイルは、JavaScriptクライアント拡張を定義します。

able-global-js:
   name: Able JS
   scriptElementAttributes:
      async: true
      data-attribute: "value"
      data-senna-track: "permanent"
      fetchpriority: "low"
   type: globalJS
   url: global.js

必須のurlプロパティは、JavaScriptリソースファイルの場所を定義します。ページで有効にすると、このパスにあるJavaScriptが各ページの読み込み時に実行されます。

サンプルワークスペースには、完全な JavaScript クライアント拡張機能が含まれています。

YAML プロパティ

これらのプロパティは、JavaScriptクライアント拡張に特有のものです。

名前	データ型	説明
`url`	URL	(必須）クライアント拡張が有効な場合に、ページのHEADに追加されるJavaScriptファイルへのパス。完全なURIは、`baseURL`の値が先頭に付きます。
`scriptElementAttributes`	文字列	Liferay DXP 2024.Q2/Portal GA120 以降では、HTML `スクリプト` 要素に文字列属性とブール属性を追加できます。文字列の場合は `名前: "値"` の形式を使用し、ブール値の場合は `名前: 値` の形式を使用します。
`scope`	文字列	Liferay DXP 2024.Q4.8/2025.Q1.5/2025.Q2/Portal GA133 以降では、スコープを `会社` に設定して、JavaScript クライアント拡張機能をインスタンスのすべてのページ（管理ページ（サイト管理やコントロールパネルなど）を含む）に適用できます。デフォルトは `レイアウト`で、管理者によって設定されたサイトページにのみ適用されます。
`scriptLocation`	文字列	Liferay DXP 2024.Q4/Portal GA129 以降では、スクリプトをページ `ヘッダー` で実行するか、 `ボトム`で実行するかを指定できるようになりました。これは、スコープが `会社`の場合にのみ適用されます。