As mentioned before, CoreMedia Studio comes with a ready-to-use CKEditor 5 configuration. Theses configurations can be referenced in RichTextPropertyFields or RichTextAreas. To do so, they must be registered first and can also be overridden.

The CKEditor 5 configuration is located in the @coremedia-blueprint/studio-client.main.ckeditor5 package in the Blueprint. The contents of this package are based on CKEditor architecture and API only. Before you start, we recommend reading the CKEditor 5 Quickstart Guide in order to understand the setup of the package. Please also have a look at the Creating a simple Plugin documentation to learn about how to create own plugins for the CKEditor 5.

You can change the editor's configuration by simply editing src/ckeditor/ckeditorDefault.ts.

To be able to dynamically create new editor instances whenever needed, this package will not create the editor directly, but instead export a function that returns an editor instance. This can be seen in src/ckeditor/ckeditor.ts.

The parameter type will be used later on to distinguish between different types of editors.

The initEditor function will be used in Studio plugins to register a certain editorType. We will describe this in the next section. You can also extend this package to export multiple editor instances, as mentioned before, with different configurations. This is described in Section 9.6.6.4, “Adding multiple CKEditor 5 Configurations”.