Browse Source

Merge pull request #7455 from rshipp/i/7274

Docs: Add note about createEditableElement() in the data view. Closes #7274.
Piotrek Koszuliński 5 years ago
parent
commit
b80c677949
1 changed files with 3 additions and 0 deletions
  1. 3 0
      packages/ckeditor5-engine/src/view/downcastwriter.js

+ 3 - 0
packages/ckeditor5-engine/src/view/downcastwriter.js

@@ -214,6 +214,9 @@ export default class DowncastWriter {
 	 *		writer.createEditableElement( 'div' );
 	 *		writer.createEditableElement( 'div', { id: 'foo-1234' } );
 	 *
+	 * Note: The editable element is to be used in the editing pipeline. Usually, together with
+	 * {@link module:widget/utils~toWidgetEditable `toWidgetEditable()`}.
+	 *
 	 * @param {String} name Name of the element.
 	 * @param {Object} [attributes] Elements attributes.
 	 * @returns {module:engine/view/editableelement~EditableElement} Created element.