@ckeditor/ckeditor5-engine
Advanced tools
The editing engine of CKEditor 5 – the best browser-based rich text editor.
@ckeditor/ckeditor5-engine is a core package of CKEditor 5, a modern JavaScript rich text editor. This package provides the engine that powers the editor, including the data model, editing view, and rendering process. It is highly modular and extensible, allowing developers to create custom editing experiences.
Creating a Document
This feature allows you to create a new document instance, which is the core of the editing engine. The document holds the data model and manages the editing operations.
const { Document } = require('@ckeditor/ckeditor5-engine');
const doc = new Document();
console.log(doc);Adding a Root Element
This feature allows you to add a root element to the document. The root element is the top-level container for the document's content.
const { Document } = require('@ckeditor/ckeditor5-engine');
const doc = new Document();
const root = doc.createRoot();
console.log(root);Inserting Text
This feature allows you to insert text into the document. The Writer class is used to perform editing operations on the document.
const { Document, Writer } = require('@ckeditor/ckeditor5-engine');
const doc = new Document();
const root = doc.createRoot();
const writer = new Writer();
writer.insertText('Hello, world!', root);
console.log(root);Listening to Changes
This feature allows you to listen to changes in the document. The document emits events whenever its content is modified, enabling you to react to these changes.
const { Document } = require('@ckeditor/ckeditor5-engine');
const doc = new Document();
doc.on('change', (event, batch) => {
console.log('Document changed:', batch);
});ProseMirror is a toolkit for building rich-text editors on the web. It provides a similar data model and editing capabilities as @ckeditor/ckeditor5-engine but is more low-level, offering greater flexibility at the cost of requiring more setup and configuration.
Slate is another framework for building rich text editors. It offers a more React-friendly API compared to @ckeditor/ckeditor5-engine and is highly customizable. However, it may require more effort to implement complex features.
Quill is a modern WYSIWYG editor built for compatibility and extensibility. It provides a simpler API compared to @ckeditor/ckeditor5-engine and is easier to get started with, but it may not offer the same level of customization and control.
The CKEditor 5 editing engine implements a flexible MVC-based architecture for creating rich text editing features.
This plugin is part of the ckeditor5 package. Install the whole package to use it.
npm install ckeditor5
If you want to check full CKEditor 5 capabilities, sign up for a free non-commitment 14-day trial.
contentEditable nightmares!For a general introduction see the Overview of CKEditor 5 Framework guide and then the Editing engine architecture guide.
Additionally, refer to the @ckeditor/ckeditor5-engine package page in CKEditor 5 documentation for even more information.
Licensed under a dual-license model, this software is available under:
For more information, see: https://ckeditor.com/legal/ckeditor-licensing-options.
44.3.0 (March 5, 2025)
We are happy to announce the release of CKEditor 5 v44.3.0.
This release brings a couple of minor improvements and bug fixes:
rel attribute. The fix happened so deep in the engine that we improved the overall performance of the editor slightly as well.EmptyBlock plugin: From now on, new plugin prevents adding to the output data of blocks, works similarly to the fillEmptyBlocks configuration in CKEditor 4.<hr> element in the General HTML Support plugin enhanced: attributes of the <hr> element are now properly preserved if configuration allows it.For more details, see the changelog below.
ViewConsumable.consumablesFromElement() is removed and replaced with the view.Element#_getConsumables() internal method. You should use ViewConsumable.createFrom() to create consumables if needed.ViewElementConsumables now accepts and outputs only normalized data. The ViewConsumable still accepts normalized or non-normalized input.Matcher#match() and Matcher#matchAll() output is now normalized. The MatchResult#match now contains normalized data compatible with changes in the ViewConsumable.SchemaContext class from package. Closes https://github.com/ckeditor/ckeditor5/issues/18003. (commit)<hr> element. Closes #12973. (commit)EmptyBlock plugin that prevents adding to output data. (commit)[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)<span> when GHS is enabled. Closes #15329. (commit)viewToPlainText() function. Closes #17950. (commit)config.users.getInitialsCallback. It allows providing a custom callback function for user initials generation.emoji.useCustomFont option to disable the filtering mechanism. Closes #18029. (commit) ) are ignored while loading editor data. (commit)Check out the Versioning policy guide for more information.
<details> <summary>Released packages (summary)</summary>Minor releases (contain minor breaking changes):
Releases containing new features:
Other releases:
FAQs
The editing engine of CKEditor 5 – the best browser-based rich text editor.
The npm package @ckeditor/ckeditor5-engine receives a total of 1,072,533 weekly downloads. As such, @ckeditor/ckeditor5-engine popularity was classified as popular.
We found that @ckeditor/ckeditor5-engine demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
A survey of 500 cybersecurity pros reveals high pay isn't enough—lack of growth and flexibility is driving attrition and risking organizational security.
Product
Socket, the leader in open source security, is now available on Google Cloud Marketplace for simplified procurement and enhanced protection against supply chain attacks.
Security News
Corepack will be phased out from future Node.js releases following a TSC vote.