@ckeditor/ckeditor5-comments
Version:
Collaborative comments feature for CKEditor 5.
54 lines (53 loc) • 1.51 kB
TypeScript
/**
* @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 comments/annotations/view/sidebarview
* @publicApi
*/
import { View, FocusCycler, type ViewCollection, type ViewWithFocusCycler } from 'ckeditor5/src/ui.js';
import { FocusTracker, type Locale } from 'ckeditor5/src/utils.js';
import { type AnnotationsSidebarItemView } from './sidebaritemview.js';
import '../../../theme/sidebar.css';
/**
* The sidebar view class that displays the collection of sidebar item views.
*/
export declare class AnnotationsSidebarView extends View implements ViewWithFocusCycler {
/**
* @observable
*/
minHeight: number | null;
/**
* @observable
*/
class: string;
/**
* A collection of sidebar item views.
*/
list: ViewCollection<AnnotationsSidebarItemView>;
/**
* A collection of focusable views in the sidebar.
*/
focusables: ViewCollection<AnnotationsSidebarItemView>;
/**
* Tracks information about DOM focus among sidebar item views.
*/
readonly focusTracker: FocusTracker;
/**
* Helps cycling over {@link #focusables focusable items} in the sidebar.
*/
readonly focusCycler: FocusCycler;
/**
* @inheritDoc
*/
constructor(locale: Locale);
/**
* @inheritDoc
*/
render(): void;
/**
* @inheritDoc
*/
focus(): void;
}