@ckeditor/ckeditor5-widget 45.2.1-alpha.9 → 46.0.0-alpha.0

package/src/widgetresize/resizerstate.d.ts

@@ -2,15 +2,15 @@
  * @license Copyright (c) 2003-2025, CKSource Holding sp. z o.o. All rights reserved.
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
  */
-import type { ResizerOptions } from '../widgetresize.js';
-declare const ResizeState_base: {
+import type { WidgetResizerOptions } from '../widgetresize.js';
+declare const WidgetResizeState_base: {
     new (): import("@ckeditor/ckeditor5-utils").Observable;
     prototype: import("@ckeditor/ckeditor5-utils").Observable;
 };
 /**
  * Stores the internal state of a single resizable object.
  */
-export default class ResizeState extends /* #__PURE__ */ ResizeState_base {
+export declare class WidgetResizeState extends /* #__PURE__ */ WidgetResizeState_base {
     /**
      * The position of the handle that initiated the resizing. E.g. `"top-left"`, `"bottom-right"` etc. or `null`
      * if unknown.
@@ -92,7 +92,7 @@ export default class ResizeState extends /* #__PURE__ */ ResizeState_base {
     /**
      * @param options Resizer options.
      */
-    constructor(options: ResizerOptions);
+    constructor(options: WidgetResizerOptions);
     /**
      * The original width (pixels) of the resized object when the resize process was started.
      */

package/src/widgetresize/resizerstate.js

@@ -10,7 +10,7 @@ import { calculateResizeHostPercentageWidth } from '../utils.js';
 /**
  * Stores the internal state of a single resizable object.
  */
-export default class ResizeState extends /* #__PURE__ */ ObservableMixin() {
+export class WidgetResizeState extends /* #__PURE__ */ ObservableMixin() {
     /**
      * The reference point of the resizer where the dragging started. It is used to measure the distance the user cursor
      * traveled, so how much the image should be enlarged.

package/src/widgetresize/sizeview.d.ts

@@ -6,12 +6,14 @@
  * @module widget/widgetresize/sizeview
  */
 import { View } from '@ckeditor/ckeditor5-ui';
-import type { ResizerOptions } from '../widgetresize.js';
-import type ResizeState from './resizerstate.js';
+import type { WidgetResizerOptions } from '../widgetresize.js';
+import { type WidgetResizeState } from './resizerstate.js';
 /**
  * A view displaying the proposed new element size during the resizing.
+ *
+ * @internal
  */
-export default class SizeView extends View {
+export declare class SizeView extends View {
     /**
      * The visibility of the view defined based on the existence of the host proposed dimensions.
      *
@@ -45,7 +47,7 @@ export default class SizeView extends View {
      * @param options An object defining the resizer options, used for setting the proper size label.
      * @param resizeState The `ResizeState` class instance, used for keeping the `SizeView` state up to date.
      */
-    _bindToState(options: ResizerOptions, resizeState: ResizeState): void;
+    _bindToState(options: WidgetResizerOptions, resizeState: WidgetResizeState): void;
     /**
      * A method used for cleaning up. It removes the bindings and hides the view.
      *

package/src/widgetresize/sizeview.js

@@ -8,8 +8,10 @@
 import { View } from '@ckeditor/ckeditor5-ui';
 /**
  * A view displaying the proposed new element size during the resizing.
+ *
+ * @internal
  */
-export default class SizeView extends View {
+export class SizeView extends View {
     constructor() {
         super();
         const bind = this.bindTemplate;

package/src/widgetresize.d.ts

@@ -5,22 +5,22 @@
 /**
  * @module widget/widgetresize
  */
-import Resizer from './widgetresize/resizer.js';
+import { WidgetResizer } from './widgetresize/resizer.js';
 import { Plugin, type Editor } from '@ckeditor/ckeditor5-core';
-import { type Element, type ViewContainerElement } from '@ckeditor/ckeditor5-engine';
+import { type ModelElement, type ViewContainerElement } from '@ckeditor/ckeditor5-engine';
 import '../theme/widgetresize.css';
 /**
  * The widget resize feature plugin.
  *
  * Use the {@link module:widget/widgetresize~WidgetResize#attachTo} method to create a resizer for the specified widget.
  */
-export default class WidgetResize extends Plugin {
+export declare class WidgetResize extends Plugin {
     /**
      * The currently selected resizer.
      *
      * @observable
      */
-    selectedResizer: Resizer | null;
+    selectedResizer: WidgetResizer | null;
     /**
      * References an active resizer.
      *
@@ -29,7 +29,7 @@ export default class WidgetResize extends Plugin {
      * @internal
      * @observable
      */
-    _activeResizer: Resizer | null;
+    _activeResizer: WidgetResizer | null;
     /**
      * A map of resizers created using this plugin instance.
      */
@@ -59,7 +59,7 @@ export default class WidgetResize extends Plugin {
     /**
      * Marks resizer as selected.
      */
-    select(resizer: Resizer): void;
+    select(resizer: WidgetResizer): void;
     /**
      * Deselects currently set resizer.
      */
@@ -67,13 +67,13 @@ export default class WidgetResize extends Plugin {
     /**
      * @param options Resizer options.
      */
-    attachTo(options: ResizerOptions): Resizer;
+    attachTo(options: WidgetResizerOptions): WidgetResizer;
     /**
      * Returns a resizer created for a given view element (widget element).
      *
      * @param viewElement View element associated with the resizer.
      */
-    getResizerByViewElement(viewElement: ViewContainerElement): Resizer | undefined;
+    getResizerByViewElement(viewElement: ViewContainerElement): WidgetResizer | undefined;
     /**
      * Returns a resizer that contains a given resize handle.
      */
@@ -91,12 +91,12 @@ export default class WidgetResize extends Plugin {
 /**
  * Interface describing a resizer. It allows to specify the resizing host, custom logic for calculating aspect ratio, etc.
  */
-export interface ResizerOptions {
+export interface WidgetResizerOptions {
     /**
      * Editor instance associated with the resizer.
      */
     editor: Editor;
-    modelElement: Element;
+    modelElement: ModelElement;
     /**
      * A view of an element to be resized. Typically it's the main widget's view instance.
      */
@@ -125,5 +125,5 @@ export interface ResizerOptions {
     onCommit: (newValue: string) => void;
     getResizeHost: (widgetWrapper: HTMLElement) => HTMLElement;
     getHandleHost: (widgetWrapper: HTMLElement) => HTMLElement;
-    isCentered?: (resizer: Resizer) => boolean;
+    isCentered?: (resizer: WidgetResizer) => boolean;
 }

package/src/widgetresize.js

@@ -5,7 +5,7 @@
 /**
  * @module widget/widgetresize
  */
-import Resizer from './widgetresize/resizer.js';
+import { WidgetResizer } from './widgetresize/resizer.js';
 import { Plugin } from '@ckeditor/ckeditor5-core';
 import { MouseObserver } from '@ckeditor/ckeditor5-engine';
 import { DomEmitterMixin, global } from '@ckeditor/ckeditor5-utils';
@@ -16,7 +16,7 @@ import '../theme/widgetresize.css';
  *
  * Use the {@link module:widget/widgetresize~WidgetResize#attachTo} method to create a resizer for the specified widget.
  */
-export default class WidgetResize extends Plugin {
+export class WidgetResize extends Plugin {
     /**
      * A map of resizers created using this plugin instance.
      */
@@ -116,7 +116,7 @@ export default class WidgetResize extends Plugin {
      * @param options Resizer options.
      */
     attachTo(options) {
-        const resizer = new Resizer(options);
+        const resizer = new WidgetResizer(options);
         const plugins = this.editor.plugins;
         resizer.attach();
         if (plugins.has('WidgetToolbarRepository')) {
@@ -165,7 +165,7 @@ export default class WidgetResize extends Plugin {
      */
     _mouseDownListener(event, domEventData) {
         const resizeHandle = domEventData.domTarget;
-        if (!Resizer.isResizeHandle(resizeHandle)) {
+        if (!WidgetResizer.isResizeHandle(resizeHandle)) {
             return;
         }
         this._activeResizer = this._getResizerByHandle(resizeHandle) || null;

package/src/widgettoolbarrepository.d.ts

@@ -35,7 +35,7 @@ import { type PositioningFunction } from '@ckeditor/ckeditor5-utils';
  * }
  * ```
  */
-export default class WidgetToolbarRepository extends Plugin {
+export declare class WidgetToolbarRepository extends Plugin {
     /**
      * A map of toolbar definitions.
      */

package/src/widgettoolbarrepository.js

@@ -35,7 +35,7 @@ import { isWidget } from './utils.js';
  * }
  * ```
  */
-export default class WidgetToolbarRepository extends Plugin {
+export class WidgetToolbarRepository extends Plugin {
     /**
      * A map of toolbar definitions.
      */

package/src/widgettypearound/utils.d.ts

@@ -2,18 +2,22 @@
  * @license Copyright (c) 2003-2025, CKSource Holding sp. z o.o. All rights reserved.
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
  */
-import type { DocumentSelection, DomConverter, Element, Schema, Selection, ViewElement } from '@ckeditor/ckeditor5-engine';
+import type { ModelDocumentSelection, ViewDomConverter, ModelElement, ModelSchema, ModelSelection, ViewElement } from '@ckeditor/ckeditor5-engine';
 /**
  * The name of the type around model selection attribute responsible for
  * displaying a fake caret next to a selected widget.
+ *
+ * @internal
  */
 export declare const TYPE_AROUND_SELECTION_ATTRIBUTE = "widget-type-around";
 /**
  * Checks if an element is a widget that qualifies to get the widget type around UI.
  */
-export declare function isTypeAroundWidget(viewElement: ViewElement | undefined, modelElement: Element, schema: Schema): boolean;
+export declare function isTypeAroundWidget(viewElement: ViewElement | undefined, modelElement: ModelElement, schema: ModelSchema): boolean;
 /**
  * For the passed HTML element, this helper finds the closest widget type around button ancestor.
+ *
+ * @internal
  */
 export declare function getClosestTypeAroundDomButton(domElement: HTMLElement): HTMLElement | null;
 /**
@@ -21,18 +25,22 @@ export declare function getClosestTypeAroundDomButton(domElement: HTMLElement):
  * the paragraph would be inserted into the content if, for instance, the button was
  * clicked by the user.
  *
+ * @internal
  * @returns The position of the button.
  */
 export declare function getTypeAroundButtonPosition(domElement: HTMLElement): 'before' | 'after';
 /**
  * For the passed HTML element, this helper returns the closest view widget ancestor.
+ *
+ * @internal
  */
-export declare function getClosestWidgetViewElement(domElement: HTMLElement, domConverter: DomConverter): ViewElement;
+export declare function getClosestWidgetViewElement(domElement: HTMLElement, domConverter: ViewDomConverter): ViewElement;
 /**
  * For the passed selection instance, it returns the position of the fake caret displayed next to a widget.
  *
  * **Note**: If the fake caret is not currently displayed, `null` is returned.
  *
+ * @internal
  * @returns The position of the fake caret or `null` when none is present.
  */
-export declare function getTypeAroundFakeCaretPosition(selection: Selection | DocumentSelection): 'before' | 'after' | null;
+export declare function getTypeAroundFakeCaretPosition(selection: ModelSelection | ModelDocumentSelection): 'before' | 'after' | null;

package/src/widgettypearound/utils.js

@@ -9,6 +9,8 @@ import { isWidget } from '../utils.js';
 /**
  * The name of the type around model selection attribute responsible for
  * displaying a fake caret next to a selected widget.
+ *
+ * @internal
  */
 export const TYPE_AROUND_SELECTION_ATTRIBUTE = 'widget-type-around';
 /**
@@ -19,6 +21,8 @@ export function isTypeAroundWidget(viewElement, modelElement, schema) {
 }
 /**
  * For the passed HTML element, this helper finds the closest widget type around button ancestor.
+ *
+ * @internal
  */
 export function getClosestTypeAroundDomButton(domElement) {
     return domElement.closest('.ck-widget__type-around__button');
@@ -28,6 +32,7 @@ export function getClosestTypeAroundDomButton(domElement) {
  * the paragraph would be inserted into the content if, for instance, the button was
  * clicked by the user.
  *
+ * @internal
  * @returns The position of the button.
  */
 export function getTypeAroundButtonPosition(domElement) {
@@ -35,6 +40,8 @@ export function getTypeAroundButtonPosition(domElement) {
 }
 /**
  * For the passed HTML element, this helper returns the closest view widget ancestor.
+ *
+ * @internal
  */
 export function getClosestWidgetViewElement(domElement, domConverter) {
     const widgetDomElement = domElement.closest('.ck-widget');
@@ -45,6 +52,7 @@ export function getClosestWidgetViewElement(domElement, domConverter) {
  *
  * **Note**: If the fake caret is not currently displayed, `null` is returned.
  *
+ * @internal
  * @returns The position of the fake caret or `null` when none is present.
  */
 export function getTypeAroundFakeCaretPosition(selection) {

package/src/widgettypearound/widgettypearound.d.ts

@@ -19,7 +19,7 @@ import '../../theme/widgettypearound.css';
  * user if the widget is next to the "tight spot". Once clicked, a paragraph is created with the selection anchored
  * in it so that users can type (or insert content, paste, etc.) straight away.
  */
-export default class WidgetTypeAround extends Plugin {
+export declare class WidgetTypeAround extends Plugin {
     /**
      * A reference to the model widget element that has the fake caret active
      * on either side of it. It is later used to remove CSS classes associated with the fake caret
@@ -82,7 +82,7 @@ export default class WidgetTypeAround extends Plugin {
      * Creates a listener in the editing conversion pipeline that injects the widget type around
      * UI into every single widget instance created in the editor.
      *
-     * The UI is delivered as a {@link module:engine/view/uielement~UIElement}
+     * The UI is delivered as a {@link module:engine/view/uielement~ViewUIElement}
      * wrapper which renders DOM buttons that users can use to insert paragraphs.
      */
     private _enableTypeAroundUIInjection;

package/src/widgettypearound/widgettypearound.js

@@ -29,7 +29,7 @@ const PLUGIN_DISABLED_EDITING_ROOT_CLASS = 'ck-widget__type-around_disabled';
  * user if the widget is next to the "tight spot". Once clicked, a paragraph is created with the selection anchored
  * in it so that users can type (or insert content, paste, etc.) straight away.
  */
-export default class WidgetTypeAround extends Plugin {
+export class WidgetTypeAround extends Plugin {
     /**
      * A reference to the model widget element that has the fake caret active
      * on either side of it. It is later used to remove CSS classes associated with the fake caret
@@ -165,7 +165,7 @@ export default class WidgetTypeAround extends Plugin {
      * Creates a listener in the editing conversion pipeline that injects the widget type around
      * UI into every single widget instance created in the editor.
      *
-     * The UI is delivered as a {@link module:engine/view/uielement~UIElement}
+     * The UI is delivered as a {@link module:engine/view/uielement~ViewUIElement}
      * wrapper which renders DOM buttons that users can use to insert paragraphs.
      */
     _enableTypeAroundUIInjection() {