@ckeditor/ckeditor5-clipboard

What is @ckeditor/ckeditor5-clipboard?

@ckeditor/ckeditor5-clipboard is a plugin for CKEditor 5 that provides clipboard support, enabling users to cut, copy, and paste content within the editor. It handles various clipboard operations, including pasting plain text, HTML, and rich text content, and integrates seamlessly with other CKEditor 5 plugins.

What are @ckeditor/ckeditor5-clipboard's main functionalities?

Basic Clipboard Operations

This code initializes a CKEditor 5 instance with the clipboard plugin enabled, allowing basic cut, copy, and paste operations.

ClassicEditor.create(document.querySelector('#editor'), { plugins: [ Clipboard ] })

Pasting Plain Text

This configuration ensures that only plain text is pasted into the editor, stripping out any HTML or rich text formatting.

ClassicEditor.create(document.querySelector('#editor'), { plugins: [ Clipboard ], clipboard: { plainText: true } })

Handling Custom Paste Events

This example demonstrates how to handle custom paste events by listening to the 'inputTransformation' event, allowing developers to manipulate the pasted content before it is inserted into the editor.

ClassicEditor.create(document.querySelector('#editor'), { plugins: [ Clipboard ] }).then(editor => { editor.plugins.get('Clipboard').on('inputTransformation', (evt, data) => { console.log('Custom paste event:', data); }); });

Other packages similar to @ckeditor/ckeditor5-clipboard

quill

Quill is a modern WYSIWYG editor built for compatibility and extensibility. It provides clipboard support similar to @ckeditor/ckeditor5-clipboard, allowing users to cut, copy, and paste content. Quill's clipboard module can be customized to handle different types of content and transformations.

tinymce

TinyMCE is a popular rich text editor that includes comprehensive clipboard support. It allows users to paste content from various sources, including Word and Excel, and provides options to clean up and transform pasted content. TinyMCE's clipboard functionality is comparable to @ckeditor/ckeditor5-clipboard in terms of flexibility and customization.

draft-js

Draft.js is a JavaScript framework for building rich text editors, developed by Facebook. It includes clipboard support for handling cut, copy, and paste operations. Draft.js allows developers to customize the clipboard behavior and integrate it with other editor features, similar to @ckeditor/ckeditor5-clipboard.

README

CKEditor 5 clipboard feature

This package implements the clipboard (copy, cut, paste) support for CKEditor 5.

Installation

This plugin is part of the ckeditor5 package. Install the whole package to use it.

npm install ckeditor5

Create free account

If you want to check full CKEditor 5 capabilities, sign up for a free non-commitment 14-day trial.

Documentation

See the @ckeditor/ckeditor5-clipboard package page in CKEditor 5 documentation.

License

Licensed under a dual-license model, this software is available under:

• the GNU General Public License Version 2 or later,
• or commercial license terms from CKSource Holding sp. z o.o.

For more information, see: https://ckeditor.com/legal/ckeditor-licensing-options.

Changelog

44.0.0 (December 2, 2024)

Release Highlights

We are excited to introduce CKEditor 5 v44.0.0, a release packed with high impact updates designed to enhance your editing experience and simplify access to our premium offers. Here's what’s new:

🚀 Self-service plans: Simplified access to premium features

We are introducing flexible self-service plans that put you in control with full transparency. Now, you can:

• Choose the plan that fits your needs, pay only for what you use, and get started instantly with a commitment-free trial.
• Seamlessly manage your license keys, track usage, and more in the new Customer Portal.

💡 Important for current users:

If you are upgrading to v44.0.0+, ensure a smooth transition by updating your license keys in the editor, as we implemented a new format of the key. To get the new key, visit the Customer Portal. You can also refer to our license key and activation guide for help with logging in to the portal.

📣 The open-source licensing remains unchanged. However, config.licenseKey is now a required property in the editor configuration. Use 'GPL' for installations under the GPL terms. Read more in the update guide.

🔖 Bookmarks: Organize your content with ease

Say hello to Bookmarks, a long-awaited feature that simplifies content navigation within the editor. With this release, you can:

• Add anchors as reference points within text.
• Link to the newly created bookmarks in the editor to navigate to specific locations within complex documents, such as contracts or technical manuals.

📍 Future updates to Bookmarks and the linking experience are planned for the upcoming releases. Follow progress and share your feedback on GitHub.

⚡ Performance improvements: Faster table rendering

The current release includes another stride towards improving the performance aspect of the editor, this time focusing on how tables are handled in the content. Implemented optimizations have made table rendering 3x faster, with the average load time of a document with a very long, complex tables dropping from around 4.5 seconds to just 1.5 seconds.