@ckeditor/ckeditor5-image 31.0.0 → 33.0.0

package/src/image/ui/utils.js

@@ -1,5 +1,5 @@
 /**
- * @license Copyright (c) 2003-2021, CKSource - Frederico Knabben. All rights reserved.
+ * @license Copyright (c) 2003-2022, CKSource Holding sp. z o.o. All rights reserved.
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
  */
 

package/src/image/utils.js

@@ -1,5 +1,5 @@
 /**
- * @license Copyright (c) 2003-2021, CKSource - Frederico Knabben. All rights reserved.
+ * @license Copyright (c) 2003-2022, CKSource Holding sp. z o.o. All rights reserved.
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
  */
 
@@ -10,33 +10,39 @@
 import { first } from 'ckeditor5/src/utils';
 
 /**
- * Creates a view element representing the image of provided image type.
+ * Creates a view element representing the inline image.
  *
- * An 'imageBlock' type (block image):
+ *		<span class="image-inline"><img></img></span>
  *
- *		<figure class="image"><img></img></figure>
+ * Note that `alt` and `src` attributes are converted separately, so they are not included.
  *
- * An 'imageInline' type (inline image):
+ * @protected
+ * @param {module:engine/view/downcastwriter~DowncastWriter} writer
+ * @returns {module:engine/view/containerelement~ContainerElement}
+ */
+export function createInlineImageViewElement( writer ) {
+	return writer.createContainerElement( 'span', { class: 'image-inline' },
+		writer.createEmptyElement( 'img' ),
+		{ isAllowedInsideAttributeElement: true }
+	);
+}
+
+/**
+ * Creates a view element representing the block image.
  *
- *		<span class="image-inline"><img></img></span>
+ *		<figure class="image"><img></img></figure>
  *
  * Note that `alt` and `src` attributes are converted separately, so they are not included.
  *
  * @protected
  * @param {module:engine/view/downcastwriter~DowncastWriter} writer
- * @param {'imageBlock'|'imageInline'} imageType The type of created image.
  * @returns {module:engine/view/containerelement~ContainerElement}
  */
-export function createImageViewElement( writer, imageType ) {
-	const emptyElement = writer.createEmptyElement( 'img' );
-
-	const container = imageType === 'imageBlock' ?
-		writer.createContainerElement( 'figure', { class: 'image' } ) :
-		writer.createContainerElement( 'span', { class: 'image-inline' }, { isAllowedInsideAttributeElement: true } );
-
-	writer.insert( writer.createPositionAt( container, 0 ), emptyElement );
-
-	return container;
+export function createBlockImageViewElement( writer ) {
+	return writer.createContainerElement( 'figure', { class: 'image' }, [
+		writer.createEmptyElement( 'img' ),
+		writer.createSlot()
+	] );
 }
 
 /**

package/src/image.js

@@ -1,5 +1,5 @@
 /**
- * @license Copyright (c) 2003-2021, CKSource - Frederico Knabben. All rights reserved.
+ * @license Copyright (c) 2003-2022, CKSource Holding sp. z o.o. All rights reserved.
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
  */
 

package/src/imageblock.js

@@ -1,5 +1,5 @@
 /**
- * @license Copyright (c) 2003-2021, CKSource - Frederico Knabben. All rights reserved.
+ * @license Copyright (c) 2003-2022, CKSource Holding sp. z o.o. All rights reserved.
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
  */
 

package/src/imagecaption/imagecaptionediting.js

@@ -1,5 +1,5 @@
 /**
- * @license Copyright (c) 2003-2021, CKSource - Frederico Knabben. All rights reserved.
+ * @license Copyright (c) 2003-2022, CKSource Holding sp. z o.o. All rights reserved.
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
  */
 
@@ -14,7 +14,7 @@ import { toWidgetEditable } from 'ckeditor5/src/widget';
 import ToggleImageCaptionCommand from './toggleimagecaptioncommand';
 
 import ImageUtils from '../imageutils';
-import { getCaptionFromImageModelElement, matchImageCaptionViewElement } from './utils';
+import ImageCaptionUtils from './imagecaptionutils';
 
 /**
  * The image caption engine plugin. It is responsible for:
@@ -30,7 +30,7 @@ export default class ImageCaptionEditing extends Plugin {
 	 * @inheritDoc
 	 */
 	static get requires() {
-		return [ ImageUtils ];
+		return [ ImageUtils, ImageCaptionUtils ];
 	}
 
 	/**
@@ -93,11 +93,12 @@ export default class ImageCaptionEditing extends Plugin {
 		const editor = this.editor;
 		const view = editor.editing.view;
 		const imageUtils = editor.plugins.get( 'ImageUtils' );
+		const imageCaptionUtils = editor.plugins.get( 'ImageCaptionUtils' );
 		const t = editor.t;
 
 		// View -> model converter for the data pipeline.
 		editor.conversion.for( 'upcast' ).elementToElement( {
-			view: element => matchImageCaptionViewElement( imageUtils, element ),
+			view: element => imageCaptionUtils.matchImageCaptionViewElement( element ),
 			model: 'caption'
 		} );
 
@@ -134,9 +135,6 @@ export default class ImageCaptionEditing extends Plugin {
 				return toWidgetEditable( figcaptionElement, writer );
 			}
 		} );
-
-		editor.editing.mapper.on( 'modelToViewPosition', mapModelPositionToView( view ) );
-		editor.data.mapper.on( 'modelToViewPosition', mapModelPositionToView( view ) );
 	}
 
 	/**
@@ -149,6 +147,7 @@ export default class ImageCaptionEditing extends Plugin {
 	_setupImageTypeCommandsIntegration() {
 		const editor = this.editor;
 		const imageUtils = editor.plugins.get( 'ImageUtils' );
+		const imageCaptionUtils = editor.plugins.get( 'ImageCaptionUtils' );
 		const imageTypeInlineCommand = editor.commands.get( 'imageTypeInline' );
 		const imageTypeBlockCommand = editor.commands.get( 'imageTypeBlock' );
 
@@ -166,7 +165,7 @@ export default class ImageCaptionEditing extends Plugin {
 			}
 
 			if ( imageUtils.isBlockImage( oldElement ) ) {
-				const oldCaptionElement = getCaptionFromImageModelElement( oldElement );
+				const oldCaptionElement = imageCaptionUtils.getCaptionFromImageModelElement( oldElement );
 
 				// If the old element was a captioned block image (the caption was visible),
 				// simply save it so it can be restored.
@@ -244,28 +243,3 @@ export default class ImageCaptionEditing extends Plugin {
 		this._savedCaptionsMap.set( imageModelElement, caption.toJSON() );
 	}
 }
-
-// Creates a mapper callback that reverses the order of `<img>` and `<figcaption>` in the image.
-// Without it, `<figcaption>` would precede the `<img>` in the conversion.
-//
-// <imageBlock>^</imageBlock> -> <figure><img>^<caption></caption></figure>
-//
-// @private
-// @param {module:engine/view/view~View} editingView
-// @returns {Function}
-function mapModelPositionToView( editingView ) {
-	return ( evt, data ) => {
-		const modelPosition = data.modelPosition;
-		const parent = modelPosition.parent;
-
-		if ( !parent.is( 'element', 'imageBlock' ) ) {
-			return;
-		}
-
-		const viewElement = data.mapper.toViewElement( parent );
-
-		// The "img" element is inserted by ImageBlockEditing during the downcast conversion via
-		// an explicit view position so the "0" position does not need any mapping.
-		data.viewPosition = editingView.createPositionAt( viewElement, modelPosition.offset + 1 );
-	};
-}

package/src/imagecaption/imagecaptionui.js

@@ -1,5 +1,5 @@
 /**
- * @license Copyright (c) 2003-2021, CKSource - Frederico Knabben. All rights reserved.
+ * @license Copyright (c) 2003-2022, CKSource Holding sp. z o.o. All rights reserved.
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
  */
 
@@ -9,9 +9,7 @@
 
 import { Plugin, icons } from 'ckeditor5/src/core';
 import { ButtonView } from 'ckeditor5/src/ui';
-import ImageUtils from '../imageutils';
-
-import { getCaptionFromModelSelection } from './utils';
+import ImageCaptionUtils from './imagecaptionutils';
 
 /**
  * The image caption UI plugin. It introduces the `'toggleImageCaption'` UI button.
@@ -23,7 +21,7 @@ export default class ImageCaptionUI extends Plugin {
 	 * @inheritDoc
 	 */
 	static get requires() {
-		return [ ImageUtils ];
+		return [ ImageCaptionUtils ];
 	}
 
 	/**
@@ -39,7 +37,7 @@ export default class ImageCaptionUI extends Plugin {
 	init() {
 		const editor = this.editor;
 		const editingView = editor.editing.view;
-		const imageUtils = editor.plugins.get( 'ImageUtils' );
+		const imageCaptionUtils = editor.plugins.get( 'ImageCaptionUtils' );
 		const t = editor.t;
 
 		editor.ui.componentFactory.add( 'toggleImageCaption', locale => {
@@ -59,7 +57,7 @@ export default class ImageCaptionUI extends Plugin {
 				editor.execute( 'toggleImageCaption', { focusCaptionOnShow: true } );
 
 				// Scroll to the selection and highlight the caption if the caption showed up.
-				const modelCaptionElement = getCaptionFromModelSelection( imageUtils, editor.model.document.selection );
+				const modelCaptionElement = imageCaptionUtils.getCaptionFromModelSelection( editor.model.document.selection );
 
 				if ( modelCaptionElement ) {
 					const figcaptionElement = editor.editing.mapper.toViewElement( modelCaptionElement );

package/src/imagecaption/imagecaptionutils.js

@@ -0,0 +1,89 @@
+/**
+ * @license Copyright (c) 2003-2022, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+
+/**
+ * @module image/imagecaptionutils/utils
+ */
+
+import { Plugin } from 'ckeditor5/src/core';
+
+import ImageUtils from '../imageutils';
+
+/**
+ * The image caption utilities plugin.
+ *
+ * @extends module:core/plugin~Plugin
+ */
+export default class ImageCaptionUtils extends Plugin {
+	/**
+	 * @inheritDoc
+	 */
+	static get pluginName() {
+		return 'ImageCaptionUtils';
+	}
+
+	/**
+	 * @inheritDoc
+	 */
+	static get requires() {
+		return [ ImageUtils ];
+	}
+
+	/**
+	 * Returns the caption model element from a given image element. Returns `null` if no caption is found.
+	 *
+	 * @param {module:engine/model/element~Element} imageModelElement
+	 * @returns {module:engine/model/element~Element|null}
+	 */
+	getCaptionFromImageModelElement( imageModelElement ) {
+		for ( const node of imageModelElement.getChildren() ) {
+			if ( !!node && node.is( 'element', 'caption' ) ) {
+				return node;
+			}
+		}
+
+		return null;
+	}
+
+	/**
+	 * Returns the caption model element for a model selection. Returns `null` if the selection has no caption element ancestor.
+	 *
+	 * @param {module:engine/model/selection~Selection} selection
+	 * @returns {module:engine/model/element~Element|null}
+	 */
+	getCaptionFromModelSelection( selection ) {
+		const imageUtils = this.editor.plugins.get( 'ImageUtils' );
+		const captionElement = selection.getFirstPosition().findAncestor( 'caption' );
+
+		if ( !captionElement ) {
+			return null;
+		}
+
+		if ( imageUtils.isBlockImage( captionElement.parent ) ) {
+			return captionElement;
+		}
+
+		return null;
+	}
+
+	/**
+	 * {@link module:engine/view/matcher~Matcher} pattern. Checks if a given element is a `<figcaption>` element that is placed
+	 * inside the image `<figure>` element.
+	 *
+	 * @param {module:engine/view/element~Element} element
+	 * @returns {Object|null} Returns the object accepted by {@link module:engine/view/matcher~Matcher} or `null` if the element
+	 * cannot be matched.
+	 */
+	matchImageCaptionViewElement( element ) {
+		const imageUtils = this.editor.plugins.get( 'ImageUtils' );
+
+		// Convert only captions for images.
+		if ( element.name == 'figcaption' && imageUtils.isBlockImageView( element.parent ) ) {
+			return { name: true };
+		}
+
+		return null;
+	}
+}

package/src/imagecaption/toggleimagecaptioncommand.js

@@ -1,5 +1,5 @@
 /**
- * @license Copyright (c) 2003-2021, CKSource - Frederico Knabben. All rights reserved.
+ * @license Copyright (c) 2003-2022, CKSource Holding sp. z o.o. All rights reserved.
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
  */
 
@@ -10,7 +10,6 @@
 import { Command } from 'ckeditor5/src/core';
 
 import ImageBlockEditing from '../image/imageblockediting';
-import { getCaptionFromImageModelElement, getCaptionFromModelSelection } from './utils';
 
 /**
  * The toggle image caption command.
@@ -41,7 +40,7 @@ export default class ToggleImageCaptionCommand extends Command {
 	 */
 	refresh() {
 		const editor = this.editor;
-		const imageUtils = editor.plugins.get( 'ImageUtils' );
+		const imageCaptionUtils = editor.plugins.get( 'ImageCaptionUtils' );
 
 		// Only block images can get captions.
 		if ( !editor.plugins.has( ImageBlockEditing ) ) {
@@ -55,7 +54,7 @@ export default class ToggleImageCaptionCommand extends Command {
 		const selectedElement = selection.getSelectedElement();
 
 		if ( !selectedElement ) {
-			const ancestorCaptionElement = getCaptionFromModelSelection( imageUtils, selection );
+			const ancestorCaptionElement = imageCaptionUtils.getCaptionFromModelSelection( selection );
 
 			this.isEnabled = !!ancestorCaptionElement;
 			this.value = !!ancestorCaptionElement;
@@ -70,7 +69,7 @@ export default class ToggleImageCaptionCommand extends Command {
 		if ( !this.isEnabled ) {
 			this.value = false;
 		} else {
-			this.value = !!getCaptionFromImageModelElement( selectedElement );
+			this.value = !!imageCaptionUtils.getCaptionFromImageModelElement( selectedElement );
 		}
 	}
 
@@ -145,14 +144,14 @@ export default class ToggleImageCaptionCommand extends Command {
 		const editor = this.editor;
 		const selection = editor.model.document.selection;
 		const imageCaptionEditing = editor.plugins.get( 'ImageCaptionEditing' );
-		const imageUtils = editor.plugins.get( 'ImageUtils' );
+		const imageCaptionUtils = editor.plugins.get( 'ImageCaptionUtils' );
 		let selectedImage = selection.getSelectedElement();
 		let captionElement;
 
 		if ( selectedImage ) {
-			captionElement = getCaptionFromImageModelElement( selectedImage );
+			captionElement = imageCaptionUtils.getCaptionFromImageModelElement( selectedImage );
 		} else {
-			captionElement = getCaptionFromModelSelection( imageUtils, selection );
+			captionElement = imageCaptionUtils.getCaptionFromModelSelection( selection );
 			selectedImage = captionElement.parent;
 		}
 

package/src/imagecaption.js

@@ -1,5 +1,5 @@
 /**
- * @license Copyright (c) 2003-2021, CKSource - Frederico Knabben. All rights reserved.
+ * @license Copyright (c) 2003-2022, CKSource Holding sp. z o.o. All rights reserved.
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
  */
 

package/src/imageinline.js

@@ -1,5 +1,5 @@
 /**
- * @license Copyright (c) 2003-2021, CKSource - Frederico Knabben. All rights reserved.
+ * @license Copyright (c) 2003-2022, CKSource Holding sp. z o.o. All rights reserved.
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
  */
 

package/src/imageinsert/imageinsertui.js

@@ -1,5 +1,5 @@
 /**
- * @license Copyright (c) 2003-2021, CKSource - Frederico Knabben. All rights reserved.
+ * @license Copyright (c) 2003-2022, CKSource Holding sp. z o.o. All rights reserved.
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
  */
 

package/src/imageinsert/ui/imageinsertformrowview.js

@@ -1,5 +1,5 @@
 /**
- * @license Copyright (c) 2003-2021, CKSource - Frederico Knabben. All rights reserved.
+ * @license Copyright (c) 2003-2022, CKSource Holding sp. z o.o. All rights reserved.
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
  */
 

package/src/imageinsert/ui/imageinsertpanelview.js

@@ -1,5 +1,5 @@
 /**
- * @license Copyright (c) 2003-2021, CKSource - Frederico Knabben. All rights reserved.
+ * @license Copyright (c) 2003-2022, CKSource Holding sp. z o.o. All rights reserved.
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
  */
 
@@ -203,6 +203,16 @@ export default class ImageInsertPanelView extends View {
 		}, { priority: 'high' } );
 	}
 
+	/**
+	 * @inheritDoc
+	 */
+	destroy() {
+		super.destroy();
+
+		this.focusTracker.destroy();
+		this.keystrokes.destroy();
+	}
+
 	/**
 	 * Returns a view of the integration.
 	 *

package/src/imageinsert/utils.js

@@ -1,5 +1,5 @@
 /**
- * @license Copyright (c) 2003-2021, CKSource - Frederico Knabben. All rights reserved.
+ * @license Copyright (c) 2003-2022, CKSource Holding sp. z o.o. All rights reserved.
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
  */
 

package/src/imageinsert.js

@@ -1,5 +1,5 @@
 /**
- * @license Copyright (c) 2003-2021, CKSource - Frederico Knabben. All rights reserved.
+ * @license Copyright (c) 2003-2022, CKSource Holding sp. z o.o. All rights reserved.
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
  */
 

package/src/imageresize/imageresizebuttons.js

@@ -1,5 +1,5 @@
 /**
- * @license Copyright (c) 2003-2021, CKSource - Frederico Knabben. All rights reserved.
+ * @license Copyright (c) 2003-2022, CKSource Holding sp. z o.o. All rights reserved.
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
  */
 

package/src/imageresize/imageresizeediting.js

@@ -1,5 +1,5 @@
 /**
- * @license Copyright (c) 2003-2021, CKSource - Frederico Knabben. All rights reserved.
+ * @license Copyright (c) 2003-2022, CKSource Holding sp. z o.o. All rights reserved.
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
  */
 

package/src/imageresize/imageresizehandles.js

@@ -1,5 +1,5 @@
 /**
- * @license Copyright (c) 2003-2021, CKSource - Frederico Knabben. All rights reserved.
+ * @license Copyright (c) 2003-2022, CKSource Holding sp. z o.o. All rights reserved.
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
  */
 

package/src/imageresize/resizeimagecommand.js

@@ -1,5 +1,5 @@
 /**
- * @license Copyright (c) 2003-2021, CKSource - Frederico Knabben. All rights reserved.
+ * @license Copyright (c) 2003-2022, CKSource Holding sp. z o.o. All rights reserved.
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
  */
 

package/src/imageresize.js

@@ -1,5 +1,5 @@
 /**
- * @license Copyright (c) 2003-2021, CKSource - Frederico Knabben. All rights reserved.
+ * @license Copyright (c) 2003-2022, CKSource Holding sp. z o.o. All rights reserved.
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
  */
 

package/src/imagestyle/converters.js

@@ -1,5 +1,5 @@
 /**
- * @license Copyright (c) 2003-2021, CKSource - Frederico Knabben. All rights reserved.
+ * @license Copyright (c) 2003-2022, CKSource Holding sp. z o.o. All rights reserved.
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
  */
 

package/src/imagestyle/imagestylecommand.js

@@ -1,5 +1,5 @@
 /**
- * @license Copyright (c) 2003-2021, CKSource - Frederico Knabben. All rights reserved.
+ * @license Copyright (c) 2003-2022, CKSource Holding sp. z o.o. All rights reserved.
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
  */
 

package/src/imagestyle/imagestyleediting.js

@@ -1,5 +1,5 @@
 /**
- * @license Copyright (c) 2003-2021, CKSource - Frederico Knabben. All rights reserved.
+ * @license Copyright (c) 2003-2022, CKSource Holding sp. z o.o. All rights reserved.
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
  */
 

package/src/imagestyle/imagestyleui.js

@@ -1,5 +1,5 @@
 /**
- * @license Copyright (c) 2003-2021, CKSource - Frederico Knabben. All rights reserved.
+ * @license Copyright (c) 2003-2022, CKSource Holding sp. z o.o. All rights reserved.
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
  */