@ckeditor/ckeditor5-image 39.0.2 → 40.0.0

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,65 +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}).
-     * @fires execute
-     */
-    execute(options?: {
-        value?: string;
-    }): 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;
+}

package/src/imagestyle/imagestylecommand.js

@@ -1,101 +1,107 @@
-/**
- * @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 { Command } from 'ckeditor5/src/core';
-/**
- * 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 {
-    /**
-     * 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, styles) {
-        super(editor);
-        this._defaultStyles = {
-            imageBlock: false,
-            imageInline: false
-        };
-        this._styles = new Map(styles.map(style => {
-            if (style.isDefault) {
-                for (const modelElementName of style.modelElements) {
-                    this._defaultStyles[modelElementName] = style.name;
-                }
-            }
-            return [style.name, style];
-        }));
-    }
-    /**
-     * @inheritDoc
-     */
-    refresh() {
-        const editor = this.editor;
-        const imageUtils = editor.plugins.get('ImageUtils');
-        const element = imageUtils.getClosestSelectedImageElement(this.editor.model.document.selection);
-        this.isEnabled = !!element;
-        if (!this.isEnabled) {
-            this.value = false;
-        }
-        else if (element.hasAttribute('imageStyle')) {
-            this.value = element.getAttribute('imageStyle');
-        }
-        else {
-            this.value = this._defaultStyles[element.name];
-        }
-    }
-    /**
-     * 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}).
-     * @fires execute
-     */
-    execute(options = {}) {
-        const editor = this.editor;
-        const model = editor.model;
-        const imageUtils = editor.plugins.get('ImageUtils');
-        model.change(writer => {
-            const requestedStyle = options.value;
-            let imageElement = imageUtils.getClosestSelectedImageElement(model.document.selection);
-            // Change the image type if a style requires it.
-            if (requestedStyle && this.shouldConvertImageType(requestedStyle, imageElement)) {
-                this.editor.execute(imageUtils.isBlockImage(imageElement) ? 'imageTypeInline' : 'imageTypeBlock');
-                // Update the imageElement to the newly created image.
-                imageElement = imageUtils.getClosestSelectedImageElement(model.document.selection);
-            }
-            // Default style means that there is no `imageStyle` attribute in the model.
-            // https://github.com/ckeditor/ckeditor5-image/issues/147
-            if (!requestedStyle || this._styles.get(requestedStyle).isDefault) {
-                writer.removeAttribute('imageStyle', imageElement);
-            }
-            else {
-                writer.setAttribute('imageStyle', requestedStyle, imageElement);
-            }
-        });
-    }
-    /**
-     * 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, imageElement) {
-        const supportedTypes = this._styles.get(requestedStyle).modelElements;
-        return !supportedTypes.includes(imageElement.name);
-    }
-}
+/**
+ * @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 { Command } from 'ckeditor5/src/core';
+/**
+ * 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 {
+    /**
+     * 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, styles) {
+        super(editor);
+        this._defaultStyles = {
+            imageBlock: false,
+            imageInline: false
+        };
+        this._styles = new Map(styles.map(style => {
+            if (style.isDefault) {
+                for (const modelElementName of style.modelElements) {
+                    this._defaultStyles[modelElementName] = style.name;
+                }
+            }
+            return [style.name, style];
+        }));
+    }
+    /**
+     * @inheritDoc
+     */
+    refresh() {
+        const editor = this.editor;
+        const imageUtils = editor.plugins.get('ImageUtils');
+        const element = imageUtils.getClosestSelectedImageElement(this.editor.model.document.selection);
+        this.isEnabled = !!element;
+        if (!this.isEnabled) {
+            this.value = false;
+        }
+        else if (element.hasAttribute('imageStyle')) {
+            this.value = element.getAttribute('imageStyle');
+        }
+        else {
+            this.value = this._defaultStyles[element.name];
+        }
+    }
+    /**
+     * 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 = {}) {
+        const editor = this.editor;
+        const model = editor.model;
+        const imageUtils = editor.plugins.get('ImageUtils');
+        model.change(writer => {
+            const requestedStyle = options.value;
+            const { setImageSizes = true } = options;
+            let imageElement = imageUtils.getClosestSelectedImageElement(model.document.selection);
+            // Change the image type if a style requires it.
+            if (requestedStyle && this.shouldConvertImageType(requestedStyle, imageElement)) {
+                this.editor.execute(imageUtils.isBlockImage(imageElement) ? 'imageTypeInline' : 'imageTypeBlock', { setImageSizes });
+                // Update the imageElement to the newly created image.
+                imageElement = imageUtils.getClosestSelectedImageElement(model.document.selection);
+            }
+            // Default style means that there is no `imageStyle` attribute in the model.
+            // https://github.com/ckeditor/ckeditor5-image/issues/147
+            if (!requestedStyle || this._styles.get(requestedStyle).isDefault) {
+                writer.removeAttribute('imageStyle', imageElement);
+            }
+            else {
+                writer.setAttribute('imageStyle', requestedStyle, imageElement);
+            }
+            if (setImageSizes) {
+                imageUtils.setImageNaturalSizeAttributes(imageElement);
+            }
+        });
+    }
+    /**
+     * 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, imageElement) {
+        const supportedTypes = this._styles.get(requestedStyle).modelElements;
+        return !supportedTypes.includes(imageElement.name);
+    }
+}

package/src/imagestyle/imagestyleediting.d.ts

@@ -1,50 +1,50 @@
-/**
- * @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/imagestyleediting
- */
-import { Plugin } from 'ckeditor5/src/core';
-import ImageUtils from '../imageutils';
-import type { ImageStyleOptionDefinition } from '../imageconfig';
-/**
- * The image style engine plugin. It sets the default configuration, creates converters and registers
- * {@link module:image/imagestyle/imagestylecommand~ImageStyleCommand ImageStyleCommand}.
- */
-export default class ImageStyleEditing extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "ImageStyleEditing";
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly [typeof ImageUtils];
-    /**
-     * It contains a list of the normalized and validated style options.
-     *
-     * * Each option contains a complete icon markup.
-     * * The style options not supported by any of the loaded image editing plugins (
-     * {@link module:image/image/imageinlineediting~ImageInlineEditing `ImageInlineEditing`} or
-     * {@link module:image/image/imageblockediting~ImageBlockEditing `ImageBlockEditing`}) are filtered out.
-     *
-     * @internal
-     * @readonly
-     */
-    normalizedStyles?: Array<ImageStyleOptionDefinition>;
-    /**
-     * @inheritDoc
-     */
-    init(): void;
-    /**
-     * Sets the editor conversion taking the presence of
-     * {@link module:image/image/imageinlineediting~ImageInlineEditing `ImageInlineEditing`}
-     * and {@link module:image/image/imageblockediting~ImageBlockEditing `ImageBlockEditing`} plugins into consideration.
-     */
-    private _setupConversion;
-    /**
-     * Registers a post-fixer that will make sure that the style attribute value is correct for a specific image type (block vs inline).
-     */
-    private _setupPostFixer;
-}
+/**
+ * @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/imagestyleediting
+ */
+import { Plugin } from 'ckeditor5/src/core';
+import ImageUtils from '../imageutils';
+import type { ImageStyleOptionDefinition } from '../imageconfig';
+/**
+ * The image style engine plugin. It sets the default configuration, creates converters and registers
+ * {@link module:image/imagestyle/imagestylecommand~ImageStyleCommand ImageStyleCommand}.
+ */
+export default class ImageStyleEditing extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "ImageStyleEditing";
+    /**
+     * @inheritDoc
+     */
+    static get requires(): readonly [typeof ImageUtils];
+    /**
+     * It contains a list of the normalized and validated style options.
+     *
+     * * Each option contains a complete icon markup.
+     * * The style options not supported by any of the loaded image editing plugins (
+     * {@link module:image/image/imageinlineediting~ImageInlineEditing `ImageInlineEditing`} or
+     * {@link module:image/image/imageblockediting~ImageBlockEditing `ImageBlockEditing`}) are filtered out.
+     *
+     * @internal
+     * @readonly
+     */
+    normalizedStyles?: Array<ImageStyleOptionDefinition>;
+    /**
+     * @inheritDoc
+     */
+    init(): void;
+    /**
+     * Sets the editor conversion taking the presence of
+     * {@link module:image/image/imageinlineediting~ImageInlineEditing `ImageInlineEditing`}
+     * and {@link module:image/image/imageblockediting~ImageBlockEditing `ImageBlockEditing`} plugins into consideration.
+     */
+    private _setupConversion;
+    /**
+     * Registers a post-fixer that will make sure that the style attribute value is correct for a specific image type (block vs inline).
+     */
+    private _setupPostFixer;
+}