Module

minimap/utils

@ckeditor/ckeditor5-minimap/src/utils

module

Filtering

Classes

Functions

  • cloneEditingViewDomRoot( editor, rootName ) → HTMLElement

    protected

    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.

  • findClosestScrollableAncestor( domElement ) → HTMLElement | null

    protected

    Returns the closest scrollable ancestor of a DOM element.

    TODO: Move to shared utils.

    Parameters

    domElement : HTMLElement

    Returns

    HTMLElement | null
  • getClientHeight() → Number

    protected

    Returns

    Number
  • getDomElementRect() → Rect

    protected

    Returns

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

    protected

    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)>
  • getScrollable() → HTMLElement

    protected

    Returns

    HTMLElement