close

Filter

loading table of contents...

CoreMedia Content Cloud v11 Upgrade Guide / Version 2110

Table Of Contents

6.4.4.1 Mandatory code adjustments when upgrading to CKEditor 5

Note

Note

If you have no custom richtext implementations or CKEditor customizations, you don't need to follow these steps at all. All the core Studio components will use the new CKEditor out-of-the-box.

If you are using richtext in your custom Studio code, you probably depend on one of these Ext JS components:

  • RichTextArea.ts

  • CoreMediaRichTextArea.ts

  • RichTextPropertyField

These components still exist and can be used by changing their imports to

  • @coremedia/studio-client.main.ckeditor4-components/RichTextArea
  • @coremedia/studio-client.main.ckeditor4-components/CoreMediaRichTextArea
  • @coremedia/studio-client.main.ckeditor4-components/RichTextPropertyField

Please notice, changing the imports might not suffice if you have customized the editor by using plugins:

  • You will need to convert your CKEditor plugins, actions and toolbar items to CKEditor 5. To quote the Migration from CKEditor 4 - CKEditor 5 documentation:

    "The trickiest migration challenge to be faced may be related to custom plugins you have developed for CKEditor 4. Although their concept may stay the same, their implementation will certainly be different and will require rewriting them from scratch.”

  • The configuration for the default CKEditor instance in CoreMedia Studio is located in @coremedia-blueprint/studio-client.main.ckeditor5. You can customize this configuration to fit your needs.

  • You will need to add build configurations if you need multiple CKEditor instances with different configurations.

These tasks will be explained in the following sections.

Search Results

Table Of Contents
warning

Your Internet Explorer is no longer supported.

Please use Mozilla Firefox, Google Chrome, or Microsoft Edge.