Skip to content
This repository has been archived by the owner on Jun 26, 2020. It is now read-only.

Commit

Permalink
More docs polish.
Browse files Browse the repository at this point in the history
  • Loading branch information
Reinmar committed Jul 3, 2018
1 parent 76aeef3 commit d0da654
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 17 deletions.
30 changes: 14 additions & 16 deletions src/decouplededitor.js
Original file line number Diff line number Diff line change
Expand Up @@ -57,25 +57,15 @@ export default class DecoupledEditor extends Editor {
* {@link module:editor-decoupled/decouplededitor~DecoupledEditor.create `DecoupledEditor.create()`} method instead.
*
* @protected
* @param {HTMLElement|String} sourceElementOrData The DOM element that serves as an editable.
* The data will be loaded from it and loaded back to it once the editor is destroyed.
* Alternatively, a data string to be loaded into the editor.
* @param {HTMLElement|String} sourceElementOrData The DOM element that will be the source for the created editor
* (on which the editor will be initialized) or initial data for the editor. For more information see
* {@link module:editor-balloon/ballooneditor~BalloonEditor.create `BalloonEditor.create()`}.
* @param {module:core/editor/editorconfig~EditorConfig} config The editor configuration.
*/
constructor( sourceElementOrData, config ) {
super( config );

if ( isElement( sourceElementOrData ) ) {
/**
* The element used as an editable. The data will be loaded from it and loaded back to
* it once the editor is destroyed.
*
* **Note:** The property is available only when such element has been passed
* to the {@link #constructor}.
*
* @readonly
* @member {HTMLElement}
*/
this.sourceElement = sourceElementOrData;
}

Expand All @@ -90,6 +80,8 @@ export default class DecoupledEditor extends Editor {
* @inheritDoc
*/
get element() {
// This editor has no single "main UI element". Its editable and toolbar are exposed separately and need
// to be added to the DOM manually by the consumer.
return null;
}

Expand Down Expand Up @@ -185,9 +177,15 @@ export default class DecoupledEditor extends Editor {
* console.error( err.stack );
* } );
*
* @param {HTMLElement|String} sourceElementOrData The DOM element that serves as an editable.
* The data will be loaded from it and loaded back to it once the editor is destroyed.
* Alternatively, a data string to be loaded into the editor.
* @param {HTMLElement|String} sourceElementOrData The DOM element that will be the source for the created editor
* (on which the editor will be initialized) or initial data for the editor.
*
* If a source element is passed, then its contents will be automatically
* {@link module:editor-decoupled/decouplededitor~DecoupledEditor#setData loaded} to the editor on startup and the element
* itself will be used as the editor's editable element.
*
* If data is provided, then `editor.ui.view.editable.element` will be created automatically and needs to be added
* to the DOM manually.
* @param {module:core/editor/editorconfig~EditorConfig} config The editor configuration.
* @returns {Promise} A promise resolved once the editor is ready.
* The promise returns the created {@link module:editor-decoupled/decouplededitor~DecoupledEditor} instance.
Expand Down
3 changes: 2 additions & 1 deletion src/decouplededitoruiview.js
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,8 @@ export default class DecoupledEditorUIView extends EditorUIView {
* Creates an instance of the decoupled editor UI view.
*
* @param {module:utils/locale~Locale} locale The {@link module:core/editor/editor~Editor#locale} instance.
* @param {HTMLElement} [editableElement] The DOM element to be used as editable.
* @param {HTMLElement} [editableElement] The editable element. If not specified, it will be automatically created by
* {@link module:ui/editableui/editableuiview~EditableUIView}. Otherwise, the given element will be used.
*/
constructor( locale, editableElement ) {
super( locale );
Expand Down

0 comments on commit d0da654

Please sign in to comment.