ckeditor/ckeditor5 v39.0.0

on GitHub

We are happy to announce the release of CKEditor 5 v39.0.0.

Release highlights

Paste from Office Enhanced

This release introduces a new plugin that significantly boosts the retention of styles when pasting content from Microsoft Word and Excel. This improved functionality is available as part of our Productivity pack feature set.

Color picker in table (cell) properties

It is now possible to select the desired color for table properties, such as cell background or border color, using a color picker. You can test it in the Table and cell styling tools guide.

CKBox

As the new version of CKBox supports workspaces, the integration with CKEditor was updated to support them. Read more in the update guide.

Watchdog performance improvements

We have greatly improved the editor performance when Watchdog is used and huge amount of data is loaded in the editor. The editor should no longer lag every few seconds while typing, as Watchdog data backup mechanism is much faster now.

Since Watchdog is used by default in our frameworks integrations, if you use one of our integrations, you will benefit from this improvement as well!

Multi-root editor - delayed root loading [experimental]

It is now possible to initialize the multi-root editor with just one or a few of the document roots and load the other roots later on.

This solution is useful for huge documents that are split into chapters or sections, where each chapter or section is a separate document root.

Real-time collaboration and revision history features are supported. Users can join the same document but have different parts of the document loaded initially.

Please note, that there are some technical obstacles that we will be addressing in further releases:

• As of now, the solution should be used with new documents only.
• As of now, the revision data will still include and use the whole document data. However, the performance impact is significantly smaller than loading this data upfront when the editor is initialized.
• Since only a part of the document is loaded, some of the features (e.g. word count, table of contents) may behave unexpectedly.

Note: this is an experimental feature. Its API and details of its behavior may change in the upcoming releases.

Major bugfixes

• Improved sticky toolbar behavior when nesting in an overflown element. Closes #5465.

  We have resolved an issue where the sticky toolbar was incorrectly positioned if the editor was nested within multiple clipped and scrollable elements.

• The editor does not scroll down while typing in the editable with a fixed height. Closes #13411.

  When typing in an editor with a fixed height, the scroll automatically follows as the text flows onto the next line.

• Reverse typing effect on slower machines. Closes #14569.

  We have addressed an issue where the cursor seemed to be "stuck" and did not update in a timely manner, causing the text to be inserted behind it, especially under a very heavy JS thread load. The issue has been successfully resolved, ensuring smoother and more accurate cursor behavior.

Please refer to the update guide to learn more about these changes.

MAJOR BREAKING CHANGES ℹ️

• ckbox: The plugin requires CKBox in version at least 2.0.0. The editor configuration option ckbox.assetsOrigin is no longer supported.

MINOR BREAKING CHANGES ℹ️

• engine: The enablePlaceholder() helper now uses a placeholder property of the passed element. It no longer takes the placeholder text as a text argument.
• font: The ColorTableView class has been moved to the @ckeditor/ckeditor5-ui package and remains available as a public ColorSelectorView component.
• font: CSS classes such as .ck-color-table__remove-color or .ck-color-table__color-picker (prefixed with .ck-color-table) are now prefixed with .ck-color-selector. For instance: .ck-color-selector__remove-color or .ck-color-selector__color-picker.
• table: Color pickers are now displayed by default for all color fields in the table and table cell properties UI. In places where users should use a limited number of colors, it is possible to disable the color picker using a configuration option. See the configuration reference of the table properties and table cell properties features to learn more.

Features

• ckbox: Adds support for CKBox workspaces. Closes #14504. (commit)
• ckbox: CKBoxUploadAdapter looks for categories using file extension case-insensitively. Closes #13751. (commit)
• engine: Introduced model.Document#getRoots(). (commit)
• engine: Placeholders can now be changed after the initialization. This can be done by changing the placeholder property of the element passed to the enablePlaceholder() helper. Closes #9925. (commit)
• html-support: Introduced a configuration option to allow empty inline elements. Closes #9888. (commit)
• multi-root-editor: Introduced MultiRootEditor#loadRoot() and EditorConfig.lazyRoots which can be used to implement the roots progressive ("lazy") loading. (commit)
• multi-root-editor: Introduced MultiRootEditor#getRootAttributes(). (commit)
• table: Implemented color pickers to color selection fields in the table properties and table cell properties UI. Closes #14500. (commit)
• track-changes: Added track changes data support for multi-root editor without the need to specify a custom callback.
• ui: Extracted the ColorTableView UI from ckeditor5-font as a public ColorSelectorView component (see #14500). (commit)

Bug fixes

• comments: The comment's read-only state will now depend on the comment thread's read-only state.
• comments: A comment thread annotation will no longer disappear after clicking on a mention hint.
• comments: Sidebar min-height should be correctly updated after switching between various annotations display modes.
• engine: Fixed a reverse typing issue on an editor gaining focus. Closes #14569. (commit)
• engine: Fixed random selection-related crashes happening on Firefox for unknown reasons (error code NS_ERROR_FAILURE). Closes #14493. (commit)
• engine: The DOM selection should not obscure the clickability of dropdown items on iOS. Closes #5753. (commit)
• pagination: Prevented crash when the floating image is the only element in the document.
• paragraph: The insertParagraph command will no longer insert two paragraphs when the position is at the edge of the block. Closes #13866. (commit)
• paste-from-office: CKEditor 5 properly reflects table alignments pasted from Microsoft Word. Closes #8752. (commit)
• paste-from-office: Fixed rendering thin space when content is pasted from Microsoft Word. Closes #12562. (commit)
• revision-history: Fixed a minor UI error happening when root add or remove change was the first change in a given revision and changes navigation arrows were used.
• source-editing: Fixes infinite loop in source editing mode. Closes #14469. (commit)
• theme-lark: Adjusted the balloon tip color to match the rest of the panel. Closes #14652. (commit)
• track-changes: Roots attributes will now be passed to internal editor in track changes data plugin. This may solve some errors with custom plugins using root attributes.
• track-changes: Suggestion annotations will now stay open after clicking on a mention hint when writing a comment for a suggestion.
• typing: The editor should scroll to the selection after inserting the text. Closes #13411. (commit)
• ui: The dropdown view should not be closed when interacting with a scrollbar. Closes #14364. (commit)
• ui: The "Powered by CKEditor" balloon is now hidden if outside the editor. (commit)
• ui: Fixed the sticky panel behavior in overflowing containers. Closes #5465. (commit)
• ui: Dropdowns will stay open after clicking on an HTML element added to the dropdown's focus tracker. (commit)
• undo: Fixed incorrect selection reversion which lead to editor crash in very peculiar scenarios involving adding and removing roots and using undo and redo. (commit)
• watchdog: Watchdog now correctly supports multi-root editor after roots were added or detached. (commit)
• watchdog: Comments and suggestions data is now correctly restored by Watchdog in non-real-time editing "load and save" integrations. (commit)
• watchdog: Improved the Watchdog save mechanism performance to prevent editor unresponsiveness ("lags") while editing the document. Closes #13098. (commit)
• Fixed editor crash happening in real-time collaboration when two clients removed and re-attached a root at the same time. (commit)

Other changes

• comments: Added the CommentThread#deletedAt property. It can be used to filter out already removed threads (e.g. in comments-outside-editor integrations).
• core: Commands will now be disabled when the editor has no roots (applies only to commands whose state is based on a document selection placement). (commit)
• engine: Introduced the cleanSelection event in DowncastDispatcher for downcast conversion. The event is fired before selection events and should be used to do any clean-ups before the model document selection is downcasted. (commit)
• engine: Prevented document selection conversion if the selection is inside a model root that does not have a corresponding view root. In such a case, selection downcast event will not be fired. (commit)
• engine: Renamed clearAttributes() converter to cleanSelection() converter. (commit)
• engine: Schema#getNearestSelectionRange() will now return null for any position inside the graveyard root. (commit)
• engine: model.DocumentSelection will not inherit attributes from nodes inside a graveyard. (commit)
• engine: The DomConverter should allow registering custom matchers to detect inline object elements. See #9888. (commit)
• paste-from-office: Adjusted the public API for Paste from Office Enhanced usage. (commit)
• source-editing: Fixed formatting of the <br> elements in source editing. Whitespaces before a <br> element should not be added. (commit)
• track-changes: Added the DescriptionItem type.
• typing: The FocusObserver should be flushed if typing occurred. See #14569. (commit)
• undo: UndoCommand#event:revert will now be fired after all changes triggered by undo are applied (including changes in post-fixer). (commit)
• utils: Made the scrollAncestorsToShowTarget() helper take a limiter element as an argument in order to stop it from scrolling the entire viewport. Closes #14598. (commit)
• Optimized icons. (commit)
• Updated translations. (commit, commit, commit)

Released packages

Check out the Versioning policy guide for more information.