CKEditor Ecosystem Documentation
Search
Home/CKEditor 5/API
Module

minimap/utils

@ckeditor/ckeditor5-minimap/src/utils

module

Filtering

Functions

  • protected

    cloneEditingViewDomRoot( editor, rootName ) → HTMLElement

    See source

    Clones the editing view DOM root by using a dedicated pair of Renderer and DomConverter. The DOM root clone updates incrementally to stay in sync with the source root.

    Parameters

    editor : Editor

    The editor instance the original editing root belongs to.

    rootName : String

    The name of the root to clone.

    Returns

    HTMLElement

    The editing root DOM clone element.

  • protected

    findClosestScrollableAncestor( domElement ) → HTMLElement | null

    See source

    Returns the closest scrollable ancestor of a DOM element.

    TODO: Move to shared utils.

    Parameters

    domElement : HTMLElement

    Returns

    HTMLElement | null

  • protected

    getClientHeight() → Number

    See source

    TODO

    Returns

    Number

  • protected

    getDomElementRect() → Rect

    See source

    TODO

    Returns

    Rect

  • protected

    getPageStyles() → Array.<(String | Object)>

    See source

    Harvests all web page styles, for instance, to allow re-using them in an <iframe> preserving the look of the content.

    The returned data format is as follows:

    [
	'p { color: red; ... } h2 { font-size: 2em; ... } ...',
	'.spacing { padding: 1em; ... }; ...',
	'...',
	{ href: 'http://link.to.external.stylesheet' },
	{ href: '...' }
]

    Note: For stylesheets with href different than window origin, an object is returned because accessing rules of these styles may cause CORS errors (depending on the configuration of the web page).

    Returns

    Array.<(String | Object)>

  • protected

    getScrollable() → HTMLElement

    See source

    TODO

    Returns

    HTMLElement