Преглед изворни кода

Added example to UIElement.render method docs.

Szymon Kupś пре 8 година
родитељ
комит
205a74af3d
1 измењених фајлова са 9 додато и 0 уклоњено
  1. 9 0
      packages/ckeditor5-engine/src/view/uielement.js

+ 9 - 0
packages/ckeditor5-engine/src/view/uielement.js

@@ -68,6 +68,15 @@ export default class UIElement extends Element {
 	/**
 	/**
 	 * Renders this {@link module:engine/view/uielement~UIElement} to DOM. This method is called by
 	 * Renders this {@link module:engine/view/uielement~UIElement} to DOM. This method is called by
 	 * {@link module:engine/view/domconverter~DomConverter}.
 	 * {@link module:engine/view/domconverter~DomConverter}.
+	 * Do not use inheritance to create custom rendering method, replace `render()` method instead:
+	 *
+	 *		const myUIElement = new UIElement( 'span' );
+	 *		myUIElement.render = function( domDocument ) {
+	 *			const domElement = this.toDomElement( domDocument );
+	 *			domElement.innerHTML = '<b>this is ui element</b>';
+	 *
+	 *			return domElement;
+	 *		};
 	 *
 	 *
 	 * @param {Document} domDocument
 	 * @param {Document} domDocument
 	 * @return {HTMLElement}
 	 * @return {HTMLElement}