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

エディター設定貢献者 YAML 設定リファレンス

Liferay DXP 2024.Q1+/ポータル GA112+

重要

この機能は現在、リリース機能フラグ (LPS-186870) の背後にあります。詳細については、リリース機能フラグをお読みください。

client-extension.yaml ファイルを使用して、Editor Config Contributor クライアント拡張機能を定義できます。

使用法の詳細

この client-extension.yaml ファイルは、Editor Config Contributor 拡張機能の定義を定義します。

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 プロパティ

これらのプロパティは、Editor Config Contributor クライアント拡張機能に固有のものです。

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