@ckeditor/ckeditor5-image 39.0.1 → 40.0.0

package/src/image/utils.js

@@ -1,100 +1,121 @@
-/**
- * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-import { first } from 'ckeditor5/src/utils';
-/**
- * Creates a view element representing the inline image.
- *
- * ```html
- * <span class="image-inline"><img></img></span>
- * ```
- *
- * Note that `alt` and `src` attributes are converted separately, so they are not included.
- *
- * @internal
- */
-export function createInlineImageViewElement(writer) {
-    return writer.createContainerElement('span', { class: 'image-inline' }, writer.createEmptyElement('img'));
-}
-/**
- * Creates a view element representing the block image.
- *
- * ```html
- * <figure class="image"><img></img></figure>
- * ```
- *
- * Note that `alt` and `src` attributes are converted separately, so they are not included.
- *
- * @internal
- */
-export function createBlockImageViewElement(writer) {
-    return writer.createContainerElement('figure', { class: 'image' }, [
-        writer.createEmptyElement('img'),
-        writer.createSlot('children')
-    ]);
-}
-/**
- * A function returning a `MatcherPattern` for a particular type of View images.
- *
- * @internal
- * @param matchImageType The type of created image.
- */
-export function getImgViewElementMatcher(editor, matchImageType) {
-    const imageUtils = editor.plugins.get('ImageUtils');
-    const areBothImagePluginsLoaded = editor.plugins.has('ImageInlineEditing') && editor.plugins.has('ImageBlockEditing');
-    return element => {
-        // Check if the matched view element is an <img>.
-        if (!imageUtils.isInlineImageView(element)) {
-            return null;
-        }
-        // If just one of the plugins is loaded (block or inline), it will match all kinds of images.
-        if (!areBothImagePluginsLoaded) {
-            return getPositiveMatchPattern(element);
-        }
-        // The <img> can be standalone, wrapped in <figure>...</figure> (ImageBlock plugin) or
-        // wrapped in <figure><a>...</a></figure> (LinkImage plugin).
-        const imageType = element.getStyle('display') == 'block' || element.findAncestor(imageUtils.isBlockImageView) ?
-            'imageBlock' :
-            'imageInline';
-        if (imageType !== matchImageType) {
-            return null;
-        }
-        return getPositiveMatchPattern(element);
-    };
-    function getPositiveMatchPattern(element) {
-        const pattern = {
-            name: true
-        };
-        // This will trigger src consumption (See https://github.com/ckeditor/ckeditor5/issues/11530).
-        if (element.hasAttribute('src')) {
-            pattern.attributes = ['src'];
-        }
-        return pattern;
-    }
-}
-/**
- * Considering the current model selection, it returns the name of the model image element
- * (`'imageBlock'` or `'imageInline'`) that will make most sense from the UX perspective if a new
- * image was inserted (also: uploaded, dropped, pasted) at that selection.
- *
- * The assumption is that inserting images into empty blocks or on other block widgets should
- * produce block images. Inline images should be inserted in other cases, e.g. in paragraphs
- * that already contain some text.
- *
- * @internal
- */
-export function determineImageTypeForInsertionAtSelection(schema, selection) {
-    const firstBlock = first(selection.getSelectedBlocks());
-    // Insert a block image if the selection is not in/on block elements or it's on a block widget.
-    if (!firstBlock || schema.isObject(firstBlock)) {
-        return 'imageBlock';
-    }
-    // A block image should also be inserted into an empty block element
-    // (that is not an empty list item so the list won't get split).
-    if (firstBlock.isEmpty && firstBlock.name != 'listItem') {
-        return 'imageBlock';
-    }
-    // Otherwise insert an inline image.
-    return 'imageInline';
-}
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+import { first } from 'ckeditor5/src/utils';
+/**
+ * Creates a view element representing the inline image.
+ *
+ * ```html
+ * <span class="image-inline"><img></img></span>
+ * ```
+ *
+ * Note that `alt` and `src` attributes are converted separately, so they are not included.
+ *
+ * @internal
+ */
+export function createInlineImageViewElement(writer) {
+    return writer.createContainerElement('span', { class: 'image-inline' }, writer.createEmptyElement('img'));
+}
+/**
+ * Creates a view element representing the block image.
+ *
+ * ```html
+ * <figure class="image"><img></img></figure>
+ * ```
+ *
+ * Note that `alt` and `src` attributes are converted separately, so they are not included.
+ *
+ * @internal
+ */
+export function createBlockImageViewElement(writer) {
+    return writer.createContainerElement('figure', { class: 'image' }, [
+        writer.createEmptyElement('img'),
+        writer.createSlot('children')
+    ]);
+}
+/**
+ * A function returning a `MatcherPattern` for a particular type of View images.
+ *
+ * @internal
+ * @param matchImageType The type of created image.
+ */
+export function getImgViewElementMatcher(editor, matchImageType) {
+    const imageUtils = editor.plugins.get('ImageUtils');
+    const areBothImagePluginsLoaded = editor.plugins.has('ImageInlineEditing') && editor.plugins.has('ImageBlockEditing');
+    return element => {
+        // Check if the matched view element is an <img>.
+        if (!imageUtils.isInlineImageView(element)) {
+            return null;
+        }
+        // If just one of the plugins is loaded (block or inline), it will match all kinds of images.
+        if (!areBothImagePluginsLoaded) {
+            return getPositiveMatchPattern(element);
+        }
+        // The <img> can be standalone, wrapped in <figure>...</figure> (ImageBlock plugin) or
+        // wrapped in <figure><a>...</a></figure> (LinkImage plugin).
+        const imageType = element.getStyle('display') == 'block' || element.findAncestor(imageUtils.isBlockImageView) ?
+            'imageBlock' :
+            'imageInline';
+        if (imageType !== matchImageType) {
+            return null;
+        }
+        return getPositiveMatchPattern(element);
+    };
+    function getPositiveMatchPattern(element) {
+        const pattern = {
+            name: true
+        };
+        // This will trigger src consumption (See https://github.com/ckeditor/ckeditor5/issues/11530).
+        if (element.hasAttribute('src')) {
+            pattern.attributes = ['src'];
+        }
+        return pattern;
+    }
+}
+/**
+ * Considering the current model selection, it returns the name of the model image element
+ * (`'imageBlock'` or `'imageInline'`) that will make most sense from the UX perspective if a new
+ * image was inserted (also: uploaded, dropped, pasted) at that selection.
+ *
+ * The assumption is that inserting images into empty blocks or on other block widgets should
+ * produce block images. Inline images should be inserted in other cases, e.g. in paragraphs
+ * that already contain some text.
+ *
+ * @internal
+ */
+export function determineImageTypeForInsertionAtSelection(schema, selection) {
+    const firstBlock = first(selection.getSelectedBlocks());
+    // Insert a block image if the selection is not in/on block elements or it's on a block widget.
+    if (!firstBlock || schema.isObject(firstBlock)) {
+        return 'imageBlock';
+    }
+    // A block image should also be inserted into an empty block element
+    // (that is not an empty list item so the list won't get split).
+    if (firstBlock.isEmpty && firstBlock.name != 'listItem') {
+        return 'imageBlock';
+    }
+    // Otherwise insert an inline image.
+    return 'imageInline';
+}
+/**
+ * Returns parsed value of the size, but only if it contains unit: px.
+ */
+export function getSizeValueIfInPx(size) {
+    if (size && size.endsWith('px')) {
+        return parseInt(size);
+    }
+    return null;
+}
+/**
+ * Returns true if both styles (width and height) are set.
+ *
+ * If both image styles: width & height are set, they will override the image width & height attributes in the
+ * browser. In this case, the image looks the same as if these styles were applied to attributes instead of styles.
+ * That's why we can upcast these styles to width & height attributes instead of resizedWidth and resizedHeight.
+ */
+export function widthAndHeightStylesAreBothSet(viewElement) {
+    const widthStyle = getSizeValueIfInPx(viewElement.getStyle('width'));
+    const heightStyle = getSizeValueIfInPx(viewElement.getStyle('height'));
+    return !!(widthStyle && heightStyle);
+}

package/src/image.d.ts

@@ -1,34 +1,34 @@
-/**
- * @license Copyright (c) 2003-2023, 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
- */
-import { Plugin } from 'ckeditor5/src/core';
-import ImageBlock from './imageblock';
-import ImageInline from './imageinline';
-import '../theme/image.css';
-/**
- * The image plugin.
- *
- * For a detailed overview, check the {@glink features/images/images-overview image feature} documentation.
- *
- * This is a "glue" plugin which loads the following plugins:
- *
- * * {@link module:image/imageblock~ImageBlock},
- * * {@link module:image/imageinline~ImageInline},
- *
- * Usually, it is used in conjunction with other plugins from this package. See the {@glink api/image package page}
- * for more information.
- */
-export default class Image extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly [typeof ImageBlock, typeof ImageInline];
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "Image";
-}
+/**
+ * @license Copyright (c) 2003-2023, 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
+ */
+import { Plugin } from 'ckeditor5/src/core';
+import ImageBlock from './imageblock';
+import ImageInline from './imageinline';
+import '../theme/image.css';
+/**
+ * The image plugin.
+ *
+ * For a detailed overview, check the {@glink features/images/images-overview image feature} documentation.
+ *
+ * This is a "glue" plugin which loads the following plugins:
+ *
+ * * {@link module:image/imageblock~ImageBlock},
+ * * {@link module:image/imageinline~ImageInline},
+ *
+ * Usually, it is used in conjunction with other plugins from this package. See the {@glink api/image package page}
+ * for more information.
+ */
+export default class Image extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get requires(): readonly [typeof ImageBlock, typeof ImageInline];
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "Image";
+}

package/src/image.js

@@ -1,38 +1,38 @@
-/**
- * @license Copyright (c) 2003-2023, 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
- */
-import { Plugin } from 'ckeditor5/src/core';
-import ImageBlock from './imageblock';
-import ImageInline from './imageinline';
-import '../theme/image.css';
-/**
- * The image plugin.
- *
- * For a detailed overview, check the {@glink features/images/images-overview image feature} documentation.
- *
- * This is a "glue" plugin which loads the following plugins:
- *
- * * {@link module:image/imageblock~ImageBlock},
- * * {@link module:image/imageinline~ImageInline},
- *
- * Usually, it is used in conjunction with other plugins from this package. See the {@glink api/image package page}
- * for more information.
- */
-export default class Image extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get requires() {
-        return [ImageBlock, ImageInline];
-    }
-    /**
-     * @inheritDoc
-     */
-    static get pluginName() {
-        return 'Image';
-    }
-}
+/**
+ * @license Copyright (c) 2003-2023, 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
+ */
+import { Plugin } from 'ckeditor5/src/core';
+import ImageBlock from './imageblock';
+import ImageInline from './imageinline';
+import '../theme/image.css';
+/**
+ * The image plugin.
+ *
+ * For a detailed overview, check the {@glink features/images/images-overview image feature} documentation.
+ *
+ * This is a "glue" plugin which loads the following plugins:
+ *
+ * * {@link module:image/imageblock~ImageBlock},
+ * * {@link module:image/imageinline~ImageInline},
+ *
+ * Usually, it is used in conjunction with other plugins from this package. See the {@glink api/image package page}
+ * for more information.
+ */
+export default class Image extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get requires() {
+        return [ImageBlock, ImageInline];
+    }
+    /**
+     * @inheritDoc
+     */
+    static get pluginName() {
+        return 'Image';
+    }
+}

package/src/imageblock.d.ts

@@ -1,33 +1,33 @@
-/**
- * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @module image/imageblock
- */
-import { Plugin } from 'ckeditor5/src/core';
-import { Widget } from 'ckeditor5/src/widget';
-import ImageTextAlternative from './imagetextalternative';
-import ImageBlockEditing from './image/imageblockediting';
-import '../theme/image.css';
-/**
- * The image block plugin.
- *
- * This is a "glue" plugin which loads the following plugins:
- *
- * * {@link module:image/image/imageblockediting~ImageBlockEditing},
- * * {@link module:image/imagetextalternative~ImageTextAlternative}.
- *
- * Usually, it is used in conjunction with other plugins from this package. See the {@glink api/image package page}
- * for more information.
- */
-export default class ImageBlock extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly [typeof ImageBlockEditing, typeof Widget, typeof ImageTextAlternative];
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "ImageBlock";
-}
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module image/imageblock
+ */
+import { Plugin } from 'ckeditor5/src/core';
+import { Widget } from 'ckeditor5/src/widget';
+import ImageTextAlternative from './imagetextalternative';
+import ImageBlockEditing from './image/imageblockediting';
+import '../theme/image.css';
+/**
+ * The image block plugin.
+ *
+ * This is a "glue" plugin which loads the following plugins:
+ *
+ * * {@link module:image/image/imageblockediting~ImageBlockEditing},
+ * * {@link module:image/imagetextalternative~ImageTextAlternative}.
+ *
+ * Usually, it is used in conjunction with other plugins from this package. See the {@glink api/image package page}
+ * for more information.
+ */
+export default class ImageBlock extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get requires(): readonly [typeof ImageBlockEditing, typeof Widget, typeof ImageTextAlternative];
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "ImageBlock";
+}

package/src/imageblock.js

@@ -1,37 +1,37 @@
-/**
- * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @module image/imageblock
- */
-import { Plugin } from 'ckeditor5/src/core';
-import { Widget } from 'ckeditor5/src/widget';
-import ImageTextAlternative from './imagetextalternative';
-import ImageBlockEditing from './image/imageblockediting';
-import '../theme/image.css';
-/**
- * The image block plugin.
- *
- * This is a "glue" plugin which loads the following plugins:
- *
- * * {@link module:image/image/imageblockediting~ImageBlockEditing},
- * * {@link module:image/imagetextalternative~ImageTextAlternative}.
- *
- * Usually, it is used in conjunction with other plugins from this package. See the {@glink api/image package page}
- * for more information.
- */
-export default class ImageBlock extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get requires() {
-        return [ImageBlockEditing, Widget, ImageTextAlternative];
-    }
-    /**
-     * @inheritDoc
-     */
-    static get pluginName() {
-        return 'ImageBlock';
-    }
-}
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module image/imageblock
+ */
+import { Plugin } from 'ckeditor5/src/core';
+import { Widget } from 'ckeditor5/src/widget';
+import ImageTextAlternative from './imagetextalternative';
+import ImageBlockEditing from './image/imageblockediting';
+import '../theme/image.css';
+/**
+ * The image block plugin.
+ *
+ * This is a "glue" plugin which loads the following plugins:
+ *
+ * * {@link module:image/image/imageblockediting~ImageBlockEditing},
+ * * {@link module:image/imagetextalternative~ImageTextAlternative}.
+ *
+ * Usually, it is used in conjunction with other plugins from this package. See the {@glink api/image package page}
+ * for more information.
+ */
+export default class ImageBlock extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get requires() {
+        return [ImageBlockEditing, Widget, ImageTextAlternative];
+    }
+    /**
+     * @inheritDoc
+     */
+    static get pluginName() {
+        return 'ImageBlock';
+    }
+}