Browse Source

Docs: Added the direction option to the Model#deleteContent() docs.

Aleksander Nowodzinski 5 years ago
parent
commit
122dc6da31
1 changed files with 4 additions and 0 deletions
  1. 4 0
      packages/ckeditor5-engine/src/model/model.js

+ 4 - 0
packages/ckeditor5-engine/src/model/model.js

@@ -438,6 +438,10 @@ export default class Model {
 	 * **Note:** if there is no valid position for the selection, the paragraph will always be created:
 	 *
 	 * `[<image src="foo.jpg"></image>]` -> `<paragraph>[]</paragraph>`.
+	 *
+	 * @param {'forward'|'backward'} [options.direction='backward'] The direction in which the content is being consumed.
+	 * Deleting backward corresponds to using the <kbd>Delete</kbd> key, while deleting content forward corresponds to
+	 * the <kbd>Shift</kbd>+<kbd>Delete</kbd> keystroke.
 	 */
 	deleteContent( selection, options ) {
 		deleteContent( this, selection, options );