@ckeditor/ckeditor5-comments/dist/comments/commentsui.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/commentsui
*/
import { Plugin, type PluginDependenciesOf } from "@ckeditor/ckeditor5-core";
import { CommentsRepository } from "./commentsrepository.js";
import { CommentsEditing } from "./commentsediting.js";
import { EditorAnnotations } from "../annotations/editorannotations.js";
import { Annotations } from "../annotations/annotations.js";
/**
* Creates `comment` {@link module:ui/button/buttonview~ButtonView ui button} and binds with
* {@link module:comments/comments/addcommentthreadcommand~AddCommentThreadCommand}.
*
* Because of CommentsRepository handles UI of CommentThreads responsibility of this plugin is limited to
* adjusting comments UX for the editor purpose.
*/
export declare class CommentsUI extends Plugin {
	/**
	* @inheritDoc
	*/
	static get pluginName(): "CommentsUI";
	/**
	* @inheritDoc
	*/
	static override get isOfficialPlugin(): true;
	/**
	* @inheritDoc
	*/
	static override get isPremiumPlugin(): true;
	/**
	* @inheritDoc
	*/
	static get requires(): PluginDependenciesOf<[CommentsRepository, CommentsEditing, EditorAnnotations, Annotations]>;
	/**
	* @inheritDoc
	*/
	init(): void;
	/**
	* @inheritDoc
	*/
	override destroy(): void;
}