Bladeren bron

Update input and text watcher documentation.

Maciej Gołaszewski 6 jaren geleden
bovenliggende
commit
d1320f1ccc
2 gewijzigde bestanden met toevoegingen van 9 en 1 verwijderingen
  1. 8 0
      packages/ckeditor5-typing/src/input.js
  2. 1 1
      packages/ckeditor5-typing/src/textwatcher.js

+ 8 - 0
packages/ckeditor5-typing/src/input.js

@@ -44,6 +44,14 @@ export default class Input extends Plugin {
 	/**
 	 * Checks batch if it is a result of user input - e.g. typing.
 	 *
+	 *		const input = editor.plugins.get( 'Input' );
+	 *
+	 *		editor.model.document.on( 'change:data', ( evt, batch ) => {
+	 *			if ( input.isTyping( batch) ) {
+	 *				console.log( 'The user typed something...' );
+	 *			}
+	 *		} );
+	 *
 	 * **Note:** This method checks if the batch was created using {@link module:typing/inputcommand~InputCommand 'input'}
 	 * command as typing changes coming from user input are inserted to the document using that command.
 	 *

+ 1 - 1
packages/ckeditor5-typing/src/textwatcher.js

@@ -106,7 +106,7 @@ export default class TextWatcher {
 			 * @event matched:data
 			 * @param {Object} data Event data.
 			 * @param {String} data.text The full text before selection.
-			 * @param {Boolean} data.isTyping Set to true for user typing changes.
+			 * @param {module:engine/model/batch~Batch} data.batch A batch associated with a change.
 			 */
 			/**
 			 * Fired whenever the text watcher found a match for selection changes.