@ckeditor/ckeditor5-image 40.0.0 → 40.2.0

package/src/imagesizeattributes.js

@@ -1,143 +1,142 @@
-/**
- * @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/imagesizeattributes
- */
-import { Plugin } from 'ckeditor5/src/core';
-import ImageUtils from './imageutils';
-import { widthAndHeightStylesAreBothSet, getSizeValueIfInPx } from './image/utils';
-/**
- * This plugin enables `width` and `height` attributes in inline and block image elements.
- */
-export default class ImageSizeAttributes extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get requires() {
-        return [ImageUtils];
-    }
-    /**
-     * @inheritDoc
-     */
-    static get pluginName() {
-        return 'ImageSizeAttributes';
-    }
-    /**
-     * @inheritDoc
-     */
-    afterInit() {
-        this._registerSchema();
-        this._registerConverters('imageBlock');
-        this._registerConverters('imageInline');
-    }
-    /**
-     * Registers the `width` and `height` attributes for inline and block images.
-     */
-    _registerSchema() {
-        if (this.editor.plugins.has('ImageBlockEditing')) {
-            this.editor.model.schema.extend('imageBlock', { allowAttributes: ['width', 'height'] });
-        }
-        if (this.editor.plugins.has('ImageInlineEditing')) {
-            this.editor.model.schema.extend('imageInline', { allowAttributes: ['width', 'height'] });
-        }
-    }
-    /**
-     * Registers converters for `width` and `height` attributes.
-     */
-    _registerConverters(imageType) {
-        const editor = this.editor;
-        const imageUtils = editor.plugins.get('ImageUtils');
-        const viewElementName = imageType === 'imageBlock' ? 'figure' : 'img';
-        editor.conversion.for('upcast')
-            .attributeToAttribute({
-            view: {
-                name: viewElementName,
-                styles: {
-                    width: /.+/
-                }
-            },
-            model: {
-                key: 'width',
-                value: (viewElement) => {
-                    if (widthAndHeightStylesAreBothSet(viewElement)) {
-                        return getSizeValueIfInPx(viewElement.getStyle('width'));
-                    }
-                    return null;
-                }
-            }
-        })
-            .attributeToAttribute({
-            view: {
-                name: viewElementName,
-                key: 'width'
-            },
-            model: 'width'
-        })
-            .attributeToAttribute({
-            view: {
-                name: viewElementName,
-                styles: {
-                    height: /.+/
-                }
-            },
-            model: {
-                key: 'height',
-                value: (viewElement) => {
-                    if (widthAndHeightStylesAreBothSet(viewElement)) {
-                        return getSizeValueIfInPx(viewElement.getStyle('height'));
-                    }
-                    return null;
-                }
-            }
-        })
-            .attributeToAttribute({
-            view: {
-                name: viewElementName,
-                key: 'height'
-            },
-            model: 'height'
-        });
-        // Dedicated converters to propagate attributes to the <img> element.
-        editor.conversion.for('editingDowncast').add(dispatcher => {
-            attachDowncastConverter(dispatcher, 'width', 'width', true);
-            attachDowncastConverter(dispatcher, 'height', 'height', true);
-        });
-        editor.conversion.for('dataDowncast').add(dispatcher => {
-            attachDowncastConverter(dispatcher, 'width', 'width', false);
-            attachDowncastConverter(dispatcher, 'height', 'height', false);
-        });
-        function attachDowncastConverter(dispatcher, modelAttributeName, viewAttributeName, setRatioForInlineImage) {
-            dispatcher.on(`attribute:${modelAttributeName}:${imageType}`, (evt, data, conversionApi) => {
-                if (!conversionApi.consumable.consume(data.item, evt.name)) {
-                    return;
-                }
-                const viewWriter = conversionApi.writer;
-                const viewElement = conversionApi.mapper.toViewElement(data.item);
-                const img = imageUtils.findViewImgElement(viewElement);
-                if (data.attributeNewValue !== null) {
-                    viewWriter.setAttribute(viewAttributeName, data.attributeNewValue, img);
-                }
-                else {
-                    viewWriter.removeAttribute(viewAttributeName, img);
-                }
-                // Do not set aspect-ratio for pictures. See https://github.com/ckeditor/ckeditor5/issues/14579.
-                if (data.item.hasAttribute('sources')) {
-                    return;
-                }
-                const isResized = data.item.hasAttribute('resizedWidth');
-                // Do not set aspect ratio for inline images which are not resized (data pipeline).
-                if (imageType === 'imageInline' && !isResized && !setRatioForInlineImage) {
-                    return;
-                }
-                const width = data.item.getAttribute('width');
-                const height = data.item.getAttribute('height');
-                const aspectRatio = img.getStyle('aspect-ratio');
-                if (width && height && !aspectRatio) {
-                    viewWriter.setStyle('aspect-ratio', `${width}/${height}`, img);
-                }
-            });
-        }
-    }
-}
+/**
+ * @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/imagesizeattributes
+ */
+import { Plugin } from 'ckeditor5/src/core';
+import ImageUtils from './imageutils';
+import { widthAndHeightStylesAreBothSet, getSizeValueIfInPx } from './image/utils';
+/**
+ * This plugin enables `width` and `height` attributes in inline and block image elements.
+ */
+export default class ImageSizeAttributes extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get requires() {
+        return [ImageUtils];
+    }
+    /**
+     * @inheritDoc
+     */
+    static get pluginName() {
+        return 'ImageSizeAttributes';
+    }
+    /**
+     * @inheritDoc
+     */
+    afterInit() {
+        this._registerSchema();
+        this._registerConverters('imageBlock');
+        this._registerConverters('imageInline');
+    }
+    /**
+     * Registers the `width` and `height` attributes for inline and block images.
+     */
+    _registerSchema() {
+        if (this.editor.plugins.has('ImageBlockEditing')) {
+            this.editor.model.schema.extend('imageBlock', { allowAttributes: ['width', 'height'] });
+        }
+        if (this.editor.plugins.has('ImageInlineEditing')) {
+            this.editor.model.schema.extend('imageInline', { allowAttributes: ['width', 'height'] });
+        }
+    }
+    /**
+     * Registers converters for `width` and `height` attributes.
+     */
+    _registerConverters(imageType) {
+        const editor = this.editor;
+        const imageUtils = editor.plugins.get('ImageUtils');
+        const viewElementName = imageType === 'imageBlock' ? 'figure' : 'img';
+        editor.conversion.for('upcast')
+            .attributeToAttribute({
+            view: {
+                name: viewElementName,
+                styles: {
+                    width: /.+/
+                }
+            },
+            model: {
+                key: 'width',
+                value: (viewElement) => {
+                    if (widthAndHeightStylesAreBothSet(viewElement)) {
+                        return getSizeValueIfInPx(viewElement.getStyle('width'));
+                    }
+                    return null;
+                }
+            }
+        })
+            .attributeToAttribute({
+            view: {
+                name: viewElementName,
+                key: 'width'
+            },
+            model: 'width'
+        })
+            .attributeToAttribute({
+            view: {
+                name: viewElementName,
+                styles: {
+                    height: /.+/
+                }
+            },
+            model: {
+                key: 'height',
+                value: (viewElement) => {
+                    if (widthAndHeightStylesAreBothSet(viewElement)) {
+                        return getSizeValueIfInPx(viewElement.getStyle('height'));
+                    }
+                    return null;
+                }
+            }
+        })
+            .attributeToAttribute({
+            view: {
+                name: viewElementName,
+                key: 'height'
+            },
+            model: 'height'
+        });
+        // Dedicated converters to propagate attributes to the <img> element.
+        editor.conversion.for('editingDowncast').add(dispatcher => {
+            attachDowncastConverter(dispatcher, 'width', 'width', true);
+            attachDowncastConverter(dispatcher, 'height', 'height', true);
+        });
+        editor.conversion.for('dataDowncast').add(dispatcher => {
+            attachDowncastConverter(dispatcher, 'width', 'width', false);
+            attachDowncastConverter(dispatcher, 'height', 'height', false);
+        });
+        function attachDowncastConverter(dispatcher, modelAttributeName, viewAttributeName, setRatioForInlineImage) {
+            dispatcher.on(`attribute:${modelAttributeName}:${imageType}`, (evt, data, conversionApi) => {
+                if (!conversionApi.consumable.consume(data.item, evt.name)) {
+                    return;
+                }
+                const viewWriter = conversionApi.writer;
+                const viewElement = conversionApi.mapper.toViewElement(data.item);
+                const img = imageUtils.findViewImgElement(viewElement);
+                if (data.attributeNewValue !== null) {
+                    viewWriter.setAttribute(viewAttributeName, data.attributeNewValue, img);
+                }
+                else {
+                    viewWriter.removeAttribute(viewAttributeName, img);
+                }
+                // Do not set aspect-ratio for pictures. See https://github.com/ckeditor/ckeditor5/issues/14579.
+                if (data.item.hasAttribute('sources')) {
+                    return;
+                }
+                const isResized = data.item.hasAttribute('resizedWidth');
+                // Do not set aspect ratio for inline images which are not resized (data pipeline).
+                if (imageType === 'imageInline' && !isResized && !setRatioForInlineImage) {
+                    return;
+                }
+                const width = data.item.getAttribute('width');
+                const height = data.item.getAttribute('height');
+                if (width && height) {
+                    viewWriter.setStyle('aspect-ratio', `${width}/${height}`, img);
+                }
+            });
+        }
+    }
+}

package/src/imagestyle/converters.d.ts

@@ -1,24 +1,24 @@
-/**
- * @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 type { DowncastAttributeEvent, UpcastElementEvent } from 'ckeditor5/src/engine';
-import { type GetCallback } from 'ckeditor5/src/utils';
-import type { ImageStyleOptionDefinition } from '../imageconfig';
-/**
- * @module image/imagestyle/converters
- */
-/**
- * Returns a converter for the `imageStyle` attribute. It can be used for adding, changing and removing the attribute.
- *
- * @param styles An array containing available image style options.
- * @returns A model-to-view attribute converter.
- */
-export declare function modelToViewStyleAttribute(styles: Array<ImageStyleOptionDefinition>): GetCallback<DowncastAttributeEvent>;
-/**
- * Returns a view-to-model converter converting image CSS classes to a proper value in the model.
- *
- * @param styles Image style options for which the converter is created.
- * @returns A view-to-model converter.
- */
-export declare function viewToModelStyleAttribute(styles: Array<ImageStyleOptionDefinition>): GetCallback<UpcastElementEvent>;
+/**
+ * @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 type { DowncastAttributeEvent, UpcastElementEvent } from 'ckeditor5/src/engine';
+import { type GetCallback } from 'ckeditor5/src/utils';
+import type { ImageStyleOptionDefinition } from '../imageconfig';
+/**
+ * @module image/imagestyle/converters
+ */
+/**
+ * Returns a converter for the `imageStyle` attribute. It can be used for adding, changing and removing the attribute.
+ *
+ * @param styles An array containing available image style options.
+ * @returns A model-to-view attribute converter.
+ */
+export declare function modelToViewStyleAttribute(styles: Array<ImageStyleOptionDefinition>): GetCallback<DowncastAttributeEvent>;
+/**
+ * Returns a view-to-model converter converting image CSS classes to a proper value in the model.
+ *
+ * @param styles Image style options for which the converter is created.
+ * @returns A view-to-model converter.
+ */
+export declare function viewToModelStyleAttribute(styles: Array<ImageStyleOptionDefinition>): GetCallback<UpcastElementEvent>;

package/src/imagestyle/converters.js

@@ -1,79 +1,79 @@
-/**
- * @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';
-/**
- * @module image/imagestyle/converters
- */
-/**
- * Returns a converter for the `imageStyle` attribute. It can be used for adding, changing and removing the attribute.
- *
- * @param styles An array containing available image style options.
- * @returns A model-to-view attribute converter.
- */
-export function modelToViewStyleAttribute(styles) {
-    return (evt, data, conversionApi) => {
-        if (!conversionApi.consumable.consume(data.item, evt.name)) {
-            return;
-        }
-        // Check if there is class name associated with given value.
-        const newStyle = getStyleDefinitionByName(data.attributeNewValue, styles);
-        const oldStyle = getStyleDefinitionByName(data.attributeOldValue, styles);
-        const viewElement = conversionApi.mapper.toViewElement(data.item);
-        const viewWriter = conversionApi.writer;
-        if (oldStyle) {
-            viewWriter.removeClass(oldStyle.className, viewElement);
-        }
-        if (newStyle) {
-            viewWriter.addClass(newStyle.className, viewElement);
-        }
-    };
-}
-/**
- * Returns a view-to-model converter converting image CSS classes to a proper value in the model.
- *
- * @param styles Image style options for which the converter is created.
- * @returns A view-to-model converter.
- */
-export function viewToModelStyleAttribute(styles) {
-    // Convert only non–default styles.
-    const nonDefaultStyles = {
-        imageInline: styles.filter(style => !style.isDefault && style.modelElements.includes('imageInline')),
-        imageBlock: styles.filter(style => !style.isDefault && style.modelElements.includes('imageBlock'))
-    };
-    return (evt, data, conversionApi) => {
-        if (!data.modelRange) {
-            return;
-        }
-        const viewElement = data.viewItem;
-        const modelImageElement = first(data.modelRange.getItems());
-        // Run this converter only if an image has been found in the model.
-        // In some cases it may not be found (for example if we run this on a figure with different type than image).
-        if (!modelImageElement) {
-            return;
-        }
-        // ...and the `imageStyle` attribute is allowed for that element, otherwise stop conversion early.
-        if (!conversionApi.schema.checkAttribute(modelImageElement, 'imageStyle')) {
-            return;
-        }
-        // Convert styles one by one.
-        for (const style of nonDefaultStyles[modelImageElement.name]) {
-            // Try to consume class corresponding with the style.
-            if (conversionApi.consumable.consume(viewElement, { classes: style.className })) {
-                // And convert this style to model attribute.
-                conversionApi.writer.setAttribute('imageStyle', style.name, modelImageElement);
-            }
-        }
-    };
-}
-/**
- * Returns the style with a given `name` from an array of styles.
- */
-function getStyleDefinitionByName(name, styles) {
-    for (const style of styles) {
-        if (style.name === name) {
-            return style;
-        }
-    }
-}
+/**
+ * @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';
+/**
+ * @module image/imagestyle/converters
+ */
+/**
+ * Returns a converter for the `imageStyle` attribute. It can be used for adding, changing and removing the attribute.
+ *
+ * @param styles An array containing available image style options.
+ * @returns A model-to-view attribute converter.
+ */
+export function modelToViewStyleAttribute(styles) {
+    return (evt, data, conversionApi) => {
+        if (!conversionApi.consumable.consume(data.item, evt.name)) {
+            return;
+        }
+        // Check if there is class name associated with given value.
+        const newStyle = getStyleDefinitionByName(data.attributeNewValue, styles);
+        const oldStyle = getStyleDefinitionByName(data.attributeOldValue, styles);
+        const viewElement = conversionApi.mapper.toViewElement(data.item);
+        const viewWriter = conversionApi.writer;
+        if (oldStyle) {
+            viewWriter.removeClass(oldStyle.className, viewElement);
+        }
+        if (newStyle) {
+            viewWriter.addClass(newStyle.className, viewElement);
+        }
+    };
+}
+/**
+ * Returns a view-to-model converter converting image CSS classes to a proper value in the model.
+ *
+ * @param styles Image style options for which the converter is created.
+ * @returns A view-to-model converter.
+ */
+export function viewToModelStyleAttribute(styles) {
+    // Convert only non–default styles.
+    const nonDefaultStyles = {
+        imageInline: styles.filter(style => !style.isDefault && style.modelElements.includes('imageInline')),
+        imageBlock: styles.filter(style => !style.isDefault && style.modelElements.includes('imageBlock'))
+    };
+    return (evt, data, conversionApi) => {
+        if (!data.modelRange) {
+            return;
+        }
+        const viewElement = data.viewItem;
+        const modelImageElement = first(data.modelRange.getItems());
+        // Run this converter only if an image has been found in the model.
+        // In some cases it may not be found (for example if we run this on a figure with different type than image).
+        if (!modelImageElement) {
+            return;
+        }
+        // ...and the `imageStyle` attribute is allowed for that element, otherwise stop conversion early.
+        if (!conversionApi.schema.checkAttribute(modelImageElement, 'imageStyle')) {
+            return;
+        }
+        // Convert styles one by one.
+        for (const style of nonDefaultStyles[modelImageElement.name]) {
+            // Try to consume class corresponding with the style.
+            if (conversionApi.consumable.consume(viewElement, { classes: style.className })) {
+                // And convert this style to model attribute.
+                conversionApi.writer.setAttribute('imageStyle', style.name, modelImageElement);
+            }
+        }
+    };
+}
+/**
+ * Returns the style with a given `name` from an array of styles.
+ */
+function getStyleDefinitionByName(name, styles) {
+    for (const style of styles) {
+        if (style.name === name) {
+            return style;
+        }
+    }
+}

package/src/imagestyle/imagestylecommand.d.ts

@@ -1,68 +1,68 @@
-/**
- * @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/imagestyle/imagestylecommand
- */
-import type { Element } from 'ckeditor5/src/engine';
-import { Command, type Editor } from 'ckeditor5/src/core';
-import type { ImageStyleOptionDefinition } from '../imageconfig';
-/**
- * The image style command. It is used to apply {@link module:image/imageconfig~ImageStyleConfig#options image style option}
- * to a selected image.
- *
- * **Note**: Executing this command may change the image model element if the desired style requires an image of a different
- * type. See {@link module:image/imagestyle/imagestylecommand~ImageStyleCommand#execute} to learn more.
- */
-export default class ImageStyleCommand extends Command {
-    /**
-     * An object containing names of default style options for the inline and block images.
-     * If there is no default style option for the given image type in the configuration,
-     * the name will be `false`.
-     */
-    private _defaultStyles;
-    /**
-     * The styles handled by this command.
-     */
-    private _styles;
-    /**
-     * Creates an instance of the image style command. When executed, the command applies one of
-     * {@link module:image/imageconfig~ImageStyleConfig#options style options} to the currently selected image.
-     *
-     * @param editor The editor instance.
-     * @param styles The style options that this command supports.
-     */
-    constructor(editor: Editor, styles: Array<ImageStyleOptionDefinition>);
-    /**
-     * @inheritDoc
-     */
-    refresh(): void;
-    /**
-     * Executes the command and applies the style to the currently selected image:
-     *
-     * ```ts
-     * editor.execute( 'imageStyle', { value: 'side' } );
-     * ```
-     *
-     * **Note**: Executing this command may change the image model element if the desired style requires an image
-     * of a different type. Learn more about {@link module:image/imageconfig~ImageStyleOptionDefinition#modelElements model element}
-     * configuration for the style option.
-     *
-     * @param options.value The name of the style (as configured in {@link module:image/imageconfig~ImageStyleConfig#options}).
-     * @param options.setImageSizes Specifies whether the image `width` and `height` attributes should be set automatically.
-     * The default is `true`.
-     * @fires execute
-     */
-    execute(options?: {
-        value?: string;
-        setImageSizes?: boolean;
-    }): void;
-    /**
-     * Returns `true` if requested style change would trigger the image type change.
-     *
-     * @param requestedStyle The name of the style (as configured in {@link module:image/imageconfig~ImageStyleConfig#options}).
-     * @param imageElement The image model element.
-     */
-    shouldConvertImageType(requestedStyle: string, imageElement: Element): boolean;
-}
+/**
+ * @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/imagestyle/imagestylecommand
+ */
+import type { Element } from 'ckeditor5/src/engine';
+import { Command, type Editor } from 'ckeditor5/src/core';
+import type { ImageStyleOptionDefinition } from '../imageconfig';
+/**
+ * The image style command. It is used to apply {@link module:image/imageconfig~ImageStyleConfig#options image style option}
+ * to a selected image.
+ *
+ * **Note**: Executing this command may change the image model element if the desired style requires an image of a different
+ * type. See {@link module:image/imagestyle/imagestylecommand~ImageStyleCommand#execute} to learn more.
+ */
+export default class ImageStyleCommand extends Command {
+    /**
+     * An object containing names of default style options for the inline and block images.
+     * If there is no default style option for the given image type in the configuration,
+     * the name will be `false`.
+     */
+    private _defaultStyles;
+    /**
+     * The styles handled by this command.
+     */
+    private _styles;
+    /**
+     * Creates an instance of the image style command. When executed, the command applies one of
+     * {@link module:image/imageconfig~ImageStyleConfig#options style options} to the currently selected image.
+     *
+     * @param editor The editor instance.
+     * @param styles The style options that this command supports.
+     */
+    constructor(editor: Editor, styles: Array<ImageStyleOptionDefinition>);
+    /**
+     * @inheritDoc
+     */
+    refresh(): void;
+    /**
+     * Executes the command and applies the style to the currently selected image:
+     *
+     * ```ts
+     * editor.execute( 'imageStyle', { value: 'side' } );
+     * ```
+     *
+     * **Note**: Executing this command may change the image model element if the desired style requires an image
+     * of a different type. Learn more about {@link module:image/imageconfig~ImageStyleOptionDefinition#modelElements model element}
+     * configuration for the style option.
+     *
+     * @param options.value The name of the style (as configured in {@link module:image/imageconfig~ImageStyleConfig#options}).
+     * @param options.setImageSizes Specifies whether the image `width` and `height` attributes should be set automatically.
+     * The default is `true`.
+     * @fires execute
+     */
+    execute(options?: {
+        value?: string;
+        setImageSizes?: boolean;
+    }): void;
+    /**
+     * Returns `true` if requested style change would trigger the image type change.
+     *
+     * @param requestedStyle The name of the style (as configured in {@link module:image/imageconfig~ImageStyleConfig#options}).
+     * @param imageElement The image model element.
+     */
+    shouldConvertImageType(requestedStyle: string, imageElement: Element): boolean;
+}