CKEditor Ecosystem Documentation
Search
Home/CKEditor 5/API
Module

minimap/utils

@ckeditor/ckeditor5-minimap/src/utils

module

Filtering

Functions

  • internal

    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.

  • internal

    getClientHeight( domElement ) → number

    See source

    Gets client height according to passed DOM element. Returns window's height for body element.

    Parameters

    domElement : HTMLElement

    Returns

    number

  • internal

    getDomElementRect( domElement ) → Rect

    See source

    Gets dimensions rectangle according to passed DOM element. Returns whole window's size for body element.

    Parameters

    domElement : HTMLElement

    Returns

    Rect

  • internal

    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>

  • internal

    getScrollable( domElement ) → Window | HTMLElement

    See source

    Returns the DOM element itself if it's not a body element, whole window otherwise.

    Parameters

    domElement : HTMLElement

    Returns

    Window | HTMLElement