@ckeditor/ckeditor5-comments 48.2.0-alpha.7 → 48.3.0-alpha.0

package/dist/annotations/annotation.d.ts

@@ -1,97 +1,94 @@
 /**
- * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
+* @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
+* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
+*/
 /**
- * @module comments/annotations/annotation
- * @publicApi
- */
-import { Rect, Collection } from '@ckeditor/ckeditor5-utils';
-import type { View } from '@ckeditor/ckeditor5-ui';
-import { type AnnotationView } from './view/annotationview.js';
-import type { AnnotationOptions } from './annotations.js';
-declare const Annotation_base: {
-    new (): import("@ckeditor/ckeditor5-utils").Observable;
-    prototype: import("@ckeditor/ckeditor5-utils").Observable;
-};
+* @module comments/annotations/annotation
+* @publicApi
+*/
+import { Rect, Collection, type ObservableMixinConstructor } from "@ckeditor/ckeditor5-utils";
+import type { View } from "@ckeditor/ckeditor5-ui";
+import { type AnnotationView } from "./view/annotationview.js";
+import type { AnnotationOptions } from "./annotations.js";
+declare const _AnnotationBase: ObservableMixinConstructor;
 /**
- * Represents an annotation.
- *
- * Annotation is an entity that combines an {@link module:comments/annotations/view/annotationview~AnnotationView}
- * and an annotation target (a DOM element or a {@link module:utils/dom/rect~Rect}) to which the annotation is bound.
- */
-export declare class Annotation extends /* #__PURE__ -- @preserve */ Annotation_base {
-    /**
-     * The visibility of the annotation. Annotations that are not visible, are filtered from Annotation UI collections.
-     *
-     * @observable
-     */
-    isVisible: boolean;
-    /**
-     * The annotation view.
-     */
-    view: AnnotationView;
-    /**
-     * A collection of DOM elements which, when focused, make the annotation active.
-     *
-     * By default, this collection only contains the annotation view element.
-     * It can be extended with custom targets that will be tracked by the annotation focus tracking system.
-     */
-    focusableElements: Collection<HTMLElement>;
-    /**
-     * Creates an instance of the {@link module:comments/annotations/annotation~Annotation}.
-     */
-    constructor({ view, target, type, isVisible }: AnnotationOptions);
-    /**
-     * The type of the annotation.
-     */
-    get type(): string;
-    /**
-     * The annotation inner view.
-     *
-     * It is the view that is wrapped by the annotation view.*
-     */
-    get innerView(): View;
-    /**
-     * The annotation target to which the annotation view should be pinned.
-     *
-     * It can be an array of DOM elements or {@link module:utils/dom/rect~Rect a rect instance} or `null`.
-     */
-    get target(): Rect | Array<HTMLElement> | null;
-    /**
-     * The position and dimensions of the annotation target to which the annotation is bound.
-     */
-    get targetRect(): Rect | null;
-    /**
-     * The state of the annotation.
-     */
-    get isActive(): boolean;
-    set isActive(value: boolean);
-    /**
-     * Updates the target rect in the annotation view instance.
-     */
-    updateTargetRect(): void;
-    /**
-     * Clears all event listeners and internal collections.
-     */
-    destroy(): void;
-    /**
-     * Refreshes the visibility of the annotation based on the visibility of the annotation target.
-     *
-     * It sets the {@link #isVisible} property when the target is not attached to DOM or if the target or its descendant has
-     * set the `display` attribute to `none`.
-     *
-     * This method only updates an annotation if the annotation target is an HTML Element.
-     */
-    refreshVisibility(): void;
+* Represents an annotation.
+*
+* Annotation is an entity that combines an {@link module:comments/annotations/view/annotationview~AnnotationView}
+* and an annotation target (a DOM element or a {@link module:utils/dom/rect~Rect}) to which the annotation is bound.
+*/
+export declare class Annotation extends _AnnotationBase {
+	/**
+	* The visibility of the annotation. Annotations that are not visible, are filtered from Annotation UI collections.
+	*
+	* @observable
+	*/
+	isVisible: boolean;
+	/**
+	* The annotation view.
+	*/
+	view: AnnotationView;
+	/**
+	* A collection of DOM elements which, when focused, make the annotation active.
+	*
+	* By default, this collection only contains the annotation view element.
+	* It can be extended with custom targets that will be tracked by the annotation focus tracking system.
+	*/
+	focusableElements: Collection<HTMLElement>;
+	/**
+	* Creates an instance of the {@link module:comments/annotations/annotation~Annotation}.
+	*/
+	constructor({ view, target, type, isVisible }: AnnotationOptions);
+	/**
+	* The type of the annotation.
+	*/
+	get type(): string;
+	/**
+	* The annotation inner view.
+	*
+	* It is the view that is wrapped by the annotation view.*
+	*/
+	get innerView(): View;
+	/**
+	* The annotation target to which the annotation view should be pinned.
+	*
+	* It can be an array of DOM elements or {@link module:utils/dom/rect~Rect a rect instance} or `null`.
+	*/
+	get target(): Rect | Array<HTMLElement> | null;
+	/**
+	* The position and dimensions of the annotation target to which the annotation is bound.
+	*/
+	get targetRect(): Rect | null;
+	/**
+	* The state of the annotation.
+	*/
+	get isActive(): boolean;
+	set isActive(value: boolean);
+	/**
+	* Updates the target rect in the annotation view instance.
+	*/
+	updateTargetRect(): void;
+	/**
+	* Clears all event listeners and internal collections.
+	*/
+	destroy(): void;
+	/**
+	* Refreshes the visibility of the annotation based on the visibility of the annotation target.
+	*
+	* It sets the {@link #isVisible} property when the target is not attached to DOM or if the target or its descendant has
+	* set the `display` attribute to `none`.
+	*
+	* This method only updates an annotation if the annotation target is an HTML Element.
+	*/
+	refreshVisibility(): void;
 }
 export type AnnotationTargetBase = Rect | HTMLElement | null;
 export type AnnotationTarget = AnnotationTargetBase | (() => AnnotationTargetBase | Array<AnnotationTargetBase>);
 /**
- * An event fired when the user pressed Escape key while the annotation view was focused.
- */
+* An event fired when the user pressed Escape key while the annotation view was focused.
+*/
 export type AnnotationEscapeEvent = {
-    name: string;
-    args: [];
+	name: string;
+	args: [];
 };
 export {};

package/dist/annotations/annotationcollection.d.ts

@@ -1,97 +1,97 @@
 /**
- * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
+* @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
+* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
+*/
 /**
- * @module comments/annotations/annotationcollection
- * @publicApi
- */
-import { Collection } from '@ckeditor/ckeditor5-utils';
-import type { View } from '@ckeditor/ckeditor5-ui';
-import { type Annotation } from './annotation.js';
+* @module comments/annotations/annotationcollection
+* @publicApi
+*/
+import { Collection } from "@ckeditor/ckeditor5-utils";
+import type { View } from "@ckeditor/ckeditor5-ui";
+import { type Annotation } from "./annotation.js";
 /**
- * A collection of {@link module:comments/annotations/annotation~Annotation annotations}.
- *
- * It implements methods for managing annotations and creates a focus tracker for them to make it easier to manage
- * the focus for all annotations.
- *
- * `AnnotationCollection` fires {@link module:comments/annotations/annotationcollection~AnnotationCollection#event:focus} when an annotation
- * becomes focused and {@link module:comments/annotations/annotationcollection~AnnotationCollection#event:blur} when all annotations
- * lose focus.
- */
+* A collection of {@link module:comments/annotations/annotation~Annotation annotations}.
+*
+* It implements methods for managing annotations and creates a focus tracker for them to make it easier to manage
+* the focus for all annotations.
+*
+* `AnnotationCollection` fires {@link module:comments/annotations/annotationcollection~AnnotationCollection#event:focus} when an annotation
+* becomes focused and {@link module:comments/annotations/annotationcollection~AnnotationCollection#event:blur} when all annotations
+* lose focus.
+*/
 export declare class AnnotationCollection extends Collection<Annotation> {
-    /**
-     * @param annotations Initial annotations.
-     */
-    constructor(annotations?: Iterable<Annotation>);
-    /**
-    * Equals to `true` when one of the annotation in the collection is focused.
-    */
-    get isFocused(): boolean;
-    /**
-     * Adds an annotation to the collection.
-     */
-    add(annotation: Annotation): this;
-    /**
-     * Removes the annotation from the collection.
-     */
-    remove(annotation: Annotation): Annotation;
-    /**
-     * Gets the annotation for a given annotation view's inner view.
-     */
-    getByInnerView(innerView: View): Annotation | undefined;
-    /**
-     * Gets the annotation for a given annotation view.
-     */
-    getByView(view: View): Annotation | undefined;
-    /**
-     * Destroys all bindings and clears the collection.
-     */
-    destroy(): void;
-    /**
-     * Refreshes the positioning of all annotations and sorts them topmost and leftmost.
-     */
-    refreshPositioning(): void;
+	/**
+	* @param annotations Initial annotations.
+	*/
+	constructor(annotations?: Iterable<Annotation>);
+	/**
+	* Equals to `true` when one of the annotation in the collection is focused.
+	*/
+	get isFocused(): boolean;
+	/**
+	* Adds an annotation to the collection.
+	*/
+	override add(annotation: Annotation): this;
+	/**
+	* Removes the annotation from the collection.
+	*/
+	override remove(annotation: Annotation): Annotation;
+	/**
+	* Gets the annotation for a given annotation view's inner view.
+	*/
+	getByInnerView(innerView: View): Annotation | undefined;
+	/**
+	* Gets the annotation for a given annotation view.
+	*/
+	getByView(view: View): Annotation | undefined;
+	/**
+	* Destroys all bindings and clears the collection.
+	*/
+	destroy(): void;
+	/**
+	* Refreshes the positioning of all annotations and sorts them topmost and leftmost.
+	*/
+	refreshPositioning(): void;
 }
 /**
- * Fired when an annotation becomes active.
- *
- * @eventName ~AnnotationCollection#focus
- * @param annotation An annotation that was focused.
- */
+* Fired when an annotation becomes active.
+*
+* @eventName ~AnnotationCollection#focus
+* @param annotation An annotation that was focused.
+*/
 export type AnnotationFocusEvent = {
-    name: 'focus';
-    args: [annotation: Annotation];
+	name: "focus";
+	args: [annotation: Annotation];
 };
 /**
- * Fired when all annotations become blurred.
- *
- * @eventName ~AnnotationCollection#blur
- */
+* Fired when all annotations become blurred.
+*
+* @eventName ~AnnotationCollection#blur
+*/
 export type AnnotationBlurEvent = {
-    name: 'blur';
-    args: [];
+	name: "blur";
+	args: [];
 };
 /**
- * A helper function that binds two {@link module:comments/annotations/annotationcollection~AnnotationCollection AnnotationCollection}s
- * and allows filtering items based on the passed callback.
- *
- * Since {@link module:comments/annotations/annotationcollection~AnnotationCollection#refreshPositioning}
- * sorts the annotations by removing and inserting items, the binding implemented by the `bindTo()` method is lost. This is why
- * this helper needs to be used.
- *
- * This helper is used by the annotations UIs to filter which annotations from the
- * {@link module:comments/annotations/annotations~Annotations#collection main annotation collection} should be handled by
- * a given annotations UI.
- *
- * @param options An object with configuration options.
- * @param options.source The source collection from which the annotations will be taken.
- * @param options.target The target collection that will be synced to the source collection.
- * @param options.filter Filtering function that gets an annotation and should return `true` if the annotation should be
- * copied to the `target` collection.
- */
+* A helper function that binds two {@link module:comments/annotations/annotationcollection~AnnotationCollection AnnotationCollection}s
+* and allows filtering items based on the passed callback.
+*
+* Since {@link module:comments/annotations/annotationcollection~AnnotationCollection#refreshPositioning}
+* sorts the annotations by removing and inserting items, the binding implemented by the `bindTo()` method is lost. This is why
+* this helper needs to be used.
+*
+* This helper is used by the annotations UIs to filter which annotations from the
+* {@link module:comments/annotations/annotations~Annotations#collection main annotation collection} should be handled by
+* a given annotations UI.
+*
+* @param options An object with configuration options.
+* @param options.source The source collection from which the annotations will be taken.
+* @param options.target The target collection that will be synced to the source collection.
+* @param options.filter Filtering function that gets an annotation and should return `true` if the annotation should be
+* copied to the `target` collection.
+*/
 export declare function bindAnnotationCollections({ source, target, filter }: {
-    source: AnnotationCollection;
-    target: AnnotationCollection;
-    filter: (annotation: Annotation) => boolean;
+	source: AnnotationCollection;
+	target: AnnotationCollection;
+	filter: (annotation: Annotation) => boolean;
 }): void;