Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

ckeditor5

ckeditor3.6mSEE LICENSE IN LICENSE.md45.0.0TypeScript support: included

A set of ready-to-use rich text editors created with a powerful framework. Made with real-time collaborative editing in mind.

ckeditor, ckeditor5, ckeditor 5, wysiwyg, rich text, editor, html, contentEditable, editing, operational transformation, ot, collaboration, collaborative, real-time, framework

readme

CKEditor 5 Tweet

npm version Coverage Status CircleCI TypeScript Support

Join newsletter Follow Twitter

CKEditor 5 is a modern JavaScript rich-text editor with MVC architecture, custom data model, and virtual DOM, written from scratch in TypeScript with excellent support for modern bundlers. It provides every type of WYSIWYG editing solution imaginable with extensive collaboration support. From editors similar to Google Docs and Medium to Slack or Twitter-like applications, all is possible within a single editing framework. As a market leader, it is constantly expanded and updated.

A composition of screenshots presenting various features of CKEditor 5 rich text editor

Table of contents

Quick start

Refer to the Quick Start guide to learn more about CKEditor 5 installation.

CKEditor 5 Builder

The easiest way to start using CKEditor 5 with all the features you need is to prepare a customized setup with the CKEditor 5 Builder. All you need to do is choose the preferred editor type as a base, add all the required plugins, and download the ready-to-use package.

TypeScript support

CKEditor 5 is a TypeScript project. Starting from v37.0.0, it offers native type definitions. Check out our dedicated guide to read more about TypeScript support.

CKEditor 5 advanced installation

For more advanced users or those who need to integrate CKEditor 5 with their applications, we prepared integrations with popular JavaScript frameworks:

CKEditor 5 Framework

CKEditor 5 is also a framework for creating custom-made rich text editing solutions.

To find out how to start building your editor from scratch go to the CKEditor 5 Framework overview section of the CKEditor 5 documentation.

Documentation and FAQ

Extensive documentation dedicated to all things CKEditor 5-related is available. You will find basic guides that will help you kick off your project, advanced deep-dive tutorials to tailor the editor to your specific needs, and help sections with solutions and answers to any of your possible questions. To find out more refer to the following CKEditor 5 documentation sections:

For FAQ please go to the CKEditor Ecosystem help center. For a high-level overview of the project see the CKEditor Ecosystem website.

Releases

Follow the CKEditor 5 changelog for release details and check out the CKEditor 5 release blog posts on the CKSource blog for important release highlights and additional information.

Editing and collaboration features

The CKEditor 5 Framework offers access to a plethora of various plugins, supporting all kinds of editing features.

From collaborative editing support providing comments and tracking changes, through editing tools that let users control the content looks and structure such as tables, lists, and font styles, to accessibility helpers and multi-language support - CKEditor 5 is easily extensible and customizable. Special duty features like Markdown input and output and source editing, or export to PDF and Word provide solutions for users with diverse and specialized needs. Images and videos are easily supported and CKEditor 5 offers various upload and storage systems to manage these.

The number of options and the ease of customization and adding new ones make the editing experience even better for any environment and professional background.

Refer to the CKEditor 5 Features documentation for details.

Create a free account and test full potential

If you want to check full CKEditor 5 capabilities, including premium features, sign up for a free non-commitment 14-day trial.

Contributing and project organization

Ideas and discussions

The development repository of CKEditor 5 is located at https://github.com/ckeditor/ckeditor5. This is the best place for bringing opinions and contributions. Letting the core team know if they are going in the right or wrong direction is great feedback and will be much appreciated!

Development

CKEditor 5 is a modular, multi-package, monorepo project. It consists of several packages that create the editing framework, based on which the feature packages are implemented.

The ckeditor5 repository is the place that centralizes the development of CKEditor 5. It bundles different packages into a single place, adding the necessary helper tools for the development workflow, like the builder and the test runner. Basic information on how to set up the development environment can be found in the documentation.

See the official contributors' guide to learn how to contribute your code to the project.

Reporting issues and feature requests

Report issues in the ckeditor5 repository. Read more in the Getting support section of the CKEditor 5 documentation.

License

Licensed under a dual-license model, this software is available under:

For more information, see: https://ckeditor.com/legal/ckeditor-licensing-options.

changelog

Changelog

45.0.0 (April 7, 2025)

The CKEditor 5 v45.0.0 release brings powerful new features and improvements, making content creation smoother and more versatile. From enhanced email editing to a refined linking experience and a brand-new full-screen mode, this update is packed with valuable upgrades.

Release highlights

Email editing enhancements

We are making it easier to create and edit emails directly in CKEditor 5 with several enhancements. This release introduces the following new features:

  • Export with Inline Styles (⭐) provides the ability to export email content with automatically inlined styles, ensuring compatibility and proper rendering across different email clients.
  • Email Configuration Helper (⭐) is a new configuration helper plugin that provides guidance for integrators to correctly set up an email-friendly editor while avoiding common pitfalls.
  • Layout tables: are a new type of tables that has been introduced to simplify the creation of structured email designs, offering better control over layout, alignment and spacing.

Apart from these new features, this update also brings various fixes and improvements related to table behavior, enhanced HTML support, and better handling of complex email structures. These refinements help ensure a more seamless email editing experience, reducing inconsistencies and improving compatibility with external email clients.

The fullscreen feature

A long-requested feature has finally arrived with the introduction of full-screen editing for the classic and decoupled editor types. This new mode provides a focused writing experience by making the editor the centerpiece of the screen. The expanded screen space allows for better visibility of content in sidebars such as comments, suggestions, and document outlines, enhancing your overall workflow.

Improved linking experience

Linking in CKEditor 5 has been significantly upgraded with a redesigned user interface, making adding and editing links more intuitive. Users can now easily link to bookmarks within the document and select links from predefined lists (defined by the developer). These improvements make inserting and managing links faster and more flexible than ever before.

During this initiative, we also aligned visual and technical components of the editor. Each balloon got a header with the tile, we also unified the toolbar behavior and keystrokes of Link and Bookmarks with other widget’s toolbars like image and tables.

[!NOTE] The UI got updated in several places: main view, link properties (decorators), and also its technical implementation changed. Make sure to give special attention to the update if you did any customizations to the link interface.

New installation methods improvements: icons replacement

We are continuing to strengthen the new installation methods while phasing out older solutions. We added one of the key components you asked for: replacing our icons with your custom ones. It is now possible to replace the icons via the package’s override mechanism.

[!NOTE] To achieve a proper solution for icons replacement for the npm builds, we needed to introduce a breaking change. If you used our icons for any purposes, make sure to update their paths.

⚠️ Deprecations in old installation methods: stage 1 completed

We are progressing with deprecation according to our sunset plan. From this release, predefined builds’ packages, such as @ckeditor/ckeditor-build-classic, are now officially deprecated. We also dropped support for Webpack 4 in both the old and new installation methods.

By the end of 2025, custom builds that rely on webpack and DLL builds will also be deprecated. Refer to our documentation and migration guides to ensure a smooth transition.

We are committed to making CKEditor 5 even better. Stay tuned for more improvements in upcoming releases! If you have any feedback, let us know — we are always listening.

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

Happy editing!

MAJOR BREAKING CHANGES ℹ️

  • bookmark: The BookmarkUI#actionsView is no longer available. The bookmark feature is now using the WidgetToolbarRepository instead.
  • build-*: CKEditor 5 predefined builds are no longer available.
  • link: The LinkUI#actionsView is no longer available. The bookmark feature now uses the LinkUI#toolbarView (an instance of the ToolbarView class) instead of the custom LinkActionsView.

MINOR BREAKING CHANGES ℹ️

  • link: The createBookmarkCallbacks() helper is now replaced by the isScrollableToTarget() and scrollToTarget() helpers.
  • table: The FormRowView class was moved to the @ckeditor/ckeditor5-ui package.
  • table: The form.css component was moved to the @ckeditor/ckeditor5-theme-lark package.
  • All CKEditor 5 icons are now available in the @ckeditor/ckeditor5-icons package.

Features

  • email: Introduced a new package to validate the editor configuration for email compatibility. It helps prevent misconfigurations by enforcing best practices and future-proof rules. Added utilities for post-processing CSS, improving support across various email clients by adjusting styles for better rendering consistency.
  • export-inline-styles: Added a new package for exporting content with inline styles. Ensures CSS classes ([class]) and IDs ([id]) are inlined within elements, improving compatibility with email clients that strip external styles. It helps maintain consistent formatting across different email clients, reducing rendering issues.
  • fullscreen: Introduced the fullscreen mode feature. Closes #18026. (commit)
  • html-support: Introduced the ability to render the<style> elements from the <head> section of editor data content using the FullPage plugin. See #13482. (commit)
  • revision-history: Added a new property RevisionHistory#isRevisionViewerOpen that indicates whether the revision history is opened or not.
  • source-editing-enhanced: The one-dark theme is now built-in and available via config.sourceEditingEnhanced.theme by passing the 'dark' value. This change enables the use of the dark theme with the CDN installation method, which does not support external CodeMirror dependencies. Additionally, if you previously used the oneDark extension directly, you can now switch to theme: 'dark' for built-in support.
  • table: Introduced the layout tables feature to enable constructing grids with tables, for example for email editing. These tables are designed for layout purposes, and include the role="presentation" parameter for accessibility. Users can insert layout tables via the editor toolbar and switch between content and layout tables. The editing view now closely matches the rendered output. Closes #18132. (commit)
  • table: Added the ability to toggle between content tables and layout tables. Users can switch table types using a split button in the table properties UI. While captions and <th> elements may be lost, table structure remains intact. Closes #18131. (commit)
  • table: Dragging and dropping a table into another table no longer merges them. Instead, the dropped table is placed as a whole inside the target cell. Pasting tables remains unchanged. Closes #18126. (commit)
  • template: Inserting a template containing a table into another table no longer merges them. Instead, the template is placed as a whole inside the target cell. See #18126.
  • theme-lark: Introduced the form.css component . (commit)
  • ui: Added the MenuBarView#disable() and MenuBarView#enable() methods. They disable/enable all top-level menus in menu bar. Closes #17940. (commit)
  • ui: Added the ToolbarView#switchBehavior() method to switch toolbar behavior after the editor has been initialized. Closes #18159. (commit)
  • ui: Introduced the FormRowView class. (commit)
  • Moved all icons to the @ckeditor/ckeditor5-icons package. Related to #16546. (commit)
  • Added the @ckeditor/ckeditor5-icons package to the core DLL package. (commit)

Bug fixes

  • ckbox: Resolved an issue where images from private categories were not appearing in the selector. Closes #18044. (commit)
  • emoji: Fixed the emoji panel not being visible while used in comments archive. Closes #17964. (commit)
  • engine: The selection should not move to another table row while switching heading rows. Closes #17962. (commit)
  • heading: Added the missing converterPriority type definition to HeadingOption interface. Closes #18182. (commit)
  • html-support: The floated tables are now loaded and showed as expected in the editor's view. Closes #18203. (commit)
  • link: The Autolink feature will now correctly autolink http://localhost and http://localhost:port. Closes #18185. (commit)
  • mention: Fixed the mention panel not being visible while used in comments archive. Closes #17964. (commit)
  • revision-history: Revisions will now correctly retain data for HTML embed widget, as well as <script> and <style> tags enabled by the General HTML Support feature. Before, when revision was saved, these elements were saved empty, and this lead to data loss when such revision was restored. Note, that this will not fix revisions that are already affected by this error.
  • revision-history: Fixed a crash when viewing a revision which had an HTML comment node in its data (reproducible with General HTML Support plugin).
  • revision-history: Fixed handling UIElements and RawElements by revision history (may concern third-party custom plugins).
  • revision-history: Fixed a crash when viewing a revision which had a collapsed marker in its data (may concern third-party custom plugins).
  • table: Removed [role="textbox"] from the <td>/` editables. Windows Narrator no longer reads table dimensions as 0 by 0. Closes #16923. (commit)
  • track-changes: The editor no longer crashes during initialization when the ShiftEnter plugin is removed.
  • ui: Do not open disabled menu bar menu items on arrow down press. Closes #17915. (commit)
  • ui: The ButtonView#icon property can now be set/reset after the button's first render. (commit)
  • table: Widgets UI elements should be visible when they are inside tables. Closes #18268.
  • table: Nested tables outline should not be cut of at the bottom during hovering. Closes #18262.
  • link: Link balloon no longer disappears when scrolling the page slightly on iOS. Closes #18022.

Other changes

  • bookmark: The Bookmark feature now uses the WidgetToolbarRepository instead of a custom ActionsView to display the bookmark toolbar in the contextual balloon. The new toolbar uses components registered in the ComponentFactory. (commit)
  • bookmark: Form styles and structure are now unified with use of ck-form and ck-form__row. (commit)
  • collaboration-core: Translations are now supported in the date formatter used by comments and suggestions, allowing for localizing dates.
  • engine: Added the read-only DomConverter#domDocument property. Closes #18146. (commit)
  • image: Image and custom resize form styles and structure now unified with use of ck-form and ck-form__row. (commit)
  • link: The link feature now uses the ToolbarView instead of a custom LinkActionsView to display the link toolbar in the contextual balloon. The new toolbar uses components registered in the ComponentFactory. (commit)
  • link: Form styles and structure are now unified with use of ck-form and ck-form__row. (commit)
  • real-time-collaboration: Added a more modern look to the presence list collapsed view (used when many users are connected to the document).
  • revision-history: The document outline will now be hidden when the revision history is opened.
  • source-editing: Document outline and annotations will now be hidden when editor is in source editing mode. Closes #17978. (commit)
  • table: Extracted the form.css to @ckeditor/ckeditor5-theme-lark package. (commit)
  • table: Extracted the FormRowView to @ckeditor/ckeditor5-ui package. (commit)
  • ui: The IconView now throws a meaningful error if the provided icon content is not a valid SVG. (commit)
  • widget: The WidgetToolbarRepository#register() now accepts a customized list of desired balloon positions. (commit)
  • Added the Belarusian language translations for CKEditor 5. Huge thanks to @karavanjo. (commit)
  • Upgraded the minimal version of Node.js to 20.0.0 due to the end of LTS. (commit)
  • Updated TypeScript target to es2022. Closes #17886. (commit)
  • Replaced lodash-es with es-toolkit. See #16395. (commit)
  • The @ckeditor/ckeditor5-build-* packages are no longer maintained. (commit)

Released packages

Check out the Versioning policy guide for more information.

<summary>Released packages (summary)</summary>

New packages:

Major releases (contain major breaking changes):

Releases containing new features:

Other releases:

44.3.0 (March 5, 2025)

We are happy to announce the release of CKEditor 5 v44.3.0.

Release Highlights

This release brings a couple of minor improvements and bug fixes:

  • Link Decorators: We fixed the behavior of the multiple manual link decorators that set the rel attribute. The fix happened so deep in the engine that we improved the overall performance of the editor slightly as well.
  • Added a new EmptyBlock plugin: From now on, new plugin prevents adding &nbsp; to the output data of blocks, works similarly to the fillEmptyBlocks configuration in CKEditor 4.
  • Support for the <hr> element in the General HTML Support plugin enhanced: attributes of the <hr> element are now properly preserved if configuration allows it.
  • Emoji: We enhanced emoji support for better compatibility with users' older devices.

For more details, see the changelog below.

MINOR BREAKING CHANGES ℹ️

  • engine: The ViewConsumable.consumablesFromElement() is removed and replaced with the view.Element#_getConsumables() internal method. You should use ViewConsumable.createFrom() to create consumables if needed.
  • engine: The ViewElementConsumables now accepts and outputs only normalized data. The ViewConsumable still accepts normalized or non-normalized input.
  • engine: The Matcher#match() and Matcher#matchAll() output is now normalized. The MatchResult#match now contains normalized data compatible with changes in the ViewConsumable.

Features

Bug fixes

  • collaboration-core: User initials will now be generated based on the words that start with letters, ensuring that only valid alphabetic characters are used in the initials.
  • comments: Annotations will no longer be lost during real-time collaboration when a user removes and immediately reverts (undo) content containing comment markers.
  • comments: The editor will no longer crash when one user removes content containing a comment that another user is editing.
  • engine: The link [rel] attribute will now allow mixing manual link decorators for the same attribute, as it will be now handled as a token list. Closes #13985, Closes #6436. (commit)
  • mention: Mention should not be wrapped with an additional <span> when GHS is enabled. Closes #15329. (commit)
  • ui: Fixed an issue where the first selected color was applied instead of the second selected color when using the font color picker for the first time after loading the page. Closes #17069. (commit)
  • typing: Removing a nested editable does not remove an entire widget when the selection is placed at the beginning of that element. (commit)

Other changes

  • clipboard: Export the viewToPlainText() function. Closes #17950. (commit)
  • collaboration-core: Introduced a new configuration option: config.users.getInitialsCallback. It allows providing a custom callback function for user initials generation.
  • emoji: Improved emoji support by expanding the range of versions compatible with users' devices. Closes #18014. (commit)
  • emoji: Icons representing categories in the grid come from the same Unicode version to avoid rendering the non-supported ones. (commit)
  • emoji: Introduced the emoji.useCustomFont option to disable the filtering mechanism. Closes #18029. (commit)
  • engine: The whitespaces around a block filler (&nbsp;) are ignored while loading editor data. (commit)

Released packages

Check out the Versioning policy guide for more information.

<summary>Released packages (summary)</summary>

Minor releases (contain minor breaking changes):

Releases containing new features:

Other releases:

44.2.1 (February 20, 2025)

We are happy to announce the release of CKEditor 5 v44.2.1.

During a recent internal audit, we identified a cross-site scripting (XSS) vulnerability in the CKEditor 5 real-time collaboration package (CVE-2025-25299). This vulnerability can lead to unauthorized JavaScript code execution and affects user markers, which represent users' positions within the document.

This vulnerability affects only installations with real-time collaborative editing enabled.

You can read more details in the relevant security advisory and contact us if you have more questions.

Bug fixes

  • comments: Fixed a few scenarios for which creating a new comment thread was impossible (for example, when a selection was made on multiple table cells). This was a regression introduced in v44.2.0.

Other changes

Released packages

Check out the Versioning policy guide for more information.

<summary>Released packages (summary)</summary>

Other releases:

44.2.0 (February 12, 2025)

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

Release Highlights

🖥️ Enhanced Source Code Editing (⭐)

Introducing new premium feature: Enhanced Source Code Editing. It displays the source code in a dialog and is compatible with all editor types. It offers syntax highlighting, code completion, code folding, and other advanced functionalities. Additionally, it supports both HTML and Markdown formats.

📤 Uploadcare and image optimizer (⭐)

We have integrated the Uploadcare image manager service, enabling you to upload and edit images to their cloud environment. You can upload files from various sources, including local devices, social media, or online drives ensuring rapid uploads. The integration takes care of efficient media delivery with responsive images mechanism, making sure your users will save bandwidth and have faster website loading. You can also optimize images with the built-in image editor which offers a range of features, such as cropping, rotating, flipping, photo filters and more. All this directly from the editor, try it out!

🖼️ Image Merge Fields (⭐)

Image merge fields are a new type of merge fields, dedicated for image placeholders. They maintain all standard image interactions, like styling, resizing or captions (in which you can use merge fields too!) At the same time, they keep all merge fields functionalities, like data previews or document export integration. In the document data, image merge fields are represented like other images, however their src attribute is set to a respective merge field, for example, src="{{CompanyLogo}}", making them easy to post-process!

📝 Track Changes Preview (⭐)

We have added the preview mode that displays a document with all suggestions accepted. Accessible from the track changes dropdown, this modal preview helps check the final content without extensive markers.

😀 Emoji support

They are here! 🎉 🥳 🎊 Insert emojis effortlessly in the editor by typing : or through a user-friendly emoji picker. This feature enhances the richness of your content by allowing quick access to a wide range of emojis.

⚡ Performance improvements: Part 4

Here comes the final batch of the planned performance improvements in the editor loading speed area, that we worked on through a couple of past releases.

  • A new caching mechanism in Mapper now handles model-to-view mappings, substantially improving performance for loading and saving data.
  • Images with specified height and width automatically use [loading="lazy"] in the editing area, optimizing the loading time (read more on MDN). This attribute is only applied during editing to enhance the loading efficiency of images, and it does not reflect in the final data output.

We are greatly satisfied with the improved editor loading times. At the same time, we acknowledge some other problematic areas, and we will keep delivering more performance-related improvements in the future.

MINOR BREAKING CHANGES ℹ️

  • engine: Mapper#registerViewToModelLength() is now deprecated and will be removed in one of the upcoming releases. This method is useful only in obscure and complex converters, where model element, or a group of model elements, are represented very differently in the view. We believe that every feature using a custom view-to-model length callback can be rewritten in a way that this mechanism is no longer necessary. Note: if this method is used, the caching mechanism for Mapper will be turned off which may degrade performance when handling big documents. Note: this method is used by the deprecated legacy lists feature. As a result, you will not experience the performance improvements if you are still using the deprecated legacy lists feature.
  • image: Starting this release, images that have [height] and [width] attributes set will automatically receive the [loading="lazy"] attribute in the editing area. This happens only for the content loaded into the editor, the data output produced by the editor remains the same. The reason for this change is to improve user experience in documents that may contain hundreds of images.
  • list: The lower-alpha and upper-alpha list styles are now upcasted to lower-latin and upper-latin styles.
  • merge-fields: The MergeFieldsEditing#getLabel() method will now return null instead of the merge field id if the merge field definition was not found or it did not contain the label property.
  • basic-styles: Elements which contains the [style] attribute with word-wrap: break-word will not be converted to <code>. See #17789.

Features

  • ai: Comment threads will now be preserved when AI Assistant processes selected content with comments. This can be disabled through the ai.aiAssistant.preserveComments flag. Note, that the actual result depends on the response provided by the AI model (AI model has to keep the comments markup in the response). Additionally, the copy-paste comments functionality must be enabled (configured by comments.copyMarkers).
  • ai: The ai.aiAssistant.removeCommands configuration now allows removing entire command groups.
  • ckbox: It is now allowed to specify which files chosen from CKBox are downloadable. Closes #15928. (commit)
  • clipboard: Added the ability to detect paste events originating from the editor. Closes #15935. (commit)
  • clipboard: Passed information to the downcast converter when clipboard pipeline is used to allow for customization. Closes #17745. (commit)
  • clipboard: The viewToPlainText() helper will now parse the view RawElement instances. Closes #17746. (commit)
  • emoji: Created the Emoji feature. Closes #17361. (commit)
  • image: Added a possibility to break the current block by InsertImageCommand with the breakBlock flag. Closes #17742. (commit)
  • list: Allowed to specify which list style types are shown in list type selector dropdown. Closes #17176. (commit)
  • list: Added support for the lower-alpha and upper-alpha list type highlighting in the list style properties buttons. Closes #17424. (commit)
  • mention: Allowed the mention marker to be longer than 1 character. Closes #17744. (commit)
  • merge-fields: Introduced the image merge fields.
  • merge-fields: Added the [data-merge-field-name] attribute in the editing pipeline.
  • merge-fields: Use the actual merge field value when they are copied from the editor in preview mode other than $labels.
  • source-editing-enhanced: Introduced the Enhanced Source Code Editing feature.
  • table: Improve aria attributes in the table and cell align toolbars. Closes #17722. (commit)
  • track-changes: Introduced the final document preview for track changes. It allows to display the document with all suggestions accepted in the modal.
  • ui: The .ck-with-instant-tooltip class may now be used to display the tooltip without the delay. Closes #17743. (commit)
  • upload: Added support for passing a callback to the SimpleUploadConfig#headers property. Closes #15693. (commit)
  • uploadcare: Introduced the Uploadcare integration.
  • utils: Added a collectStylesheets() helper function to retrieve style sheets from the provided URLs. (commit)

Bug fixes

  • ai: The content generated by the AI Assistant will now be correctly inserted into tables when both "Replace" and "Insert below" actions are used.
  • basic-styles: The Code feature should not convert element with the word-wrap: break-word style into the <code> tag. Closes #17789. (commit)
  • cloud-services: No longer keep refreshing token if the cloudServices.tokenUrl method failed in the initialization of the plugin. Closes #17531. (commit)
  • comments: Unlinked comment threads created before the editor initialization are now correctly handled and displayed in the comments archive. This error was experienced in asynchronous integrations which are using the Context mechanism.
  • comments: Do not allow editing content source via the source mode in the comments-only mode.
  • comments: Introduced the name field tooltip in comments UI.
  • editor-classic: Export ClassicEditorUIView from package. (commit)
  • editor-inline: No longer crash while destroying the editor when the editable was manually detached before destroying. Closes #16561. (commit)
  • editor-multi-root: No longer crash while destroying the editor when the editable was manually detached before destroying. Closes #16561. (commit)
  • image: The insert image via URL dialog can now be submitted by pressing the <kbd>Enter</kbd> key. Closes #16902. (commit)
  • link: Trailing punctuation is no longer included in an autolinked URL. Closes #14497. (commit)
  • list: The list style buttons should show proper list type after clicking list for the first time. (commit)
  • list-multi-level: Multi-level lists should work when typing in Japanese.
  • merge-fields: Do not automatically convert the merge-fields-like text containing disallowed characters.
  • merge-fields: Properly handle block merge fields mixed with text during data upcast and pasting.
  • revision-history: The Revision history feature sidebar header height now matches the height of the editor toolbar.
  • revision-history: The Revision history feature loading overlay now overlaps images correctly.
  • table: Prevent a table corruption when setting editor data with <th> cells following colspan rows. Closes #17556, #17404. (commit)
  • track-changes: Introduced the name field tooltip in suggestions UI.
  • typing: Fixed not working two-step caret movement on iOS devices. Closes #17171. (commit)
  • ui: Tooltip will no longer show after quickly hovering and moving the mouse away before the tooltip shows. Closes #16949. (commit)
  • ui: Destroying another editor instance while a modal is open will no longer unlock page scroll. Closes #17585. (commit)
  • utils: Extended getEnvKeystrokeText() with option to use it in the context of specified environment which allows to generate keystrokes text for different OS than the host one. (commit)
  • Treat types as production dependencies. Fixes #17213. (commit)
  • Unify TypeScript declaration files. Fixes #17575 and #17533. (commit)

Other changes

  • ai: Exported the AIAssistantUI class and the AIAssistantConfig, CommandDefinition and GroupDefinition types.
  • clipboard: Exported the ViewDocumentPasteEvent type from the @ckeditor/ckeditor5-clipboard package. (commit)
  • comments: Exported the AddCommentThreadEventData type.
  • comments: Activating an annotation now scrolls to the target if it is out of view.
  • comments: Fixed the wrong filter() callback signature in AnnotationsUIs#activate().
  • engine: Introduced dynamic caching in Mapper to improve view-to-model mapping performance, and as a result improve editor data load and data save performance. Closes #17623. (commit)
  • engine: A new parameter data was added for the change:children event fired by ViewElement and ViewDocumentFragment when their children change. The data parameter is an object with the index property, which says at which index the change happened. Related to #17623. (commit)
  • engine: Mapper#registerViewToModelLength() is now deprecated and will be removed in one of upcoming releases. Note: if this method is used, the caching mechanism for Mapper will be turned off which may degrade performance when handling big documents. Note: this method is used by the deprecated legacy lists feature. See #17623. (commit)
  • engine: Export SchemaCompiledItemDefinition type. Closes #17783. (commit)
  • engine: Improve performance of the placeholders. (commit)
  • engine: Do not store non-document operation with batches. This improves memory efficiency for huge documents. Closes #17678. (commit)
  • engine: Improve performance of Selection#getSelectedBlocks when selection contains block elements with many blocks inside (such as table). Closes #17629. (commit)
  • font: Export ColorSelectorDropdownView type. Closes #17783. (commit)
  • image: The [loading="lazy"] attribute will be automatically added in editing view to images with the height and width attributes set to improve loading performance. (commit)
  • list: Skip already visited list elements during reconversion and post fixing for better performance. Fixes #17625. (commit)
  • merge-fields: The MergeFieldsEditing#refreshMergeFields() method is now public and available for external use.
  • merge-fields: Remove the default values preview mode if there is none or the merge fields has a default value configured.
  • merge-fields: Display ellipsis if the merge field name does not fit the dropdown.
  • pagination: Do not wait for images with [width] and [height] attributes.
  • pagination: Do not wait for loading images that have [width] and [height] attributes set when calculating pages.
  • real-time-collaboration: Export the Sessions class.
  • real-time-collaboration: Changed how errors related to real-time collaboration are handled. Previously, the original error was always logged on the console, and a realtimecollaborationclient- error was thrown without information related to the original error. Now, the original error is not logged anymore. Instead, the realtimecollaborationclient- error includes the data.originalError property with the original error message. This way it is possible to save error details through a custom error logging mechanism. Note, that without any custom mechanism, the realtimecollaborationclient- error will still be unhandled and logged to the console.
  • real-time-collaboration: The editor now switches to read-only mode if the real-time collaboration client crashes, ensuring that the user cannot further edit the document and no data is accidentally lost.
  • ui: Added Enhanced Source Code Editing as a default menu bar item, making it visible in the menu bar when the plugin is present in the editor. (commit)
  • ui: Extended the dialog API to support custom keystroke handler options, allowing to override priorities of the keystroke callback and filter keystrokes based on arbitrary criteria. (commit)
  • ui: The ImageInsertUI#registerIntegration method now supports handling an array of views for a specific integration type. This allows, for example, registering an assetManager integration with multiple sources like Facebook and Instagram, where each source has its own dedicated button. (commit)
  • ui: Exported the DocumentColorCollection class. Closes #17783. (commit)
  • utils: Extended key codes with the End and Home keys, enabling the use and display of shortcuts containing these keys in the UI. (commit)
  • utils: Exported the add() function. Closes #17783. (commit)

Released packages

Check out the Versioning policy guide for more information.

<summary>Released packages (summary)</summary>

New packages:

Minor releases (contain minor breaking changes):

Releases containing new features:

Other releases:

44.1.0 (December 16, 2024)

We are pleased to announce the latest CKEditor 5 release, focusing on performance enhancements and key bug fixes to improve your editing and collaboration experience.

Release Highlights

Performance enhancements: Part 3

This release introduces another set of performance related improvements, focused on faster editor initialization for huge documents. The initialization time was lowered by further 15% to 45%, depending on the tested sample.

The combined improvements introduced in recent releases amount to around 65%-80% lower loading time in total, which means the editor will load 3-5x faster. As the gain is not linear, bigger documents see even better improvement (more than 10x faster).

Moreover, all these improvements positively impact document save time (editor.getData()), which should help with autosave issues, among others.

We still actively work in this area, so you may expect even more editor load and save efficiency improvements in the upcoming releases.

🔨 Bug Fixes and improvements

  • Comments enhancements:
    • Data export options: We introduced the showCommentHighlights option in editor.getData(), that changes the comment marker conversion, allowing for styling comments in the output. Perfect for showing what was commented in Export to PDF, for example.
    • Inline mode improvements: We addressed a problem where comment annotations in inline mode did not close properly when clicking elsewhere in the content.
    • Thread management: We resolved an issue where creating a new thread was not interrupted when the corresponding marker was removed from the content, ensuring better stability during collaborative editing.
  • Revision History update:
    • Restore functionality: We disabled the ability to restore the current (edited, not saved) revision, as it represents current content, so there is nothing to restore. At the same time, using it led to some non-obvious behaviors.
  • Image handling: We resolved an issue where images in the uploading state could be deleted when dragged and dropped within the editor. Keep dragging, even when it is not there 🙈.

🎄 Happy holidays!

As the holiday season approaches, we extend our warmest wishes to our community and users. Thank you for your continued support, and we look forward to bringing you further enhancements and exciting features in the coming year.

MINOR BREAKING CHANGES ℹ️

  • utils: spliceArray now modifies the target array and does not accept a fourth (count) argument.

Features

  • comments: Introduced the showCommentHighlights option in editor.getData() method that changes the comment marker conversion and allows styling the comments in the output.

Bug fixes

  • comments: Resolved an issue where creating a new thread was not interrupted when the corresponding marker was removed from the content, for example, by another user in real-time collaboration.
  • comments: When adding a comment in inline mode, the comment annotation will now close properly if you click elsewhere in the content.
  • find-and-replace: It should be possible to search within content of inline widgets. Closes #11162. (commit)
  • image: Copying and pasting images in the uploading state is now possible. Closes #16967. (commit)
  • ui: Surrounding spaces are no longer added to colors produced by hex inputs. Closes #17386. (commit)

Other changes

Released packages

Check out the Versioning policy guide for more information.

<summary>Released packages (summary)</summary>

Minor releases (contain minor breaking changes):

Other releases:


To see all releases, visit the release page.