@ckeditor/ckeditor5-upload

What is @ckeditor/ckeditor5-upload?

@ckeditor/ckeditor5-upload is a plugin for CKEditor 5 that provides file upload capabilities. It allows users to upload images and other files directly within the editor, enhancing the content creation experience.

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

Simple Upload Adapter

This feature allows you to configure a simple upload adapter that sends files to a specified server endpoint. The server should handle the file storage and return the URL of the uploaded file.

ClassicEditor.create(document.querySelector('#editor'), { extraPlugins: [SimpleUploadAdapter], simpleUpload: { uploadUrl: 'https://your-upload-endpoint.com/upload' } })

Base64 Upload Adapter

This feature enables the Base64 upload adapter, which converts files to Base64 strings and embeds them directly into the content. This is useful for quick prototyping or when you don't have a server-side upload handler.

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

Custom Upload Adapter

This feature allows you to create a custom upload adapter by defining your own upload logic. This is useful when you need more control over the upload process or need to integrate with a specific backend service.

class MyUploadAdapter { constructor(loader) { this.loader = loader; } upload() { return this.loader.file.then(file => new Promise((resolve, reject) => { const data = new FormData(); data.append('file', file); fetch('https://your-upload-endpoint.com/upload', { method: 'POST', body: data }) .then(response => response.json()) .then(result => resolve({ default: result.url })) .catch(reject); })); } } ClassicEditor.create(document.querySelector('#editor'), { extraPlugins: [function(editor) { editor.plugins.get('FileRepository').createUploadAdapter = loader => new MyUploadAdapter(loader); }] })

Other packages similar to @ckeditor/ckeditor5-upload

quill-image-uploader

quill-image-uploader is a module for the Quill rich text editor that provides image upload capabilities. It allows users to upload images directly within the editor. Compared to @ckeditor/ckeditor5-upload, it is specific to the Quill editor and offers similar functionality for image uploads.

react-dropzone

react-dropzone is a React component for handling file uploads via drag and drop. While it is not specific to any rich text editor, it can be integrated with various editors to provide file upload capabilities. It offers more flexibility in terms of how files are uploaded and handled compared to @ckeditor/ckeditor5-upload.

README

CKEditor 5 file upload feature

This package implements various file upload utilities 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-upload 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.