ckeditor5-simple-image-upload-plugin
A generic ckeditor plugin to upload images with a custom api backend.
Features
- Simple UploadAdapter to upload files with a custom backend.
How to use
To be able to use this plugin you need a custom build of ckeditor.
Further instructions can be found here: https://ckeditor.com/docs/ckeditor5/latest/builds/guides/integration/installing-plugins.html
Installation:
npm i @samhammer/ckeditor5-simple-image-upload-plugin
Configuration
This plugin uses a hook which can be configured like shown below. This hook is called with the JS-File-Object as parameter and has to return a Promise which resolves to the full URL of the uploaded image.
Example:
InlineEditor
.create( editorElement, {
simpleImageUpload: {
onUpload: file => {
// do any upload stuff here with the JS-File-Object
return Promise.resolve("http://path/to/the/uploaded/image.jpg");
},
onAbort: () => { // OPTIONAL
// abort the upload here. The promise from onImageUpload should be rejected after that.
}
}
} )
.then( ... )
.catch( ... );
How to publish
For publishing an npm account that is referenced to the organization is required.
See the following how to:
https://docs.npmjs.com/getting-started/publishing-npm-packages
If everything is configured correctly just count up the version number in our package.json and execute one of the following commands:
npm publish --access public
License
ckeditor5-simple-image-upload-plugin is released under the MIT License. See LICENSE file for details.