Module ckeditor5-coremedia-images
CoreMedia CKEditor 5 Images
Module: @coremedia/ckeditor5-coremedia-images
General Information
The ckeditor5-coremedia-images package is responsible for showing and editing
images in CoreMedia RichText.
Installation
pnpm install @coremedia/ckeditor5-coremedia-images
ClassicEditor.create(document.querySelector('#editor'), {
plugins: [
ContentImagePlugin,
/* ... */
],
}).then((editor) => {
/* ... */
});
Note, that you most likely will also install some of CKEditor's image plugins.
Plugins
ContentImagePluginAggregator plugin for:
ContentImageEditingPluginContentImageClipboardPluginContentImageOpenInTabUI
ContentImageEditingPluginPlugin to support images from CoreMedia RichText.
ContentImageClipboardPluginPlugin that registers a creator function to support images in the
ContentClipboardplugin.ContentImageOpenInTabUIPlugin that registers a button for the "OpenInTabCommand" in the componentFactory.
ModelBoundSubscriptionPluginPlugin to register active subscriptions for cleanup. Controlled by
ContentImageEditingPlugin.
Attributes for Images from RichText and mappings to model/view/data-view
Note, that the representation in model depends on the installed plugins. If model elements are provided by General RichText Support (based on CKEditor's General HTML support), it most likely means, that a corresponding plugin to edit this attribute has not been installed.
| Data | Data-View | Model | Plugin | Data Example |
|---|---|---|---|---|
alt |
alt |
htmlAttributes by GRS | default | alt="Some Alternative" |
dir |
dir |
htmlAttributes by GRS | GeneralRichTextPlugin | dir="ltr" |
xlink:actuate |
data-xlink-actuate |
htmlAttributes by GRS | GeneralRichTextPlugin | xlink:actuate="onLoad" |
xlink:href |
data-xlink-href |
xlink-href |
ContentImageEditingPlugin | xlink:href="content/42#properties.data" |
xlink:role |
data-xlink-role |
htmlAttributes by GRS | GeneralRichTextPlugin | xlink:role="https://example.org/" |
xlink:show |
data-xlink-show |
htmlAttributes by GRS | GeneralRichTextPlugin | xlink:show="embed" |
xlink:title |
title |
htmlAttributes by GRS | GeneralRichTextPlugin | xlink:title="All Attributes" |
xlink:type |
data-xlink-type |
htmlAttributes by GRS | GeneralRichTextPlugin | xlink:type="simple" |
class |
class |
htmlAttributes by GRS | GeneralRichTextPlugin | class="grs xmp" |
xml:lang |
lang |
htmlAttributes by GRS | GeneralRichTextPlugin | xml:lang="en" |
height |
height |
htmlAttributes by GRS | GeneralRichTextPlugin | height="48" |
width |
width |
htmlAttributes by GRS | GeneralRichTextPlugin | width="48" |
This package provides support for images in CoreMedia RichText.