@ckeditor/ckeditor5-comments/dist/annotations/widesidebar.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/annotations/widesidebar
* @publicApi
*/
import { ContextPlugin, Context, type Editor, type PluginDependenciesOf } from "@ckeditor/ckeditor5-core";
import { AnnotationsUIs, type AnnotationsUI } from "./annotationsuis.js";
import { Sidebar } from "./sidebar.js";
import { type Annotation } from "./annotation.js";
import type { AnnotationCollection } from "./annotationcollection.js";
/**
* The wide sidebar UI for displaying annotations.
*
* In this implementation {@link module:comments/annotations/sidebar~Sidebar the sidebar} displays full
* {@link module:comments/annotations/view/annotationview~AnnotationView annotation views}.
*
* To activate this UI use one of the following:
*
* ```ts
* editor.plugins.get( 'AnnotationsUIs' ).switchTo( 'wideSidebar' );
* editor.plugins.get( 'AnnotationsUIs' ).activate( 'wideSidebar', filter );
* ```
*
* See {@link module:comments/annotations/annotationsuis~AnnotationsUIs}.
*/
export declare class WideSidebar extends ContextPlugin implements AnnotationsUI<ContextPlugin> {
	/**
	* An active annotation tracked by this UI.
	*
	* @observable
	*/
	activeAnnotation: Annotation | null;
	isAttached: boolean;
	/**
	* A collection of annotations controlled by this UI.
	*
	* This property is readonly and should not be operated on directly. Use it only to read which annotations are added to this UI.
	*
	* It is set to `null` if `WideSidebar` is not {@link module:comments/annotations/widesidebar~WideSidebar#attach attached}.
	*/
	annotations: AnnotationCollection | null;
	/**
	* @inheritDoc
	*/
	static get requires(): PluginDependenciesOf<[Sidebar, AnnotationsUIs]>;
	/**
	* @inheritDoc
	*/
	static get pluginName(): "WideSidebar";
	/**
	* @inheritDoc
	*/
	static override get isOfficialPlugin(): true;
	/**
	* @inheritDoc
	*/
	static override get isPremiumPlugin(): true;
	/**
	* @inheritDoc
	*/
	constructor(context: Context | Editor);
	/**
	* @inheritDoc
	*/
	init(): void;
	/**
	* Sets the active annotation for this UI.
	*/
	setActiveAnnotation(annotation: Annotation | null): void;
	/**
	* @inheritDoc
	*/
	attach(annotations: AnnotationCollection): void;
	/**
	* @inheritDoc
	*/
	detach(): void;
	/**
	* @inheritDoc
	*/
	override destroy(): void;
}