@ckeditor/ckeditor5-essentials

What is @ckeditor/ckeditor5-essentials?

@ckeditor/ckeditor5-essentials is a package that provides essential features for CKEditor 5, a modern JavaScript rich text editor. It includes basic functionalities such as undo, redo, and clipboard support, which are fundamental for any text editing experience.

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

Undo

This feature allows users to undo and redo their actions within the editor. The code sample demonstrates how to include the Essentials plugin in a CKEditor 5 instance and add undo/redo buttons to the toolbar.

import Essentials from '@ckeditor/ckeditor5-essentials/src/essentials';
import ClassicEditor from '@ckeditor/ckeditor5-editor-classic/src/classiceditor';

ClassicEditor
    .create( document.querySelector( '#editor' ), {
        plugins: [ Essentials ],
        toolbar: [ 'undo', 'redo' ]
    } )
    .catch( error => {
        console.error( error );
    } );

Clipboard

This feature provides clipboard support, allowing users to copy, cut, and paste content within the editor. The code sample shows how to configure the CKEditor 5 instance to include clipboard functionalities.

import Essentials from '@ckeditor/ckeditor5-essentials/src/essentials';
import ClassicEditor from '@ckeditor/ckeditor5-editor-classic/src/classiceditor';

ClassicEditor
    .create( document.querySelector( '#editor' ), {
        plugins: [ Essentials ],
        toolbar: [ 'copy', 'cut', 'paste' ]
    } )
    .catch( error => {
        console.error( error );
    } );

Other packages similar to @ckeditor/ckeditor5-essentials

quill

Quill is a modern WYSIWYG editor built for compatibility and extensibility. It offers similar functionalities to CKEditor 5 Essentials, such as undo/redo and clipboard support, but also includes a more extensive set of features out of the box. Quill is known for its ease of use and flexibility in customization.

tinymce

TinyMCE is another popular rich text editor that provides a wide range of features, including undo/redo and clipboard support. It is highly customizable and offers a robust plugin architecture, making it comparable to CKEditor 5 Essentials in terms of functionality and extensibility.

draft-js

Draft.js is a JavaScript rich text editor framework developed by Facebook. It provides similar core functionalities like undo/redo and clipboard support. Draft.js is highly extensible and allows developers to build complex text editing experiences, but it requires more setup and configuration compared to CKEditor 5 Essentials.

README

CKEditor 5 essentials plugin

Essential editing features for CKEditor 5 wrapped in one plugin.

The Essentials plugin includes all fundamental editing features:

• Clipboard
• Enter
• SelectAll
• Typing
• Undo

Documentation

See the @ckeditor/ckeditor5-essentials 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.