AnnotationsSidebarConfig
The configuration of the sidebar feature.
ClassicEditor
.create( {
sidebar: {
// Sidebar feature configuration.
}
} )
.then( ... )
.catch( ... );Properties
container?: HTMLElementmodule:comments/config~AnnotationsSidebarConfig#containerDOM element into which the sidebar will be inserted.
overlayContainer?: ShadowRoot | HTMLElementmodule:comments/config~AnnotationsSidebarConfig#overlayContainerDOM element or shadow root into which the floating annotation balloon of the narrow sidebar is mounted.
When the narrow sidebar runs inside a shadow root, provide this container as a separate shadow root attached to a host element placed at the end of
document.body, rather than to an element nested in the sidebar's own tree. As a direct child ofdocument.body, that host has no scrollable oroverflow: hiddenancestor to clip the balloon (thecontainertypically clips its own overflow).When it is not set, the shared
ui.overlayContainerfrom the context configuration is used instead, if present. Otherwise the balloon is mounted into the shadow root that thecontainerlives in, so it inherits the same styles; thedocument.bodydefault is meant just for a narrow sidebar in the light DOM.preventScrollOutOfView?: booleanmodule:comments/config~AnnotationsSidebarConfig#preventScrollOutOfViewChanges how the annotations are positioned inside the sidebar.
If set to
true, the top annotation in the sidebar will never be scrolled above the top edge of the sidebar (which would make it hidden).On the other hand, with this setting enabled, if there is not enough space, annotations will not be positioned exactly next to their linked elements when selected.
Defaults to
false