@ckeditor/ckeditor5-editor-balloon
Advanced tools
Balloon editor implementation for CKEditor 5.
@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.
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);
});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 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 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.
The balloon editor implementation (Medium-like editor) for CKEditor 5.
This package contains the BalloonEditor class. Follow there to learn more about this type of editor and how to initialize it.
This package contains the source version of the balloon editor. This kind of editor implementation is also available as a ready-to-use balloon build. Read more about CKEditor 5 predefined builds in the CKEditor 5 documentation.
See the @ckeditor/ckeditor5-editor-balloon 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.1 (November 6, 2024)
We are happy to announce the release of CKEditor 5 v43.3.1.
We had to revert a change introduced in v43.3.0 related to the icons export in one of our packages. This was due to unforeseen TypeScript issues in some setups.
Token class is now exported as a value instead of a type only. (commit)Check out the Versioning policy guide for more information.
<details> <summary>Released packages (summary)</summary>Other releases:
FAQs
Balloon editor implementation for CKEditor 5.
We found that @ckeditor/ckeditor5-editor-balloon 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.