CKEditor Ecosystem Documentation
Search
⚠️ WarningNightly documentation ahead. Switch to the stable editor documentation.
Home/CKEditor 5/API
Interface

MinimapConfig (minimap)

@ckeditor/ckeditor5-minimap/src/minimap

interface
See source

The configuration of the Minimap feature.

ClassicEditor
	.create( {
		minimap: ... // Minimap feature config.
	} )
	.then( ... )
	.catch( ... );

See all editor options.

Filtering

Properties

  • container : HTMLElement

    The DOM element container for the minimap.

    See source

    Note: The container must have a fixed width and overflow: hidden for the minimap to work correctly.

  • extraClasses : String

    Extra CSS class (or classes) that will be set internally on the <body> element of the <iframe> enclosing the minimap.

    See source

    By default, the minimap feature will attempt to clone all website styles and re-apply them in the <iframe> for the best accuracy. However, this may not work if the content of your editor inherits the styles from parent containers, resulting in inconsistent look and imprecise scrolling of the minimap.

    This optional configuration can address these issues by ensuring the same CSS rules apply to the content of the minimap and the original content of the editor.

    For instance, consider the following DOM structure:

    <div class="website">
	<!-- ... -->
	<div class="styled-container">
		 <!-- ... -->
		<div id="editor">
			<!-- content of the editor -->
		</div>
	</div>
	<!-- ... -->
</div>

    and the following CSS styles:

    .website p {
	font-size: 13px;
}

.styled-container p {
	color: #ccc;
}

    To maintain the consistency of styling (font-size and color of paragraphs), you will need to pass the CSS class names of these containers:

    ClassicEditor
	.create( document.getElementById( 'editor' ), {
		minimap: {
			extraClasses: 'website styled-container'
		}
	} )
	.then( ... )
	.catch( ... );

  • useSimplePreview : Boolean

    When set to true, the minimap will render content as simple boxes instead of replicating the look of the content (default).

    See source