@ckeditor/ckeditor5-adapter-ckfinder

What is @ckeditor/ckeditor5-adapter-ckfinder?

@ckeditor/ckeditor5-adapter-ckfinder is an adapter for CKEditor 5 that enables integration with the CKFinder file manager. It allows users to easily upload and manage files directly from the CKEditor interface.

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

File Upload

This feature allows users to upload files directly from the CKEditor interface to the server using CKFinder.

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

File Management

This feature enables users to manage files, such as images, by specifying resource types and other options.

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

Custom File Browser

This feature allows users to open the CKFinder file browser in a popup window, providing a custom file browsing experience.

ClassicEditor.create(document.querySelector('#editor'), { ckfinder: { openerMethod: 'popup' } })

Other packages similar to @ckeditor/ckeditor5-adapter-ckfinder

ckeditor4

CKEditor 4 is a different version of the CKEditor that also supports file management and uploads through CKFinder. It is more mature but less modern compared to CKEditor 5.

filepond

FilePond is a JavaScript library for file uploads. It offers a modern interface and can be integrated with various backends, but it does not provide the same level of file management as CKFinder.

README

CKEditor 5 CKFinder adapter

This package implements a CKEditor 5 upload adapter compatible with the CKFinder file manager and uploader's server–side connector.

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.

Demo

Check out the demo in the CKFinder feature guide.

Documentation

See the "CKFinder integration" guide and the plugin documentation to learn how to configure the adapter.

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

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.