/** * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved. * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license */ /** * @module image/image/imageinlineediting */ import { Plugin } from 'ckeditor5/src/core.js'; import { ClipboardPipeline } from 'ckeditor5/src/clipboard.js'; import ImageEditing from './imageediting.js'; import ImageSizeAttributes from '../imagesizeattributes.js'; import ImageUtils from '../imageutils.js'; import ImagePlaceholder from './imageplaceholder.js'; /** * The image inline plugin. * * It registers: * * * `` as an inline element in the document schema, and allows `alt`, `src` and `srcset` attributes. * * converters for editing and data pipelines. * * {@link module:image/image/imagetypecommand~ImageTypeCommand `'imageTypeInline'`} command that converts block images into * inline images. */ export default class ImageInlineEditing extends Plugin { /** * @inheritDoc */ static get requires(): readonly [typeof ImageEditing, typeof ImageSizeAttributes, typeof ImageUtils, typeof ImagePlaceholder, typeof ClipboardPipeline]; /** * @inheritDoc */ static get pluginName(): "ImageInlineEditing"; /** * @inheritDoc */ init(): void; /** * Configures conversion pipelines to support upcasting and downcasting * inline images (inline image widgets) and their attributes. */ private _setupConversion; /** * Integrates the plugin with the clipboard pipeline. * * Idea is that the feature should recognize the user's intent when an **block** image is * pasted or dropped. If such an image is pasted/dropped into a non-empty block * (e.g. a paragraph with some text) it gets converted into an inline image on the fly. * * We assume this is the user's intent if they decided to put their image there. * * **Note**: If a block image has a caption, it will not be converted to an inline image * to avoid the confusion. Captions are added on purpose and they should never be lost * in the clipboard pipeline. * * See the `ImageBlockEditing` for the similar integration that works in the opposite direction. * * The feature also sets image `width` and `height` attributes when pasting. */ private _setupClipboardIntegration; }