CKEditor Ecosystem Documentation
Search
Home/CKEditor 5/API
Interface

SidebarConfig (comments/annotations)

@ckeditor/ckeditor5-comments/src/annotations/sidebar

interface

The configuration of the sidebar feature.

ClassicEditor
	.create( {
		sidebar: {
			// Sidebar feature configuration.
		}
	} )
	.then( ... )
	.catch( ... );

See all editor configuration options.

Filtering

Properties

  • container : HTMLElement

    DOM element into which the sidebar will be inserted.

  • preventScrollOutOfView : Boolean

    Changes 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