Browse Source

Docs: Improved .create() method docs.

Piotrek Koszuliński 6 years ago
parent
commit
a992fc8ebc
1 changed files with 22 additions and 3 deletions
  1. 22 3
      packages/ckeditor5-editor-inline/src/inlineeditor.js

+ 22 - 3
packages/ckeditor5-editor-inline/src/inlineeditor.js

@@ -100,9 +100,11 @@ export default class InlineEditor extends Editor {
 	}
 
 	/**
-	 * Creates an `InlineEditor` instance.
+	 * Creates a new inline editor instance.
 	 *
-	 * There are two general ways how the editor can be initialized.
+	 * There are three general ways how the editor can be initialized.
+	 *
+	 * # Using an existing DOM element (and loading data from it)
 	 *
 	 * You can initialize the editor using an existing DOM element:
 	 *
@@ -117,6 +119,8 @@ export default class InlineEditor extends Editor {
 	 *
 	 * The element's content will be used as the editor data and the element will become the editable element.
 	 *
+	 * # Creating a detached editor
+	 *
 	 * Alternatively, you can initialize the editor by passing the initial data directly as a `String`.
 	 * In this case, the editor will render an element that must be inserted into the DOM for the editor to work properly:
 	 *
@@ -135,6 +139,8 @@ export default class InlineEditor extends Editor {
 	 * This lets you dynamically append the editor to your web page whenever it is convenient for you. You may use this method if your
 	 * web page content is generated on the client-side and the DOM structure is not ready at the moment when you initialize the editor.
 	 *
+	 * # Using an existing DOM element (and data provided in `config.initialData`)
+	 *
 	 * You can also mix those two ways by providing a DOM element to be used and passing the initial data through the config:
 	 *
 	 *		InlineEditor
@@ -153,9 +159,22 @@ export default class InlineEditor extends Editor {
 	 *
 	 * Note that an error will be thrown if you pass initial data both as the first parameter and also in the config.
 	 *
-	 * See also the {@link module:core/editor/editorconfig~EditorConfig editor configuration documentation} to learn more about
+	 * # Configuring the editor
+	 *
+	 * See the {@link module:core/editor/editorconfig~EditorConfig editor configuration documentation} to learn more about
 	 * customizing plugins, toolbar and other.
 	 *
+	 * # Using the editor from source
+	 *
+	 * The code samples listed in the previous sections of this documentation assume that you are using an
+	 * {@glink builds/guides/overview editor build} (for example – `@ckeditor/ckeditor5-build-inline`).
+	 *
+	 * If you want to use the inline editor from source (`@ckeditor/ckeditor5-editor-inline/src/inlineeditor`),
+	 * then you need to define the list of
+	 * {@link module:core/editor/editorconfig~EditorConfig#plugins plugins to be initialized} and
+	 * {@link module:core/editor/editorconfig~EditorConfig#toolbar toolbar items}. Read more about using the editor from
+	 * source in the {@glink builds/guides/integration/advanced-setup "Advanced setup" guide}.
+	 *
 	 * @param {HTMLElement|String} sourceElementOrData The DOM element that will be the source for the created editor
 	 * or the editor's initial data.
 	 *