Release Notes / Version 12.2404
Table Of ContentsCKEditor 5 has been updated to version 41.1.0 (CKEditor 5 Development Tooling to 39.6.0). CoreMedia's CKEditor 5 Plugins and the CKEditor 5 CoreMedia OEM License have been updated accordingly:
CoreMedia CKEditor 5 Plugins: 17.0.0
CKEditor 5 CoreMedia OEM License: 2.1.0
Along with that, we fixed some meanwhile broken references to the CKEditor 5 documentation within the Studio Developer Manual.
Upgrade Highlights – CoreMedia CKEditor 5 Plugins
Hardening Default Link Target Configuration: Prior to this release, a configured function based default link target filter (to apply a default target based on a given URL) may have been called with
nullin contrast to the method signature. This has been fixed, so that the function is only called for non-empty URLs.
Notable Upgrade Highlights – CKEditor 5
This section is just about remarkable changes we observed during the upgrade. For detailed information and possibly required upgrade steps in context of custom plugins, take a look at the CKEditor 5 changelog, please.
Links: For external links, you may now just paste the URL having a text selected, and the text will get the link applied. Side Note: This feature also automatically triggers the possible default target selection provided by CoreMedia CKEditor 5 Plugins based on your configuration.
Paste from Office: When General HTML Support is activated (transitively through CoreMedia Rich Text Support), class attribute values like
MsoNormalwere kept during paste. CKEditor 5 now actively removes such artificial artifacts.AI Assistant Capability: While not enabled in CoreMedia Blueprint, you may be interested to know, that with supporting CKEditor 5 41.0.0 within CoreMedia Studio, it is the first supported release, that comes with AI features.
Integration Changes: CKEditor 5 now ships as ECMAScript modules, which requires additional upgrade steps, where the most important one is upgrading to TypeScript 5. Find more details below.
API Changes:
CKEditor 5 UI: While there was no need to apply adaptations in CoreMedia Blueprint, we observed typing adjustments in context of the CKEditor 5 UI. This is due to some progress towards providing a so-called dialog system.
Document Lists: They are now the “standard list API”. As a result the prefix
Document*, likeDocumentListis deprecated and got replaced byList, while the old feature got prefixed withLegacy*.
Upgrade Information
The following changes ship with ckeditorDefault.ts
that may require to adapt your customizations to incoming changes, as
well as you may need to adapt your custom CKEditor 5 flavors:
Recommended (due to deprecation): Rename import from
@ckeditor/ckeditor5-list:Was:
DocumentListIs:
List
CSS Adaptation: Rename
- ck-z-modalto-ck-z-panelincustom.css(CKEditor 5 Theme).Required – Opt-In to previous Find & Replace UI: Add a new configuration:
config.findAndReplace.uiTypeand set it todropdown. While the new behavior (based on a so-called “dialog-system”) has many benefits, we experienced severe issues within the Studio integration regarding context management (dialog stays open, even if switching tabs). Thus, for now, our recommendation is to ensure to opt in to the old behavior.
Note, that this update requires TypeScript 5 and Jangaroo Tooling in version 2. If you see conflicts between “CommonJS” and “EcmaScript Modules” while building, you may have missed the required update.
(CMS-24095)
