@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

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.

43.2.0 (October 2, 2024)

We are happy to announce the release of CKEditor 5 v43.2.0.

Release highlights

Notable improvements

Operational Transformation Stability: Significant changes have been made to the OT system, enhancing the undo functionality and real-time collaboration, especially in conflict resolution scenarios. These improvements ensure smoother editor operations during complex interactions.
Performance Improvements: We have merged several community-driven performance enhancements (thanks @sunesimonsen), that optimize the editor’s core engine. While no changes to the editor’s logic were made, these updates improve overall efficiency and responsiveness.

More imports available via `ckeditor5` and `ckeditor5-premium-features` indexes

As users transition to new installation methods (v42.0.0+) with ckeditor5 and ckeditor5-premium-features as the main packages, we are continuously addressing missing imports for less common classes, functions, types, and utilities, broadening their availability. Since our TypeScript rewrite (v37.0.0), imports can now be made directly through the package indexes, simplifying integration. As many users historically imported from src, we encourage you to try the new version and report any missing imports. In the future, we are considering removing src from published packages to reduce package size, so the more feedback we receive, the better and more stable API we will provide.

Features

engine: Added the usePassive option to DomEventObserver that enables listening to passive events. Closes #16412. (commit)
media-embed: It is now possible to embed YouTube shorts. Closes #17090. (commit)
ui: Updated the "Powered by" link. (commit)

Bug fixes

ckbox: Editing inline images using CKBox no longer changes and reinserts them simultaneously. Closes #17056. (commit)
engine: Fixed incorrect marker handling in some scenarios involving undo and real-time collaboration, which earlier led to a model-nodelist-offset-out-of-bounds error. See #9296. (commit)
engine: Fixed incorrect handling of merge changes during undo in some scenarios involving real-time collaboration, which earlier led to a model-nodelist-offset-out-of-bounds error. See #9296. (commit)
engine: Fixed conflict resolution error, which led to editor crash in some scenarios where two users removed larger intersecting part of the content and used undo. See #9296. (commit)
engine: Fixed incorrect undo behavior leading to an editor crash when a user pressed <kbd>Enter</kbd> key multiple times, then pressed backspace that many times, then undid all the changes. Closes #9296. (commit)
theme-lark: Increased the specificity of the dropdown menu panel styles to address issues with incorrect z-index ordering. (commit)
ui: Fixed scrolling in dropdowns when a block toolbar button is active. Closes #17067. (commit)
ui: Increased the specificity of the dropdown menu panel styles to address issues with incorrect z-index ordering. (commit)

Other changes

basic-styles: Exported the AttributeCommand class. Closes #17105. (commit)
ckeditor5-premium-features: Marked the ckeditor5 package as peerDependencies.
engine: Performance improvements. Avoided creating unnecessary arrays. Closes #17143. (commit)
Exported several classes and utilities from various packages (commit).

Released packages

Check out the Versioning policy guide for more information.

<details> <summary>Released packages (summary)</summary>

Releases containing new features:

@ckeditor/ckeditor5-engine: v43.1.1 => v43.2.0
@ckeditor/ckeditor5-media-embed: v43.1.1 => v43.2.0
@ckeditor/ckeditor5-ui: v43.1.1 => v43.2.0

Other releases:

@ckeditor/ckeditor5-adapter-ckfinder: v43.1.1 => v43.2.0
@ckeditor/ckeditor5-ai: v43.1.1 => v43.2.0
@ckeditor/ckeditor5-alignment: v43.1.1 => v43.2.0
@ckeditor/ckeditor5-autoformat: v43.1.1 => v43.2.0
@ckeditor/ckeditor5-autosave: v43.1.1 => v43.2.0
@ckeditor/ckeditor5-basic-styles: v43.1.1 => v43.2.0
@ckeditor/ckeditor5-block-quote: v43.1.1 => v43.2.0
@ckeditor/ckeditor5-build-balloon: v43.1.1 => v43.2.0
@ckeditor/ckeditor5-build-balloon-block: v43.1.1 => v43.2.0
@ckeditor/ckeditor5-build-classic: v43.1.1 => v43.2.0
@ckeditor/ckeditor5-build-decoupled-document: v43.1.1 => v43.2.0
@ckeditor/ckeditor5-build-inline: v43.1.1 => v43.2.0
@ckeditor/ckeditor5-build-multi-root: v43.1.1 => v43.2.0
@ckeditor/ckeditor5-case-change: v43.1.1 => v43.2.0
@ckeditor/ckeditor5-ckbox: v43.1.1 => v43.2.0
@ckeditor/ckeditor5-ckfinder: v43.1.1 => v43.2.0
@ckeditor/ckeditor5-clipboard: v43.1.1 => v43.2.0
@ckeditor/ckeditor5-cloud-services: v43.1.1 => v43.2.0
@ckeditor/ckeditor5-code-block: v43.1.1 => v43.2.0
@ckeditor/ckeditor5-collaboration-core: v43.1.1 => v43.2.0
@ckeditor/ckeditor5-comments: v43.1.1 => v43.2.0
@ckeditor/ckeditor5-core: v43.1.1 => v43.2.0
@ckeditor/ckeditor5-document-outline: v43.1.1 => v43.2.0
@ckeditor/ckeditor5-easy-image: v43.1.1 => v43.2.0
@ckeditor/ckeditor5-editor-balloon: v43.1.1 => v43.2.0
@ckeditor/ckeditor5-editor-classic: v43.1.1 => v43.2.0
@ckeditor/ckeditor5-editor-decoupled: v43.1.1 => v43.2.0
@ckeditor/ckeditor5-editor-inline: v43.1.1 => v43.2.0
@ckeditor/ckeditor5-editor-multi-root: v43.1.1 => v43.2.0
@ckeditor/ckeditor5-enter: v43.1.1 => v43.2.0
@ckeditor/ckeditor5-essentials: v43.1.1 => v43.2.0
@ckeditor/ckeditor5-export-pdf: v43.1.1 => v43.2.0
@ckeditor/ckeditor5-export-word: v43.1.1 => v43.2.0
@ckeditor/ckeditor5-find-and-replace: v43.1.1 => v43.2.0
@ckeditor/ckeditor5-font: v43.1.1 => v43.2.0
@ckeditor/ckeditor5-format-painter: v43.1.1 => v43.2.0
@ckeditor/ckeditor5-heading: v43.1.1 => v43.2.0
@ckeditor/ckeditor5-highlight: v43.1.1 => v43.2.0
@ckeditor/ckeditor5-horizontal-line: v43.1.1 => v43.2.0
@ckeditor/ckeditor5-html-embed: v43.1.1 => v43.2.0
@ckeditor/ckeditor5-html-support: v43.1.1 => v43.2.0
@ckeditor/ckeditor5-image: v43.1.1 => v43.2.0
@ckeditor/ckeditor5-import-word: v43.1.1 => v43.2.0
@ckeditor/ckeditor5-indent: v43.1.1 => v43.2.0
@ckeditor/ckeditor5-language: v43.1.1 => v43.2.0
@ckeditor/ckeditor5-link: v43.1.1 => v43.2.0
@ckeditor/ckeditor5-list: v43.1.1 => v43.2.0
@ckeditor/ckeditor5-list-multi-level: v43.1.1 => v43.2.0
@ckeditor/ckeditor5-markdown-gfm: v43.1.1 => v43.2.0
@ckeditor/ckeditor5-mention: v43.1.1 => v43.2.0
@ckeditor/ckeditor5-merge-fields: v43.1.1 => v43.2.0
@ckeditor/ckeditor5-minimap: v43.1.1 => v43.2.0
@ckeditor/ckeditor5-operations-compressor: v43.1.1 => v43.2.0
@ckeditor/ckeditor5-page-break: v43.1.1 => v43.2.0
@ckeditor/ckeditor5-pagination: v43.1.1 => v43.2.0
@ckeditor/ckeditor5-paragraph: v43.1.1 => v43.2.0
@ckeditor/ckeditor5-paste-from-office: v43.1.1 => v43.2.0
@ckeditor/ckeditor5-paste-from-office-enhanced: v43.1.1 => v43.2.0
@ckeditor/ckeditor5-real-time-collaboration: v43.1.1 => v43.2.0
@ckeditor/ckeditor5-remove-format: v43.1.1 => v43.2.0
@ckeditor/ckeditor5-restricted-editing: v43.1.1 => v43.2.0
@ckeditor/ckeditor5-revision-history: v43.1.1 => v43.2.0
@ckeditor/ckeditor5-select-all: v43.1.1 => v43.2.0
@ckeditor/ckeditor5-show-blocks: v43.1.1 => v43.2.0
@ckeditor/ckeditor5-slash-command: v43.1.1 => v43.2.0
@ckeditor/ckeditor5-source-editing: v43.1.1 => v43.2.0
@ckeditor/ckeditor5-special-characters: v43.1.1 => v43.2.0
@ckeditor/ckeditor5-style: v43.1.1 => v43.2.0
@ckeditor/ckeditor5-table: v43.1.1 => v43.2.0
@ckeditor/ckeditor5-template: v43.1.1 => v43.2.0
@ckeditor/ckeditor5-theme-lark: v43.1.1 => v43.2.0
@ckeditor/ckeditor5-track-changes: v43.1.1 => v43.2.0
@ckeditor/ckeditor5-typing: v43.1.1 => v43.2.0
@ckeditor/ckeditor5-undo: v43.1.1 => v43.2.0
@ckeditor/ckeditor5-upload: v43.1.1 => v43.2.0
@ckeditor/ckeditor5-utils: v43.1.1 => v43.2.0
@ckeditor/ckeditor5-watchdog: v43.1.1 => v43.2.0
@ckeditor/ckeditor5-widget: v43.1.1 => v43.2.0
@ckeditor/ckeditor5-word-count: v43.1.1 => v43.2.0
ckeditor5-collaboration: v43.1.1 => v43.2.0
ckeditor5-premium-features: v43.1.1 => v43.2.0

</details>

Keywords

FAQs

What is @ckeditor/ckeditor5-upload?

Is @ckeditor/ckeditor5-upload popular?

Is @ckeditor/ckeditor5-upload well maintained?

Package last updated on 02 Oct 2024

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

@ckeditor/ckeditor5-upload

What is @ckeditor/ckeditor5-upload?

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

Other packages similar to @ckeditor/ckeditor5-upload

quill-image-uploader

react-dropzone