@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.

Documentation

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

Installation

npm install ckeditor5

License

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.