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

package/dist/annotations/inlineannotations.d.ts

@@ -1,98 +1,98 @@
 /**
- * @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/inlineannotations
- * @publicApi
- */
-import { Plugin, type Editor } from '@ckeditor/ckeditor5-core';
-import { AnnotationsUIs, type AnnotationsUI } from './annotationsuis.js';
-import { EditorAnnotations } from './editorannotations.js';
-import { ContextualBalloon } from '@ckeditor/ckeditor5-ui';
-import './../../theme/annotation-inline.css';
-import { type Annotation } from './annotation.js';
-import { type AnnotationCollection } from './annotationcollection.js';
+* @module comments/annotations/inlineannotations
+* @publicApi
+*/
+import { Plugin, type Editor, type PluginDependenciesOf } from "@ckeditor/ckeditor5-core";
+import { AnnotationsUIs, type AnnotationsUI } from "./annotationsuis.js";
+import { EditorAnnotations } from "./editorannotations.js";
+import { ContextualBalloon } from "@ckeditor/ckeditor5-ui";
+import "./../../theme/annotation-inline.css";
+import { type Annotation } from "./annotation.js";
+import { type AnnotationCollection } from "./annotationcollection.js";
 /**
- * The popup-style UI for displaying annotations next to editor target elements.
- *
- * It displays {@link module:comments/annotations/annotation~Annotation annotations} in the
- * {@link module:ui/panel/balloon/contextualballoon~ContextualBalloon balloon} where the current
- * {@link module:comments/annotations/inlineannotations~InlineAnnotations#activeAnnotation} is the displayed one.
- *
- * Note: this UI type works only with {@link module:core/editor/editor~Editor the Editor} and cannot be used in integrations where
- * there is only {@link module:core/context~Context context} without any editor.
- *
- * This UI is intended for narrow screens.
- *
- * To activate this UI use one of the following:
- *
- * ```ts
- * editor.plugins.get( 'AnnotationsUIs' ).switchTo( 'inline' );
- * editor.plugins.get( 'AnnotationsUIs' ).activate( 'inline', filter );
- * ```
- *
- * See {@link module:comments/annotations/annotationsuis~AnnotationsUIs}.
- */
+* The popup-style UI for displaying annotations next to editor target elements.
+*
+* It displays {@link module:comments/annotations/annotation~Annotation annotations} in the
+* {@link module:ui/panel/balloon/contextualballoon~ContextualBalloon balloon} where the current
+* {@link module:comments/annotations/inlineannotations~InlineAnnotations#activeAnnotation} is the displayed one.
+*
+* Note: this UI type works only with {@link module:core/editor/editor~Editor the Editor} and cannot be used in integrations where
+* there is only {@link module:core/context~Context context} without any editor.
+*
+* This UI is intended for narrow screens.
+*
+* To activate this UI use one of the following:
+*
+* ```ts
+* editor.plugins.get( 'AnnotationsUIs' ).switchTo( 'inline' );
+* editor.plugins.get( 'AnnotationsUIs' ).activate( 'inline', filter );
+* ```
+*
+* See {@link module:comments/annotations/annotationsuis~AnnotationsUIs}.
+*/
 export declare class InlineAnnotations extends Plugin implements AnnotationsUI<Plugin> {
-    /**
-     * An active annotation tracked by this UI.
-     *
-     * @observable
-     */
-    activeAnnotation: Annotation | null;
-    isAttached: boolean;
-    /**
-     * A collection of annotations controlled by this UI.
-     *
-     * This property is readonly and should not be operated on directly. Use it only to read which annotations are added to this UI.
-     *
-     * It is set to `null` if `InlineAnnotations` is not
-     * {@link module:comments/annotations/inlineannotations~InlineAnnotations#attach attached}.
-     */
-    annotations: AnnotationCollection | null;
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly [typeof EditorAnnotations, typeof ContextualBalloon, typeof AnnotationsUIs];
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "InlineAnnotations";
-    /**
-     * @inheritDoc
-     */
-    static get isOfficialPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    static get isPremiumPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    constructor(editor: Editor);
-    /**
-     * @inheritDoc
-     */
-    init(): void;
-    /**
-     * @inheritDoc
-     */
-    afterInit(): void;
-    /**
-     * Sets the active annotation for this UI.
-     */
-    setActiveAnnotation(annotation: Annotation | null): void;
-    /**
-     * @inheritDoc
-     */
-    attach(annotations: AnnotationCollection): void;
-    /**
-     * @inheritDoc
-     */
-    detach(): void;
-    /**
-     * @inheritDoc
-     */
-    destroy(): void;
+	/**
+	* An active annotation tracked by this UI.
+	*
+	* @observable
+	*/
+	activeAnnotation: Annotation | null;
+	isAttached: boolean;
+	/**
+	* A collection of annotations controlled by this UI.
+	*
+	* This property is readonly and should not be operated on directly. Use it only to read which annotations are added to this UI.
+	*
+	* It is set to `null` if `InlineAnnotations` is not
+	* {@link module:comments/annotations/inlineannotations~InlineAnnotations#attach attached}.
+	*/
+	annotations: AnnotationCollection | null;
+	/**
+	* @inheritDoc
+	*/
+	static get requires(): PluginDependenciesOf<[EditorAnnotations, ContextualBalloon, AnnotationsUIs]>;
+	/**
+	* @inheritDoc
+	*/
+	static get pluginName(): "InlineAnnotations";
+	/**
+	* @inheritDoc
+	*/
+	static override get isOfficialPlugin(): true;
+	/**
+	* @inheritDoc
+	*/
+	static override get isPremiumPlugin(): true;
+	/**
+	* @inheritDoc
+	*/
+	constructor(editor: Editor);
+	/**
+	* @inheritDoc
+	*/
+	init(): void;
+	/**
+	* @inheritDoc
+	*/
+	afterInit(): void;
+	/**
+	* Sets the active annotation for this UI.
+	*/
+	setActiveAnnotation(annotation: Annotation | null): void;
+	/**
+	* @inheritDoc
+	*/
+	attach(annotations: AnnotationCollection): void;
+	/**
+	* @inheritDoc
+	*/
+	detach(): void;
+	/**
+	* @inheritDoc
+	*/
+	override destroy(): void;
 }

package/dist/annotations/narrowsidebar.d.ts

@@ -1,93 +1,93 @@
 /**
- * @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/narrowsidebar
- * @publicApi
- */
-import { ContextPlugin, Context, type Editor } from '@ckeditor/ckeditor5-core';
-import { AnnotationsUIs, type AnnotationsUI } from './annotationsuis.js';
-import { Sidebar } from './sidebar.js';
-import { BalloonPanelView, BodyCollection } from '@ckeditor/ckeditor5-ui';
-import '../../theme/sidebar-narrow.css';
-import { type Annotation } from './annotation.js';
-import type { AnnotationCollection } from './annotationcollection.js';
+* @module comments/annotations/narrowsidebar
+* @publicApi
+*/
+import { ContextPlugin, Context, type Editor, type PluginDependenciesOf } from "@ckeditor/ckeditor5-core";
+import { AnnotationsUIs, type AnnotationsUI } from "./annotationsuis.js";
+import { Sidebar } from "./sidebar.js";
+import { BalloonPanelView, BodyCollection } from "@ckeditor/ckeditor5-ui";
+import "../../theme/sidebar-narrow.css";
+import { type Annotation } from "./annotation.js";
+import type { AnnotationCollection } from "./annotationcollection.js";
 /**
- * The narrow sidebar UI for displaying annotations.
- *
- * Binds {@link module:comments/annotations/annotations~Annotations} plugin with
- * {@link module:comments/annotations/sidebar~Sidebar} plugin to display annotations in the sidebar as
- * {@link module:comments/annotations/view/annotationcounterbuttonview~AnnotationCounterButtonView small icons}.
- *
- * After selecting an annotation the {@link module:ui/panel/balloon/balloonpanelview~BalloonPanelView} with an
- * {@link module:comments/annotations/view/annotationview~AnnotationView} appears attached to the sidebar item.
- *
- * This UI is intended for medium-sized viewports.
- *
- * To activate this UI use one of the following:
- *
- * ```ts
- * editor.plugins.get( 'AnnotationsUIs' ).switchTo( 'narrowSidebar' );
- * editor.plugins.get( 'AnnotationsUIs' ).activate( 'narrowSidebar', filter );
- * ```
- *
- * See {@link module:comments/annotations/annotationsuis~AnnotationsUIs}.
- */
+* The narrow sidebar UI for displaying annotations.
+*
+* Binds {@link module:comments/annotations/annotations~Annotations} plugin with
+* {@link module:comments/annotations/sidebar~Sidebar} plugin to display annotations in the sidebar as
+* {@link module:comments/annotations/view/annotationcounterbuttonview~AnnotationCounterButtonView small icons}.
+*
+* After selecting an annotation the {@link module:ui/panel/balloon/balloonpanelview~BalloonPanelView} with an
+* {@link module:comments/annotations/view/annotationview~AnnotationView} appears attached to the sidebar item.
+*
+* This UI is intended for medium-sized viewports.
+*
+* To activate this UI use one of the following:
+*
+* ```ts
+* editor.plugins.get( 'AnnotationsUIs' ).switchTo( 'narrowSidebar' );
+* editor.plugins.get( 'AnnotationsUIs' ).activate( 'narrowSidebar', filter );
+* ```
+*
+* See {@link module:comments/annotations/annotationsuis~AnnotationsUIs}.
+*/
 export declare class NarrowSidebar extends ContextPlugin implements AnnotationsUI<ContextPlugin> {
-    /**
-     * An active annotation tracked by this UI.
-     */
-    activeAnnotation: Annotation | null;
-    bodyCollection: BodyCollection;
-    balloonPanelView: BalloonPanelView;
-    isAttached: boolean;
-    /**
-     * A collection of annotations controlled by this UI.
-     *
-     * This property is readonly and should not be operated on directly. Use it only to read which annotations are added to this UI.
-     *
-     * It is set to `null` if `NarrowSidebar` is not {@link module:comments/annotations/narrowsidebar~NarrowSidebar#attach attached}.
-     */
-    annotations: AnnotationCollection | null;
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly [typeof Sidebar, typeof AnnotationsUIs];
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "NarrowSidebar";
-    /**
-     * @inheritDoc
-     */
-    static get isOfficialPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    static get isPremiumPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    constructor(context: Context | Editor);
-    /**
-     * @inheritDoc
-     */
-    init(): void;
-    /**
-     * @inheritDoc
-     */
-    attach(annotations: AnnotationCollection): void;
-    /**
-     * Sets the active annotation for this UI.
-     */
-    setActiveAnnotation(annotation: Annotation | null): void;
-    /**
-     * @inheritDoc
-     */
-    detach(): void;
-    /**
-     * @inheritDoc
-     */
-    destroy(): void;
+	/**
+	* An active annotation tracked by this UI.
+	*/
+	activeAnnotation: Annotation | null;
+	bodyCollection: BodyCollection;
+	balloonPanelView: BalloonPanelView;
+	isAttached: boolean;
+	/**
+	* A collection of annotations controlled by this UI.
+	*
+	* This property is readonly and should not be operated on directly. Use it only to read which annotations are added to this UI.
+	*
+	* It is set to `null` if `NarrowSidebar` is not {@link module:comments/annotations/narrowsidebar~NarrowSidebar#attach attached}.
+	*/
+	annotations: AnnotationCollection | null;
+	/**
+	* @inheritDoc
+	*/
+	static get requires(): PluginDependenciesOf<[Sidebar, AnnotationsUIs]>;
+	/**
+	* @inheritDoc
+	*/
+	static get pluginName(): "NarrowSidebar";
+	/**
+	* @inheritDoc
+	*/
+	static override get isOfficialPlugin(): true;
+	/**
+	* @inheritDoc
+	*/
+	static override get isPremiumPlugin(): true;
+	/**
+	* @inheritDoc
+	*/
+	constructor(context: Context | Editor);
+	/**
+	* @inheritDoc
+	*/
+	init(): void;
+	/**
+	* @inheritDoc
+	*/
+	attach(annotations: AnnotationCollection): void;
+	/**
+	* Sets the active annotation for this UI.
+	*/
+	setActiveAnnotation(annotation: Annotation | null): void;
+	/**
+	* @inheritDoc
+	*/
+	detach(): void;
+	/**
+	* @inheritDoc
+	*/
+	override destroy(): void;
 }

package/dist/annotations/sidebar.d.ts

@@ -1,110 +1,110 @@
 /**
- * @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/sidebar
- * @publicApi
- */
-import { ContextPlugin, type Context, type Editor } from '@ckeditor/ckeditor5-core';
-import type { FocusableView } from '@ckeditor/ckeditor5-ui';
-import { AnnotationsSidebarView } from './view/sidebarview.js';
-import { AnnotationsSidebarItemView } from './view/sidebaritemview.js';
-import { type Annotation } from './annotation.js';
+* @module comments/annotations/sidebar
+* @publicApi
+*/
+import { ContextPlugin, type Context, type Editor } from "@ckeditor/ckeditor5-core";
+import type { FocusableView } from "@ckeditor/ckeditor5-ui";
+import { AnnotationsSidebarView } from "./view/sidebarview.js";
+import { AnnotationsSidebarItemView } from "./view/sidebaritemview.js";
+import { type Annotation } from "./annotation.js";
 /**
- * Displays {@link module:comments/annotations/annotationcollection~AnnotationCollection annotations} inside a sidebar.
- *
- * `Sidebar` provides a {@link module:comments/annotations/view/sidebarview~AnnotationsSidebarView} which can be injected at any place on
- * a website.
- *
- * It's main role is to display and correctly position annotation views added to the sidebar, accordingly to their target elements
- * or `Rect`s.
- *
- * The following plugins use `Sidebar` to provide annotations UI:
- *
- * * {@link module:comments/annotations/widesidebar~WideSidebar}
- * * {@link module:comments/annotations/narrowsidebar~NarrowSidebar}
- *
- * The sidebar plugin introduces {@link module:comments/annotations/view/sidebaritemview~AnnotationsSidebarItemView} which is a wrapper view
- * for {@link module:comments/annotations/view/annotationview~AnnotationView}. It adds an interface needed for positioning views inside
- * the sidebar.
- *
- * Structure of items:
- *
- *	                   |-> AnnotationsSidebarItemView -> AnnotationView -> added View
- *	Sidebar#view#list -|-> AnnotationsSidebarItemView -> AnnotationView -> added View
- *	                   |-> ...
- */
+* Displays {@link module:comments/annotations/annotationcollection~AnnotationCollection annotations} inside a sidebar.
+*
+* `Sidebar` provides a {@link module:comments/annotations/view/sidebarview~AnnotationsSidebarView} which can be injected at any place on
+* a website.
+*
+* It's main role is to display and correctly position annotation views added to the sidebar, accordingly to their target elements
+* or `Rect`s.
+*
+* The following plugins use `Sidebar` to provide annotations UI:
+*
+* * {@link module:comments/annotations/widesidebar~WideSidebar}
+* * {@link module:comments/annotations/narrowsidebar~NarrowSidebar}
+*
+* The sidebar plugin introduces {@link module:comments/annotations/view/sidebaritemview~AnnotationsSidebarItemView} which is a wrapper view
+* for {@link module:comments/annotations/view/annotationview~AnnotationView}. It adds an interface needed for positioning views inside
+* the sidebar.
+*
+* Structure of items:
+*
+*	                   |-> AnnotationsSidebarItemView -> AnnotationView -> added View
+*	Sidebar#view#list -|-> AnnotationsSidebarItemView -> AnnotationView -> added View
+*	                   |-> ...
+*/
 export declare class Sidebar extends ContextPlugin {
-    /**
-     * Container element into which sidebar is injected (in the DOM).
-     *
-     * @observable
-     */
-    container: HTMLElement | null;
-    /**
-     * Sidebar view.
-     */
-    view: AnnotationsSidebarView;
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "Sidebar";
-    /**
-     * @inheritDoc
-     */
-    static get isOfficialPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    static get isPremiumPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    constructor(context: Context | Editor);
-    /**
-     * @inheritDoc
-     */
-    init(): void;
-    /**
-     * Sets a new sidebar container.
-     */
-    setContainer(container: HTMLElement): void;
-    /**
-     * Rearranges annotations when the annotation is removed.
-     */
-    rearrange({ removedAnnotation, previousAnnotation, nextAnnotation }: {
-        removedAnnotation: Annotation;
-        previousAnnotation: Annotation | null;
-        nextAnnotation: Annotation | null;
-    }): void;
-    /**
-     * Refreshes sidebar items when one of the annotations is activated.
-     *
-     * @param options Configuration options.
-     * @param options.activatedAnnotation The activated annotation.
-     * @param options.blurredAnnotation The previously active annotation.
-     * @param options.disableAnimationOnActivatedAnnotation Disables animation on the activated annotation.
-     */
-    refresh({ blurredAnnotation, activatedAnnotation, disableAnimationOnActivatedAnnotation }: {
-        blurredAnnotation: Annotation | null;
-        activatedAnnotation: Annotation | null;
-        disableAnimationOnActivatedAnnotation?: boolean;
-    }): void;
-    /**
-     * Creates new {@link module:comments/annotations/view/sidebaritemview~AnnotationsSidebarItemView} and binds its
-     * position with {@link module:comments/annotations/view/annotationview~AnnotationView} target position.
-     *
-     * By default, annotation's view will be displayed in the sidebar. However, you can provide any other view
-     * to be displayed instead using `annotationToDisplay`. `annotation` will be then used only to gather data needed by `Sidebar`.
-     */
-    addAnnotation(annotation: Annotation, viewToDisplay?: FocusableView): AnnotationsSidebarItemView;
-    /**
-     * Returns sidebar item view that wraps given annotation view.
-     */
-    getSidebarItemView(annotation: Annotation): AnnotationsSidebarItemView | undefined;
-    /**
-     * @inheritDoc
-     */
-    destroy(): void;
+	/**
+	* Container element into which sidebar is injected (in the DOM).
+	*
+	* @observable
+	*/
+	container: HTMLElement | null;
+	/**
+	* Sidebar view.
+	*/
+	view: AnnotationsSidebarView;
+	/**
+	* @inheritDoc
+	*/
+	static get pluginName(): "Sidebar";
+	/**
+	* @inheritDoc
+	*/
+	static override get isOfficialPlugin(): true;
+	/**
+	* @inheritDoc
+	*/
+	static override get isPremiumPlugin(): true;
+	/**
+	* @inheritDoc
+	*/
+	constructor(context: Context | Editor);
+	/**
+	* @inheritDoc
+	*/
+	init(): void;
+	/**
+	* Sets a new sidebar container.
+	*/
+	setContainer(container: HTMLElement): void;
+	/**
+	* Rearranges annotations when the annotation is removed.
+	*/
+	rearrange({ removedAnnotation, previousAnnotation, nextAnnotation }: {
+		removedAnnotation: Annotation;
+		previousAnnotation: Annotation | null;
+		nextAnnotation: Annotation | null;
+	}): void;
+	/**
+	* Refreshes sidebar items when one of the annotations is activated.
+	*
+	* @param options Configuration options.
+	* @param options.activatedAnnotation The activated annotation.
+	* @param options.blurredAnnotation The previously active annotation.
+	* @param options.disableAnimationOnActivatedAnnotation Disables animation on the activated annotation.
+	*/
+	refresh({ blurredAnnotation, activatedAnnotation, disableAnimationOnActivatedAnnotation }: {
+		blurredAnnotation: Annotation | null;
+		activatedAnnotation: Annotation | null;
+		disableAnimationOnActivatedAnnotation?: boolean;
+	}): void;
+	/**
+	* Creates new {@link module:comments/annotations/view/sidebaritemview~AnnotationsSidebarItemView} and binds its
+	* position with {@link module:comments/annotations/view/annotationview~AnnotationView} target position.
+	*
+	* By default, annotation's view will be displayed in the sidebar. However, you can provide any other view
+	* to be displayed instead using `annotationToDisplay`. `annotation` will be then used only to gather data needed by `Sidebar`.
+	*/
+	addAnnotation(annotation: Annotation, viewToDisplay?: FocusableView): AnnotationsSidebarItemView;
+	/**
+	* Returns sidebar item view that wraps given annotation view.
+	*/
+	getSidebarItemView(annotation: Annotation): AnnotationsSidebarItemView | undefined;
+	/**
+	* @inheritDoc
+	*/
+	override destroy(): void;
 }

package/dist/annotations/view/annotationcounterbuttonview.d.ts

@@ -1,29 +1,29 @@
 /**
- * @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/view/annotationcounterbuttonview
- * @publicApi
- */
-import { ButtonView, View } from '@ckeditor/ckeditor5-ui';
-import type { Locale } from '@ckeditor/ckeditor5-utils';
+* @module comments/annotations/view/annotationcounterbuttonview
+* @publicApi
+*/
+import { ButtonView, View } from "@ckeditor/ckeditor5-ui";
+import type { Locale } from "@ckeditor/ckeditor5-utils";
 /**
- * A view used in the sidebar by {@link module:comments/annotations/narrowsidebar~NarrowSidebar}.
- */
+* A view used in the sidebar by {@link module:comments/annotations/narrowsidebar~NarrowSidebar}.
+*/
 export declare class AnnotationCounterButtonView extends ButtonView {
-    /**
-     * @observable
-     */
-    isDirty: boolean;
-    /**
-     * @observable
-     */
-    number: number;
-    /**
-     * @observable
-     */
-    annotationType: string;
-    counterView: View;
-    constructor(locale: Locale);
+	/**
+	* @observable
+	*/
+	isDirty: boolean;
+	/**
+	* @observable
+	*/
+	number: number;
+	/**
+	* @observable
+	*/
+	annotationType: string;
+	counterView: View;
+	constructor(locale: Locale);
 }