@ckeditor/ckeditor5-easy-image

What is @ckeditor/ckeditor5-easy-image?

@ckeditor/ckeditor5-easy-image is a plugin for CKEditor 5 that simplifies the process of inserting images into the editor. It provides an easy-to-use interface for uploading images directly from the user's device or from a URL, and it integrates seamlessly with CKEditor's image handling capabilities.

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

Easy Image Upload

This feature allows users to upload images directly from their device to the editor. The code sample demonstrates how to configure the CKEditor with the EasyImage plugin and set up the necessary cloud services for image upload.

ClassicEditor.create(document.querySelector('#editor'), { extraPlugins: [ EasyImage ], cloudServices: { tokenUrl: 'https://example.com/cs-token-endpoint', uploadUrl: 'https://your-organization-id.cke-cs.com/easyimage/upload/' } })

Image Insertion from URL

This feature allows users to insert images into the editor from a URL. The code sample shows how to configure the CKEditor with the EasyImage plugin and use the uploadImage method to insert an image from a URL.

ClassicEditor.create(document.querySelector('#editor'), { extraPlugins: [ EasyImage ], cloudServices: { tokenUrl: 'https://example.com/cs-token-endpoint', uploadUrl: 'https://your-organization-id.cke-cs.com/easyimage/upload/' } }).then(editor => { editor.plugins.get('EasyImage').uploadImage('https://example.com/image.jpg'); });

Other packages similar to @ckeditor/ckeditor5-easy-image

@ckeditor/ckeditor5-image

@ckeditor/ckeditor5-image is another CKEditor 5 plugin that provides comprehensive image handling capabilities, including image resizing, alignment, and styling. While it does not offer the same simplified upload interface as @ckeditor/ckeditor5-easy-image, it provides more advanced image editing features.

react-dropzone

react-dropzone is a popular React component for handling file uploads, including images. It provides a drag-and-drop interface for uploading files and can be integrated with various image handling libraries. Unlike @ckeditor/ckeditor5-easy-image, it is not specific to CKEditor and requires additional configuration for image handling.

ngx-image-cropper

ngx-image-cropper is an Angular component for cropping images. It provides a user-friendly interface for selecting and cropping images before uploading them. While it does not offer direct integration with CKEditor, it can be used in conjunction with CKEditor to provide advanced image editing capabilities.

README

CKEditor 5 Easy Image feature with Cloud Services

This package implements the Easy Image feature for CKEditor 5.

Easy Image lets you easily insert images which are automatically rescaled, optimized, responsive and delivered through a blazing-fast CDN. It integrates automatically with the CKEditor Cloud Services.

Demo

Check out the demo in the Easy Image feature guide.

Documentation

See the Easy Image integration guide and the plugin documentation to learn how to enable 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.

Changelog

43.1.0 (September 5, 2024)

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

Release highlights

This release includes important bug fixes and enhancements for the editor:

• Block merge fields: In contrast to regular, inline merge fields, the block merge fields are designed to represent complex, block-level structures, such as a dynamically generated table, a row of products, or a personalized call-to-action segment. Block merge fields are supposed to be replaced by arbitrary HTML data when the document template is post-processed or exported to a PDF or Word file.

• Nested dropdown menus: this release introduces a new UI component: nested dropdown menus. They can be used by feature developers to easily provide an advanced user interface where UI elements are organized into a nested menu structure.

• Customizable accessible label: You can now configure the label for the accessible editable area through the editor settings, ensuring it fits your system’s needs.

• Improved table and cell border controls: It is now easier to manage both table and cell borders. The table user interface now clearly indicates the default border settings, allowing you to set “no borders” (None) for tables and cells without any additional configuration.

  ⚠️ In some cases this update may lead to data changes in the tables’ HTML markup when the editor loads them. However, visually nothing will change, and the experience will be the same.

The full list of enhancements can be found below.