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

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

@@ -1,76 +1,76 @@
 /**
- * @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/commentthreadheaderview
- */
-import { View, ButtonView, FocusCycler, type FocusableView, type ViewCollection } from '@ckeditor/ckeditor5-ui';
-import { FocusTracker, KeystrokeHandler, type Locale } from '@ckeditor/ckeditor5-utils';
-import type { CommentThread } from '../../commentsrepository.js';
-import { CommentThreadHeaderContextView } from './commentthreadheadercontextview.js';
+* @module comments/comments/ui/view/commentthreadheaderview
+*/
+import { View, ButtonView, FocusCycler, type FocusableView, type ViewCollection } from "@ckeditor/ckeditor5-ui";
+import { FocusTracker, KeystrokeHandler, type Locale } from "@ckeditor/ckeditor5-utils";
+import type { CommentThread } from "../../commentsrepository.js";
+import { CommentThreadHeaderContextView } from "./commentthreadheadercontextview.js";
 export declare const MAX_CONTENT_LENGTH = 150;
 /**
- * A view for the comment thread header.
- */
+* A view for the comment thread header.
+*/
 export declare class CommentThreadHeaderView extends View implements FocusableView {
-    locale: Locale;
-    /**
-     * Defines whether the context value exists.
-     *
-     * @observable
-     */
-    hasContext: boolean;
-    /**
-     * Context value to display in the header.
-     *
-     * @observable
-     */
-    contextValue: string;
-    /**
-     * Button view for the button which reopen the comment thread.
-     */
-    reopenButtonView: ButtonView;
-    /**
-     * The view that displays the context of the comment thread to the user, for instance,
-     * the part of text the thread (first comment) relates to.
-     */
-    contextView: CommentThreadHeaderContextView;
-    /**
-     * The collection of focusable sub-views in the header.
-     */
-    readonly focusables: ViewCollection<FocusableView>;
-    /**
-     * Tracks information about DOM focus in the header view.
-     */
-    readonly focusTracker: FocusTracker;
-    /**
-     * Instance of the {@link module:utils/keystrokehandler~KeystrokeHandler}.
-     */
-    readonly keystrokes: KeystrokeHandler;
-    /**
-     * Helps cycling over focusable {@link #commentThreadChildren} in the header view.
-     */
-    readonly focusCycler: FocusCycler;
-    /**
-     * @inheritDoc
-     */
-    constructor(locale: Locale, model: CommentThread);
-    /**
-     * @inheritDoc
-     */
-    render(): void;
-    /**
-     * @inheritDoc
-     */
-    focus(): void;
+	locale: Locale;
+	/**
+	* Defines whether the context value exists.
+	*
+	* @observable
+	*/
+	hasContext: boolean;
+	/**
+	* Context value to display in the header.
+	*
+	* @observable
+	*/
+	contextValue: string;
+	/**
+	* Button view for the button which reopen the comment thread.
+	*/
+	reopenButtonView: ButtonView;
+	/**
+	* The view that displays the context of the comment thread to the user, for instance,
+	* the part of text the thread (first comment) relates to.
+	*/
+	contextView: CommentThreadHeaderContextView;
+	/**
+	* The collection of focusable sub-views in the header.
+	*/
+	readonly focusables: ViewCollection<FocusableView>;
+	/**
+	* Tracks information about DOM focus in the header view.
+	*/
+	readonly focusTracker: FocusTracker;
+	/**
+	* Instance of the {@link module:utils/keystrokehandler~KeystrokeHandler}.
+	*/
+	readonly keystrokes: KeystrokeHandler;
+	/**
+	* Helps cycling over focusable {@link #commentThreadChildren} in the header view.
+	*/
+	readonly focusCycler: FocusCycler;
+	/**
+	* @inheritDoc
+	*/
+	constructor(locale: Locale, model: CommentThread);
+	/**
+	* @inheritDoc
+	*/
+	override render(): void;
+	/**
+	* @inheritDoc
+	*/
+	focus(): void;
 }
 /**
- * Fired when a user performed an action that should lead to reopen the resolved comment thread.
- *
- * @eventName ~CommentThreadHeaderView#reopenCommentThread
- */
+* Fired when a user performed an action that should lead to reopen the resolved comment thread.
+*
+* @eventName ~CommentThreadHeaderView#reopenCommentThread
+*/
 export type UIReopenCommentThreadEvent = {
-    name: 'reopenCommentThread';
-    args: [id: string];
+	name: "reopenCommentThread";
+	args: [id: string];
 };

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

@@ -1,56 +1,56 @@
 /**
- * @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/commentthreadinputview
- */
-import { type FocusableView, type FocusCycler, View } from '@ckeditor/ckeditor5-ui';
-import { CommentInputView } from './commentinputview.js';
-import type { Locale } from '@ckeditor/ckeditor5-utils';
-import type { EditorConfig } from '@ckeditor/ckeditor5-core';
-import { UserView, type User } from '@ckeditor/ckeditor5-collaboration-core';
+* @module comments/comments/ui/view/commentthreadinputview
+*/
+import { type FocusableView, type FocusCycler, View } from "@ckeditor/ckeditor5-ui";
+import { CommentInputView } from "./commentinputview.js";
+import type { Locale } from "@ckeditor/ckeditor5-utils";
+import type { EditorConfig } from "@ckeditor/ckeditor5-core";
+import { UserView, type User } from "@ckeditor/ckeditor5-collaboration-core";
 /**
- * View that represents comment input area for a comment thread. Includes editor, user view and buttons.
- */
+* View that represents comment input area for a comment thread. Includes editor, user view and buttons.
+*/
 export declare class CommentThreadInputView extends View implements FocusableView {
-    /**
-     * Specifies whether the comment input view should be visible (`true`) or hidden (`false`).
-     *
-     * @observable
-     */
-    showInput: boolean;
-    /**
-     * Comment input view.
-     */
-    commentInputView: CommentInputView;
-    /**
-     * Helps move focus between focusable elements.
-     *
-     * **Note:** This property is a proxy is exposed for parent views to discover and use focus cycling capabilities of the view
-     * while in fact the actual implementation is in the {@link #commentInputView}.
-     */
-    focusCycler: FocusCycler;
-    /**
-     * User view for the input area. Presents the local user.
-     */
-    userView: UserView;
-    /**
-     * @param locale The localization service instance.
-     * @param localUser Current local user.
-     * @param editorConfig
-     */
-    constructor(locale: Locale, localUser: User, editorConfig: EditorConfig);
-    /**
-     * @inheritDoc
-     */
-    render(): void;
-    /**
-     * @inheritDoc
-     */
-    destroy(): Promise<void>;
-    /**
-     * @inheritDoc
-     */
-    focus(direction?: 1 | -1): void;
+	/**
+	* Specifies whether the comment input view should be visible (`true`) or hidden (`false`).
+	*
+	* @observable
+	*/
+	showInput: boolean;
+	/**
+	* Comment input view.
+	*/
+	commentInputView: CommentInputView;
+	/**
+	* Helps move focus between focusable elements.
+	*
+	* **Note:** This property is a proxy is exposed for parent views to discover and use focus cycling capabilities of the view
+	* while in fact the actual implementation is in the {@link #commentInputView}.
+	*/
+	focusCycler: FocusCycler;
+	/**
+	* User view for the input area. Presents the local user.
+	*/
+	userView: UserView;
+	/**
+	* @param locale The localization service instance.
+	* @param localUser Current local user.
+	* @param editorConfig
+	*/
+	constructor(locale: Locale, localUser: User, editorConfig: EditorConfig);
+	/**
+	* @inheritDoc
+	*/
+	override render(): void;
+	/**
+	* @inheritDoc
+	*/
+	override destroy(): Promise<void>;
+	/**
+	* @inheritDoc
+	*/
+	focus(direction?: 1 | -1): void;
 }

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

@@ -1,121 +1,121 @@
 /**
- * @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/commentthreadview
- * @publicApi
- */
-import { type Locale } from '@ckeditor/ckeditor5-utils';
-import { LateFocusButtonView, type User } from '@ckeditor/ckeditor5-collaboration-core';
-import { type View, type ViewWithFocusCycler, type TemplateDefinition, type ViewCollection } from '@ckeditor/ckeditor5-ui';
-import { BaseCommentThreadView } from './basecommentthreadview.js';
-import type { CommentThread } from '../../commentsrepository.js';
-import type { CommentThreadConfig } from '../../../config.js';
-declare const CommentThreadView_base: import("@ckeditor/ckeditor5-utils").Mixed<typeof BaseCommentThreadView, import("@ckeditor/ckeditor5-collaboration-core").ConfirmApi>;
+* @module comments/comments/ui/view/commentthreadview
+* @publicApi
+*/
+import { type Locale } from "@ckeditor/ckeditor5-utils";
+import { LateFocusButtonView, type ConfirmMixinConstructor, type User } from "@ckeditor/ckeditor5-collaboration-core";
+import { type View, type ViewWithFocusCycler, type TemplateDefinition, type ViewCollection } from "@ckeditor/ckeditor5-ui";
+import { BaseCommentThreadView } from "./basecommentthreadview.js";
+import type { CommentThread } from "../../commentsrepository.js";
+import type { CommentThreadConfig } from "../../../config.js";
+declare const _CommentThreadViewBase: ConfirmMixinConstructor<typeof BaseCommentThreadView>;
 /**
- * The default view for comment thread.
- */
-export declare class CommentThreadView extends /* #__PURE__ -- @preserve */ CommentThreadView_base implements ViewWithFocusCycler {
-    cancelConfirm: () => void;
-    showConfirm: (key: string, element: unknown) => Promise<void>;
-    /**
-     * The locale instance.
-     */
-    readonly locale: Locale;
-    /**
-     * 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;
-    /**
-     * View collection which holds all comment thread children elements.
-     *
-     * These views are:
-     *
-     * * {@link ~CommentThreadView#commentThreadHeaderView `commentThreadHeaderView`} (added at the beginning when the comment thread is
-     * resolved),
-     * * {@link ~CommentThreadView#commentsListView `commentsListView`},
-     * * {@link ~CommentThreadView#commentThreadInputView `commentThreadInputView`}.
-     *
-     * @readonly
-     */
-    readonly commentThreadChildren: ViewCollection<View>;
-    /**
-     * `ConfirmView` uses this element as a container for confirmation dialog.
-     *
-     * The element is set after `view#render()` is called.
-     *
-     * @readonly
-     */
-    containerElement: HTMLElement | null;
-    /**
-     * Resolve button view. Resolve button fires the 'resolveCommentThread' event when submitted.
-     *
-     * @readonly
-     */
-    readonly resolveButton: LateFocusButtonView;
-    /**
-     * @inheritDoc
-     */
-    constructor(locale: Locale, model: CommentThread, localUser: User, config: CommentThreadConfig);
-    /**
-     * 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 thread view.
-     *
-     * The default template looks as follows:
-     *
-     * ```ts
-     * const bind = this.bindTemplate;
-     *
-     * {
-     * 	tag: 'div',
-     *
-     * 	attributes: {
-     * 		class: [
-     * 			'ck',
-     * 			'ck-thread',
-     * 			'ck-reset_all-excluded',
-     * 			'ck-rounded-corners',
-     * 			bind.if( 'isActive', 'ck-thread--active' ),
-     * 			bind.if( 'isUnlinked', 'ck-thread--unlinked' ),
-     * 			bind.to( 'actionIndicator', value => value ? `ck-thread--${ value }` : '' )
-     * 		],
-     * 		'data-thread-id': this._model.id,
-     * 		// Needed for managing focus after adding new comment.
-     * 		tabindex: 0,
-     * 		role: 'listitem',
-     * 		'aria-label': bind.to( 'ariaLabel' ),
-     * 		'aria-describedby': this.ariaDescriptionView.id
-     * 	},
-     *
-     * 	children: [
-     * 		{
-     * 			tag: 'div',
-     * 			attributes: {
-     * 				class: 'ck-thread__container'
-     * 			},
-     * 			children: this.commentThreadChildren
-     * 		}
-     * 	]
-     * };
-     * ```
-     *
-     * See the {@glink features/collaboration/annotations/annotations-custom-view Annotation custom view guide} to learn more about
-     * the possible annotation customizations.
-     *
-     * @returns The definition of a comment thread view's template.
-     */
-    getTemplate(): TemplateDefinition;
-    /**
-     * @inheritDoc
-     */
-    render(): void;
+* The default view for comment thread.
+*/
+export declare class CommentThreadView extends _CommentThreadViewBase implements ViewWithFocusCycler {
+	cancelConfirm: () => void;
+	showConfirm: (key: string, element: unknown) => Promise<void>;
+	/**
+	* The locale instance.
+	*/
+	readonly locale: Locale;
+	/**
+	* 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;
+	/**
+	* View collection which holds all comment thread children elements.
+	*
+	* These views are:
+	*
+	* * {@link ~CommentThreadView#commentThreadHeaderView `commentThreadHeaderView`} (added at the beginning when the comment thread is
+	* resolved),
+	* * {@link ~CommentThreadView#commentsListView `commentsListView`},
+	* * {@link ~CommentThreadView#commentThreadInputView `commentThreadInputView`}.
+	*
+	* @readonly
+	*/
+	readonly commentThreadChildren: ViewCollection<View>;
+	/**
+	* `ConfirmView` uses this element as a container for confirmation dialog.
+	*
+	* The element is set after `view#render()` is called.
+	*
+	* @readonly
+	*/
+	containerElement: HTMLElement | null;
+	/**
+	* Resolve button view. Resolve button fires the 'resolveCommentThread' event when submitted.
+	*
+	* @readonly
+	*/
+	readonly resolveButton: LateFocusButtonView;
+	/**
+	* @inheritDoc
+	*/
+	constructor(locale: Locale, model: CommentThread, localUser: User, config: CommentThreadConfig);
+	/**
+	* 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 thread view.
+	*
+	* The default template looks as follows:
+	*
+	* ```ts
+	* const bind = this.bindTemplate;
+	*
+	* {
+	* 	tag: 'div',
+	*
+	* 	attributes: {
+	* 		class: [
+	* 			'ck',
+	* 			'ck-thread',
+	* 			'ck-reset_all-excluded',
+	* 			'ck-rounded-corners',
+	* 			bind.if( 'isActive', 'ck-thread--active' ),
+	* 			bind.if( 'isUnlinked', 'ck-thread--unlinked' ),
+	* 			bind.to( 'actionIndicator', value => value ? `ck-thread--${ value }` : '' )
+	* 		],
+	* 		'data-thread-id': this._model.id,
+	* 		// Needed for managing focus after adding new comment.
+	* 		tabindex: 0,
+	* 		role: 'listitem',
+	* 		'aria-label': bind.to( 'ariaLabel' ),
+	* 		'aria-describedby': this.ariaDescriptionView.id
+	* 	},
+	*
+	* 	children: [
+	* 		{
+	* 			tag: 'div',
+	* 			attributes: {
+	* 				class: 'ck-thread__container'
+	* 			},
+	* 			children: this.commentThreadChildren
+	* 		}
+	* 	]
+	* };
+	* ```
+	*
+	* See the {@glink features/collaboration/annotations/annotations-custom-view Annotation custom view guide} to learn more about
+	* the possible annotation customizations.
+	*
+	* @returns The definition of a comment thread view's template.
+	*/
+	getTemplate(): TemplateDefinition;
+	/**
+	* @inheritDoc
+	*/
+	override render(): void;
 }
 export {};