@ckeditor/ckeditor5-track-changes
Version:
CKEditor 5 track changes plugin.
58 lines (57 loc) • 1.68 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 track-changes/trackchangesui
* @publicApi
*/
import { Plugin, type Editor, type PluginDependenciesOf } from "@ckeditor/ckeditor5-core";
import { Users } from "@ckeditor/ckeditor5-collaboration-core";
import { Annotations, CommentsRepository, EditorAnnotations, type Annotation } from "@ckeditor/ckeditor5-comments";
import { TrackChangesEditing } from "./trackchangesediting.js";
import { type Suggestion } from "./suggestion.js";
/**
* Provides UI for track changes plugin.
*
* This plugin displays {@link module:track-changes/suggestion~Suggestion suggestions} as a
* {@link module:comments/annotations/annotations~Annotations}.
*/
export declare class TrackChangesUI extends Plugin {
/**
* @inheritDoc
*/
static get requires(): PluginDependenciesOf<[TrackChangesEditing, Users, CommentsRepository, Annotations, EditorAnnotations]>;
/**
* @inheritDoc
*/
static get pluginName(): "TrackChangesUI";
/**
* @inheritDoc
*/
static override get isOfficialPlugin(): true;
/**
* @inheritDoc
*/
static override get isPremiumPlugin(): true;
/**
* @inheritDoc
*/
constructor(editor: Editor);
/**
* @inheritDoc
*/
init(): void;
/**
* Returns the annotation associated with the given suggestion.
*/
getAnnotationForSuggestion(suggestion: Suggestion): Annotation | null;
/**
* Returns the suggestion associated with the given annotation.
*/
getSuggestionForAnnotation(annotation: Annotation): Suggestion | null;
/**
* @inheritDoc
*/
override destroy(): void;
}