@ckeditor/ckeditor5-editor-classic
Advanced tools
@ckeditor/ckeditor5-editor-classic is a classic editor build for CKEditor 5, which provides a rich text editor with a wide range of features for content creation. It is highly customizable and can be extended with various plugins to enhance its functionality.
Basic Text Editing
This code initializes a basic instance of the classic editor, allowing users to perform standard text editing operations such as typing, formatting, and styling text.
const ClassicEditor = require('@ckeditor/ckeditor5-editor-classic/src/classiceditor');
ClassicEditor.create(document.querySelector('#editor'))
.then(editor => {
console.log('Editor was initialized', editor);
})
.catch(error => {
console.error(error);
});Adding Plugins
This code demonstrates how to add plugins to the classic editor. In this example, the 'Bold' and 'Italic' plugins are added, and the toolbar is configured to include buttons for these functionalities.
const ClassicEditor = require('@ckeditor/ckeditor5-editor-classic/src/classiceditor');
const Essentials = require('@ckeditor/ckeditor5-essentials/src/essentials');
const Bold = require('@ckeditor/ckeditor5-basic-styles/src/bold');
const Italic = require('@ckeditor/ckeditor5-basic-styles/src/italic');
ClassicEditor.create(document.querySelector('#editor'), {
plugins: [Essentials, Bold, Italic],
toolbar: ['bold', 'italic']
})
.then(editor => {
console.log('Editor with plugins was initialized', editor);
})
.catch(error => {
console.error(error);
});Customizing Toolbar
This code shows how to customize the toolbar of the classic editor. The toolbar is configured to include specific items such as 'heading', 'bold', 'italic', 'link', 'bulletedList', 'numberedList', 'undo', and 'redo'.
const ClassicEditor = require('@ckeditor/ckeditor5-editor-classic/src/classiceditor');
ClassicEditor.create(document.querySelector('#editor'), {
toolbar: {
items: [
'heading',
'|',
'bold',
'italic',
'link',
'bulletedList',
'numberedList',
'|',
'undo',
'redo'
]
}
})
.then(editor => {
console.log('Editor with custom toolbar was initialized', editor);
})
.catch(error => {
console.error(error);
});TinyMCE is a popular rich text editor that offers a wide range of features similar to CKEditor. It is highly customizable and supports various plugins for extending its functionality. Compared to @ckeditor/ckeditor5-editor-classic, TinyMCE has a different API and plugin system but offers comparable text editing capabilities.
Quill is a modern rich text editor built for compatibility and extensibility. It provides a clean API and a modular architecture, making it easy to customize and extend. While Quill offers a different approach to text editing compared to @ckeditor/ckeditor5-editor-classic, it is also a powerful tool for creating rich text content.
Draft.js is a JavaScript rich text editor framework developed by Facebook. It provides a set of tools for building rich text editors with React. Unlike @ckeditor/ckeditor5-editor-classic, Draft.js is more of a framework than a ready-to-use editor, offering more flexibility for developers to create custom text editing experiences.
The classic editor implementation for CKEditor 5.
This package contains the ClassicEditor class. Follow there to learn more about this type of editor and how to initialize it.
This package contains the source version of the classic editor. This kind of editor implementation is also available as a ready-to-use classic build. Read more about CKEditor 5 predefined builds in the CKEditor 5 documentation.
See the @ckeditor/ckeditor5-editor-classic 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
Classic editor implementation for CKEditor 5.
The npm package @ckeditor/ckeditor5-editor-classic receives a total of 345,569 weekly downloads. As such, @ckeditor/ckeditor5-editor-classic popularity was classified as popular.
We found that @ckeditor/ckeditor5-editor-classic 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
Research
The Socket Research Team uncovered a malicious Python package typosquatting the popular 'fabric' SSH library, silently exfiltrating AWS credentials from unsuspecting developers.
Security News
At its inaugural meeting, the JSR Working Group outlined plans for an open governance model and a roadmap to enhance JavaScript package management.
Security News
Research
An advanced npm supply chain attack is leveraging Ethereum smart contracts for decentralized, persistent malware control, evading traditional defenses.