![From Academia to Industry](https://cdn.sanity.io/images/cgdhsj6q/production/70501690bf807891573e259da9719cf24302c7e3-4288x2848.jpg?w=400&fit=max&auto=format)
Employee Spotlight
From Academia to Industry
Philipp Burckhardt recounts his journey from childhood computer fascinations, to building an e-learning platform at Carnegie Mellon University, and on to his current role at Socket.
@ckeditor/ckeditor5-engine
Advanced tools
The editing engine of CKEditor 5 – the best browser-based rich text editor.
Package description
@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.
Changelog
42.0.1 (July 11, 2024)
We are happy to announce the release of CKEditor 5 v42.0.1.
This is a patch release that fixes issues with ckeditor5-editor.css
and other editor-only stylesheets that contained extra newline characters causing incorrect syntax reported in ckeditor/ckeditor5#16670.
Additionally, if you maintain custom CKEditor 5 plugins and migrated them to the new package generator, you should update @ckeditor/ckeditor5-dev-build-tools
to the latest version to avoid this problem in your plugin.
Check out the Versioning policy guide for more information.
<details> <summary>Released packages (summary)</summary>Other releases:
Readme
The CKEditor 5 editing engine implements a flexible MVC-based architecture for creating rich text editing features.
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.
npm install ckeditor5
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.
FAQs
The editing engine of CKEditor 5 – the best browser-based rich text editor.
The npm package @ckeditor/ckeditor5-engine receives a total of 537,425 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 1 open source maintainer 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.
Employee Spotlight
Philipp Burckhardt recounts his journey from childhood computer fascinations, to building an e-learning platform at Carnegie Mellon University, and on to his current role at Socket.
Security News
Git dependencies in open source packages can introduce significant risks, including lack of version control, stability issues, dependency drift, and difficulty in auditing, making them potential targets for supply chain attacks.
Security News
Node.js has added experimental support for TypeScript, a move that highlights the growing importance of TypeScript in modern development.