Editor Config Contributor YAML Configuration Reference

Liferay DXP 2024.Q1+/Portal 7.4 GA112+

Important

This feature is currently behind a release feature flag (LPS-186870). Read Release Feature Flags for more information.

You can define an Editor Config Contributor client extension with a client-extension.yaml file.

Usage Details

This client-extension.yaml file defines an Editor Config Contributor extension definition:

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

Editor Config Contributor client extensions override existing CKEditor configurations in a ConfigContributor.java file. The client extension’s configuration options must match the ConfigContributor it’s overriding (portlet names, editor names, and editor config keys).

Client extensions are deployed at the instance level and impact all CKEditor instances across pages within that virtual instance if they meet the configuration criteria.

Tip

By specifying configuration options, you can control which CKEditor instances your extensions affect. If you omit specific configuration options, the extension applies to all CKEditors filtered by the provided criteria. If no options are specified, the extension applies to every CKEditor instance in the DXP environment.

The required URL property points to a JavaScript snippet that should implement a function according to the TypeScript interfaces outlined in the public API.

The example workspace includes a complete Editor Config Contributor client extension.

Important

Developers must provide valid configurations when implementing the client extension. The system does not perform any validation checks on these configurations.

YAML Properties

These properties are specific to Editor Config Contributor client extensions:

Name	Data Type	Description
`editorConfigKeys`	`Set<String>`	Specifies the keys related to the editor configurations that this client extension will override or contribute to.
`name`	`String`	The name of the client extension.
`type`	`String`	Indicates the type of client extension.
`url`	`URL`	(Required) The path to the JavaScript snippet that implements the functionality of the Editor Config Contributor client extension.