CKEditor Ecosystem Documentation
Search
Home/CKEditor 5/API
Interface

BookmarkConfig (bookmark)

@ckeditor/ckeditor5-bookmark/src/bookmarkconfig

interface
See source

The configuration of the bookmark feature.

The properties defined in this config are set in the config.bookmark namespace.

ClassicEditor
	.create( editorElement, {
		bookmark: {
			// Bookmark configuration.
		}
	} )
	.then( ... )
	.catch( ... );

See all editor options.

Filtering

Properties

  • enableNonEmptyAnchorConversion : boolean | undefined

    See source

    Allows to convert into bookmarks non-empty anchor elements.

    With this option enabled you will have all non-empty anchors converted into bookmakrs. For example:

    <a id="bookmark">Bookmark</a>

    will be converted into:

    <a id="bookmark"></a>Bookmark

    Note: This is enabled by default.

    Defaults to true

  • toolbar : Array<string> | undefined

    See source

    Items to be placed in the bookmark contextual toolbar.

    Assuming that you use the BookmarkUI feature, the following toolbar items will be available in ComponentFactory:

    • 'bookmarkPreview',
    • 'editBookmark',
    • 'removeBookmark'.

    The default configuration for bookmark toolbar is:

    const bookmarkConfig = {
	toolbar: [ 'bookmarkPreview', '|', 'editBookmark', 'removeBookmark' ]
};

    Of course, the same buttons can also be used in the main editor toolbar.

    Read more about configuring the toolbar in toolbar.