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

Documentation

See the @ckeditor/ckeditor5-upload 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.