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

エディター設定コントリビューターYAML設定リファレンス

Liferay DXP 2024.Q1+/Portal GA112+

client-extension.yaml ファイルを使用して、エディター設定コントリビュータークライアント拡張機能を定義できます。

使用法の詳細

この client-extension.yaml ファイルは、エディター設定コントリビューター拡張機能の定義を定義します。

able-editorConfigContributor:
   editorConfigKeys:
      - contentEditor
      - description
      - sampleClassicEditor
      - sampleLegacyEditor
   name: Liferay Sample Editor Config Contributor
   type: editorConfigContributor
   url: index.js

Editor Config Contributor クライアント拡張機能は、 ConfigContributor.java ファイル内の既存の CKEditor 設定を上書きします。クライアント拡張機能の設定オプションは、上書きする ConfigContributor と一致している必要があります (ポートレット名、エディター名、エディター設定キー)。エディタ設定キーは、クライアント拡張機能が設定するエディタを指定します。また、エディタ設定キーを使用しないことで、Liferay のすべての WYSIWYG エディタに適用することもできます。

クライアント拡張機能はインスタンスレベルでデプロイされ、構成条件を満たしている場合、その仮想インスタンス内のすべてのCKEditorインスタンスおよびページに影響を与えます。

ヒント

設定オプションを指定することで、拡張機能が影響を与えるCKEditorインスタンスを制御できます。特定の構成オプションを省略した場合、拡張機能は指定された条件でフィルタリングされたすべてのCKEditorに適用されます。オプションが指定されていない場合、拡張機能はDXP環境内のすべてのCKEditorインスタンスに適用されます。

必須の URL プロパティは、公開 API で概説されている TypeScript インターフェイスに従って関数を実装する JavaScript スニペットを指します。

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

重要

開発者は、クライアント拡張機能を実装する際に、有効な設定を提供する必要があります。システムはこれらの設定に対して検証チェックを行いません。

YAML プロパティ

これらのプロパティは、エディター設定コントリビュータークライアント拡張機能に固有のものです。

名前	データ型	説明
`editorConfigKeys`	`Set<String>`	このクライアント拡張機能が上書きまたは影響を与えるエディタ構成に関連するキーを指定します。キーを指定しない場合、すべてのWYSIWYGエディタに適用されます。
`name`	`String`	クライアント拡張機能の名前。
`type`	`String`	クライアント拡張機能の種類を示します。
`url`	`URL`	（必須）エディター設定コントリビュータークライアント拡張機能の機能を実装するJavaScriptスニペットへのパス。