Skip to content

Releases: ckeditor/ckeditor5

v38.0.0-rc.0

16 May 07:36
@pomek pomek
v38.0.0-rc.0
a49fefe
Compare
Choose a tag to compare
v38.0.0-rc.0 Pre-release
Pre-release

Release highlights

"Powered by CKEditor" logo

From version v38.0.0 onwards, all open-source installations of CKEditor (using it under the GPL terms) will carry a small “Powered by CKEditor” logo in the bottom right corner of the editing area. This new logo links directly to the CKEditor website to strengthen the awareness of who’s powering and modernizing their rich text editor.

This change does not affect customers with commercial licenses. You can reach out to our Technical Support team, using this form, if you have any questions.

You can read more about this change in the announcement on GitHub, the update guide and the Managing the "Powered by CKEditor" logo guide.

Color picker

Until v38.0.0 users were only able to choose from predefined colors in features like font color, font background color, table border color, etc. Starting from v38.0.0 they are now also able to use a color picker to choose any possible color.

The color picker is now available in font color and font background color features. In the coming versions (next month) it will also be added to the table-related color features.

If you're interested in keeping the old behavior where the user was able to choose only from predefined colors, check out the update guide.

MAJOR BREAKING CHANGES ℹ️

  • Introduced the "Powered by CKEditor" logo.

MINOR BREAKING CHANGES ℹ️

  • font: Color picker is now added by default to the font color and fonto background color dropdowns allowing to apply any color to it. In places where users should only use a limited number of colors, it is possible to disable color picker using a configuration option.
  • track-changes: Introduced new values for the trackFormatChanges configuration parameter. Previously possible values were true or false. New possible values are 'always', 'default' (the old true) and 'never' (the old false). Please update your configuration accordingly.
  • Changed the look of the buttons in the comments and suggestions annotations. Previously, the buttons to add a comment, a reply or to save the edited comment were represented by icons. Now they are proper buttons with text labels.

Features

  • clipboard: Introduced an experimental support for block drag & drop. Closes #14033. (commit)
  • comments: Added support for resolved comment threads imported from Word.
  • editor-multi-root: Introduced the MultiRootEditor#disableRoot() and MultiRootEditor#enableRoot() methods that allow to switch only a particular root to a read-only state. (commit)
  • engine: Introduced the Model#canEditAt( selectable ) method that checks whether a given selectable is at an editable place in the model. It should be used instead of Editor#isReadOnly in multi-root integrations as it acknowledges the roots read-only state. (commit)
  • font: Introduced the color picker feature for font and font background colors. Closes #10988. (commit)
  • style: The styles dropdown now applies link styles only to the whole link. Closes #11709. (commit)
  • style: Added custom styling support for the <td>, <th>, <caption> and <figcaption> elements. Closes #13777. (commit)
  • style: Added support for the document lists feature. Closes #11590, #12668. (commit)
  • style: The <figure> element can now be styled. See #11590. (commit)
  • track-changes: Added a more granular changes tracking.
  • track-changes: Introduced a new config parameter: mergeNestedSuggestions: boolean (default true). Introduced new values for the trackFormatChanges config parameter. Please see the API reference.
  • ui: Introduced the color picker view. See #10988. (commit)

Bug fixes

  • comments: The mentions dropdown no longer appears behind the comments archive dropdown panel and is now accessible.
  • comments: Fixed an error thrown when a resolved comment thread was received in a particular scenario.
  • comments: The comments archive panel is now correctly visible when the comments archive is opened from various toolbars.
  • comments: The comment thread attributes are now correctly returned in CommentsRepository#getCommentThreads().
  • comments: Fixed the comment thread input area which was incorrectly displayed or hidden in particular cases.
  • comments: Fixed the editor crash when a comment was added to a comment thread imported from a Word file.
  • core: Added the licenseKey property to the EditorConfig interface. Closes #13906. (commit)
  • document-outline: The document outline and table of contents features should now support the multi-root editor.
  • document-outline: The document outline and table of contents features should not display placeholders for empty headings by default.
  • engine: TypeScript should suggest editingDowncast and dataDowncast in conversion.for. Closes #13750. (commit)
  • engine: The editor should not crash when a custom element with an invalid attribute name is pasted. Closes #13841. (commit)
  • font: Screen readers should now announce the selected option in dropdown lists for the font size, font family, and heading features. Closes #13250. (commit)
  • heading: Screen readers should now announce the selected option in dropdown lists for the font size, font family, and heading features. Closes #13250. (commit)
  • html-support: Fixed the editor crash when pasting a table from Google Sheets. Closes #13876. (commit)
  • html-support: HTML classes from a...
Read more
Assets 2
Loading

v37.1.0

19 Apr 07:38
@pomek pomek
v37.1.0
d18cd2c
Compare
Choose a tag to compare
v37.1.0

Release highlights

Productivity Pack

We are excited to announce the release of a Productivity Pack for CKEditor 5. It includes five new premium features designed to boost productivity when working with the editor.

  • Content templates: The template feature allows you to insert predefined content structures into the document. Templates can provide both smaller portions of content (e.g. a formatted table) and base structures for entire documents (e.g. a formal letter template).
  • Table of contents: The table of contents feature lets you insert a widget with the list of headings (section titles) that reflects the structure of the document. The list stays up–to–date automatically as the user works on the document. Clicking a list item navigates the user to the corresponding document section.
  • Document outline: The document outline feature displays the list of sections (headings) of the document next to the editor. The outline updates automatically as the user works on the document. It offers quick navigation to a specific section upon clicking.
  • Format painter: The format painter feature lets you copy text formatting (such as bold, italic, font size, color, etc.) and apply it in a different place in the edited document. It helps keep the formatting consistent and speeds up the creation of rich content.
  • Slash commands: The slash commands feature lets you execute a predefined command by writing its name or alias directly in the editor. When you type a slash (/), the suggested commands are displayed in a panel next to it. You can also type a phrase after the / to filter the results in the panel and to easily find the desired command.

Other changes

We continue to work on the multi-root editor. This release introduces compatibility with reversion history and pagination. We also made some minor improvements and bug fixes.

MINOR BREAKING CHANGES ℹ️

  • language: A text with language set is no longer styled as italic. To re-enable the previous behavior, add the following style definition to your CSS:

     .ck-content span[lang] { font-style: italic; }

Features

  • template Introduced the content templates feature. It allows inserting predefined templates into the editor content.
  • document-outline Introduced the document outline and table of contents features. The document outline feature allows the user to display a navigable list of sections (headings) of the document next to the editor. The table of contents feature lets them insert a widget with a list of headings (section titles) that reflects the structure of the document.
  • format-painter Introduced the format painter feature. It allows the user to copy text formatting (such as bold, italic, font size, color, etc.) and apply it in a different place in the edited document.
  • slash-command Introduced the slash commands feature. It allows the user to execute a predefined command by writing its name or alias directly in the editor.
  • revision-history: Introduced the revision history feature support for multi-root editor.
  • pagination: Introduced the basic pagination feature support for multi-root editor.
  • source-editing: Made the SourceEditing.updateEditorData() method public to allow saving source editing data independently of the UI. Closes #11008. (commit)

Bug fixes

  • comments: Fixed the incorrect default permissions applied in non-real-time collaboration integrations.
  • engine: Selection#getSelectedBlocks() should ignore trailing blocks where no content is selected. The selection of such blocks is not visible to the content author and is usually there unintentionally. Closes #11585. (commit)
  • enter: Pressing Shift+Enter in Safari should insert <br> instead of splitting a block. Closes #13321. (commit)
  • list: ListPropertiesEditing should not crash if there was a list in an image caption element. Closes #13858. (commit)
  • real-time-collaboration: Fixed an issue when the editor selection would sometimes not be moved past other users' selection when pressing arrow keys.
  • typing: Text suggestions should replace the whole words. Closes #13583. (commit)

Other changes

  • editor-multi-root: The multi-root editor will now throw an error if EditorConfig#initialData is mismatched with initial roots set in MultiRootEditor#create(). (commit)
  • engine: The targetRanges property of the beforeInput event data should be fixed to not cross the limit elements' boundaries. See #13583. (commit)
  • language: TextPartLanguage no longer styles text as italic when the language is set. Closes #12672. (commit)
  • Switched from ts-loader to esbuild-loader when processing the TypeScript sources. It significantly reduces the build time when processing automated and manual tests or preparing snippets in the documentation. Closes #13643. (commit)
  • MultiRootEditor will first fire all detachRoot events and then all addRoot events if there are detached and added roots in the same batch. (commit)
  • Updated translations.

Released packages

Check out the Versioning policy guide for more information.

Released packages (summary)

New packages:

Minor releases (contain minor breaking changes):

Releases containing new features:

Other releases:

Read more
Assets 2
Loading

v37.0.1

05 Apr 11:39
@pomek pomek
v37.0.1
fba274b
Compare
Choose a tag to compare
v37.0.1

Release highlights

There was an invalid version of the ckeditor5-collaboration dependency in the following packages:

Due to that and the CKEditor 5 versioning policy, we release all packages once again.

Check out the highlights of the v37.0.0 original release.

Released packages

Check out the Versioning policy guide for more information.

Released packages (summary)

Other releases:

Assets 2
Loading

v37.0.0

05 Apr 08:11
@pomek pomek
v37.0.0
860ffc9
Compare
Choose a tag to compare
v37.0.0

Release highlights

We are excited to announce that CKEditor 5 has been completely migrated to TypeScript, making v37.0.0 the first major release with full TypeScript support. This migration has brought numerous improvements, including better code organization and enhanced stability:

  • Full TypeScript support: CKEditor now supports TypeScript in all its packages, making it easier for developers to write type-safe code and provide better code completion and error checking in IDEs.
  • Improved code quality: The migration to TypeScript has allowed us to improve the overall code quality of CKEditor, resulting in better stability and performance.
  • Better documentation: With TypeScript, we have been able to provide comprehensive and accurate type definitions for all the components in CKEditor, making it easier for developers to understand and use the API.
  • Enhanced developer experience: TypeScript provides better tooling support, including code completion and error checking, which improves the overall developer experience.

Feel free to check our documentation to find out more about the Using CKEditor 5 with a TypeScript setup and read the migration guide.

We believe this release will be a significant milestone for CKEditor 5 and will provide a better development experience for our users. Please try it out and let us know your feedback by leaving a comment in this issue.

Comments archive

We are excited to introduce the Comments Archive feature. It provides a way to archive comments that are no longer relevant, reducing clutter and making it easier to focus on the most important feedback. Users can access the archive from the toolbar and use the comments archive dropdown to view and restore archived comments if necessary. This new feature will help simplify the feedback management process for our users.

Multi-root editor

In this release, we added official support for multi-root editor type and a new multi-root editor build. Additionally, we bring some fundamental improvements that make the multi-root editor more flexible and useful!

  • Add and detach document roots. The multi-root editor will allow you to add or remove editing fields in your application in a dynamic fashion (i.e. after the editor was initialised), without the need to create additional editor instances.
  • The multi-root editor will allow you to use root attributes to store additional metadata related to roots (editable fields). You can change these attributes and obtain them when you save the document data. Finally, you can react to these changes to alter how your application looks or behaves. Root attributes are a tool that will help you customize the editing experience further according to your needs. To take advantage of root attributes, you will need to provide a custom feature. As of now, there are no official plugins that would require saving and using the attributes of the root.

The multi-root editor is still a project in progress!

While the new predefined build is readily available, several features are not yet supported in the multi-root editor as of this release. These include: revision history, pagination, PDF/Word export, table resize, word count, HTML comments, full-page editing, title, mini-map, and the Cloud Services editor bundle. We will work on bringing support for these features in upcoming releases.

Other than that we look forward to sharing with you guides that will better explain how you can use these new improvements!

Tables

We expanded the General HTM Support feature with support for the <colgroup>’s and <col>’s attributes. We significantly refactored how these HTML elements are handled by the editor. They are now legit elements in the model instead of being kept as a <table> attribute.

MAJOR BREAKING CHANGES ℹ️

  • Upgraded the minimal versions of Node.js to 16.0.0 due to the end of LTS.

MINOR BREAKING CHANGES ℹ️

  • table: The table columns' widths are stored as model elements instead of a model element attribute. See #11479.
  • The @ckeditor/ckeditor5-watchdog package is no longer available as a standalone DLL build. It is now included in the main ckeditor5-dll.js build. See #13707.

Features

  • build-multi-root: Introduced a new editor build featuring the multi-root editor. (commit)
  • comments: Introduced comments archive. It is now possible to resolve a comment thread instead of removing it. Resolved comment threads can be reviewed in the comments archive and can be re-opened if the commented content is still available in the editor.
  • comments: Introduced comment:modify_all permission that will allow the user to edit or remove all comments.
  • engine: Introduced model.Writer#addRoot() and model.Writer#detachRoot(). Model roots can now be dynamically added to or detached from the document. All content gets removed from a detached root and new content cannot be inserted as long as the root is detached. Closes #13388. (commit)
  • engine: Introduced Differ.getChangedRoots() which returns the roots added or detached since last the differ reset. Differ#isEmpty and Differ#hasDataChanges() will return true if a root was added or detached. (commit)
  • mention: Limiting the dropdown on the singular feed level should now be possible. Closes #13504. (commit)
  • multi-root-editor: Introduced the multi-root editor type that allows defining multiple editable areas handled by a single editor instance. Closes #11493. (commit)
  • real-time-collaboration: Added support for custom path prefixes in WebSocket URLs. Any path proceeding the required /ws part in the WebSocket URL is now preserved.

Bug fixes

  • build-*: Typings from the CKEditor 5 builds contain types of loaded plugins. Closes #13676. (commit)
  • clipboard: Dragging images in the editor should not lag in Firefox. Closes #13366. (commit)
  • engine: Dragging images in the editor should not lag in Firefox. Closes #13366. (commit)
  • engine: The Renderer should try to update existing DOM text nodes (instead of replacing them completely) so that external tools should not get lost if the watched DOM text node is removed and replaced with another one. Closes #13051. (commit)
  • engine: The elementToStructure() downcast helper should not skip attribute changes that happened with the modification of the children list. (commit)
  • html-support: Attributes on the <colgroup>, and <col> elements should be preserved in the data. Closes #11479. (commit)
  • html-support: Fixed description lists with name-value groups wrapped in div elements wh...
Read more
Assets 2
Loading

v37.0.0-rc.0

03 Apr 08:08
@pomek pomek
v37.0.0-rc.0
dfd3268
Compare
Choose a tag to compare
v37.0.0-rc.0 Pre-release
Pre-release

MAJOR BREAKING CHANGES ℹ️

  • Upgraded the minimal versions of Node.js to 16.0.0 due to the end of LTS.

MINOR BREAKING CHANGES ℹ️

  • table: The table columns' widths are stored as model elements instead of a model element attribute. See #11479.
  • The @ckeditor/ckeditor5-watchdog package is no longer available as a standalone DLL build. It is now included in the main ckeditor5-dll.js build. See #13707.

Features

  • build-multi-root: Introduced a new editor build featuring the multi-root editor. (commit)
  • comments: Introduced comments archive. It is now possible to resolve a comment thread instead of removing it. Resolved comment threads can be reviewed in the comments archive and can be re-opened if the commented content is still available in the editor.
  • comments: Introduced comment:modify_all permission that will allow the user to edit or remove all comments.
  • engine: Introduced model.Writer#addRoot() and model.Writer#detachRoot(). Model roots can now be dynamically added to or detached from the document. All content gets removed from a detached root and new content cannot be inserted as long as the root is detached. Closes #13388. (commit)
  • engine: Introduced Differ.getChangedRoots() which returns the roots added or detached since last the differ reset. Differ#isEmpty and Differ#hasDataChanges() will return true if a root was added or detached. (commit)
  • mention: Limiting the dropdown on the singular feed level should now be possible. Closes #13504. (commit)
  • multi-root-editor: Introduced the multi-root editor type that allows defining multiple editable areas handled by a single editor instance. Closes #11493. (commit)

Bug fixes

  • build-*: Typings from the CKEditor 5 builds contain types of loaded plugins. Closes #13676. (commit)
  • clipboard: Dragging images in the editor should not lag in Firefox. Closes #13366. (commit)
  • engine: Dragging images in the editor should not lag in Firefox. Closes #13366. (commit)
  • engine: The Renderer should try to update existing DOM text nodes (instead of replacing them completely) so that external tools should not get lost if the watched DOM text node is removed and replaced with another one. Closes #13051. (commit)
  • engine: The elementToStructure() downcast helper should not skip attribute changes that happened with the modification of the children list. (commit)
  • html-support: Attributes on the <colgroup>, and <col> elements should be preserved in the data. Closes #11479. (commit)
  • html-support: Fixed description lists with name-value groups wrapped in div elements when upcasting using the General HTML Support feature. Closes #12240. (commit)
  • image: Fixed the image resize handle displaying NaN in some scenarios. Closes #10776. (commit)
  • link: The link text should update along with the URL if they were the same in the first place. Closes #12588. (commit)
  • mention: Mentions reexport the MentionFeed and ItemRenderer types. Closes #13705. (commit)
  • mention: Make a text property optional in the MentionFeedObjectItem type. Closes #13550. (commit)
  • mention: Mentions panel should be positioned left to the caret in editors with a right–to–left UI language. Closes #13459. (commit)
  • paste-from-office: Fixed handling of bold text in RTL lists pasted from MS Word. Closes #13711. (commit)
  • table: Changed detection on heading rows and columns on table upcast. Closes #3172. (commit)
  • track-changes: Suggestion annotation discard button state is now bound with the DiscardSuggestionCommand state, instead of AcceptSuggestionCommand.
  • track-changes: Fixed error thrown when a list item was created using autoformatting in the track changes mode.
  • track-changes: List style and document list style iss now applied directly to a non-list element when used in the track changes mode.

Other changes

  • core: The EditorConfig#initialData and EditorConfig#placeholder options can now be set to Record<string, string> where the keys are root names and the values are settings for the related roots. (commit)
  • editor-*: Exposed the Context, EditorWatchdog, and ContextWatchdog classes as static editor properties. Closes #13707. (commit)
  • engine: RootAttributeOperation is now correctly handled by Differ. Root attribute changes will be returned in Differ#getChangedRoots(). (commit)
  • engine: model.Document#getRootNames() now returns only attached roots by default. The includeDetached parameter was introduced to enable returning detached roots as well. (commit)
  • **[engine](https://www.npmjs.com/packa...
Read more
Assets 2
Loading

v37.0.0-alpha.3

22 Mar 09:18
@pomek pomek
v37.0.0-alpha.3
98319ec
Compare
Choose a tag to compare
v37.0.0-alpha.3 Pre-release
Pre-release

Release highlights

This release exposes Context, EditorWatchdog, and ContextWatchdog as static editor properties. This should simplify integrations and provide consistency with editor builds.

This introduces a minor breaking change: the @ckeditor/ckeditor5-watchdog package is no longer available as a standalone DLL build. It is now included in the main ckeditor5-dll.js build. See #13707.

Please keep in mind that the release is marked as alpha, which means it is an experimental version, and some unexpected results may occur when using these typings.

We appreciate all of your feedback, as it helps us greatly to improve the final shape of the project. Please share it here.

MINOR BREAKING CHANGES ℹ️

Bug fixes

  • link: The link text should update along with the URL if they were the same in the first place. Closes #12588. (commit)

Other changes

  • editor-*: Exposed the Context, EditorWatchdog, and ContextWatchdog classes as static editor properties. Closes #13707. (commit)
  • utils: Added configuration to the View#scrollToTheSelection() helper allowing to scroll to the top of the boundary. Closes #13688. (commit)

Released packages

Check out the Versioning policy guide for more information.

Released packages (summary)

New packages:

Other releases:

Read more
Assets 2
Loading

v37.0.0-alpha.2

15 Mar 09:53
@pomek pomek
v37.0.0-alpha.2
7a3bbff
Compare
Choose a tag to compare
v37.0.0-alpha.2 Pre-release
Pre-release

Release highlights

This release fixes typings in the predefined builds which should now properly maintain information about included plugins.

Please keep in mind that the release is marked as alpha, which means it is an experimental version and some unexpected results may occur when using these typings.

We appreciate all of your feedback, as it helps us greatly to improve the final shape of the project. Please share it here.

Bug fixes

  • build-*: Typings from the CKEditor 5 builds contain types of loaded plugins. Closes #13676. (commit)
  • image: Fix the image resize handle displaying NaN in some scenarios. Closes #10776. (commit)

Released packages

Check out the Versioning policy guide for more information.

Released packages (summary)

Other releases:

Assets 2
Loading

v37.0.0-alpha.1

13 Mar 09:41
@pomek pomek
v37.0.0-alpha.1
5ad0150
Compare
Choose a tag to compare
v37.0.0-alpha.1 Pre-release
Pre-release

Release highlights

This release addresses the issues with TypeScript reporting some commands, plugins, and configurations as either unavailable or unknown, despite them being correctly registered.

This update also includes a breaking change from alpha.0. To ensure proper TypeScript support, update your imports to use the main package entry point instead of importing from package internals. See the example below:

// ✔️
import { Table } from '@ckeditor/ckeditor5-table';

// ❌
import Table from '@ckeditor/ckeditor5-table/src/table';

Please keep in mind that the release is marked as alpha, which means it is an experimental version and some unexpected results may occur when using these typings.

We appreciate all of your feedback, as it helps us greatly to improve the final shape of the project. Please share it here.

Features

Bug fixes

  • mention: Make a text property optional in the MentionFeedObjectItem type. Closes #13550. (commit)
  • table: Change detection on heading rows and columns on table upcast. Closes #3172. (commit)

Other changes

  • core: The EditorConfig#initialData and EditorConfig#placeholder options can now be set to Record<string, string> where the keys are root names and the values are settings for the related roots. (commit)
  • Improve augmentation in some packages. Related to #13565. (commit)

Released packages

Check out the Versioning policy guide for more information.

Released packages (summary)

New packages:

Releases containing new features:

Other releases:

Read more
Assets 2
Loading

v37.0.0-alpha.0

27 Feb 12:24
@pomek pomek
v37.0.0-alpha.0
ddffd03
Compare
Choose a tag to compare
v37.0.0-alpha.0 Pre-release
Pre-release

Release highlights

This release brings the long-awaited feature: typings for CKEditor 5. They are compatible with TypeScript version 4.8.4 or higher.

Please keep in mind the release is marked as alpha which means it is an experimental version and some unexpected results may occur when using these typings.

We appreciate all your feedback that lets us improve the final shape of the project.

MINOR BREAKING CHANGES ℹ️

  • table: The table columns' widths are stored as model elements instead of model element attributes. See #11479.

Features

  • mention: Limiting the dropdown on the singular feed level should be possible. Closes #13504. (commit)

Bug fixes

  • engine: The elementToStructure() downcast helper should not skip attribute changes that happened with the modification of the children list. (commit)
  • html-support: Attributes on the <colgroup>, and <col> elements should be preserved in the data. Closes #11479. (commit)
  • html-support: Fix description lists with name-value groups wrapped in div elements when upcasting using the General HTML Support feature. Closes #12240. (commit)
  • mention: Mentions panel should be positioned left to the caret in editors with right–to–left UI language. Closes #13459. (commit)

Other changes

Released packages

Check out the [Versioning policy](https://ckeditor.com/docs/ckeditor5/latest/framework/guides/support/versioning-policy....

Read more
Assets 2
Loading

v36.0.1

07 Feb 08:30
@pomek pomek
v36.0.1
240bb31
Compare
Choose a tag to compare
v36.0.1

Release highlights

This is a patch release that resolves two recent issues:

  • The broken release to npm of the @ckeditor/ckeditor5-highlight package. We mistakenly published TypeScript source next to JavaScript files and that breaks some setups, making it harder to integrate the v36.0.0 of CKEditor 5 in your systems. See #13373 for more details.
  • The performance regression in drag&drop of images on the newest version of Firefox (109.0.1). This is an issue caused by a change in Firefox itself and while Firefox’s team plans to revert it, we want to ship the workaround as soon as possible to you. See #13366 for more details.

Bug fixes

Released packages

Check out the Versioning policy guide for more information.

Released packages (summary)

Other releases:

Read more
Assets 2
Loading