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

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

Liferay DXP 2026.Q1+

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

使用方法の詳細

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

assemble:
    - from: build
        into: static
liferay-sample-editor-config-contributor-2:
    editorConfigKeys:
        - sampleReactCKEditor5ClassicEditor
    name: Liferay Sample Editor Config Contributor 2
    type: editorConfigContributor
    url: index.js

Editor Config Contributorクライアント拡張機能は、Liferay独自の構成に加えて、新しいエディター構成を提供します。 editorConfigKeys、 editorNames、および portletNames プロパティは、構成するエディタと一致する必要があります。エディタ設定キーは、クライアント拡張機能が設定するエディタを指定します。エディタ設定キーを指定しない場合、Liferay はクライアント拡張機能を Liferay 内のすべての WYSIWYG エディタに適用します。

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

ヒント

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

「url」プロパティには、@liferay/js-apinpm パッケージ（バージョン0.8.0）が「editor」サブパス下に公開しているTypeScript インターフェースを実装した JavaScript ファイルへのパスが指定されます。

サンプルワークスペースの liferay-sample-editor-config-contributor-2 プロジェクトは、完全な Editor Config Contributor クライアント拡張機能です。

重要

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

YAMLプロパティ

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

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