Skip to content

Latest commit

 

History

History
944 lines (762 loc) · 124 KB

CHANGELOG.md

File metadata and controls

944 lines (762 loc) · 124 KB
Raw

Changelog

41.0.0 (January 17, 2024)

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

Improved list suggestions behavior

We continue to improve the way the editor displays the formatting suggestions.

This release includes integration of the list features with the new suggestions behavior. All list-related suggestions are now visible in the editor content.

The dialog system

The dialogs finally come to the CKEditor 5 UI!

Some users found using the find and replace feature through a dropdown inconvenient as it might have covered the content, including the searched text. We listened to these voices and the find and replace UI will now be using a dialog.

If you liked the earlier user interface of this feature, you can still display it inside a dropdown by setting the config.findAndReplace.uiType configuration option.

We have also introduced a dialog in the AI Assistant feature. Displaying the AI Assistant inside a balloon came with many UX hiccups, especially when you selected large content. It works great now.

The dialogs are now a part of the CKEditor 5 UI library so you can use them, too! Read the documentation to learn how to display your custom features inside dialogs and modals.

Case change

No more selecting, deleting, retyping with Caps Lock for long legal preambles. The case change plugin enables users to easily change text cases, applying UPPERCASE, lowercase, and Title Case. This feature simplifies text formatting by allowing quick alterations with a single click or a keyboard shortcut.

As a key component of CKEditor 5's Productivity Pack, this plugin complements and enhances the suite's editing capabilities, offering a practical tool for efficient text manipulation.

Improving CKEditor 5 installation methods

We start the new year with improvements in the new installation methods project. This includes an upgrade to the latest TypeScript version, ensuring enhanced type safety.

A key part of this release is the resolution of ECMAScript Module (ESM) compliance issues. We updated all packages and their definitions to be fully ESM-compliant. This ensures smoother integration and compatibility across various development environments.

We have also renamed exports of several classes, interfaces, and helpers to eliminate naming conflicts in the code for the new bundle that will appear later this year.

Take a look at the RFC to see what is coming: ckeditor#15502.

Deprecation of lists v1

This release marks a significant change in the list feature. As announced before, we are phasing out the older implementation of the List plugin, originally designed for plain lists. We are directing the development efforts towards the more advanced list v2 feature (formerly named DocumentList). This change aims to eliminate confusion for integrators and optimize the number of list functionalities.

The DocumentList plugins, which represent the advanced lists v2 feature, will now be available under the standard name List. This change enables document lists across all integrations, with the new version ensuring no loss of features from the older one.

We renamed the previous List plugins to LegacyList, providing a fallback option for integrators after the update. We will keep the LegacyList available for a couple of releases to lower the migration impact.

The existing DocumentList plugins were replaced with aliases. Integrations using the older DocumentList will continue to function without any need for configuration changes for a couple of releases. Users will be notified via console warnings to consider updating their configurations.

Additionally, we completely removed the ListStyle plugin, which has been deprecated for a while. This change aligns with our goal to simplify the list features.

Release highlights

Refer to the update guide to learn more about these changes.

MAJOR BREAKING CHANGES ℹ️

  • ai: From this release on, the UI of the AI Assistant feature is displayed in a dialog instead of a balloon. See #14973.
  • find-and-replace: From this release on, the UI of the find and replace feature is displayed by default in a dialog instead of a dropdown. To bring the previous user experience back, you can use the config.findAndReplace.uiType configuration option. See #14973.
  • list: The AdjacentListsSupport plugin is moved from the documentlist directory to the list directory. See #14942.

MINOR BREAKING CHANGES ℹ️

  • adapter-ckfinder: Rename export of the UploadAdapter class to CKFinderUploadAdapter. See #15511.
  • ai: The layout of the UI changed. Customizations based on certain CSS selectors may not work anymore because of a different DOM structure in the UI. Learn more about the scope of changes. See #14973.
  • ckfinder: Moved the browseFiles icon to the core package and added it to the icons object exported from it. See #15511.
  • ckbox: Moved the browseFiles icon to the core package and added it to the icons object exported from it. See #15511.
  • code-block: Moved the codeBlock icon to the core package and added it to the icons object exported from it. See #15511.
  • core: Bumped the TypeScript version to 5.0. See #15452.
  • engine: Renamed export of the View class to EditingView. See #15511.
  • engine: Moved the findOptimalInsertionRange function to the Schema class as a new method. See #15511.
  • find-and-replace: The layout of the UI changed. Customizations based on certain CSS selectors may not work anymore because of a different DOM structure in the UI. Learn more about the scope of changes. See #14973.
  • heading: Moved the heading1, heading2, heading3, heading4, heading5, and heading6 icons to the core package and added them to the icons object exported from it. See #15511.
  • horizontal-line: Moved the horizontalLine icon to the core package and added it to the icons object exported from it. See #15511.
  • html-embed: Moved the html icon to the core package and added it to the icons object exported from it. See #15511.
  • indent: Moved the indent and outdent icons to the core package and added them to the icons object exported from it. See #15511.
  • link: Added validation to the URL field to disallow empty URLs by default. See #12501.
  • list: All old list plugins are now prefixed with Legacy (including directory names): List -> LegacyList, ListProperties -> LegacyListProperties, TodoList -> LegacyTodoList, ListEditing -> LegacyListEditing, ListUtils -> LegacyListUtils, ListPropertiesEditing -> LegacyListPropertiesEditing, TodoListEditing -> LegacyTodoListEditing. See #14942.
  • list: The document list plugins are no longer prefixed with Document (including directory names): DocumentList -> List, DocumentListProperties -> ListProperties, TodoDocumentList -> TodoList, DocumentListEditing -> ListEditing, DocumentListUtils -> ListUtils, DocumentListPropertiesEditing -> ListPropertiesEditing, DocumentListPropertiesUtils -> ListPropertiesUtils, TodoDocumentListEditing -> TodoListEditing. See #14942.
  • list: The ListStyle plugin was removed since it had been deprecated for a while. Use the ListProperties plugin instead. See #14942.
  • list: Moved the bulletedList, numberedList, and todoList icons to the core package and added them to the icons object exported from it. See #15511.
  • table: Moved the table icon to the core package and added it to the icons object exported from it. See #15511.
  • ui: Moved the colorPalette, previousArrow, and nextArrow icons to the core package and added them to the icons object exported from it. See #15511.
  • ui: The --ck-z-modal CSS custom property was renamed to --ck-z-panel. We recommend updating custom CSS and integrations that use this custom property to avoid presentation issues. See #14973.
  • ui: The view collection (focusables) required by FocusCycler#constructor() must only contain views implementing the FocusableView interface. Failing to do so will result in a TypeScript error. If your custom code creates FocusCycler instances, make sure that all views passed in focusables implement the focus() method. See #14973.
  • ui: The font size of the FormHeaderView component was increased. This change affects the look of the find and replace and table styling features as well as custom user interfaces that use this component. See #14973.
  • ui: The type of AriaLiveAnnouncerPoliteness changed (previously enum, now a constant object). See #14973.
  • ui: The #next and #previous properties of a FocusCycler will now point to the same view if there is only one focusable view (previously null). This change may affect integrations that use this helper to manage advanced focus navigation in dynamic UIs. See #14973.
  • undo: Moved the undo and redo icons to the core package and added them to the icons object exported from it. See #15511.
  • utils: Renamed the Position interface to DomPoint. See #15511.

Features

  • ai: The UI of the feature was migrated to a dialog for a better user experience. See #14973.
  • case-change: Introduced the case change feature.
  • find-and-replace: The UI of the feature was migrated to a dialog for a better user experience. See #14973. (commit)
  • track-changes: Integrated the list feature with the new attribute suggestions. Tracked changes in lists are now immediately visible in the editor.
  • ui: Implemented the Dialog plugin that allows for displaying dialog windows in the UI of the editor. Learn more about using dialogs. Closes #14973. (commit)

Bug fixes

  • ai: AWSTextAdapter should be able to handle many data objects returned in one update (chunk).
  • ai: AWSTextAdapter should be able to handle data objects that were split between many updates (chunks).
  • ckbox: Replaced some toolbar icons with ones with improved alignment. Closes #15549. (commit)
  • ckbox: Fixed the relative URL image editing. (commit)
  • clipboard: Drag and drop into the document title element should not throw errors. Closes #15306. (commit)
  • comments: Unlinked and resolved comment threads will now be correctly handled when added during the editor initialization.
  • core: Replaced some toolbar icons with ones with improved alignment. Closes #15549. (commit)
  • html-support: The editor should not be stuck in an infinite post-fixing loop while modifying a list structure inside a GHS element. Closes #15527, #15565. (commit)
  • link: Fixed the editor crash using the LinkImage plugin loaded before Image, which ends with extending the schema definitions before they registering them. Closes #15617. (commit)
  • media-embed: Replaced some toolbar icons with ones with improved alignment. Closes #15549. (commit)
  • ui: The TextareaView component should correctly update its size if its value changes while it is invisible. See #14973. (commit)
  • Made all CKEditor 5 packages valid ES Modules. See #13673.

Other changes

  • ckbox: Image editing should work with the on-premises CKBox. Closes #5834. (commit)
  • core: Bumped the TypeScript version to 5.0. Closes #15452 . (commit)
  • engine: Made the types of the Schema.addChildCheck and Schema.addAttributeCheck callbacks more specific. See #15290. (commit)
  • list: The document list feature was promoted to the main list feature implementation. The Document prefix was removed. The old list implementation was prefixed with the Legacy keyword. Aliases were introduced (DocumentList, DocumentListProperties, TodoDocumentList) for backward compatibility but those are marked as deprecated and log a warning in the browser console. Closes #14942. (commit)
  • ui: The FocusCycler#focusables collection should only contain FocusableView instances. See #14973. (commit)
  • ui: The #next and #previous properties of a FocusCycler instance should point to the same view if there is only one focusable view registered in the focusables collection. See #14973. (commit)
  • Updated translations. (commit)

Released packages

Check out the Versioning policy guide for more information.

Released packages (summary)

New packages:

Major releases (contain major breaking changes):

Minor releases (contain minor breaking changes):

Releases containing new features:

Other releases:

40.2.0 (December 12, 2023)

We are happy to announce the release of CKEditor 5 v40.2.0.

Release highlights

AI Assistant: AWS and custom integrations

Enabling many AI model services was one of our priorities for the AI Assistant. We wanted everyone to be able to use a platform that they find the most convenient.

We are happy to inform you that as of this release, you can use the AI Assistant together with the Amazon Bedrock service.

What is more, you can now extend existing adapters to enable more advanced customizations, such as decorating the AI Assistant requests.

Finally, you can even create a custom adapter to connect to your custom model or any model that does not have an official adapter yet.

Visit the new integration guide to learn more about integrating and customizing the AI Assistant feature.

These improvements come with minor breaking changes in the editor configuration, so visit the breaking changes section and the update guide.

Image editing

CKBox’s image editing capabilities, introduced in CKBox v1.6.0, are now accessible straight from the CKEditor image toolbar. CKBox users can resize, crop, or rotate images right within CKEditor.

You can also edit images that are not added to CKBox yet (for example, hotlinked images). CKBox will automatically download the images in the background to allow users to edit them without having to leave CKEditor to manually add the image into CKBox. This dual functionality, combined with server-side processing, ensures ease of use and maintains high image quality and file integrity. It also provides a more efficient and reliable image editing experience within CKEditor.

Refer to the update guide to learn more about these changes.

(Experimental) Paste Markdown

This release introduces the new paste Markdown feature. It will automatically format any raw Markdown source or output copied and pasted directly into the editor – without having to switch to source editing. This feature is in its experimental phase, and its behavior may change in the future. Experience this functionality firsthand by pasting Markdown content into the demo editor. We welcome your feedback and observations for ongoing improvements, so share them in the GitHub issue.

(Coming soon!) New installation methods

We are excited to announce upcoming improvements to CKEditor 5's installation process, set to release next year. Our goal is to address and resolve the accumulated pain points that you experienced over the years. For a detailed overview of our plans and the background behind them, dive into the comprehensive proposal in the RFC. Your feedback is crucial in refining and perfecting these improvements, and we eagerly await your input!

Other notable improvements

  • Improved insert image button: The insertImage component now supports file managers and automatically detects if you are using CKBox. We have also changed the default icon for upload image from computer to better indicate it is an upload action, not a generic image button.
  • Paste link over text: The editor automatically converts the selected text to a link when you paste a URL onto it.

MINOR BREAKING CHANGES ℹ️

  • ai: The configuration for AI Assistant has changed and will require an update. Additionally, a proper adapter (OpenAIAdapter, AWSAdapter, or a custom adapter) must now be explicitly added to the plugin list. See the update guide for details.
  • image: The ImageInsertUI plugin internals were cleaned up, as it worked a bit magically with hard-coded dependencies. For example, it automatically enabled the behavior of inserting an image via URL. As of now, it will not enable any external behaviors. See the update guide for details.
  • list: The CollapsibleView was moved from the @ckeditor/ckeditor5-list package to @ckeditor/ckeditor5-ui. You can import it like this: import { CollapsibleView } from '@ckeditor/ckeditor5-ui';

Features

  • ai: Introduced Amazon Bedrock support for AI Assistant. See the AI Assistant integration guide to learn more.

  • ckbox: Enabled editing of non-CKBox images in the editor. (commit)

  • ckbox: Integrated the CKBox image editing feature into the editor. (commit)

  • image: Introduced the image insert dropdown as a consistent UI to insert images through different available integrations such as image upload, inserting an image with the asset manager, and inserting an image via URL. Closes #15303, #15149. (commit)

  • link: Links can now be applied by pasting a URL on a selected text. Closes #5656. (commit)

  • markdown-gfm: Added experimental support for pasting Markdown-formatted content. Closes #2321. (commit)

  • media-embed: Added support for short Dailymotion URLs (dai.ly) in the media embed feature. (commit)

    Thanks to @Kocal!

Bug fixes

  • ai: The fake selection marker was not always removed when the AI Assistant UI was closed.
  • ai: A user prompt containing special characters was incorrectly displayed in the prompt field (special characters were incorrectly escaped).
  • ai: The AI Assistant error message should be cleared upon closing the balloon.
  • engine: Fixed a crash happening in a peculiar scenario involving the reconversion of an element containing a marker. Closes #15411. (commit)
  • html-support: DocumentSelection should not store the GHS linkA attribute if the linkHref attribute was removed by the two-step caret movement feature. Closes #15051. (commit)
  • html-support: The editor should not crash when there is a <template> element in the content. Closes #14933. (commit)
  • paste-from-office: Content from Word documents should be pasted correctly (without HTML styles tag content) on Windows systems. Closes #15333, #9002. (commit)
  • track-changes: Prevented joining two block format suggestions made on widgets placed next to each other, which was an undesirable behavior. Fixed a related editor crash involving two tables with resized columns.
  • track-changes: Fixed incorrect handling of attribute suggestions made on a paragraph-like element when the element had an insertion suggestion inside.

Other changes

  • ai: Introduced support for the OpenAI gpt-3.5-turbo-1106 model in AI Assistant.
  • ai: Secured AI Assistant from incorrect responses that do not begin with the processed HTML.
  • ai: Introduced the AITextAdapter abstract class that can be extended to provide a custom adapter for AI Assistant.
  • ai: Introduced OpenAIAdapter and AWSAdapter that can be extended to customize how AI Assistant's requests and responses are handled.
  • ai: Reorganized the configuration parameters for AI Assistant. See the API documentation and update guide.
  • ai: Allowed to fully customize request headers by providing an object or a function to the requestHeaders configuration parameter. See API documentation and update guide.
  • image: The ImageUploadUI plugin is loaded by default when the ImageBlock or ImageInline plugins are loaded. See #15149. (commit)
  • link: The logic behind the two-step caret movement was extracted to the common code in the two-step caret movement feature. (commit)
  • list: The CollapsibleView class was moved from the @ckeditor/ckeditor5-list package to @ckeditor/ckeditor5-ui. See #15149. (commit)
  • typing: The logic behind the two-step caret movement was extracted to the common code in the two-step caret movement feature. (commit)
  • typing: Unified the behavior of the insertText command for cases using the DocumentSelection and Selection as applied attributes behaved differently in those cases. (commit)
  • ui: The CollapsibleView class was moved from the @ckeditor/ckeditor5-list package to @ckeditor/ckeditor5-ui. See #15149. (commit)
  • ui: The SplitButtonView constructor and createDropdown() helper accept an instance of a ButtonView as an action view customization. See #15149. (commit)
  • upload: The FileDialogButtonView class is now an instance of the ButtonView, not just a wrapper on it. See #15149. (commit)
  • The undo and redo toolbar components described in the @ckeditor/ckeditor5-essentials/src/ckeditor5-metadata.json file are now defined in the package that registers these buttons (@ckeditor/ckeditor5-undo). Closes #15414. (commit)
  • Updated translations. (commit, commit, commit)

Released packages

Check out the Versioning policy guide for more information.

Released packages (summary)

Major releases (contain major breaking changes):

Minor releases (contain minor breaking changes):

Releases containing new features:

Other releases:

40.1.0 (November 15, 2023)

We are happy to announce the release of CKEditor 5 v40.1.0.

Release highlights

Styling suggestions reflected in the content

This release introduces an important user experience improvement for the track changes feature. From now on, styling changes made in the track changes mode will be also reflected in the editor content, instead of just being marked with a blue suggestion highlight.

Below is a summary of the important changes related to this improvement:

  • A new suggestion type 'attribute' was introduced. All integrated features will now create 'attribute' suggestions.
  • Formatting suggestions in existing documents are still supported and will work as they used to.
  • With the new suggestions, multiple changes are put into a single suggestion if possible, to avoid bloating the sidebar with too many annotations.
  • For asynchronous collaboration integrations, make sure that you save and provide the SuggestionData#attributes property, as it is used by the new suggestions.

We will continue further work on this improvement, including integrating the new solution with the list feature.

Azure OpenAI service support

We have introduced the necessary changes to make sure that the AI Assistant can be used with the Azure OpenAI service. Please refer to the AI Assistant documentation for details.

Other notable improvements

  • Fixed triple click before widgets: The beloved triple click to select content works correctly before tables, images, and other widgets.
  • Several CKBox integration improvements include a significantly enhanced image insertion mechanism from CKBox, offering a less jumpy experience. The release also addresses key issues, such as including the proper replacement of images when URLs are edited, better focus management post-image insertion, and a fixed tokenUrl configuration for more seamless integration.
  • Paste from Office enhanced: Our advanced format preserver for Office kept too many unnecessary attributes, styles, etc., in combination with the General HTML support plugin. Now we fully clean up the markup before pasting.
  • Accessibility enhancements for markers: Users aided by assistive technologies will now be notified when the selection enters or leaves a comment or a suggestion in the editor content.
  • AI Assistant: The predefined commands can now be used when no content is selected (previously it was disabled). When used like this, the whole focused block (paragraph, list item, etc.) is passed as the context for the command.
  • AI Assistant: The response streaming is now configurable and can be turned off.

MINOR BREAKING CHANGES ℹ️

  • ai: The config.aiAssistant.uiCssClass configuration was replaced by config.aiAssistant.useTheme and changed its function. A new complementary .ck-ai-assistant-ui_theme CSS class was introduced to the AI Assistant's UI elements. Please refer to the API documentation and the UI customization guide to learn more.
  • editor-multi-root: If you have a custom plugin that uses root attributes, it is highly recommended to use the newly added MultiRootEditor#registerRootAttribute() method to register a custom root attribute.
  • image: By default, images are inserted as block images (not inline). To switch to the previous behavior (determining image type by insertion context), set the editor configuration image.insert.type to 'auto'.
  • import-word: Introduced the new config.importWord.formatting configuration property which is an object accepting the following properties: resets, defaults, styles, and comments. The old properties: config.importWord.defaultStyles and config.importWord.commentsStyles were removed. Use formatting.defaults and formatting.comments instead.

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

Features

  • ai: Enabled AI Assistant integration with the Azure OpenAI service.
  • ai: Allowed executing pre-defined AI commands on a collapsed selection.
  • ai: Allowed for ordering groups and commands in the AI Assistant's dropdown configuration through the order property. See the AIAssistantConfig API documentation for details.
  • ai: Introduced config.aiAssistant.requestParameters.stream to configure whether the AI Assistant should use streaming or not.
  • ckbox: Images inserted by CKBox should set the provided dimensions and use blurhash to indicate image loading. Closes #15090. (commit)
  • editor-multi-root: Added MultiRootEditor#registerRootAttribute(). All root attributes used by features should now be registered. Root attributes passed in the editor configuration are now automatically registered. Closes #15246. (commit)
  • image: Images inserted by CKBox should set the provided dimensions and use blurhash to indicate image loading. Closes #15090. (commit)
  • import-word: Introduced a new config.importWord.formatting configuration property in place of config.importWord.defaultStyles and config.importWord.commentsStyles.
  • track-changes: Styling changes made while in track changes mode will now be immediately reflected in the editor content in addition to creating a suggestion. This applies only to newly created suggestions.
  • track-changes: Introduced new suggestion type 'attribute' which indicates that an attribute on a model node has changed and allows to show the change immediately in the content.
  • ui: Introduced the AriaLiveAnnouncer class that allows for using aria-live regions to inform screen readers about changes in the editor state. AriaLiveAnnouncer instance is available under EditorUI#ariaLiveAnnouncer. (commit)

Bug fixes

  • ai: The pre-defined command label should be displayed in the AI Assistant's prompt field.
  • ai: The AI content area should stop scrolling automatically once the user interacts with it.
  • ai: The AI Assistant balloon should be closed when the user presses the Esc key.
  • ai: The AI pre-defined commands dropdown should reset its scroll when reopened.
  • ai: The AI Assistant should not log unnecessary warnings when detached from the DOM.
  • ai: The AI Assistant's balloon anchor point should stay at the correct position when the balloon grows.
  • ai: The AI Assistant's copy to clipboard button did not work correctly in Firefox when the General HTML support plugin was loaded.
  • clipboard: Pasting a link address should not convert its parts that look like HTML entities. Closes #15036. (commit)
  • clipboard: Improved drop marker visibility to only display in allowed drop locations. Closes #14709. (commit)
  • comments: Prevented a crash happening when importing a Word file when the comments plugin is loaded.
  • core: Fixed type definitions in ToolbarConfig by adding an optional icon parameter. Closes #15151. (commit)
  • html-support: Additional attributes for the link element (for example, CSS class) should not be applied after pressing Enter. Closes #14683. (commit)
  • image: The aspect ratio should be updated on the image replacement. Closes #15179. (commit)
  • image: Remove outdated image attributes when an image is replaced by a URL. Closes #15093. (commit)
  • list: Pasting plain text content should not break the lists. Closes #13826. (commit)
  • list: Pasting one list into another should preserve the target list type. See #13826. (commit)
  • paste-from-office: Tables pasted from Word should not lose styles when General HTML Support is enabled. (commit)
  • table: Table properties should be enabled if a table is selected from the outside. Closes #15040, #15041, #10983. (commit)
  • track-changes: Editor commands will now return a proper value when executed in track changes mode.
  • ui: The AutocompleteView should not capture the Esc key press event if its result pane is hidden. (commit)
  • ui: TextareaView will no longer update its height (and log warnings) when the element is detached from the DOM. (commit)
  • ui: Fixed the usage of the aria-checked attribute in dropdowns. Closes #14823. (commit)
  • utils: The Config#get() method should be able to return a function. Closes #14804, #12835. (commit)
  • widget: Triple-click in a paragraph should select the whole paragraph even if a block widget follows (table, block image). Closes #11130. (commit)
  • Plugins specified in config.removePlugins should now be properly filtered out when revision history and track changes data plugins are used.

Other changes

  • ai: Simplified CSS customization in the AI Assistant's UI.
  • ai: Pre-defined commands dropdown search filter will now also include group names.
  • ai: The AI Assistant's Replace button should be labeled Insert if the selection is collapsed.
  • ai: Improved the layout of the AI Assistant in the editor using a right-to-left UI language.
  • ckbox: The editor should be focused after choosing an asset or closing CKBox. Closes #15091. (commit)
  • ckbox: When multiple files are selected, add each one of them in a separate paragraph. Closes #15094. (commit)
  • ckbox: Set the default CKBox theme to lark. Closes #15096. (commit)
  • comments: Users using assistive technologies will now be notified when their selection enters or leaves a comment or a suggestion in the editor content.
  • core: Made the PluginInterface.destroy() method optional. (commit)
  • format-painter: Users using assistive technologies will now be notified when the formatting is being copied or pasted.
  • image: Changed the icon of the alternative text to be more accurate and describe its purposes. Closes #12410. (commit)
  • image: Changed the default image.insert.type configuration to "block" and added the "auto" option. Closes #15158. (commit)
  • theme-lark: Created a custom property for the shared light red color. Closes #15217. (commit)
  • theme-lark: Improved RTL layout support in some of the UI components (FormHeaderView, ButtonView, and ListItemView). (commit)
  • track-changes: Migrated feature integrations to use the 'attribute' suggestions: alignment, basic styles, font, format painter, heading, highlight, HTML embed, image (except for image styles), indent block, link, remove format, styles, and table headings.
  • track-changes: Due to substantial changes in how new styling suggestions are presented in the editor content, numerous interactions and labels displayed in the suggestion annotations were changed compared to the old suggestions.
  • track-changes: Users using assistive technologies will now be notified when their selection enters or leaves a comment or suggestion in the editor content.
  • ui: The ListItemGroupView should allow using a custom label. (commit)
  • ui: Improved RTL layout support in some of the UI components (FormHeaderView, ButtonView, and ListItemView). (commit)
  • Updated translations. (commit)

Released packages

Check out the Versioning policy guide for more information.

Released packages (summary)

Minor releases (contain minor breaking changes):

Releases containing new features:

Other releases:

40.0.0 (October 4, 2023)

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

Release highlights

Release of the AI Assistant feature

We are tremendously excited to share our AI Assistant plugin with you!

With the AI Assistant, you can boost your editing effectiveness and creativity in a completely new way. This feature gives writers and editors the power to seamlessly interact with artificial intelligence. Users can generate, expand, rewrite, improve, translate, and process the content in many different ways.

The AI Assistant can be used in two ways. You can quickly re-work selected content by choosing one of the predefined AI commands. You can also write your own query to generate or process the content in any way you like!

Make sure to visit the documentation and try the demo!

Introduction of the image height and width support

No more layout shifts! We have introduced the setting of the image width and height attributes automatically during the upload or paste process to ensure the highest-quality content with no text jumping all around. While existing images will not be automatically retroactively altered, any changes to images in the editor (like resizing) will automatically set these attributes.

We have also ensured backward compatibility with CKEditor 4, particularly while maintaining user-changed aspect ratios. You can find more details on the changes in the update guide.

Drag and drop of blocks

Just drag it!™ We have introduced a more intuitive drag-and-drop functionality for blocks and widgets. This makes content rearrangement and editing faster and easier, offering users better control over their content. Dragging by the balloon block toolbar handle is also possible, and we have updated its default icon to reflect this new drag-and-drop capability better (note: it is still changeable).

Document lists feature parity

Document lists, our second-generation list plugin that supports multiple content blocks in list items, finally support to-do lists! We have also added the configuration that enforces the document list to have only a single block inside the list item (we call it "simple lists"). All this is to start deprecating the lists v1 implementation and use the document lists as default. Coming soon!

Contextual balloon fixes

We have prepared significant fixes to the way the contextual balloons work. They tended to overflow on other elements, especially in the fixed-height editors. We polished their internals, and problems should exist no more.

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

MAJOR BREAKING CHANGES ℹ️

  • image: The model attribute name of the resized image was changed to resizedWidth. The width and height attributes are now used to preserve the image's natural width and height.
  • image: The srcset model attribute was simplified. It is no longer an object { data: "...", width: "..." }, but a value previously stored in the data part.

MINOR BREAKING CHANGES ℹ️

  • comments: The comment thread's "resolved" state was separated from the "unlinked" state (a state when the related editor content was removed from the document). A thread can have any combination of these states. If a comment thread is either resolved or unlinked, it is moved to the comments archive. This new approach is reflected in the comments archive UI. Notably, an unlinked comment thread can become resolved and reopened while still being in the comments archive. Additionally, the unlinked comment threads have a gray header color to differentiate them from the resolved comment threads.
  • comments: The CommentThread#archivedAt is now the property to check when deciding whether the comment thread is inside the comments archive or not (that property was #resolvedAt before).
  • comments: CommentsArchive#resolvedThreads was renamed to #archivedThreads. If your custom code used that property, make sure to apply this change.
  • comments: The deletedAt property is no longer passed in AddCommentThreadEvent as it is not needed anymore. Instead, deleted comment threads should never be handled in addCommentThread as they should never be added to the repository. If your custom code used that property, make sure to apply this change.
  • comments: In a real-time collaboration environment, removed comment threads will no longer be added to the comments repository after re-initializing the editor. Before, the comment thread was removed from the comments repository but was added back when the editor re-connected to Cloud Services. If your custom code expected the old (incorrect) behavior, it might need a change. This change was reflected in the comments outside the editor documentation page.

Features

  • ai: Introduced the AI Assistant feature.
  • clipboard: Enabled the block drag and drop by default. Closes #14734. (commit)
  • clipboard: Extended the drag and drop selection to parent elements when all their children are selected. Closes #14640. (commit)
  • image: The image width and height attributes are now preserved while loading the editor content. Closes #14146. (commit)
  • image: Images without a specified size will automatically gain natural image width and height dimensions on any interaction with the image. See #14146. (commit)
  • list: Allow restricting list item content to a single text block by disabling the list.multiBlock configuration option. Closes #14634. (commit)
  • list: Introducing the to-do lists compatible with the document list feature. Closes #14663. (commit)
  • ui: Implemented new UI components: ListItemGroupView, TextareaView, SpinnerView, SearchView, and AutocompleteView. (commit)
  • ui: Introduced the HighlightedTextView component for a better presentation of search results. (commit)

Bug fixes

  • clipboard: Improved displaying the preview of the drag and drop content. Closes #14968. (commit)
  • comments: Comment threads that were permanently deleted will be removed from CommentsRepository and, in case of real-time collaboration, they will not be added back after re-connecting to the document.
  • engine: The editor will no longer throw an error when clicking a balloon with input in Firefox. Closes #9635. (commit)
  • image: An image should not be replaced when dropped below a widget. Closes #14710, #14740. (commit)
  • list: A dragged whole list item should still be a list item when dropped. Closes #14969. (commit)
  • mention: Fixed the type definition of the Mention#toMentionAttribute() method. Closes #14923. (commit)
  • utils: Balloon panels should not stick out of the visible part of the editor while scrolling. (commit)
  • utils: Fixed an incorrect tooltip when hovering over the toolbar buttons in Chrome on iOS. Closes #13812. (commit)
  • utils: The coordinates of an element are now correctly calculated relative to the positioned ancestor element. Closes #14992. (commit)

Other changes

  • comments: Introduced the Comment#unlinkedAt and Comment#archivedAt properties and the Comment#setUnlinkedAt() method.
  • comments: The deletedAt property is no longer passed in AddCommentThreadEvent as it is not needed anymore.
  • comments: Renamed CommentsArchive#resolvedThreads to #archivedThreads.
  • comments: Comment threads are no longer treated as resolved when their related content is removed from the document. These threads are now in the unlinked state.
  • theme-lark: Improved the drag and drop target line. Closes #14645. (commit)
  • ui: Made the ButtonView label logic open for extension. (commit)
  • ui: Changed the default icon of the BallonEditor toolbar handle and added the ability to customize it. Closes #14646. (commit)
  • Optimized icons. (commit)
  • Updated translations. (commit, commit, commit)
  • Added support to execute the yarn run clean-up-svg-icons script without arguments to optimize all icons in the entire project. Closes #14912. (commit)

Released packages

Check out the Versioning policy guide for more information.

Released packages (summary)

New packages:

Major releases (contain major breaking changes):

Minor releases (contain minor breaking changes):

Other releases:

39.0.2 (September 6, 2023)

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

Release highlights

This is a patch release that resolves over 10 important issues. Check out the list below for more information.

Bug fixes

  • ckbox: The CKBox dialog should be focused after being opened. Closes #14312. (commit)
  • document-outline: The document outline feature no longer throws an error while scrolling when the editor is not fully initialized.
  • export-word: Added the missing type keyword to the interface re-export (ExportWordConfig).
  • find-and-replace: Undo should restore every text occurrence replaced by the replace all feature in the document at once. Closes #13892. (commit)
  • indent: Block elements should not be indented in document lists. Closes #14155. (commit)
  • indent: Nested lists pasted from Word should now be displayed properly in document lists. Closes #12466. (commit)
  • paste-from-office: Tables pasted from Microsoft Excel should now have proper column widths. Closes #14521, #14516. (commit)
  • table: The editor no longer crashes when handling tables with over 2500 rows. Closes #14785. (commit)
  • table: Fixed a scrolling issue when headings are inside a table. (commit)
  • table: Tables pasted from Microsoft Excel will now have proper column widths. Closes #14521, #14516. (commit)
  • track-changes: Two existing suggestions will not be joined if they have different attributes. In real-time collaboration, suggestions are not joined until the attribute data is loaded.
  • track-changes: A new suggestion will not be joined with an existing suggestion if any of its attribute values is different than the existing suggestion's attribute.
  • track-changes: The editor no longer crashes when a suggestion is clicked after it was brought back using undo.
  • CKEditor 5 does not rely on the global object only available in Node.js. Fixes ckeditor/vite-plugin-ckeditor5#17 and #14801. (commit)

Other changes

Released packages

Check out the Versioning policy guide for more information.

Released packages (summary)

Other releases:

To see all releases, visit the release page.