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

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

@@ -1,101 +1,101 @@
 /**
- * @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/commentinputview
- */
-import { View, FocusCycler, ButtonView, type FocusableView, type ViewCollection } from '@ckeditor/ckeditor5-ui';
-import { FocusTracker, KeystrokeHandler, type Locale } from '@ckeditor/ckeditor5-utils';
-import type { EditorConfig } from '@ckeditor/ckeditor5-core';
-import { CommentEditor } from '../commenteditor/commenteditor.js';
+* @module comments/comments/ui/view/commentinputview
+*/
+import { View, FocusCycler, ButtonView, type FocusableView, type ViewCollection } from "@ckeditor/ckeditor5-ui";
+import { FocusTracker, KeystrokeHandler, type Locale } from "@ckeditor/ckeditor5-utils";
+import type { EditorConfig } from "@ckeditor/ckeditor5-core";
+import { CommentEditor } from "../commenteditor/commenteditor.js";
 /**
- * A view for the comment input section that includes a comment editor.
- */
+* A view for the comment input section that includes a comment editor.
+*/
 export declare class CommentInputView extends View {
-    /**
-     * Comment editor.
-     */
-    editor: CommentEditor | null;
-    /**
-     * The input value (comment editor content).
-     *
-     * @observable
-     */
-    value: string;
-    /**
-     * When set to `true` it is not possible to submit the commit.
-     *
-     * @observable
-     */
-    disabledSubmit: boolean;
-    /**
-     * Specifies whether the buttons should be visible (`true`) or hidden (`false`).
-     *
-     * @observable
-     */
-    showButtons: boolean;
-    /**
-     * The comment editor placeholder.
-     *
-     * @observable
-     */
-    placeholder: string;
-    /**
-     * The submit button label.
-     *
-     * @observable
-     */
-    submitLabel: string;
-    element: HTMLElement;
-    /**
-     * Keystroke handler for the view.
-     */
-    keystrokes: KeystrokeHandler;
-    /**
-     * Focus tracker for the view.
-     */
-    focusTracker: FocusTracker;
-    /**
-     * Collection of focusable sub-views in the input component.
-     */
-    focusables: ViewCollection<FocusableView>;
-    /**
-     * Helps providing keyboard navigation between {@link #focusables}.
-     */
-    focusCycler: FocusCycler;
-    /**
-     * Button view for the button which submits the comment.
-     */
-    submitButtonView: ButtonView;
-    /**
-     * Button view for the button which cancels comment input.
-     */
-    cancelButtonView: ButtonView;
-    constructor(locale: Locale, editorConfig?: EditorConfig);
-    /**
-     * @inheritDoc
-     */
-    render(): void;
-    /**
-     * Creates the comment editor instance.
-     *
-     * @returns Promise resolved after the editor instance is initialized.
-     */
-    createEditor(): Promise<CommentEditor | undefined>;
-    /**
-     * Focuses the view.
-     */
-    focus(direction?: 1 | -1): void;
-    /**
-     * @inheritDoc
-     */
-    destroy(): Promise<void>;
+	/**
+	* Comment editor.
+	*/
+	editor: CommentEditor | null;
+	/**
+	* The input value (comment editor content).
+	*
+	* @observable
+	*/
+	value: string;
+	/**
+	* When set to `true` it is not possible to submit the commit.
+	*
+	* @observable
+	*/
+	disabledSubmit: boolean;
+	/**
+	* Specifies whether the buttons should be visible (`true`) or hidden (`false`).
+	*
+	* @observable
+	*/
+	showButtons: boolean;
+	/**
+	* The comment editor placeholder.
+	*
+	* @observable
+	*/
+	placeholder: string;
+	/**
+	* The submit button label.
+	*
+	* @observable
+	*/
+	submitLabel: string;
+	element: HTMLElement;
+	/**
+	* Keystroke handler for the view.
+	*/
+	keystrokes: KeystrokeHandler;
+	/**
+	* Focus tracker for the view.
+	*/
+	focusTracker: FocusTracker;
+	/**
+	* Collection of focusable sub-views in the input component.
+	*/
+	focusables: ViewCollection<FocusableView>;
+	/**
+	* Helps providing keyboard navigation between {@link #focusables}.
+	*/
+	focusCycler: FocusCycler;
+	/**
+	* Button view for the button which submits the comment.
+	*/
+	submitButtonView: ButtonView;
+	/**
+	* Button view for the button which cancels comment input.
+	*/
+	cancelButtonView: ButtonView;
+	constructor(locale: Locale, editorConfig?: EditorConfig);
+	/**
+	* @inheritDoc
+	*/
+	override render(): void;
+	/**
+	* Creates the comment editor instance.
+	*
+	* @returns Promise resolved after the editor instance is initialized.
+	*/
+	createEditor(): Promise<CommentEditor | undefined>;
+	/**
+	* Focuses the view.
+	*/
+	focus(direction?: 1 | -1): void;
+	/**
+	* @inheritDoc
+	*/
+	override destroy(): Promise<void>;
 }
 /**
- * An event fired when a user successfully submits a comment. The event carries the comment content.
- */
+* An event fired when a user successfully submits a comment. The event carries the comment content.
+*/
 export type CommentInputSubmitEvent = {
-    name: 'submit';
-    args: [cotnent: string];
+	name: "submit";
+	args: [cotnent: string];
 };

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

@@ -1,46 +1,46 @@
 /**
- * @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/commentsarchiveview
- */
-import { View, FocusCycler, type ViewCollection, type FocusableView } from '@ckeditor/ckeditor5-ui';
-import { FocusTracker, type Locale } from '@ckeditor/ckeditor5-utils';
-import { type AnnotationView } from '../../../annotations/view/annotationview.js';
+* @module comments/comments/ui/view/commentsarchiveview
+*/
+import { View, FocusCycler, type ViewCollection, type FocusableView } from "@ckeditor/ckeditor5-ui";
+import { FocusTracker, type Locale } from "@ckeditor/ckeditor5-utils";
+import { type AnnotationView } from "../../../annotations/view/annotationview.js";
 /**
- * A view representing the content of comments archive.
- */
+* A view representing the content of comments archive.
+*/
 export declare class CommentsArchiveView extends View implements FocusableView {
-    /**
-     * The flag indicating whether there are items to display in the comments archive.
-     *
-     * @observable
-     */
-    isEmpty: boolean;
-    /**
-     * Tracks information about the DOM focus in the comments archive.
-     */
-    readonly focusTracker: FocusTracker;
-    /**
-     * Helps cycling over {@link #_focusables} in the form.
-     */
-    readonly focusCycler: FocusCycler;
-    /**
-     * @param locale The localization service instance.
-     * @param annotationViews Resolved comment thread annotation views to render inside the comments archive.
-     */
-    constructor(locale: Locale, annotationViews: ViewCollection<AnnotationView>);
-    /**
-     * @inheritDoc
-     */
-    render(): void;
-    /**
-     * @inheritDoc
-     */
-    destroy(): void;
-    /**
-     * @inheritDoc
-     */
-    focus(): void;
+	/**
+	* The flag indicating whether there are items to display in the comments archive.
+	*
+	* @observable
+	*/
+	isEmpty: boolean;
+	/**
+	* Tracks information about the DOM focus in the comments archive.
+	*/
+	readonly focusTracker: FocusTracker;
+	/**
+	* Helps cycling over {@link #_focusables} in the form.
+	*/
+	readonly focusCycler: FocusCycler;
+	/**
+	* @param locale The localization service instance.
+	* @param annotationViews Resolved comment thread annotation views to render inside the comments archive.
+	*/
+	constructor(locale: Locale, annotationViews: ViewCollection<AnnotationView>);
+	/**
+	* @inheritDoc
+	*/
+	override render(): void;
+	/**
+	* @inheritDoc
+	*/
+	override destroy(): void;
+	/**
+	* @inheritDoc
+	*/
+	focus(): void;
 }

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

@@ -1,112 +1,112 @@
 /**
- * @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/commentslistview
- */
-import { View, FocusCycler, type ViewCollection, type FocusableView } from '@ckeditor/ckeditor5-ui';
-import { FocusTracker, KeystrokeHandler, type Locale } from '@ckeditor/ckeditor5-utils';
-import type { CommentThread } from '../../commentsrepository.js';
-import { type CommentView } from './commentview.js';
-import type { CommentThreadConfig } from '../../../config.js';
+* @module comments/comments/ui/view/commentslistview
+*/
+import { View, FocusCycler, type ViewCollection, type FocusableView } from "@ckeditor/ckeditor5-ui";
+import { FocusTracker, KeystrokeHandler, type Locale } from "@ckeditor/ckeditor5-utils";
+import type { CommentThread } from "../../commentsrepository.js";
+import { type CommentView } from "./commentview.js";
+import type { CommentThreadConfig } from "../../../config.js";
 /**
- * A view representing the list of comments. It should be used as a part of the comment thread view.
- */
+* A view representing the list of comments. It should be used as a part of the comment thread view.
+*/
 export declare class CommentsListView extends View implements FocusableView {
-    locale: Locale;
-    /**
-     * Informs whether the list contains any comment view that is in the editing mode.
-     *
-     * @observable
-     */
-    hasDirtyComment: boolean;
-    /**
-     * Number of comments in the list.
-     *
-     * @observable
-     */
-    length: number;
-    /**
-     * Informs whether the comments list view is in the active state ("highlighted").
-     * Comment list view is in that state when it is focused or it was activated by the user in any different way.
-     *
-     * @observable
-     */
-    isActive: boolean;
-    /**
-     * View collection which holds all comment views to be displayed.
-     * It may also contain collapsed count view if the comments list view is collapsed and some comment views are hidden.
-     *
-     * @readonly
-     */
-    readonly visibleViews: ViewCollection;
-    /**
-     * View collection which holds all comment views created for given comment thread.
-     *
-     * @readonly
-     */
-    readonly commentViews: ViewCollection<CommentView>;
-    /**
-     * Comment view used to display information that comment has been resolved.
-     *
-     * @readonly
-     */
-    resolvedCommentView: CommentView | null;
-    /**
-     * Tracks information about DOM focus in the comments list.
-     */
-    readonly focusTracker: FocusTracker;
-    /**
-     * Instance of the {@link module:utils/keystrokehandler~KeystrokeHandler}.
-     */
-    readonly keystrokes: KeystrokeHandler;
-    /**
-     * Helps cycling over focusable {@link #commentViews} in the list.
-     */
-    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: CommentThread, config: CommentThreadConfig);
-    /**
-     * @inheritDoc
-     */
-    render(): void;
-    /**
-     * Focuses the view.
-     */
-    focus(direction?: 1 | -1): void;
-    /**
-     * @inheritDoc
-     */
-    destroy(): void;
-    /**
-     * Refreshes the list of the visible views.
-     *
-     * When doing so, it performs a minimal amount of changes, so that views are not re-added, which might cause undesirable effects
-     * like focus loss or glitches due to CSS animations.
-     *
-     * The comments list may be collapsed or expanded:
-     *
-     * * it is expanded, if it {@link ~#isActive is active},
-     * * it is expanded, if {@link module:comments/comments/commentsrepository~CommentThread#weight comment thread weight}
-     * is lower than allowed (`config.comments.maxThreadTotalWeight`),
-     * * it is expanded, if it {@link ~#hasDirtyComment has any comments in edit mode},
-     * * it is collapsed, if neither of above is true.
-     *
-     * When comments list is in collapsed state, it displays at most `config.comments.maxCommentsWhenCollapsed` comment views:
-     *
-     * * first comment view,
-     * * {@link ~#_collapsedCommentsView collapsed comments counter} (if there are any hidden views),
-     * * appropriate number of the comments from the bottom of the thread.
-     *
-     * All the comments are also {@link module:comments/comments/ui/view/basecommentview~BaseCommentView#collapse set to collapsed state}.
-     *
-     * When comments list in in expanded state, it displays all comment views for all comments. All the comments are also
-     * {@link module:comments/comments/ui/view/basecommentview~BaseCommentView#expand set to expanded state}.
-     */
-    refreshVisibleViews(): void;
+	locale: Locale;
+	/**
+	* Informs whether the list contains any comment view that is in the editing mode.
+	*
+	* @observable
+	*/
+	hasDirtyComment: boolean;
+	/**
+	* Number of comments in the list.
+	*
+	* @observable
+	*/
+	length: number;
+	/**
+	* Informs whether the comments list view is in the active state ("highlighted").
+	* Comment list view is in that state when it is focused or it was activated by the user in any different way.
+	*
+	* @observable
+	*/
+	isActive: boolean;
+	/**
+	* View collection which holds all comment views to be displayed.
+	* It may also contain collapsed count view if the comments list view is collapsed and some comment views are hidden.
+	*
+	* @readonly
+	*/
+	readonly visibleViews: ViewCollection;
+	/**
+	* View collection which holds all comment views created for given comment thread.
+	*
+	* @readonly
+	*/
+	readonly commentViews: ViewCollection<CommentView>;
+	/**
+	* Comment view used to display information that comment has been resolved.
+	*
+	* @readonly
+	*/
+	resolvedCommentView: CommentView | null;
+	/**
+	* Tracks information about DOM focus in the comments list.
+	*/
+	readonly focusTracker: FocusTracker;
+	/**
+	* Instance of the {@link module:utils/keystrokehandler~KeystrokeHandler}.
+	*/
+	readonly keystrokes: KeystrokeHandler;
+	/**
+	* Helps cycling over focusable {@link #commentViews} in the list.
+	*/
+	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: CommentThread, config: CommentThreadConfig);
+	/**
+	* @inheritDoc
+	*/
+	override render(): void;
+	/**
+	* Focuses the view.
+	*/
+	focus(direction?: 1 | -1): void;
+	/**
+	* @inheritDoc
+	*/
+	override destroy(): void;
+	/**
+	* Refreshes the list of the visible views.
+	*
+	* When doing so, it performs a minimal amount of changes, so that views are not re-added, which might cause undesirable effects
+	* like focus loss or glitches due to CSS animations.
+	*
+	* The comments list may be collapsed or expanded:
+	*
+	* * it is expanded, if it {@link ~#isActive is active},
+	* * it is expanded, if {@link module:comments/comments/commentsrepository~CommentThread#weight comment thread weight}
+	* is lower than allowed (`config.comments.maxThreadTotalWeight`),
+	* * it is expanded, if it {@link ~#hasDirtyComment has any comments in edit mode},
+	* * it is collapsed, if neither of above is true.
+	*
+	* When comments list is in collapsed state, it displays at most `config.comments.maxCommentsWhenCollapsed` comment views:
+	*
+	* * first comment view,
+	* * {@link ~#_collapsedCommentsView collapsed comments counter} (if there are any hidden views),
+	* * appropriate number of the comments from the bottom of the thread.
+	*
+	* All the comments are also {@link module:comments/comments/ui/view/basecommentview~BaseCommentView#collapse set to collapsed state}.
+	*
+	* When comments list in in expanded state, it displays all comment views for all comments. All the comments are also
+	* {@link module:comments/comments/ui/view/basecommentview~BaseCommentView#expand set to expanded state}.
+	*/
+	refreshVisibleViews(): void;
 }

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

@@ -1,24 +1,24 @@
 /**
- * @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/commentthreadheadercontextview
- */
-import { View, type FocusableView } from '@ckeditor/ckeditor5-ui';
-import type { Locale } from '@ckeditor/ckeditor5-utils';
+* @module comments/comments/ui/view/commentthreadheadercontextview
+*/
+import { View, type FocusableView } from "@ckeditor/ckeditor5-ui";
+import type { Locale } from "@ckeditor/ckeditor5-utils";
 /**
- * A view displaying the context of a comment thread. The context is a piece of text from editor content
- * that comment was created on. It gives users a better understanding of what is discussed in the thread.
- */
+* A view displaying the context of a comment thread. The context is a piece of text from editor content
+* that comment was created on. It gives users a better understanding of what is discussed in the thread.
+*/
 export declare class CommentThreadHeaderContextView extends View implements FocusableView {
-    /**
-     * The text of the content, it corresponds to some of the content in the editor.
-     */
-    contextValue: string;
-    constructor(locale: Locale);
-    /**
-     * @inheritDoc
-     */
-    focus(): void;
+	/**
+	* The text of the content, it corresponds to some of the content in the editor.
+	*/
+	contextValue: string;
+	constructor(locale: Locale);
+	/**
+	* @inheritDoc
+	*/
+	focus(): void;
 }