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

package/dist/comments/ui/view/basecommentthreadview.d.ts

@@ -1,148 +1,148 @@
 /**
- * @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/comments/ui/view/basecommentthreadview
- * @publicApi
- */
-import { FocusCycler, View, type FocusableView, type ViewCollection } from '@ckeditor/ckeditor5-ui';
-import { type Locale, FocusTracker, KeystrokeHandler } from '@ckeditor/ckeditor5-utils';
-import { CommentThreadInputView } from './commentthreadinputview.js';
-import { CommentsListView } from './commentslistview.js';
-import { CommentThreadHeaderView } from './commentthreadheaderview.js';
-import { AriaDescriptionView, type User } from '@ckeditor/ckeditor5-collaboration-core';
-import type { CommentThread } from '../../commentsrepository.js';
-import type { CommentThreadConfig } from '../../../config.js';
+* @module comments/comments/ui/view/basecommentthreadview
+* @publicApi
+*/
+import { FocusCycler, View, type FocusableView, type ViewCollection } from "@ckeditor/ckeditor5-ui";
+import { type Locale, FocusTracker, KeystrokeHandler } from "@ckeditor/ckeditor5-utils";
+import { CommentThreadInputView } from "./commentthreadinputview.js";
+import { CommentsListView } from "./commentslistview.js";
+import { CommentThreadHeaderView } from "./commentthreadheaderview.js";
+import { AriaDescriptionView, type User } from "@ckeditor/ckeditor5-collaboration-core";
+import type { CommentThread } from "../../commentsrepository.js";
+import type { CommentThreadConfig } from "../../../config.js";
 /**
- * An abstract comment thread view class that should be used as a base for comment thread view implementations.
- * It provides some behaviors, flags and building blocks to use when creating a custom comment thread view class.
- *
- * For the usage examples check the {@glink features/collaboration/annotations/annotations-custom-view Custom annotation view} guide.
- */
+* An abstract comment thread view class that should be used as a base for comment thread view implementations.
+* It provides some behaviors, flags and building blocks to use when creating a custom comment thread view class.
+*
+* For the usage examples check the {@glink features/collaboration/annotations/annotations-custom-view Custom annotation view} guide.
+*/
 export declare class BaseCommentThreadView extends View {
-    locale: Locale;
-    /**
-     * Informs whether the comment thread view is in active state ("highlighted").
-     * A comment thread view is in this state when it is focused or was activated by the user in any other way.
-     *
-     * @observable
-     */
-    isActive: boolean;
-    /**
-     * Informs whether the comment thread view is in unlinked state.
-     * A comment thread view is in this state when its corresponding target has been removed from the content.
-     *
-     * @observable
-     */
-    isUnlinked: boolean;
-    /**
-     * Informs whether the comment thread has any changes that have not been saved.
-     *
-     * @observable
-     */
-    isDirty: boolean;
-    /**
-     * The number of comments.
-     *
-     * @observable
-     */
-    readonly length: number;
-    /**
-     * The list of comment views. It should be used as a part of the view template.
-     *
-     * @readonly
-     */
-    readonly commentsListView: CommentsListView;
-    /**
-     * The comment thread header. It should be used as a part of the view template.
-     * This header is used only for resolved comment threads.
-     *
-     * @readonly
-     */
-    readonly commentThreadHeaderView: CommentThreadHeaderView;
-    /**
-     * The comment input area view. It should be used as a part of the view template.
-     *
-     * @readonly
-     */
-    readonly commentThreadInputView: CommentThreadInputView;
-    /**
-     * A helper view that provides an ARIA description for the comment thread used by
-     * assistive technologies.
-     */
-    readonly ariaDescriptionView: AriaDescriptionView;
-    /**
-     * An accessible thread label text exposed to assistive technologies.
-     */
-    ariaLabel: string;
-    /**
-     * The collection of focusable views in the comment thread.
-     */
-    readonly focusables: ViewCollection<FocusableView>;
-    /**
-     * Tracks information about DOM focus in the thread.
-     */
-    readonly focusTracker: FocusTracker;
-    /**
-     * Instance of the {@link module:utils/keystrokehandler~KeystrokeHandler}.
-     */
-    readonly keystrokes: KeystrokeHandler;
-    /**
-     * Helps cycling over focusable views in the thread.
-     */
-    readonly focusCycler: FocusCycler;
-    /**
-     * @param locale The localization service instance.
-     * @param model The model on which the view will base.
-     * @param localUser The current local user.
-     * @param config Additional view configuration.
-     */
-    constructor(locale: Locale, model: CommentThread, localUser: User, config: CommentThreadConfig);
-    /**
-     * Focuses the view.
-     */
-    focus(): void;
-    /**
-     * @inheritDoc
-     */
-    render(): void;
-    /**
-     * @inheritDoc
-     */
-    destroy(): Promise<void>;
+	locale: Locale;
+	/**
+	* Informs whether the comment thread view is in active state ("highlighted").
+	* A comment thread view is in this state when it is focused or was activated by the user in any other way.
+	*
+	* @observable
+	*/
+	isActive: boolean;
+	/**
+	* Informs whether the comment thread view is in unlinked state.
+	* A comment thread view is in this state when its corresponding target has been removed from the content.
+	*
+	* @observable
+	*/
+	isUnlinked: boolean;
+	/**
+	* Informs whether the comment thread has any changes that have not been saved.
+	*
+	* @observable
+	*/
+	isDirty: boolean;
+	/**
+	* The number of comments.
+	*
+	* @observable
+	*/
+	readonly length: number;
+	/**
+	* The list of comment views. It should be used as a part of the view template.
+	*
+	* @readonly
+	*/
+	readonly commentsListView: CommentsListView;
+	/**
+	* The comment thread header. It should be used as a part of the view template.
+	* This header is used only for resolved comment threads.
+	*
+	* @readonly
+	*/
+	readonly commentThreadHeaderView: CommentThreadHeaderView;
+	/**
+	* The comment input area view. It should be used as a part of the view template.
+	*
+	* @readonly
+	*/
+	readonly commentThreadInputView: CommentThreadInputView;
+	/**
+	* A helper view that provides an ARIA description for the comment thread used by
+	* assistive technologies.
+	*/
+	readonly ariaDescriptionView: AriaDescriptionView;
+	/**
+	* An accessible thread label text exposed to assistive technologies.
+	*/
+	ariaLabel: string;
+	/**
+	* The collection of focusable views in the comment thread.
+	*/
+	readonly focusables: ViewCollection<FocusableView>;
+	/**
+	* Tracks information about DOM focus in the thread.
+	*/
+	readonly focusTracker: FocusTracker;
+	/**
+	* Instance of the {@link module:utils/keystrokehandler~KeystrokeHandler}.
+	*/
+	readonly keystrokes: KeystrokeHandler;
+	/**
+	* Helps cycling over focusable views in the thread.
+	*/
+	readonly focusCycler: FocusCycler;
+	/**
+	* @param locale The localization service instance.
+	* @param model The model on which the view will base.
+	* @param localUser The current local user.
+	* @param config Additional view configuration.
+	*/
+	constructor(locale: Locale, model: CommentThread, localUser: User, config: CommentThreadConfig);
+	/**
+	* Focuses the view.
+	*/
+	focus(): void;
+	/**
+	* @inheritDoc
+	*/
+	override render(): void;
+	/**
+	* @inheritDoc
+	*/
+	override destroy(): Promise<void>;
 }
 /**
- * Fired when a user created a first comment in the comment thread. Then the comment thread is submitted and saved.
- *
- * @eventName ~BaseCommentThreadView#submitCommentThread
- */
+* Fired when a user created a first comment in the comment thread. Then the comment thread is submitted and saved.
+*
+* @eventName ~BaseCommentThreadView#submitCommentThread
+*/
 export type UISubmitCommentThreadEvent = {
-    name: 'submitCommentThread';
-    args: [];
+	name: "submitCommentThread";
+	args: [];
 };
 /**
- * Fired when a user performed an action that should lead to removing the comment thread.
- *
- * This event is not fired by default by any component created by `BaseCommentThreadView`.
- * If you create a view class extending `BaseCommentThreadView`, you should provide
- * a UI element that will fire this event.
- *
- * This event is fired by default when an empty comment thread view (with no comments)
- * loses focus.
- *
- * @eventName ~BaseCommentThreadView#removeCommentThread
- */
+* Fired when a user performed an action that should lead to removing the comment thread.
+*
+* This event is not fired by default by any component created by `BaseCommentThreadView`.
+* If you create a view class extending `BaseCommentThreadView`, you should provide
+* a UI element that will fire this event.
+*
+* This event is fired by default when an empty comment thread view (with no comments)
+* loses focus.
+*
+* @eventName ~BaseCommentThreadView#removeCommentThread
+*/
 export type UIRemoveCommentThreadEvent = {
-    name: 'removeCommentThread';
-    args: [];
+	name: "removeCommentThread";
+	args: [];
 };
 /**
- * Fired when a user performed an action that should lead to resolve the comment thread.
- *
- * @eventName ~BaseCommentThreadView#resolveCommentThread
- */
+* Fired when a user performed an action that should lead to resolve the comment thread.
+*
+* @eventName ~BaseCommentThreadView#resolveCommentThread
+*/
 export type UIResolveCommentThreadEvent = {
-    name: 'resolveCommentThread';
-    args: [id: string];
+	name: "resolveCommentThread";
+	args: [id: string];
 };

package/dist/comments/ui/view/basecommentview.d.ts

@@ -1,150 +1,150 @@
 /**
- * @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/comments/ui/view/basecommentview
- * @publicApi
- */
-import { View, ViewCollection, type FocusableView, FocusCycler } from '@ckeditor/ckeditor5-ui';
-import { FocusTracker, KeystrokeHandler, type Locale } from '@ckeditor/ckeditor5-utils';
-import { AriaDescriptionView } from '@ckeditor/ckeditor5-collaboration-core';
-import type { Comment } from '../../commentsrepository.js';
-import type { CommentViewConfig } from '../../../config.js';
+* @module comments/comments/ui/view/basecommentview
+* @publicApi
+*/
+import { View, ViewCollection, type FocusableView, FocusCycler } from "@ckeditor/ckeditor5-ui";
+import { FocusTracker, KeystrokeHandler, type Locale } from "@ckeditor/ckeditor5-utils";
+import { AriaDescriptionView } from "@ckeditor/ckeditor5-collaboration-core";
+import type { Comment } from "../../commentsrepository.js";
+import type { CommentViewConfig } from "../../../config.js";
 /**
- * An abstract comment view class that should be used as a base for comment view implementations.
- *
- * It provides some behaviors, flags and building blocks to use when creating a custom comment view class.
- */
+* An abstract comment view class that should be used as a base for comment view implementations.
+*
+* It provides some behaviors, flags and building blocks to use when creating a custom comment view class.
+*/
 export declare class BaseCommentView extends View implements FocusableView {
-    locale: Locale;
-    /**
-     * Informs whether the comment view is in the editing mode.
-     *
-     * @observable
-     */
-    isEditMode: boolean;
-    /**
-     * Flag indicating whether the comment view displays an actual comment (`false`) or is a system message (`true`).
-     * System message comment should not include any UI elements which allow for editing the comment as it is not an actual comment.
-     *
-     * @readonly
-     */
-    isSystemComment: boolean;
-    /**
-     * Stores the currently displayed sub-view.
-     *
-     * This is a collection that always includes one view: comment content view or comment input view.
-     * Depending whether the comment is in editing mode or not, one of the views is in the collection.
-     * When the comment mode changes, the content of this collection also changes.
-     *
-     * By default, the comment is in the "content mode" and this view collection stores the comment content view.
-     */
-    readonly visibleView: ViewCollection;
-    /**
-     * A helper view that provides an ARIA description for the comment used by
-     * assistive technologies.
-     */
-    readonly ariaDescriptionView: AriaDescriptionView;
-    /**
-     * An accessible label text used by assistive technologies describing the comment.
-     */
-    ariaLabel: string;
-    /**
-     * A collection of child views that can receive focus and contribute to the (shift) tab key navigation.
-     */
-    readonly focusables: ViewCollection<FocusableView>;
-    /**
-     * Tracks information about DOM focus in the comment view.
-     */
-    readonly focusTracker: FocusTracker;
-    /**
-     * Instance of the {@link module:utils/keystrokehandler~KeystrokeHandler}.
-     */
-    readonly keystrokes: KeystrokeHandler;
-    /**
-     * Helps cycling over focusable {@link #focusables} in the comment.
-     */
-    readonly focusCycler: FocusCycler;
-    /**
-     * @param locale The localization service instance.
-     * @param model The model on which the view will base.
-     * @param config Additional view configuration.
-     */
-    constructor(locale: Locale, model: Comment, config: CommentViewConfig);
-    /**
-     * Expands the view.
-     */
-    expand(): void;
-    /**
-     * Collapses the view.
-     */
-    collapse(): void;
-    /**
-     * Focuses the view.
-     */
-    focus(): void;
-    /**
-     * @inheritDoc
-     */
-    render(): void;
-    /**
-     * @inheritDoc
-     */
-    destroy(): Promise<void>;
-    /**
-     * Switches the comment to the editing mode.
-     */
-    switchToEditMode(): void;
-    /**
-     * Switches the comment back from the editing mode to the content display mode.
-     */
-    switchToDisplayMode(): void;
-    /**
-     * Gets the translated note which indicates that the comment comes from an external source.
-     */
-    getExternalCommentNote(): string;
-    /**
-     * Gets the translated notification text which indicates that author name comes from an external source.
-     */
-    getUserViewNotificationText(): string | null;
+	locale: Locale;
+	/**
+	* Informs whether the comment view is in the editing mode.
+	*
+	* @observable
+	*/
+	isEditMode: boolean;
+	/**
+	* Flag indicating whether the comment view displays an actual comment (`false`) or is a system message (`true`).
+	* System message comment should not include any UI elements which allow for editing the comment as it is not an actual comment.
+	*
+	* @readonly
+	*/
+	isSystemComment: boolean;
+	/**
+	* Stores the currently displayed sub-view.
+	*
+	* This is a collection that always includes one view: comment content view or comment input view.
+	* Depending whether the comment is in editing mode or not, one of the views is in the collection.
+	* When the comment mode changes, the content of this collection also changes.
+	*
+	* By default, the comment is in the "content mode" and this view collection stores the comment content view.
+	*/
+	readonly visibleView: ViewCollection;
+	/**
+	* A helper view that provides an ARIA description for the comment used by
+	* assistive technologies.
+	*/
+	readonly ariaDescriptionView: AriaDescriptionView;
+	/**
+	* An accessible label text used by assistive technologies describing the comment.
+	*/
+	ariaLabel: string;
+	/**
+	* A collection of child views that can receive focus and contribute to the (shift) tab key navigation.
+	*/
+	readonly focusables: ViewCollection<FocusableView>;
+	/**
+	* Tracks information about DOM focus in the comment view.
+	*/
+	readonly focusTracker: FocusTracker;
+	/**
+	* Instance of the {@link module:utils/keystrokehandler~KeystrokeHandler}.
+	*/
+	readonly keystrokes: KeystrokeHandler;
+	/**
+	* Helps cycling over focusable {@link #focusables} in the comment.
+	*/
+	readonly focusCycler: FocusCycler;
+	/**
+	* @param locale The localization service instance.
+	* @param model The model on which the view will base.
+	* @param config Additional view configuration.
+	*/
+	constructor(locale: Locale, model: Comment, config: CommentViewConfig);
+	/**
+	* Expands the view.
+	*/
+	expand(): void;
+	/**
+	* Collapses the view.
+	*/
+	collapse(): void;
+	/**
+	* Focuses the view.
+	*/
+	focus(): void;
+	/**
+	* @inheritDoc
+	*/
+	override render(): void;
+	/**
+	* @inheritDoc
+	*/
+	override destroy(): Promise<void>;
+	/**
+	* Switches the comment to the editing mode.
+	*/
+	switchToEditMode(): void;
+	/**
+	* Switches the comment back from the editing mode to the content display mode.
+	*/
+	switchToDisplayMode(): void;
+	/**
+	* Gets the translated note which indicates that the comment comes from an external source.
+	*/
+	getExternalCommentNote(): string;
+	/**
+	* Gets the translated notification text which indicates that author name comes from an external source.
+	*/
+	getUserViewNotificationText(): string | null;
 }
 /**
- * Fired when a user performed an action that should lead to creating a new comment in the comment thread.
- *
- * This event is fired by default when the comment input field of the comment thread is submitted.
- *
- * @eventName ~BaseCommentView#addComment
- * @param content The content of the new comment.
- */
+* Fired when a user performed an action that should lead to creating a new comment in the comment thread.
+*
+* This event is fired by default when the comment input field of the comment thread is submitted.
+*
+* @eventName ~BaseCommentView#addComment
+* @param content The content of the new comment.
+*/
 export type UIAddCommentEvent = {
-    name: 'addComment';
-    args: [content: string];
+	name: "addComment";
+	args: [content: string];
 };
 /**
- * Fired when a user performed an action that should lead to updating the comment content.
- *
- * This event is fired by default when the comment input field of a comment is submitted.
- *
- * @param commentId The ID of the updated comment.
- * @param commentContent The updated comment content.
- * @eventName ~BaseCommentView#updateComment
- */
+* Fired when a user performed an action that should lead to updating the comment content.
+*
+* This event is fired by default when the comment input field of a comment is submitted.
+*
+* @param commentId The ID of the updated comment.
+* @param commentContent The updated comment content.
+* @eventName ~BaseCommentView#updateComment
+*/
 export type UIUpdateCommentEvent = {
-    name: 'updateComment';
-    args: [commentId: string, commentContent: string];
+	name: "updateComment";
+	args: [commentId: string, commentContent: string];
 };
 /**
- * Fired when a user performed an action that should lead to removing a comment.
- *
- * This event is not fired by default by any component created by {@link module:comments/comments/ui/view/basecommentview~BaseCommentView}.
- * If you create a view class extending {@link module:comments/comments/ui/view/basecommentview~BaseCommentView} you should provide
- * a UI element that will fire this event.
- *
- * @param commentId The ID of the removed comment.
- * @eventName ~BaseCommentView#removeComment
- */
+* Fired when a user performed an action that should lead to removing a comment.
+*
+* This event is not fired by default by any component created by {@link module:comments/comments/ui/view/basecommentview~BaseCommentView}.
+* If you create a view class extending {@link module:comments/comments/ui/view/basecommentview~BaseCommentView} you should provide
+* a UI element that will fire this event.
+*
+* @param commentId The ID of the removed comment.
+* @eventName ~BaseCommentView#removeComment
+*/
 export type UIRemoveCommentEvent = {
-    name: 'removeComment';
-    args: [commentId: string];
+	name: "removeComment";
+	args: [commentId: string];
 };

package/dist/comments/ui/view/collapsedcommentsview.d.ts

@@ -1,13 +1,13 @@
 /**
- * @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/comments/ui/view/collapsedcommentsview
- */
-import { View } from '@ckeditor/ckeditor5-ui';
-import type { Locale } from '@ckeditor/ckeditor5-utils';
+* @module comments/comments/ui/view/collapsedcommentsview
+*/
+import { View } from "@ckeditor/ckeditor5-ui";
+import type { Locale } from "@ckeditor/ckeditor5-utils";
 export declare class CollapsedCommentsView extends View {
-    count: number | undefined;
-    constructor(locale: Locale);
+	count: number | undefined;
+	constructor(locale: Locale);
 }

package/dist/comments/ui/view/commentcontentview.d.ts

@@ -1,14 +1,14 @@
 /**
- * @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/comments/ui/view/commentcontentview
- */
-import { View } from '@ckeditor/ckeditor5-ui';
-import type { Locale } from '@ckeditor/ckeditor5-utils';
+* @module comments/comments/ui/view/commentcontentview
+*/
+import { View } from "@ckeditor/ckeditor5-ui";
+import type { Locale } from "@ckeditor/ckeditor5-utils";
 export declare class CommentContentView extends View {
-    content: string;
-    constructor(locale: Locale);
-    render(): void;
+	content: string;
+	constructor(locale: Locale);
+	override render(): void;
 }