@ckeditor/ckeditor5-comments
Version:
Collaborative comments feature for CKEditor 5.
54 lines (53 loc) • 1.59 kB
TypeScript
/**
* @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/commentsarchiveui
* @publicApi
*/
import "../../theme/commentsarchive.css";
import { Plugin, type Editor, type PluginDependenciesOf } from "@ckeditor/ckeditor5-core";
import { ViewCollection, Dialog } from "@ckeditor/ckeditor5-ui";
import { CommentsArchiveView } from "./ui/view/commentsarchiveview.js";
import { CommentsArchive } from "./commentsarchive.js";
import { type AnnotationView } from "../annotations/view/annotationview.js";
/**
* Creates comments archive {@link module:ui/dropdown/dropdownview~DropdownView ui dropdown} and binds with
* archived comment thread annotation views.
*/
export declare class CommentsArchiveUI extends Plugin {
/**
* The view that is rendered in the dialog.
*/
commentsArchiveView: CommentsArchiveView | undefined;
/**
* The view collection of {@link module:comments/annotations/view/annotationview~AnnotationView}
* that is displayed inside {@link #commentsArchiveView}.
*/
annotationViews: ViewCollection<AnnotationView>;
/**
* @inheritDoc
*/
static get pluginName(): "CommentsArchiveUI";
/**
* @inheritDoc
*/
static override get isOfficialPlugin(): true;
/**
* @inheritDoc
*/
static override get isPremiumPlugin(): true;
/**
* @inheritDoc
*/
static get requires(): PluginDependenciesOf<[CommentsArchive, Dialog]>;
/**
* @inheritDoc
*/
constructor(editor: Editor);
/**
* @inheritDoc
*/
init(): void;
}