@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.

Documentation

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

Installation

npm install ckeditor5

License

Licensed under the terms of GNU General Public License Version 2 or later. For full details about the license, please check the LICENSE.md file or https://ckeditor.com/legal/ckeditor-oss-license.

Changelog

43.1.0 (September 5, 2024)

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

Release highlights

This release includes important bug fixes and enhancements for the editor:

• Block merge fields: In contrast to regular, inline merge fields, the block merge fields are designed to represent complex, block-level structures, such as a dynamically generated table, a row of products, or a personalized call-to-action segment. Block merge fields are supposed to be replaced by arbitrary HTML data when the document template is post-processed or exported to a PDF or Word file.

• Nested dropdown menus: this release introduces a new UI component: nested dropdown menus. They can be used by feature developers to easily provide an advanced user interface where UI elements are organized into a nested menu structure.

• Customizable accessible label: You can now configure the label for the accessible editable area through the editor settings, ensuring it fits your system’s needs.

• Improved table and cell border controls: It is now easier to manage both table and cell borders. The table user interface now clearly indicates the default border settings, allowing you to set “no borders” (None) for tables and cells without any additional configuration.

  ⚠️ In some cases this update may lead to data changes in the tables’ HTML markup when the editor loads them. However, visually nothing will change, and the experience will be the same.

The full list of enhancements can be found below.