minimap/utils

@ckeditor/ckeditor5-minimap/src/utils

Functions

• cloneEditingViewDomRoot( editor, rootName ) → HTMLElementmodule:minimap/utils~cloneEditingViewDomRoot

  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.

  See source

  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 | nullmodule:minimap/utils~findClosestScrollableAncestor

  protected

  Returns the closest scrollable ancestor of a DOM element.

  See source

  TODO: Move to shared utils.

  Parameters

  domElement : HTMLElement

  Returns

  HTMLElement | null

• getClientHeight() → Numbermodule:minimap/utils~getClientHeight

  protected

  TODO

  See source

  Returns

  Number

• getDomElementRect() → Rectmodule:minimap/utils~getDomElementRect

  protected

  TODO

  See source

  Returns

  Rect

• getPageStyles() → Array.<(String | Object)>module:minimap/utils~getPageStyles

  protected

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

  See source

  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() → HTMLElementmodule:minimap/utils~getScrollable

  protected

  TODO

  See source

  Returns

  HTMLElement