@ckeditor/ckeditor5-essentials
Advanced tools
@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.
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 );
} );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 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 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.
Essential editing features for CKEditor 5 wrapped in one plugin.
The Essentials plugin includes all fundamental editing features:
See the @ckeditor/ckeditor5-essentials package page in CKEditor 5 documentation.
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.
43.3.0 (October 29, 2024)
We are happy to announce the release of CKEditor 5 v43.3.0.
We have improved how the editor handles the document structure by making it more reliable and efficient to access specific elements and verify their positions.
Node and NodeList elements now cache index and offset values, reducing the need for recalculations and significantly boosting overall performance during model operations.Position#isValid() method is also utilized to better validate selection ranges, ensuring more consistent behavior in various editing scenarios.We’re committed to ongoing performance enhancements, so you can expect even faster, smoother experience in future updates.
A new configuration option has been added to include a watermark when exporting documents to Word, providing additional flexibility in document branding and protection.
getChildAtOffset() method for model.Element and model.DocumentFragment. (commit)Position#isValid() method to check whether the position exists in the current model tree. (commit)RevisionTracker#getRevisionDocumentData() and RevisionTracker#getRevisionRootsAttributes() methods to the public scope of the editor API. You can use them to retrieve document data saved with the revision.FocusTracker extendable with other FocusTracker instances to allow logical focus tracking across separate DOM sub-trees (see #17277). (commit)sources downcast. (commit)LinkConfig#addTargetToExternalLinks: true is set. Closes https://github.com/ckeditor/ckeditor5/issues/17252. (commit)BalloonToolbar while the user hovers a nested menu. Closes #17277. (commit)Node and NodeList to improve performance. (commit)ckeditor5-link package. Closes #17304. (commit)Dialog plugin. Closes #17290. (commit)config.ui.viewportOffset. Closes #17290. (commit)Check out the Versioning policy guide for more information.
<details> <summary>Released packages (summary)</summary>Releases containing new features:
Other releases:
FAQs
Essential editing features for CKEditor 5.
The npm package @ckeditor/ckeditor5-essentials receives a total of 391,007 weekly downloads. As such, @ckeditor/ckeditor5-essentials popularity was classified as popular.
We found that @ckeditor/ckeditor5-essentials 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.
Security News
Socket's threat research team has detected five malicious npm packages targeting Roblox developers, deploying malware to steal credentials and personal data.
Security News
vlt introduced its new package manager and a serverless registry this week, innovating in a space where npm has stagnated.
Security News
Research
The Socket Research Team uncovered a malicious Python package typosquatting the popular 'fabric' SSH library, silently exfiltrating AWS credentials from unsuspecting developers.