@ckeditor/ckeditor5-ckfinder

What is @ckeditor/ckeditor5-ckfinder?

@ckeditor/ckeditor5-ckfinder is a plugin for CKEditor 5 that integrates CKFinder, a file manager and uploader, into the editor. This allows users to easily upload, browse, and manage files directly within the CKEditor 5 interface.

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

File Upload

This feature allows users to upload files directly from the CKEditor 5 interface using CKFinder. The `uploadUrl` specifies the endpoint to which the files will be uploaded.

ClassicEditor.create(document.querySelector('#editor'), { ckfinder: { uploadUrl: '/ckfinder/connector?command=QuickUpload&type=Files&responseType=json' } })

File Browser

This feature enables users to browse and select files from the server. The `resourceType` option can be used to filter the types of files that can be browsed.

ClassicEditor.create(document.querySelector('#editor'), { ckfinder: { options: { resourceType: 'Images' } } })

Image Insertion

This feature allows users to insert images into the editor content. The `chooseFiles` option enables the file chooser dialog for selecting images.

ClassicEditor.create(document.querySelector('#editor'), { ckfinder: { options: { chooseFiles: true } } })

Other packages similar to @ckeditor/ckeditor5-ckfinder

filepond

FilePond is a flexible JavaScript file upload library that can be easily integrated with various frameworks. It provides a modern interface for file uploads and supports multiple file types. Compared to @ckeditor/ckeditor5-ckfinder, FilePond is more versatile and can be used outside of CKEditor.

dropzone

Dropzone is a popular JavaScript library for drag-and-drop file uploads. It offers a simple and customizable interface for uploading files. While Dropzone is not specifically designed for CKEditor, it can be integrated with it to provide similar file upload functionalities as @ckeditor/ckeditor5-ckfinder.

uppy

Uppy is a modular file uploader for web applications. It supports various plugins and can be integrated with different storage services. Uppy provides a more extensive set of features compared to @ckeditor/ckeditor5-ckfinder, including file compression and resumable uploads.

README

CKEditor 5's CKFinder integration

This package implements the CKFinder feature. This feature allows you to easily insert images as well as links to files into the editor content. It is a bridge between CKEditor 5 WYSIWYG editor and CKFinder file manager and uploader.

Documentation

See the CKFinder integration guide and the plugin documentation to learn more about the integration.

Check out the comprehensive Image upload guide to learn about other ways to upload images into CKEditor 5.

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.