@ckeditor/ckeditor5-image 44.1.0 → 44.2.0-alpha.1

package/dist/imageresize/resizeimagecommand.d.ts

@@ -1,46 +0,0 @@
-/**
- * @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
- */
-/**
- * @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-licensing-options
- */
-/**
- * @module image/imageresize/resizeimagecommand
- */
-import { Command } from 'ckeditor5/src/core.js';
-/**
- * The resize image command. Currently, it only supports the width attribute.
- */
-export default class ResizeImageCommand extends Command {
-    /**
-     * Desired image width and height.
-     */
-    value: null | {
-        width: string | null;
-        height: string | null;
-    };
-    /**
-     * @inheritDoc
-     */
-    refresh(): void;
-    /**
-     * Executes the command.
-     *
-     * ```ts
-     * // Sets the width to 50%:
-     * editor.execute( 'resizeImage', { width: '50%' } );
-     *
-     * // Removes the width attribute:
-     * editor.execute( 'resizeImage', { width: null } );
-     * ```
-     *
-     * @param options
-     * @param options.width The new width of the image.
-     * @fires execute
-     */
-    execute(options: {
-        width: string | null;
-    }): void;
-}

package/dist/imageresize/ui/imagecustomresizeformview.d.ts

@@ -1,133 +0,0 @@
-/**
- * @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
- */
-/**
- * @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-licensing-options
- */
-/**
- * @module image/imageresize/ui/imagecustomresizeformview
- */
-import { ButtonView, FocusCycler, LabeledFieldView, View, ViewCollection, type FocusableView, type InputNumberView } from 'ckeditor5/src/ui.js';
-import { FocusTracker, KeystrokeHandler, type Locale } from 'ckeditor5/src/utils.js';
-import '../../../theme/imagecustomresizeform.css';
-import '@ckeditor/ckeditor5-ui/theme/components/responsive-form/responsiveform.css';
-/**
- * The ImageCustomResizeFormView class.
- */
-export default class ImageCustomResizeFormView extends View {
-    /**
-     * Tracks information about the DOM focus in the form.
-     */
-    readonly focusTracker: FocusTracker;
-    /**
-     * An instance of the {@link module:utils/keystrokehandler~KeystrokeHandler}.
-     */
-    readonly keystrokes: KeystrokeHandler;
-    /**
-     * Resize unit shortcut.
-     */
-    readonly unit: string;
-    /**
-     * An input with a label.
-     */
-    labeledInput: LabeledFieldView<InputNumberView>;
-    /**
-     * A button used to submit the form.
-     */
-    saveButtonView: ButtonView;
-    /**
-     * A button used to cancel the form.
-     */
-    cancelButtonView: ButtonView;
-    /**
-     * A collection of views which can be focused in the form.
-     */
-    protected readonly _focusables: ViewCollection<FocusableView>;
-    /**
-     * Helps cycling over {@link #_focusables} in the form.
-     */
-    protected readonly _focusCycler: FocusCycler;
-    /**
-     * An array of form validators used by {@link #isValid}.
-     */
-    private readonly _validators;
-    /**
-     * @inheritDoc
-     */
-    constructor(locale: Locale, unit: string, validators: Array<ImageCustomResizeFormValidatorCallback>);
-    /**
-     * @inheritDoc
-     */
-    render(): void;
-    /**
-     * @inheritDoc
-     */
-    destroy(): void;
-    /**
-     * Creates the button view.
-     *
-     * @param label The button label
-     * @param icon The button's icon.
-     * @param className The additional button CSS class name.
-     * @param eventName The event name that the ButtonView#execute event will be delegated to.
-     * @returns The button view instance.
-     */
-    private _createButton;
-    /**
-     * Creates an input with a label.
-     *
-     * @returns Labeled field view instance.
-     */
-    private _createLabeledInputView;
-    /**
-     * Validates the form and returns `false` when some fields are invalid.
-     */
-    isValid(): boolean;
-    /**
-     * Cleans up the supplementary error and information text of the {@link #labeledInput}
-     * bringing them back to the state when the form has been displayed for the first time.
-     *
-     * See {@link #isValid}.
-     */
-    resetFormStatus(): void;
-    /**
-     * The native DOM `value` of the input element of {@link #labeledInput}.
-     */
-    get rawSize(): string | null;
-    /**
-     * Get numeric value of size. Returns `null` if value of size input element in {@link #labeledInput}.is not a number.
-     */
-    get parsedSize(): number | null;
-    /**
-     * Returns serialized image input size with unit.
-     * Returns `null` if value of size input element in {@link #labeledInput}.is not a number.
-     */
-    get sizeWithUnits(): string | null;
-}
-/**
- * Callback used by {@link ~ImageCustomResizeFormView} to check if passed form value is valid.
- *
- * 	* If `undefined` is returned, it is assumed that the form value is correct and there is no error.
- * 	* If string is returned, it is assumed that the form value is incorrect and the returned string is displayed in the error label
- */
-export type ImageCustomResizeFormValidatorCallback = (form: ImageCustomResizeFormView) => string | undefined;
-/**
- * Fired when the form view is submitted.
- *
- * @eventName ~ImageCustomResizeFormView#submit
- */
-export type ImageCustomResizeFormViewSubmitEvent = {
-    name: 'submit';
-    args: [];
-};
-/**
- * Fired when the form view is canceled.
- *
- * @eventName ~ImageCustomResizeFormView#cancel
- */
-export type ImageCustomResizeFormViewCancelEvent = {
-    name: 'cancel';
-    args: [];
-};

package/dist/imageresize/utils/getselectedimageeditornodes.d.ts

@@ -1,28 +0,0 @@
-/**
- * @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
- */
-/**
- * @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-licensing-options
- */
-/**
- * @module image/imageresize/utils/getselectedimageeditornodes
- */
-import type { ViewElement, Element } from 'ckeditor5/src/engine.js';
-import type { Editor } from 'ckeditor5/src/core.js';
-/**
- * Finds model, view and DOM element for selected image element. Returns `null` if there is no image selected.
- *
- * @param editor Editor instance.
- */
-export declare function getSelectedImageEditorNodes(editor: Editor): ImageEditorNodes | null;
-/**
- * @internal;
- */
-type ImageEditorNodes = {
-    model: Element;
-    view: ViewElement;
-    dom: HTMLElement;
-};
-export {};

package/dist/imageresize/utils/getselectedimagepossibleresizerange.d.ts

@@ -1,28 +0,0 @@
-/**
- * @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
- */
-/**
- * @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-licensing-options
- */
-/**
- * @module image/imageresize/utils/getselectedimagepossibleresizerange
- */
-import type { Editor } from 'ckeditor5/src/core.js';
-/**
- * Returns min and max value of resize image in specified unit.
- *
- * @param editor Editor instance.
- * @param targetUnit Unit in which dimension will be returned.
- * @returns Possible resize range in numeric form.
- */
-export declare function getSelectedImagePossibleResizeRange(editor: Editor, targetUnit: string): PossibleResizeImageRange | null;
-/**
- * @internal
- */
-export type PossibleResizeImageRange = {
-    unit: string;
-    lower: number;
-    upper: number;
-};

package/dist/imageresize/utils/getselectedimagewidthinunits.d.ts

@@ -1,22 +0,0 @@
-/**
- * @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
- */
-/**
- * @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-licensing-options
- */
-import type { Editor } from 'ckeditor5/src/core.js';
-import { type DimensionWithUnit } from './tryparsedimensionwithunit.js';
-/**
- * Returns image width in specified units. It is width of image after resize.
- *
- * 	* If image is not selected or command is disabled then `null` will be returned.
- * 	* If image is not fully loaded (and it is impossible to determine its natural size) then `null` will be returned.
- *	* If `targetUnit` percentage is passed then it will return width percentage of image related to its accessors.
- *
- * @param editor Editor instance.
- * @param targetUnit Unit in which dimension will be returned.
- * @returns Parsed image width after resize (with unit).
- */
-export declare function getSelectedImageWidthInUnits(editor: Editor, targetUnit: string): DimensionWithUnit | null;

package/dist/imageresize/utils/tryparsedimensionwithunit.d.ts

@@ -1,41 +0,0 @@
-/**
- * @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
- */
-/**
- * @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-licensing-options
- */
-/**
- * @module image/imageresize/utils/tryparsedimensionwithunit
- */
-/**
- * Parses provided string with dimension value and returns extracted numeric value and unit.
- *
- * 	* If non-string dimension is passed then `null` value is returned.
- * 	* If unit is missing then `null` is returned.
- * 	* If numeric value part of string is not a number then `null` is returned.
- *
- * Example:
- * 	`"222px"` => `{ value: 222, unit: "px" }`
- *	`"99%"` => `{ value: 99, unit: "%" }`
-
- * @param dimension Unsafe string with dimension.
- * @returns Parsed dimension with extracted numeric value and units.
- */
-export declare function tryParseDimensionWithUnit(dimension: string | null | undefined): DimensionWithUnit | null;
-/**
- * Converts dimension between `px` -> `%` and `%` -> `px`.
- *
- * @param parentDimensionPx	Dimension of parent element that contains measured element.
- * @param dimension Measured element dimension.
- * @returns Casted dimension.
- */
-export declare function tryCastDimensionsToUnit(parentDimensionPx: number, dimension: DimensionWithUnit, targetUnit: string): DimensionWithUnit;
-/**
- * @internal
- */
-export type DimensionWithUnit = {
-    value: number;
-    unit: string;
-};

package/dist/imageresize.d.ts

@@ -1,36 +0,0 @@
-/**
- * @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
- */
-/**
- * @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-licensing-options
- */
-/**
- * @module image/imageresize
- */
-import { Plugin } from 'ckeditor5/src/core.js';
-import ImageResizeButtons from './imageresize/imageresizebuttons.js';
-import ImageResizeEditing from './imageresize/imageresizeediting.js';
-import ImageResizeHandles from './imageresize/imageresizehandles.js';
-import ImageCustomResizeUI from './imageresize/imagecustomresizeui.js';
-import '../theme/imageresize.css';
-/**
- * The image resize plugin.
- *
- * It adds a possibility to resize each image using handles.
- */
-export default class ImageResize extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly [typeof ImageResizeEditing, typeof ImageResizeHandles, typeof ImageCustomResizeUI, typeof ImageResizeButtons];
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "ImageResize";
-    /**
-     * @inheritDoc
-     */
-    static get isOfficialPlugin(): true;
-}

package/dist/imagesizeattributes.d.ts

@@ -1,42 +0,0 @@
-/**
- * @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
- */
-/**
- * @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-licensing-options
- */
-/**
- * @module image/imagesizeattributes
- */
-import { Plugin } from 'ckeditor5/src/core.js';
-import ImageUtils from './imageutils.js';
-/**
- * This plugin enables `width` and `height` attributes in inline and block image elements.
- */
-export default class ImageSizeAttributes extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly [typeof ImageUtils];
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "ImageSizeAttributes";
-    /**
-     * @inheritDoc
-     */
-    static get isOfficialPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    afterInit(): void;
-    /**
-     * Registers the `width` and `height` attributes for inline and block images.
-     */
-    private _registerSchema;
-    /**
-     * Registers converters for `width` and `height` attributes.
-     */
-    private _registerConverters;
-}

package/dist/imagestyle/converters.d.ts

@@ -1,28 +0,0 @@
-/**
- * @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
- */
-/**
- * @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-licensing-options
- */
-import type { DowncastAttributeEvent, UpcastElementEvent } from 'ckeditor5/src/engine.js';
-import { type GetCallback } from 'ckeditor5/src/utils.js';
-import type { ImageStyleOptionDefinition } from '../imageconfig.js';
-/**
- * @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/dist/imagestyle/imagestylecommand.d.ts

@@ -1,72 +0,0 @@
-/**
- * @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
- */
-/**
- * @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-licensing-options
- */
-/**
- * @module image/imagestyle/imagestylecommand
- */
-import type { Element } from 'ckeditor5/src/engine.js';
-import { Command, type Editor } from 'ckeditor5/src/core.js';
-import type { ImageStyleOptionDefinition } from '../imageconfig.js';
-/**
- * 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/dist/imagestyle/imagestyleediting.d.ts

@@ -1,58 +0,0 @@
-/**
- * @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
- */
-/**
- * @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-licensing-options
- */
-/**
- * @module image/imagestyle/imagestyleediting
- */
-import { Plugin } from 'ckeditor5/src/core.js';
-import ImageUtils from '../imageutils.js';
-import type { ImageStyleOptionDefinition } from '../imageconfig.js';
-/**
- * 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 isOfficialPlugin(): true;
-    /**
-     * @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;
-}

package/dist/imagestyle/imagestyleui.d.ts

@@ -1,64 +0,0 @@
-/**
- * @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
- */
-/**
- * @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-licensing-options
- */
-/**
- * @module image/imagestyle/imagestyleui
- */
-import { Plugin } from 'ckeditor5/src/core.js';
-import ImageStyleEditing from './imagestyleediting.js';
-import '../../theme/imagestyle.css';
-/**
- * The image style UI plugin.
- *
- * It registers buttons corresponding to the {@link module:image/imageconfig~ImageConfig#styles} configuration.
- * It also registers the {@link module:image/imagestyle/utils#DEFAULT_DROPDOWN_DEFINITIONS default drop-downs} and the
- * custom drop-downs defined by the developer in the {@link module:image/imageconfig~ImageConfig#toolbar} configuration.
- */
-export default class ImageStyleUI extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly [typeof ImageStyleEditing];
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "ImageStyleUI";
-    /**
-     * @inheritDoc
-     */
-    static get isOfficialPlugin(): true;
-    /**
-     * Returns the default localized style titles provided by the plugin.
-     *
-     * The following localized titles corresponding with
-     * {@link module:image/imagestyle/utils#DEFAULT_OPTIONS} are available:
-     *
-     * * `'Wrap text'`,
-     * * `'Break text'`,
-     * * `'In line'`,
-     * * `'Full size image'`,
-     * * `'Side image'`,
-     * * `'Left aligned image'`,
-     * * `'Centered image'`,
-     * * `'Right aligned image'`
-     */
-    get localizedDefaultStylesTitles(): Record<string, string>;
-    /**
-     * @inheritDoc
-     */
-    init(): void;
-    /**
-     * Creates a dropdown and stores it in the editor {@link module:ui/componentfactory~ComponentFactory}.
-     */
-    private _createDropdown;
-    /**
-     * Creates a button and stores it in the editor {@link module:ui/componentfactory~ComponentFactory}.
-     */
-    private _createButton;
-    private _executeCommand;
-}