8
0
Piotrek Koszuliński 7 лет назад
Родитель
Сommit
c9f4dffd6a
1 измененных файлов с 12 добавлено и 2 удалено
  1. 12 2
      packages/ckeditor5-core/src/editor/editorwithui.jsdoc

+ 12 - 2
packages/ckeditor5-core/src/editor/editorwithui.jsdoc

@@ -29,10 +29,20 @@
  */
 
  /**
-  * An HTML element that represents the editor with the UI.
+  * The main (outermost) DOM element of the editor's UI.
+  *
+  * For example, in the {@link module:editor-classic/classiceditor~ClassicEditor} it is a `<div>` which
+  * wraps the editable element and the toolbar. In the {@link module:editor-inline/inlineeditor~InlineEditor}
+  * it is the editable element itself (as there is no other wrapper). However, in the
+  * {@link module:editor-decoupled/decouplededitor~DecoupledEditor} it is set to `null` because this editor does not
+  * come with a single "main" HTML element (its editable element and toolbar are separate).
+  *
+  * This property can be understood as a shorthand for retrieving the element which specific editor integration
+  * considers to be its main DOM element. There are always other ways to access these elements too
+  * (e.g. via {@link #ui `editor.ui`}).
   *
   * @readonly
-  * @member {HTMLElement} #element
+  * @member {HTMLElement|null} #element
   */
 
 /**