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

package/dist/config.d.ts

@@ -1,196 +1,196 @@
 /**
- * @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/config
- * @publicApi
- */
-import type { EditorConfig, PartialBy } from '@ckeditor/ckeditor5-core';
-import { type CommentView } from './comments/ui/view/commentview.js';
-import { type BaseCommentThreadView } from './comments/ui/view/basecommentthreadview.js';
+* @module comments/config
+* @publicApi
+*/
+import type { EditorConfig, PartialBy } from "@ckeditor/ckeditor5-core";
+import { type CommentView } from "./comments/ui/view/commentview.js";
+import { type BaseCommentThreadView } from "./comments/ui/view/basecommentthreadview.js";
 /**
- * The configuration of the comments feature.
- *
- * ```ts
- * ClassicEditor.create( {
- * 	comments: ... // Comments feature configuration.
- * } )
- * .then( ... )
- * .catch( ... );
- * ```
- *
- * See {@link module:core/editor/editorconfig~EditorConfig all editor options}.
- */
+* The configuration of the comments feature.
+*
+* ```ts
+* ClassicEditor.create( {
+* 	comments: ... // Comments feature configuration.
+* } )
+* .then( ... )
+* .catch( ... );
+* ```
+*
+* See {@link module:core/editor/editorconfig~EditorConfig all editor options}.
+*/
 export interface CommentsConfig {
-    /**
-     * Specifies whether comment markers should be preserved on copy-paste and cut-and-paste actions.
-     *
-     * The following values are available:
-     *
-     * * `'default'` - the comments will be preserved on cut-paste and drag and drop actions only.
-     * * `'always'` - the markers will be preserved on all clipboard actions (cut, copy, drag and drop).
-     * * `'never'` - the markers will be ignored by clipboard.
-     *
-     * Defaults to `'default'`.
-     */
-    copyMarkers?: CommentsClipboardCopyConfig;
-    /**
-     * The total number of comments shown when the thread view is collapsed.
-     *
-     * The comments are displayed in the following way:
-     *
-     * * The first comment is displayed.
-     * * Some comments may be hidden (collapsed).
-     * * An appropriate number of the most recent comments is displayed.
-     *
-     * For example, if this parameter is set to 3, when collapsed,
-     * the thread view will display the first comment and two most recent comments.
-     *
-     * Defaults to `2`.
-     */
-    maxCommentsWhenCollapsed?: number;
-    /**
-     * The maximum total weight of a thread before the thread becomes collapsed when it is not active:
-     *
-     * * Thread weight is a sum of the weight of its comments.
-     * * Comment weight is equal to the comment length.
-     * * The minimal comment weight is 200.
-     *
-     * Defaults to `500`.
-     */
-    maxThreadTotalWeight?: number;
-    /**
-     * The maximum number of characters displayed in a comment when the thread view is collapsed.
-     * Longer comments will be trimmed.
-     *
-     * Defaults to `140`.
-     */
-    maxCommentCharsWhenCollapsed?: number;
-    /**
-     * A view class to be used to create comment views.
-     *
-     * {@link module:comments/comments/ui/view/commentview~CommentView} is used by default when this property is not set.
-     */
-    CommentView?: typeof CommentView;
-    /**
-     * A view class to be used to create comment thread views
-     * (used as annotations - in sidebar balloons or in inline annotations).
-     *
-     * {@link module:comments/comments/ui/view/commentthreadview~CommentThreadView} is used by default
-     *  when this property is not set.
-     */
-    CommentThreadView?: typeof BaseCommentThreadView;
-    /**
-     * Configuration for the comments editor.
-     *
-     * By using this property, you can customize the editor instance used in the comments
-     * reply field (e.g. by adding plugins or changing features configuration).
-     *
-     * To use the default configuration (allows only for text input, no formatting), you can pass `{}`
-     * to the comments editor configuration.
-     *
-     * ```ts
-     * ClassicEditor.create( {
-     * 	attachTo: element,
-     * 	comments: {
-     * 		editorConfig: {}
-     * 	}
-     * } );
-     * ```
-     *
-     * To provide a better experience, you may add more plugins, that will extend the default editor configuration.
-     *
-     * ```ts
-     * import { Autoformat, List, Bold, Italic } from 'ckeditor5';
-     *
-     * ClassicEditor
-     * 	.create( {
-     * 		comments: {
-     * 			editorConfig: {
-     * 				extraPlugins: [ Autoformat, Bold, Italic, List ]
-     * 			}
-     * 		}
-     * 	} )
-     * ```
-     *
-     * Importing plugins may not be possible in some scenarios (e.g. when using a build created by the online builder tool).
-     * In that case, it is possible to get the plugin constructors from the editor builtin plugins.
-     *
-     * ```ts
-     * const extraCommentsPlugins = ClassicEditor.builtinPlugins.filter( plugin => {
-     * 	return [ 'Bold', 'Italic', Autoformat, List ].includes( plugin.pluginName );
-     * } );
-     *
-     *
-     * ClassicEditor
-     * 	.create( {
-     * 		comments: {
-     * 			editorConfig: {
-     * 				extraPlugins: extraCommentsPlugins
-     * 			}
-     * 		}
-     * 	} )
-     * 	.then( ... )
-     * 	.catch( ... );
-     * ```
-     */
-    editorConfig?: EditorConfig;
-    /**
-     * A function that takes a `Date` object, formats it to a desired string and returns it.
-     * It should be used when displaying the comment creation date.
-     */
-    formatDateTime?: (date: Date) => string;
+	/**
+	* Specifies whether comment markers should be preserved on copy-paste and cut-and-paste actions.
+	*
+	* The following values are available:
+	*
+	* * `'default'` - the comments will be preserved on cut-paste and drag and drop actions only.
+	* * `'always'` - the markers will be preserved on all clipboard actions (cut, copy, drag and drop).
+	* * `'never'` - the markers will be ignored by clipboard.
+	*
+	* Defaults to `'default'`.
+	*/
+	copyMarkers?: CommentsClipboardCopyConfig;
+	/**
+	* The total number of comments shown when the thread view is collapsed.
+	*
+	* The comments are displayed in the following way:
+	*
+	* * The first comment is displayed.
+	* * Some comments may be hidden (collapsed).
+	* * An appropriate number of the most recent comments is displayed.
+	*
+	* For example, if this parameter is set to 3, when collapsed,
+	* the thread view will display the first comment and two most recent comments.
+	*
+	* Defaults to `2`.
+	*/
+	maxCommentsWhenCollapsed?: number;
+	/**
+	* The maximum total weight of a thread before the thread becomes collapsed when it is not active:
+	*
+	* * Thread weight is a sum of the weight of its comments.
+	* * Comment weight is equal to the comment length.
+	* * The minimal comment weight is 200.
+	*
+	* Defaults to `500`.
+	*/
+	maxThreadTotalWeight?: number;
+	/**
+	* The maximum number of characters displayed in a comment when the thread view is collapsed.
+	* Longer comments will be trimmed.
+	*
+	* Defaults to `140`.
+	*/
+	maxCommentCharsWhenCollapsed?: number;
+	/**
+	* A view class to be used to create comment views.
+	*
+	* {@link module:comments/comments/ui/view/commentview~CommentView} is used by default when this property is not set.
+	*/
+	CommentView?: typeof CommentView;
+	/**
+	* A view class to be used to create comment thread views
+	* (used as annotations - in sidebar balloons or in inline annotations).
+	*
+	* {@link module:comments/comments/ui/view/commentthreadview~CommentThreadView} is used by default
+	*  when this property is not set.
+	*/
+	CommentThreadView?: typeof BaseCommentThreadView;
+	/**
+	* Configuration for the comments editor.
+	*
+	* By using this property, you can customize the editor instance used in the comments
+	* reply field (e.g. by adding plugins or changing features configuration).
+	*
+	* To use the default configuration (allows only for text input, no formatting), you can pass `{}`
+	* to the comments editor configuration.
+	*
+	* ```ts
+	* ClassicEditor.create( {
+	* 	attachTo: element,
+	* 	comments: {
+	* 		editorConfig: {}
+	* 	}
+	* } );
+	* ```
+	*
+	* To provide a better experience, you may add more plugins, that will extend the default editor configuration.
+	*
+	* ```ts
+	* import { Autoformat, List, Bold, Italic } from 'ckeditor5';
+	*
+	* ClassicEditor
+	* 	.create( {
+	* 		comments: {
+	* 			editorConfig: {
+	* 				extraPlugins: [ Autoformat, Bold, Italic, List ]
+	* 			}
+	* 		}
+	* 	} )
+	* ```
+	*
+	* Importing plugins may not be possible in some scenarios (e.g. when using a build created by the online builder tool).
+	* In that case, it is possible to get the plugin constructors from the editor builtin plugins.
+	*
+	* ```ts
+	* const extraCommentsPlugins = ClassicEditor.builtinPlugins.filter( plugin => {
+	* 	return [ 'Bold', 'Italic', Autoformat, List ].includes( plugin.pluginName );
+	* } );
+	*
+	*
+	* ClassicEditor
+	* 	.create( {
+	* 		comments: {
+	* 			editorConfig: {
+	* 				extraPlugins: extraCommentsPlugins
+	* 			}
+	* 		}
+	* 	} )
+	* 	.then( ... )
+	* 	.catch( ... );
+	* ```
+	*/
+	editorConfig?: EditorConfig;
+	/**
+	* A function that takes a `Date` object, formats it to a desired string and returns it.
+	* It should be used when displaying the comment creation date.
+	*/
+	formatDateTime?: (date: Date) => string;
 }
 /**
- * The configuration of the sidebar feature.
- *
- * ```ts
- * ClassicEditor
- * 	.create( {
- * 		sidebar: {
- * 			// Sidebar feature configuration.
- * 		}
- * 	} )
- * .then( ... )
- * .catch( ... );
- * ```
- *
- * See {@link module:core/editor/editorconfig~EditorConfig all editor configuration options}.
- */
+* The configuration of the sidebar feature.
+*
+* ```ts
+* ClassicEditor
+* 	.create( {
+* 		sidebar: {
+* 			// Sidebar feature configuration.
+* 		}
+* 	} )
+* .then( ... )
+* .catch( ... );
+* ```
+*
+* See {@link module:core/editor/editorconfig~EditorConfig all editor configuration options}.
+*/
 export interface AnnotationsSidebarConfig {
-    /**
-     * DOM element into which the sidebar will be inserted.
-     */
-    container?: HTMLElement;
-    /**
-     * Changes how the annotations are positioned inside the sidebar.
-     *
-     * If set to `true`, the top annotation in the sidebar will never be scrolled
-     * above the top edge of the sidebar (which would make it hidden).
-     *
-     * On the other hand, with this setting enabled, if there is not enough space,
-     * annotations will not be positioned exactly next to their linked elements
-     * when selected.
-     *
-     * @default false
-     */
-    preventScrollOutOfView?: boolean;
+	/**
+	* DOM element into which the sidebar will be inserted.
+	*/
+	container?: HTMLElement;
+	/**
+	* Changes how the annotations are positioned inside the sidebar.
+	*
+	* If set to `true`, the top annotation in the sidebar will never be scrolled
+	* above the top edge of the sidebar (which would make it hidden).
+	*
+	* On the other hand, with this setting enabled, if there is not enough space,
+	* annotations will not be positioned exactly next to their linked elements
+	* when selected.
+	*
+	* @default false
+	*/
+	preventScrollOutOfView?: boolean;
 }
-export type CommentThreadConfig = PartialBy<Required<Omit<CommentsConfig, 'CommentThreadView'>>, 'copyMarkers'>;
-export type CommentViewConfig = Required<Pick<CommentsConfig, 'maxCommentCharsWhenCollapsed' | 'formatDateTime' | 'editorConfig'>> & {
-    /**
-     * Defines whether the comment is created by the system.
-     */
-    isSystemComment?: boolean;
+export type CommentThreadConfig = PartialBy<Required<Omit<CommentsConfig, "CommentThreadView">>, "copyMarkers">;
+export type CommentViewConfig = Required<Pick<CommentsConfig, "maxCommentCharsWhenCollapsed" | "formatDateTime" | "editorConfig">> & {
+	/**
+	* Defines whether the comment is created by the system.
+	*/
+	isSystemComment?: boolean;
 };
 /**
- * Specifies whether comment markers should be preserved on copy-paste and cut-paste actions.
- *
- * Following values are available:
- *
- * * `'default'` - the comments will be preserved on cut-paste and drag and drop actions only.
- * * `'always'` - the markers will be preserved on all clipboard actions (cut, copy, drag and drop).
- * * `'never'` - the markers will be ignored by clipboard.
- */
-export type CommentsClipboardCopyConfig = 'default' | 'always' | 'never';
+* Specifies whether comment markers should be preserved on copy-paste and cut-paste actions.
+*
+* Following values are available:
+*
+* * `'default'` - the comments will be preserved on cut-paste and drag and drop actions only.
+* * `'always'` - the markers will be preserved on all clipboard actions (cut, copy, drag and drop).
+* * `'never'` - the markers will be ignored by clipboard.
+*/
+export type CommentsClipboardCopyConfig = "default" | "always" | "never";

package/dist/index.d.ts

@@ -1,37 +1,37 @@
 /**
- * @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
- */
-export { Comments } from './comments.js';
-export { CommentsOnly } from './commentsonly.js';
-export { CommentsUI } from './comments/commentsui.js';
-export { CommentsRepository, CommentThread, Comment, type CommentDataJSON, type CommentThreadContext, type CommentThreadDataJSON, type CommentsAdapter, type AddCommentThreadEventData, type CommentPermissionsConfig, type BaseCommentThread, type BaseComment, type BaseCommentData, type AddCommentThreadEvent, type CommentThreadData, type SubmitCommentThreadEvent, type UpdateCommentThreadEvent, type UpdateCommentThreadEventData, type ResolveCommentThreadEvent, type ResolveCommentThreadEventData, type ReopenCommentThreadEvent, type RemoveCommentThreadEvent, type AddCommentEvent, type CommentData, type CommentEventData, type UpdateCommentEvent, type UpdateCommentData, type UpdateCommentEventData, type RemoveCommentEvent } from './comments/commentsrepository.js';
-export { CommentThreadController } from './comments/ui/commentthreadcontroller.js';
-export { Annotation, type AnnotationEscapeEvent, type AnnotationTargetBase, type AnnotationTarget } from './annotations/annotation.js';
-export { Annotations, type AnnotationOptions, type ActivateAnnotationEvent, type DeactivateAllAnnotationsEvent } from './annotations/annotations.js';
-export { AnnotationCollection, bindAnnotationCollections, type AnnotationFocusEvent, type AnnotationBlurEvent } from './annotations/annotationcollection.js';
-export { AnnotationsUIs, type AnnotationUI, type AnnotationsUI } from './annotations/annotationsuis.js';
-export { EditorAnnotations } from './annotations/editorannotations.js';
-export { InlineAnnotations } from './annotations/inlineannotations.js';
-export { Sidebar } from './annotations/sidebar.js';
-export { WideSidebar } from './annotations/widesidebar.js';
-export { NarrowSidebar } from './annotations/narrowsidebar.js';
-export { AnnotationView, type AnnotationMainView } from './annotations/view/annotationview.js';
-export { AnnotationsSidebarItemView } from './annotations/view/sidebaritemview.js';
-export { AnnotationsSidebarView } from './annotations/view/sidebarview.js';
-export { BaseCommentView, type UIAddCommentEvent, type UIUpdateCommentEvent, type UIRemoveCommentEvent } from './comments/ui/view/basecommentview.js';
-export { BaseCommentThreadView, type UISubmitCommentThreadEvent, type UIRemoveCommentThreadEvent, type UIResolveCommentThreadEvent } from './comments/ui/view/basecommentthreadview.js';
-export { CommentsListView } from './comments/ui/view/commentslistview.js';
-export { CommentView } from './comments/ui/view/commentview.js';
-export { CommentThreadView } from './comments/ui/view/commentthreadview.js';
-export { CommentThreadInputView } from './comments/ui/view/commentthreadinputview.js';
-export { AddCommentThreadCommand } from './comments/addcommentthreadcommand.js';
-export { CommentsArchive } from './comments/commentsarchive.js';
-export { CommentsArchiveUI } from './comments/commentsarchiveui.js';
-export type { CommentsConfig, AnnotationsSidebarConfig, CommentsClipboardCopyConfig, CommentThreadConfig, CommentViewConfig } from './config.js';
-export { CommentsEditing } from './comments/commentsediting.js';
-export { AnnotationCounterButtonView } from './annotations/view/annotationcounterbuttonview.js';
-import './augmentation.js';
+* @module comments
+*/
+export { Comments } from "./comments.js";
+export { CommentsOnly } from "./commentsonly.js";
+export { CommentsUI } from "./comments/commentsui.js";
+export { CommentsRepository, CommentThread, Comment, type CommentDataJSON, type CommentThreadContext, type CommentThreadDataJSON, type CommentsAdapter, type AddCommentThreadEventData, type CommentPermissionsConfig, type BaseCommentThread, type BaseComment, type BaseCommentData, type AddCommentThreadEvent, type CommentThreadData, type SubmitCommentThreadEvent, type UpdateCommentThreadEvent, type UpdateCommentThreadEventData, type ResolveCommentThreadEvent, type ResolveCommentThreadEventData, type ReopenCommentThreadEvent, type RemoveCommentThreadEvent, type AddCommentEvent, type CommentData, type CommentEventData, type UpdateCommentEvent, type UpdateCommentData, type UpdateCommentEventData, type RemoveCommentEvent } from "./comments/commentsrepository.js";
+export { CommentThreadController } from "./comments/ui/commentthreadcontroller.js";
+export { Annotation, type AnnotationEscapeEvent, type AnnotationTargetBase, type AnnotationTarget } from "./annotations/annotation.js";
+export { Annotations, type AnnotationOptions, type ActivateAnnotationEvent, type DeactivateAllAnnotationsEvent } from "./annotations/annotations.js";
+export { AnnotationCollection, bindAnnotationCollections, type AnnotationFocusEvent, type AnnotationBlurEvent } from "./annotations/annotationcollection.js";
+export { AnnotationsUIs, type AnnotationUI, type AnnotationsUI } from "./annotations/annotationsuis.js";
+export { EditorAnnotations } from "./annotations/editorannotations.js";
+export { InlineAnnotations } from "./annotations/inlineannotations.js";
+export { Sidebar } from "./annotations/sidebar.js";
+export { WideSidebar } from "./annotations/widesidebar.js";
+export { NarrowSidebar } from "./annotations/narrowsidebar.js";
+export { AnnotationView, type AnnotationMainView } from "./annotations/view/annotationview.js";
+export { AnnotationsSidebarItemView } from "./annotations/view/sidebaritemview.js";
+export { AnnotationsSidebarView } from "./annotations/view/sidebarview.js";
+export { BaseCommentView, type UIAddCommentEvent, type UIUpdateCommentEvent, type UIRemoveCommentEvent } from "./comments/ui/view/basecommentview.js";
+export { BaseCommentThreadView, type UISubmitCommentThreadEvent, type UIRemoveCommentThreadEvent, type UIResolveCommentThreadEvent } from "./comments/ui/view/basecommentthreadview.js";
+export { CommentsListView } from "./comments/ui/view/commentslistview.js";
+export { CommentView } from "./comments/ui/view/commentview.js";
+export { CommentThreadView } from "./comments/ui/view/commentthreadview.js";
+export { CommentThreadInputView } from "./comments/ui/view/commentthreadinputview.js";
+export { AddCommentThreadCommand } from "./comments/addcommentthreadcommand.js";
+export { CommentsArchive } from "./comments/commentsarchive.js";
+export { CommentsArchiveUI } from "./comments/commentsarchiveui.js";
+export type { CommentsConfig, AnnotationsSidebarConfig, CommentsClipboardCopyConfig, CommentThreadConfig, CommentViewConfig } from "./config.js";
+export { CommentsEditing } from "./comments/commentsediting.js";
+export { AnnotationCounterButtonView } from "./annotations/view/annotationcounterbuttonview.js";
+import "./augmentation.js";