@ckeditor/ckeditor5-comments/dist/comments.d.ts

Collaborative comments feature for CKEditor 5.

/**
* @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, 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.
*/
export declare class Comments extends Plugin {
	/**
	* @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;
}