What is @ckeditor/ckeditor5-editor-balloon?
@ckeditor/ckeditor5-editor-balloon is a package that provides a balloon editor for CKEditor 5. This type of editor is designed to appear in a floating balloon, which can be positioned relative to the content being edited. It is particularly useful for inline editing scenarios where the editor should not take up a lot of space and should be contextually relevant to the content being edited.
What are @ckeditor/ckeditor5-editor-balloon's main functionalities?
Basic Balloon Editor Initialization
This code demonstrates how to initialize a basic balloon editor using the @ckeditor/ckeditor5-editor-balloon package. The editor is created and attached to a DOM element with the id 'editor'.
const BalloonEditor = require('@ckeditor/ckeditor5-editor-balloon/src/ballooneditor');
const ClassicEditor = require('@ckeditor/ckeditor5-build-classic');
BalloonEditor.create(document.querySelector('#editor'))
.then(editor => {
console.log('Editor was initialized', editor);
})
.catch(error => {
console.error(error.stack);
});
Customizing the Balloon Editor
This code sample shows how to customize the balloon editor by adding specific plugins and configuring the toolbar. In this example, the editor is initialized with the Essentials, Bold, and Italic plugins, and the toolbar is configured to include buttons for bold and italic text.
const BalloonEditor = require('@ckeditor/ckeditor5-editor-balloon/src/ballooneditor');
const EssentialsPlugin = require('@ckeditor/ckeditor5-essentials/src/essentials');
const BoldPlugin = require('@ckeditor/ckeditor5-basic-styles/src/bold');
const ItalicPlugin = require('@ckeditor/ckeditor5-basic-styles/src/italic');
BalloonEditor.create(document.querySelector('#editor'), {
plugins: [ EssentialsPlugin, BoldPlugin, ItalicPlugin ],
toolbar: [ 'bold', 'italic' ]
})
.then(editor => {
console.log('Editor was initialized with custom plugins', editor);
})
.catch(error => {
console.error(error.stack);
});
Handling Editor Events
This example demonstrates how to handle events in the balloon editor. Specifically, it listens for changes to the editor's data and logs the new data to the console whenever it changes.
const BalloonEditor = require('@ckeditor/ckeditor5-editor-balloon/src/ballooneditor');
BalloonEditor.create(document.querySelector('#editor'))
.then(editor => {
editor.model.document.on('change:data', () => {
console.log('The data has changed!', editor.getData());
});
})
.catch(error => {
console.error(error.stack);
});
Other packages similar to @ckeditor/ckeditor5-editor-balloon
quill
Quill is a modern WYSIWYG editor built for compatibility and extensibility. It offers a similar inline editing experience with a floating toolbar, making it comparable to the balloon editor provided by @ckeditor/ckeditor5-editor-balloon. Quill is known for its ease of use and flexibility in customization.
tinymce
TinyMCE is another popular WYSIWYG editor that provides a rich text editing experience. It offers a variety of configurations, including inline editing with a floating toolbar, similar to the balloon editor in CKEditor 5. TinyMCE is highly customizable and widely used in various web applications.
froala-editor
Froala Editor is a lightweight WYSIWYG HTML editor that offers inline editing capabilities with a floating toolbar. It is similar to the balloon editor in CKEditor 5 in terms of functionality and is known for its performance and ease of integration.
43.1.1 (September 25, 2024)
We are happy to announce the release of CKEditor 5 v43.1.1.
During a recent internal audit, we identified a Cross-Site Scripting (XSS) vulnerability in the CKEditor 5 clipboard package (CVE-2024-45613
). This vulnerability could be triggered by a specific user action, leading to unauthorized JavaScript code execution, if the attacker managed to insert malicious content into the editor, which might happen with a very specific editor configuration.
This vulnerability affects only installations where the editor configuration meets the following criteria:
- The Block Toolbar plugin is enabled.
- One of the following plugins is also enabled:
You can read more details in the relevant security advisory and contact us if you have more questions.
Taking the occasion, we decided to introduce additional hardening to some parts of our codebase that introduce theoretical and unexploitable issues. Our security team confirmed that none of these issues were exploitable in a real scenario, however, we decided to fix them, in order to increase the overall security posture of our software.
Released packages
Check out the Versioning policy guide for more information.
<details>
<summary>Released packages (summary)</summary>
Other releases:
</details>