@ckeditor/ckeditor5-track-changes/src/trackchangesui.d.ts

CKEditor 5 track changes plugin.

/**
 * @license Copyright (c) 2003-2025, 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 } from 'ckeditor5/src/core.js';
import { Users } from 'ckeditor5-collaboration/src/collaboration-core.js';
import 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(): readonly [typeof TrackChangesEditing, typeof Users, "CommentsRepository", "Annotations", "EditorAnnotations"];
    /**
     * @inheritDoc
     */
    static get pluginName(): "TrackChangesUI";
    /**
     * @inheritDoc
     */
    static get isOfficialPlugin(): true;
    /**
     * @inheritDoc
     */
    static 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
     */
    destroy(): void;
}