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

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

@@ -1,90 +1,90 @@
 /**
- * @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/annotationview
- * @publicApi
- */
-import { type FocusableView, View, type ViewCollection } from '@ckeditor/ckeditor5-ui';
-import { FocusTracker, KeystrokeHandler, type Rect, type Locale } from '@ckeditor/ckeditor5-utils';
-import '../../../theme/annotation.css';
+* @module comments/annotations/view/annotationview
+* @publicApi
+*/
+import { type FocusableView, View, type ViewCollection } from "@ckeditor/ckeditor5-ui";
+import { FocusTracker, KeystrokeHandler, type Rect, type Locale } from "@ckeditor/ckeditor5-utils";
+import "../../../theme/annotation.css";
 /**
- * A wrapping view for any view added to the `Annotations` plugin.
- *
- * It introduces functionalities that make the given view ready to be used as an annotation, such as focus tracking, height resizing,
- * and other observable properties that help share current annotation state across different UIs.
- */
+* A wrapping view for any view added to the `Annotations` plugin.
+*
+* It introduces functionalities that make the given view ready to be used as an annotation, such as focus tracking, height resizing,
+* and other observable properties that help share current annotation state across different UIs.
+*/
 export declare class AnnotationView extends View implements FocusableView {
-    /**
-     * Tracks focus on the annotation view.
-     *
-     * Add a DOM element to this focus tracker to prevent blurring annotation view
-     * when the DOM element is focused.
-     */
-    readonly focusTracker: FocusTracker;
-    readonly id: string;
-    readonly keystrokes: KeystrokeHandler;
-    /**
-     * Target rectangle to which the annotation should be attached.
-     *
-     * @observable
-     */
-    targetRect: Rect | null;
-    /**
-     * Annotation view height.
-     *
-     * @observable
-     */
-    height: number;
-    /**
-     * Informs if an annotation is active.
-     *
-     * @observable
-     */
-    isActive: boolean;
-    /**
-     * Informs if there are unsaved changes in the annotation.
-     *
-     * @observable
-     */
-    isDirty: boolean;
-    /**
-     * The number of items in the annotation.
-     *
-     * @observable
-     */
-    length: number;
-    /**
-     * @observable
-     */
-    type: string;
-    element: HTMLElement;
-    /**
-     * Collection for content views.
-     */
-    content: ViewCollection<FocusableView>;
-    /**
-     * The inner annotation view.
-     */
-    mainView: AnnotationMainView;
-    /**
-     * @inheritDoc
-     */
-    constructor(locale: Locale, mainView: AnnotationMainView);
-    /**
-     * @inheritDoc
-     */
-    render(): void;
-    /**
-     * @inheritDoc
-     */
-    destroy(): void;
-    /**
-     * Focuses the annotation view.
-     */
-    focus(): void;
+	/**
+	* Tracks focus on the annotation view.
+	*
+	* Add a DOM element to this focus tracker to prevent blurring annotation view
+	* when the DOM element is focused.
+	*/
+	readonly focusTracker: FocusTracker;
+	readonly id: string;
+	readonly keystrokes: KeystrokeHandler;
+	/**
+	* Target rectangle to which the annotation should be attached.
+	*
+	* @observable
+	*/
+	targetRect: Rect | null;
+	/**
+	* Annotation view height.
+	*
+	* @observable
+	*/
+	height: number;
+	/**
+	* Informs if an annotation is active.
+	*
+	* @observable
+	*/
+	isActive: boolean;
+	/**
+	* Informs if there are unsaved changes in the annotation.
+	*
+	* @observable
+	*/
+	isDirty: boolean;
+	/**
+	* The number of items in the annotation.
+	*
+	* @observable
+	*/
+	length: number;
+	/**
+	* @observable
+	*/
+	type: string;
+	element: HTMLElement;
+	/**
+	* Collection for content views.
+	*/
+	content: ViewCollection<FocusableView>;
+	/**
+	* The inner annotation view.
+	*/
+	mainView: AnnotationMainView;
+	/**
+	* @inheritDoc
+	*/
+	constructor(locale: Locale, mainView: AnnotationMainView);
+	/**
+	* @inheritDoc
+	*/
+	override render(): void;
+	/**
+	* @inheritDoc
+	*/
+	override destroy(): void;
+	/**
+	* Focuses the annotation view.
+	*/
+	focus(): void;
 }
 export interface AnnotationMainView extends FocusableView {
-    isActive: boolean;
+	isActive: boolean;
 }

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

@@ -1,59 +1,59 @@
 /**
- * @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/sidebaritemview
- * @publicApi
- */
-import { View, type ViewCollection, type FocusableView } from '@ckeditor/ckeditor5-ui';
-import { type Locale } from '@ckeditor/ckeditor5-utils';
+* @module comments/annotations/view/sidebaritemview
+* @publicApi
+*/
+import { View, type ViewCollection, type FocusableView } from "@ckeditor/ckeditor5-ui";
+import { type Locale } from "@ckeditor/ckeditor5-utils";
 /**
- * A wrapper view that wraps given {@link module:ui/view~View} to display it as a {@link module:comments/annotations/sidebar~Sidebar} item.
- */
+* A wrapper view that wraps given {@link module:ui/view~View} to display it as a {@link module:comments/annotations/sidebar~Sidebar} item.
+*/
 export declare class AnnotationsSidebarItemView extends View implements FocusableView {
-    element: HTMLElement;
-    /**
-     * The item top offset.
-     * Setting `0` as the initial value makes new items falling from heaven.
-     *
-     * @observable
-     */
-    top: number;
-    /**
-     * @observable
-     */
-    bottom: number;
-    /**
-     * @observable
-     */
-    height: number;
-    /**
-     * @observable
-     */
-    isAnimationDisabled: boolean;
-    /**
-     * A collection of content views.
-     */
-    content: ViewCollection<FocusableView>;
-    /**
-     * @inheritDoc
-     */
-    constructor(locale: Locale);
-    /**
-     * @inheritDoc
-     */
-    render(): void;
-    /**
-     * @inheritDoc
-     */
-    focus(): void;
-    /**
-     * Updates {@link #height the height property} according to the element's DOM height.
-     */
-    updateHeight(): void;
-    /**
-     * @inheritDoc
-     */
-    destroy(): void;
+	element: HTMLElement;
+	/**
+	* The item top offset.
+	* Setting `0` as the initial value makes new items falling from heaven.
+	*
+	* @observable
+	*/
+	top: number;
+	/**
+	* @observable
+	*/
+	bottom: number;
+	/**
+	* @observable
+	*/
+	height: number;
+	/**
+	* @observable
+	*/
+	isAnimationDisabled: boolean;
+	/**
+	* A collection of content views.
+	*/
+	content: ViewCollection<FocusableView>;
+	/**
+	* @inheritDoc
+	*/
+	constructor(locale: Locale);
+	/**
+	* @inheritDoc
+	*/
+	override render(): void;
+	/**
+	* @inheritDoc
+	*/
+	focus(): void;
+	/**
+	* Updates {@link #height the height property} according to the element's DOM height.
+	*/
+	updateHeight(): void;
+	/**
+	* @inheritDoc
+	*/
+	override destroy(): void;
 }

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

@@ -1,53 +1,53 @@
 /**
- * @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/sidebarview
- * @publicApi
- */
-import { View, FocusCycler, type ViewCollection, type ViewWithFocusCycler } from '@ckeditor/ckeditor5-ui';
-import { FocusTracker, type Locale } from '@ckeditor/ckeditor5-utils';
-import { type AnnotationsSidebarItemView } from './sidebaritemview.js';
-import '../../../theme/sidebar.css';
+* @module comments/annotations/view/sidebarview
+* @publicApi
+*/
+import { View, FocusCycler, type ViewCollection, type ViewWithFocusCycler } from "@ckeditor/ckeditor5-ui";
+import { FocusTracker, type Locale } from "@ckeditor/ckeditor5-utils";
+import { type AnnotationsSidebarItemView } from "./sidebaritemview.js";
+import "../../../theme/sidebar.css";
 /**
- * The sidebar view class that displays the collection of sidebar item views.
- */
+* The sidebar view class that displays the collection of sidebar item views.
+*/
 export declare class AnnotationsSidebarView extends View implements ViewWithFocusCycler {
-    /**
-     * @observable
-     */
-    minHeight: number | null;
-    /**
-     * @observable
-     */
-    class: string;
-    /**
-     * A collection of sidebar item views.
-     */
-    list: ViewCollection<AnnotationsSidebarItemView>;
-    /**
-     * A collection of focusable views in the sidebar.
-     */
-    focusables: ViewCollection<AnnotationsSidebarItemView>;
-    /**
-     * Tracks information about DOM focus among sidebar item views.
-     */
-    readonly focusTracker: FocusTracker;
-    /**
-     * Helps cycling over {@link #focusables focusable items} in the sidebar.
-     */
-    readonly focusCycler: FocusCycler;
-    /**
-     * @inheritDoc
-     */
-    constructor(locale: Locale);
-    /**
-     * @inheritDoc
-     */
-    render(): void;
-    /**
-     * @inheritDoc
-     */
-    focus(): void;
+	/**
+	* @observable
+	*/
+	minHeight: number | null;
+	/**
+	* @observable
+	*/
+	class: string;
+	/**
+	* A collection of sidebar item views.
+	*/
+	list: ViewCollection<AnnotationsSidebarItemView>;
+	/**
+	* A collection of focusable views in the sidebar.
+	*/
+	focusables: ViewCollection<AnnotationsSidebarItemView>;
+	/**
+	* Tracks information about DOM focus among sidebar item views.
+	*/
+	readonly focusTracker: FocusTracker;
+	/**
+	* Helps cycling over {@link #focusables focusable items} in the sidebar.
+	*/
+	readonly focusCycler: FocusCycler;
+	/**
+	* @inheritDoc
+	*/
+	constructor(locale: Locale);
+	/**
+	* @inheritDoc
+	*/
+	override render(): void;
+	/**
+	* @inheritDoc
+	*/
+	focus(): void;
 }

package/dist/annotations/widesidebar.d.ts

@@ -1,85 +1,85 @@
 /**
- * @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/widesidebar
- * @publicApi
- */
-import { ContextPlugin, Context, type Editor } from '@ckeditor/ckeditor5-core';
-import { AnnotationsUIs, type AnnotationsUI } from './annotationsuis.js';
-import { Sidebar } from './sidebar.js';
-import { type Annotation } from './annotation.js';
-import type { AnnotationCollection } from './annotationcollection.js';
+* @module comments/annotations/widesidebar
+* @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 { type Annotation } from "./annotation.js";
+import type { AnnotationCollection } from "./annotationcollection.js";
 /**
- * The wide sidebar UI for displaying annotations.
- *
- * In this implementation {@link module:comments/annotations/sidebar~Sidebar the sidebar} displays full
- * {@link module:comments/annotations/view/annotationview~AnnotationView annotation views}.
- *
- * To activate this UI use one of the following:
- *
- * ```ts
- * editor.plugins.get( 'AnnotationsUIs' ).switchTo( 'wideSidebar' );
- * editor.plugins.get( 'AnnotationsUIs' ).activate( 'wideSidebar', filter );
- * ```
- *
- * See {@link module:comments/annotations/annotationsuis~AnnotationsUIs}.
- */
+* The wide sidebar UI for displaying annotations.
+*
+* In this implementation {@link module:comments/annotations/sidebar~Sidebar the sidebar} displays full
+* {@link module:comments/annotations/view/annotationview~AnnotationView annotation views}.
+*
+* To activate this UI use one of the following:
+*
+* ```ts
+* editor.plugins.get( 'AnnotationsUIs' ).switchTo( 'wideSidebar' );
+* editor.plugins.get( 'AnnotationsUIs' ).activate( 'wideSidebar', filter );
+* ```
+*
+* See {@link module:comments/annotations/annotationsuis~AnnotationsUIs}.
+*/
 export declare class WideSidebar extends ContextPlugin implements AnnotationsUI<ContextPlugin> {
-    /**
-     * 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 `WideSidebar` is not {@link module:comments/annotations/widesidebar~WideSidebar#attach attached}.
-     */
-    annotations: AnnotationCollection | null;
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly [typeof Sidebar, typeof AnnotationsUIs];
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "WideSidebar";
-    /**
-     * @inheritDoc
-     */
-    static get isOfficialPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    static get isPremiumPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    constructor(context: Context | Editor);
-    /**
-     * @inheritDoc
-     */
-    init(): 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 `WideSidebar` is not {@link module:comments/annotations/widesidebar~WideSidebar#attach attached}.
+	*/
+	annotations: AnnotationCollection | null;
+	/**
+	* @inheritDoc
+	*/
+	static get requires(): PluginDependenciesOf<[Sidebar, AnnotationsUIs]>;
+	/**
+	* @inheritDoc
+	*/
+	static get pluginName(): "WideSidebar";
+	/**
+	* @inheritDoc
+	*/
+	static override get isOfficialPlugin(): true;
+	/**
+	* @inheritDoc
+	*/
+	static override get isPremiumPlugin(): true;
+	/**
+	* @inheritDoc
+	*/
+	constructor(context: Context | Editor);
+	/**
+	* @inheritDoc
+	*/
+	init(): 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;
 }