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

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

@@ -1,236 +1,231 @@
 /**
- * @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/commentview
- * @publicApi
- */
-import { type Locale } from '@ckeditor/ckeditor5-utils';
-import { ButtonView, type TemplateDefinition, type DropdownView, type FocusableView, type ViewCollection } from '@ckeditor/ckeditor5-ui';
-import { UserView } from '@ckeditor/ckeditor5-collaboration-core';
-import { BaseCommentView } from './basecommentview.js';
-import type { Comment } from '../../commentsrepository.js';
-import { type CommentInputView } from './commentinputview.js';
-import type { CommentViewConfig } from '../../../config.js';
-declare const CommentView_base: import("@ckeditor/ckeditor5-utils").Mixed<typeof BaseCommentView, import("@ckeditor/ckeditor5-collaboration-core").ConfirmApi>;
+* @module comments/comments/ui/view/commentview
+* @publicApi
+*/
+import { type Locale } from "@ckeditor/ckeditor5-utils";
+import { ButtonView, type TemplateDefinition, type DropdownView, type FocusableView, type ViewCollection } from "@ckeditor/ckeditor5-ui";
+import { UserView, type ConfirmMixinConstructor } from "@ckeditor/ckeditor5-collaboration-core";
+import { BaseCommentView } from "./basecommentview.js";
+import type { Comment } from "../../commentsrepository.js";
+import type { CommentViewConfig } from "../../../config.js";
+declare const _CommentViewBase: ConfirmMixinConstructor<typeof BaseCommentView>;
 /**
- * The default view for comment.
- */
-export declare class CommentView extends /* #__PURE__ -- @preserve */ CommentView_base {
-    locale: Locale;
-    cancelConfirm: () => void;
-    showConfirm: (key: string, element: unknown) => Promise<void>;
-    /**
-     * A property used by the template.
-     *
-     * It works as a visual indicator for the user that an action is about to be performed.
-     * The value of this property is used in setting the CSS class.
-     * The property is used when the user interacts with the view.
-     *
-     * @observable
-     */
-    actionIndicator: string | null;
-    /**
-     * Comment editor placeholder value.
-     *
-     * @observable
-     */
-    placeholder: string;
-    /**
-     * Comment creation date.
-     *
-     * @observable
-     */
-    authoredAt: Date;
-    /**
-     * Comment resolved date.
-     *
-     * @observable
-     */
-    resolvedAt: Date | null;
-    /**
-     * Collection for UI elements that manage the comment.
-     *
-     * Elements that may be found in the action bar (depending on the comment view properties):
-     *
-     * * the resolve comment thread button (only if the comment is the first comment),
-     * * a dropdown with actions ({@link ~CommentView#dropdown `dropdown`}).
-     */
-    actionBar: ViewCollection<FocusableView>;
-    /**
-     * View collection which holds all the comments dropdown elements.
-     *
-     * May include, depending on the view properties:
-     *
-     * * {@link ~CommentView#editButton `editButton`},
-     * * {@link ~CommentView#removeButton `removeButton`}.
-     */
-    items: ViewCollection<ButtonView>;
-    /**
-     * Dropdown containing comment action buttons defined in {@link ~CommentView#items `items`}.
-     */
-    dropdown: DropdownView;
-    /**
-     * Edit button view. Edit button switches the comment to the editing mode.
-     */
-    editButton: ButtonView;
-    /**
-     * Remove button view. Remove button shows a confirmation box that fires the `removeComment` event when submitted.
-     */
-    removeButton: ButtonView;
-    /**
-     * User view for the comment. Presents the comment author.
-     */
-    userView: UserView;
-    /**
-     * @inheritDoc
-     */
-    constructor(locale: Locale, model: Comment, config: CommentViewConfig);
-    /**
-     * Returns a template definition that will be passed to {@link module:ui/view~View#setTemplate}.
-     *
-     * Overwrite this method if you want to set a custom template for the comment view.
-     *
-     * The default template looks as follows:
-     *
-     * ```ts
-     * const bind = this.bindTemplate;
-     *
-     * {
-     * 	tag: 'li',
-     *
-     * 	attributes: {
-     * 		class: [ 'ck-comment__wrapper' ],
-     * 		tabindex: -1,
-     * 		'aria-label': bind.to( 'ariaLabel' ),
-     * 		'aria-describedby': this.ariaDescriptionView.id,
-     * 		role: 'listitem'
-     * 	},
-     *
-     * 	children: [
-     * 		{
-     * 			tag: 'div',
-     *
-     * 			attributes: {
-     * 				class: [
-     * 					'ck-comment',
-     * 					'ck-annotation',
-     * 					bind.if( 'isSystemComment', 'ck-comment--info' ),
-     * 					bind.if( 'isEditMode', 'ck-comment--edit' ),
-     * 					bind.to( 'actionIndicator', value => value ? `ck-comment--${ value }` : '' )
-     * 				],
-     * 				'data-author-id': this._model.author.id,
-     * 				'data-comment-id': this._model.id,
-     * 				role: 'group'
-     * 			},
-     *
-     * 			children: [
-     * 				this.userView,
-     * 				{
-     * 					tag: 'div',
-     *
-     * 					attributes: {
-     * 						class: [ 'ck-comment__main', 'ck-annotation__main' ]
-     * 					},
-     *
-     * 					children: [
-     * 						{
-     * 							tag: 'div',
-     *
-     * 							attributes: {
-     * 								class: [ 'ck-comment__info', 'ck-annotation__info' ]
-     * 							},
-     *
-     * 							children: [
-     * 								{
-     * 									tag: 'span',
-     *
-     * 									children: [
-     * 										{
-     * 											text: this.userView.name
-     * 										}
-     * 									],
-     *
-     * 									attributes: {
-     * 										class: [ 'ck-comment__info-name', 'ck-annotation__info-name' ]
-     * 									}
-     * 								},
-     * 								{
-     * 									tag: 'time',
-     *
-     * 									attributes: {
-     * 										datetime: bind.to( 'authoredAt' ),
-     * 										class: [ 'ck-comment__info-time', 'ck-annotation__info-time' ]
-     * 									},
-     *
-     * 									children: [
-     * 										{
-     * 											text: bind.to( 'authoredAt', value => this._config.formatDateTime( value ) )
-     * 										}
-     * 									]
-     * 								}
-     * 							]
-     * 						},
-     * 						{
-     * 							tag: 'div',
-     *
-     * 							attributes: {
-     * 								class: [
-     * 									'ck-comment__actions',
-     * 									'ck-annotation__actions',
-     * 									bind.if( 'isEditMode', 'ck-comment__actions--hidden' ),
-     * 									bind.if( 'isEditMode', 'ck-annotation__actions--hidden' )
-     * 								]
-     * 							},
-     *
-     * 							children: this.actionBar
-     * 						},
-     * 						{
-     * 							tag: 'div',
-     *
-     * 							attributes: {
-     * 								class: [ 'ck-annotation__content-wrapper' ]
-     * 							},
-     *
-     * 							children: this.visibleView
-     * 						},
-     * 						this.ariaDescriptionView,
-     * 						{
-     * 							tag: 'div',
-     *
-     * 							attributes: {
-     * 								class: [ 'ck-comment__external' ]
-     * 							},
-     *
-     * 							children: [ {
-     * 								text: this.getExternalCommentNote()
-     * 							} ]
-     * 						}
-     * 					]
-     * 				}
-     *
-     * 			]
-     * 		}
-     * 	]
-     * }
-     * ```
-     *
-     * @returns Definition of comment thread view's template.
-     */
-    getTemplate(): TemplateDefinition;
-    /**
-     * @inheritDoc
-     */
-    protected _createCommentInputView(): CommentInputView;
-    /**
-     * @inheritDoc
-     */
-    render(): void;
+* The default view for comment.
+*/
+export declare class CommentView extends _CommentViewBase {
+	locale: Locale;
+	cancelConfirm: () => void;
+	showConfirm: (key: string, element: unknown) => Promise<void>;
+	/**
+	* A property used by the template.
+	*
+	* It works as a visual indicator for the user that an action is about to be performed.
+	* The value of this property is used in setting the CSS class.
+	* The property is used when the user interacts with the view.
+	*
+	* @observable
+	*/
+	actionIndicator: string | null;
+	/**
+	* Comment editor placeholder value.
+	*
+	* @observable
+	*/
+	placeholder: string;
+	/**
+	* Comment creation date.
+	*
+	* @observable
+	*/
+	authoredAt: Date;
+	/**
+	* Comment resolved date.
+	*
+	* @observable
+	*/
+	resolvedAt: Date | null;
+	/**
+	* Collection for UI elements that manage the comment.
+	*
+	* Elements that may be found in the action bar (depending on the comment view properties):
+	*
+	* * the resolve comment thread button (only if the comment is the first comment),
+	* * a dropdown with actions ({@link ~CommentView#dropdown `dropdown`}).
+	*/
+	actionBar: ViewCollection<FocusableView>;
+	/**
+	* View collection which holds all the comments dropdown elements.
+	*
+	* May include, depending on the view properties:
+	*
+	* * {@link ~CommentView#editButton `editButton`},
+	* * {@link ~CommentView#removeButton `removeButton`}.
+	*/
+	items: ViewCollection<ButtonView>;
+	/**
+	* Dropdown containing comment action buttons defined in {@link ~CommentView#items `items`}.
+	*/
+	dropdown: DropdownView;
+	/**
+	* Edit button view. Edit button switches the comment to the editing mode.
+	*/
+	editButton: ButtonView;
+	/**
+	* Remove button view. Remove button shows a confirmation box that fires the `removeComment` event when submitted.
+	*/
+	removeButton: ButtonView;
+	/**
+	* User view for the comment. Presents the comment author.
+	*/
+	userView: UserView;
+	/**
+	* @inheritDoc
+	*/
+	constructor(locale: Locale, model: Comment, config: CommentViewConfig);
+	/**
+	* Returns a template definition that will be passed to {@link module:ui/view~View#setTemplate}.
+	*
+	* Overwrite this method if you want to set a custom template for the comment view.
+	*
+	* The default template looks as follows:
+	*
+	* ```ts
+	* const bind = this.bindTemplate;
+	*
+	* {
+	* 	tag: 'li',
+	*
+	* 	attributes: {
+	* 		class: [ 'ck-comment__wrapper' ],
+	* 		tabindex: -1,
+	* 		'aria-label': bind.to( 'ariaLabel' ),
+	* 		'aria-describedby': this.ariaDescriptionView.id,
+	* 		role: 'listitem'
+	* 	},
+	*
+	* 	children: [
+	* 		{
+	* 			tag: 'div',
+	*
+	* 			attributes: {
+	* 				class: [
+	* 					'ck-comment',
+	* 					'ck-annotation',
+	* 					bind.if( 'isSystemComment', 'ck-comment--info' ),
+	* 					bind.if( 'isEditMode', 'ck-comment--edit' ),
+	* 					bind.to( 'actionIndicator', value => value ? `ck-comment--${ value }` : '' )
+	* 				],
+	* 				'data-author-id': this._model.author.id,
+	* 				'data-comment-id': this._model.id,
+	* 				role: 'group'
+	* 			},
+	*
+	* 			children: [
+	* 				this.userView,
+	* 				{
+	* 					tag: 'div',
+	*
+	* 					attributes: {
+	* 						class: [ 'ck-comment__main', 'ck-annotation__main' ]
+	* 					},
+	*
+	* 					children: [
+	* 						{
+	* 							tag: 'div',
+	*
+	* 							attributes: {
+	* 								class: [ 'ck-comment__info', 'ck-annotation__info' ]
+	* 							},
+	*
+	* 							children: [
+	* 								{
+	* 									tag: 'span',
+	*
+	* 									children: [
+	* 										{
+	* 											text: this.userView.name
+	* 										}
+	* 									],
+	*
+	* 									attributes: {
+	* 										class: [ 'ck-comment__info-name', 'ck-annotation__info-name' ]
+	* 									}
+	* 								},
+	* 								{
+	* 									tag: 'time',
+	*
+	* 									attributes: {
+	* 										datetime: bind.to( 'authoredAt' ),
+	* 										class: [ 'ck-comment__info-time', 'ck-annotation__info-time' ]
+	* 									},
+	*
+	* 									children: [
+	* 										{
+	* 											text: bind.to( 'authoredAt', value => this._config.formatDateTime( value ) )
+	* 										}
+	* 									]
+	* 								}
+	* 							]
+	* 						},
+	* 						{
+	* 							tag: 'div',
+	*
+	* 							attributes: {
+	* 								class: [
+	* 									'ck-comment__actions',
+	* 									'ck-annotation__actions',
+	* 									bind.if( 'isEditMode', 'ck-comment__actions--hidden' ),
+	* 									bind.if( 'isEditMode', 'ck-annotation__actions--hidden' )
+	* 								]
+	* 							},
+	*
+	* 							children: this.actionBar
+	* 						},
+	* 						{
+	* 							tag: 'div',
+	*
+	* 							attributes: {
+	* 								class: [ 'ck-annotation__content-wrapper' ]
+	* 							},
+	*
+	* 							children: this.visibleView
+	* 						},
+	* 						this.ariaDescriptionView,
+	* 						{
+	* 							tag: 'div',
+	*
+	* 							attributes: {
+	* 								class: [ 'ck-comment__external' ]
+	* 							},
+	*
+	* 							children: [ {
+	* 								text: this.getExternalCommentNote()
+	* 							} ]
+	* 						}
+	* 					]
+	* 				}
+	*
+	* 			]
+	* 		}
+	* 	]
+	* }
+	* ```
+	*
+	* @returns Definition of comment thread view's template.
+	*/
+	getTemplate(): TemplateDefinition;
+	/**
+	* @inheritDoc
+	*/
+	override render(): void;
 }
-declare module '@ckeditor/ckeditor5-ui' {
-    interface DropdownView {
-        isVisible: boolean;
-    }
+declare module "@ckeditor/ckeditor5-ui" {
+	interface DropdownView {
+		isVisible: boolean;
+	}
 }
 export {};

package/dist/comments.d.ts

@@ -1,43 +1,43 @@
 /**
- * @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
- * @publicApi
- */
-import { Plugin } from '@ckeditor/ckeditor5-core';
-import { CommentsRepository } from './comments/commentsrepository.js';
-import { CommentsEditing } from './comments/commentsediting.js';
-import { CommentsUI } from './comments/commentsui.js';
-import { CommentsOnly } from './commentsonly.js';
-import { WideSidebar } from './annotations/widesidebar.js';
-import { NarrowSidebar } from './annotations/narrowsidebar.js';
-import { InlineAnnotations } from './annotations/inlineannotations.js';
-import { CommentsArchiveUI } from './comments/commentsarchiveui.js';
-import { CommentsArchive } from './comments/commentsarchive.js';
+* @module comments/comments
+* @publicApi
+*/
+import { Plugin, type PluginDependenciesOf } from "@ckeditor/ckeditor5-core";
+import { CommentsRepository } from "./comments/commentsrepository.js";
+import { CommentsEditing } from "./comments/commentsediting.js";
+import { CommentsUI } from "./comments/commentsui.js";
+import { CommentsOnly } from "./commentsonly.js";
+import { WideSidebar } from "./annotations/widesidebar.js";
+import { NarrowSidebar } from "./annotations/narrowsidebar.js";
+import { InlineAnnotations } from "./annotations/inlineannotations.js";
+import { CommentsArchiveUI } from "./comments/commentsarchiveui.js";
+import { CommentsArchive } from "./comments/commentsarchive.js";
 /**
- * The comments plugin, which brings both the UI part and the editing part of this feature.
- *
- * It registers {@link module:comments/comments/addcommentthreadcommand~AddCommentThreadCommand the `AddCommentThreadCommand` command}.
- *
- * To learn more about the comments feature refer to the {@glink features/collaboration/comments/comments Comments} guide.
- */
+* The comments plugin, which brings both the UI part and the editing part of this feature.
+*
+* It registers {@link module:comments/comments/addcommentthreadcommand~AddCommentThreadCommand the `AddCommentThreadCommand` command}.
+*
+* To learn more about the comments feature refer to the {@glink features/collaboration/comments/comments Comments} guide.
+*/
 export declare class Comments extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly [typeof CommentsRepository, typeof CommentsEditing, typeof CommentsUI, typeof CommentsArchive, typeof CommentsArchiveUI, typeof CommentsOnly, typeof WideSidebar, typeof NarrowSidebar, typeof InlineAnnotations];
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "Comments";
-    /**
-     * @inheritDoc
-     */
-    static get isOfficialPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    static get isPremiumPlugin(): true;
+	/**
+	* @inheritDoc
+	*/
+	static get requires(): PluginDependenciesOf<[CommentsRepository, CommentsEditing, CommentsUI, CommentsArchive, CommentsArchiveUI, CommentsOnly, WideSidebar, NarrowSidebar, InlineAnnotations]>;
+	/**
+	* @inheritDoc
+	*/
+	static get pluginName(): "Comments";
+	/**
+	* @inheritDoc
+	*/
+	static override get isOfficialPlugin(): true;
+	/**
+	* @inheritDoc
+	*/
+	static override get isPremiumPlugin(): true;
 }

package/dist/commentsonly.d.ts

@@ -1,41 +1,41 @@
 /**
- * @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/commentsonly
- * @publicApi
- */
-import { Plugin, type Editor } from '@ckeditor/ckeditor5-core';
-import { CommentsEditing } from './comments/commentsediting.js';
+* @module comments/commentsonly
+* @publicApi
+*/
+import { Plugin, type Editor, type PluginDependenciesOf } from "@ckeditor/ckeditor5-core";
+import { CommentsEditing } from "./comments/commentsediting.js";
 /**
- * The `CommentsOnly` plugin allows you to put the editor in a mode where a user can only add, edit or delete comments.
- *
- * Check the {@glink features/collaboration/comments/comments-only-mode Comments-only mode} guide to learn how to use this plugin.
- */
+* The `CommentsOnly` plugin allows you to put the editor in a mode where a user can only add, edit or delete comments.
+*
+* Check the {@glink features/collaboration/comments/comments-only-mode Comments-only mode} guide to learn how to use this plugin.
+*/
 export declare class CommentsOnly extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "CommentsOnly";
-    /**
-     * @inheritDoc
-     */
-    static get isOfficialPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    static get isPremiumPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly [typeof CommentsEditing];
-    /**
-     * @inheritDoc
-     */
-    constructor(editor: Editor);
-    /**
-     * @inheritDoc
-     */
-    afterInit(): void;
+	/**
+	* @inheritDoc
+	*/
+	static get pluginName(): "CommentsOnly";
+	/**
+	* @inheritDoc
+	*/
+	static override get isOfficialPlugin(): true;
+	/**
+	* @inheritDoc
+	*/
+	static override get isPremiumPlugin(): true;
+	/**
+	* @inheritDoc
+	*/
+	static get requires(): PluginDependenciesOf<[CommentsEditing]>;
+	/**
+	* @inheritDoc
+	*/
+	constructor(editor: Editor);
+	/**
+	* @inheritDoc
+	*/
+	afterInit(): void;
 }