@ckeditor/ckeditor5-enter

What is @ckeditor/ckeditor5-enter?

@ckeditor/ckeditor5-enter is a plugin for CKEditor 5 that handles the 'Enter' key behavior in the editor. It provides functionality for handling new lines and paragraphs when the 'Enter' key is pressed, ensuring a consistent and expected user experience.

What are @ckeditor/ckeditor5-enter's main functionalities?

Handling Enter Key for New Paragraphs

This feature allows the editor to create a new paragraph when the 'Enter' key is pressed. The Enter plugin is included in the editor configuration to handle this behavior.

ClassicEditor.create(document.querySelector('#editor'), { plugins: [ Enter ] })

Soft Line Breaks

This feature allows the editor to insert a soft line break (a new line within the same paragraph) when 'Shift+Enter' is pressed. The ShiftEnter plugin is included alongside the Enter plugin to handle this behavior.

ClassicEditor.create(document.querySelector('#editor'), { plugins: [ Enter, ShiftEnter ] })

Other packages similar to @ckeditor/ckeditor5-enter

@ckeditor/ckeditor5-paragraph

The @ckeditor/ckeditor5-paragraph package provides support for paragraph handling in CKEditor 5. It is often used in conjunction with the Enter plugin to manage paragraph creation and formatting. While @ckeditor/ckeditor5-enter focuses on the 'Enter' key behavior, @ckeditor/ckeditor5-paragraph provides broader paragraph management capabilities.

quill

Quill is a modern WYSIWYG editor built for compatibility and extensibility. It provides similar functionality for handling the 'Enter' key and creating new paragraphs or line breaks. Quill offers a different API and configuration approach compared to CKEditor 5 but serves a similar purpose in text editing applications.

tinymce

TinyMCE is another popular WYSIWYG editor that provides extensive text editing capabilities, including handling the 'Enter' key for new paragraphs and line breaks. TinyMCE offers a rich set of plugins and configuration options, making it a strong alternative to CKEditor 5 for various text editing needs.

README

CKEditor 5 enter feature

This package implements the Enter and Shift+Enter (soft break) support for CKEditor 5.

Installation

This plugin is part of the ckeditor5 package. Install the whole package to use it.

npm install ckeditor5

Create free account

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

Documentation

See the @ckeditor/ckeditor5-enter package page in CKEditor 5 documentation.

License

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

• the GNU General Public License Version 2 or later,
• or commercial license terms from CKSource Holding sp. z o.o.

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

Changelog

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.