8
0
Просмотр исходного кода

Docs and comment improvements.

Piotrek Koszuliński 7 лет назад
Родитель
Сommit
a12791ab7b

+ 2 - 3
packages/ckeditor5-enter/README.md

@@ -1,4 +1,4 @@
-CKEditor 5 Enter feature
+CKEditor 5 enter feature
 ========================================
 
 [![Join the chat at https://gitter.im/ckeditor/ckeditor5](https://badges.gitter.im/ckeditor/ckeditor5.svg)](https://gitter.im/ckeditor/ckeditor5?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
@@ -10,8 +10,7 @@ CKEditor 5 Enter feature
 [![Dependency Status](https://david-dm.org/ckeditor/ckeditor5-enter/status.svg)](https://david-dm.org/ckeditor/ckeditor5-enter)
 [![devDependency Status](https://david-dm.org/ckeditor/ckeditor5-enter/dev-status.svg)](https://david-dm.org/ckeditor/ckeditor5-enter?type=dev)
 
-This package implements the <kbd>Enter</kbd> key support -- and optionally <kbd>Shift+Enter</kbd> soft breaks -- for CKEditor 5.
-
+This package implements the <kbd>Enter</kbd> and <kbd>Shift</kbd>+<kbd>Enter</kbd> (soft break) support for CKEditor 5.
 
 ## Documentation
 

+ 2 - 3
packages/ckeditor5-enter/src/enter.js

@@ -12,7 +12,7 @@ import EnterCommand from './entercommand';
 import EnterObserver from './enterobserver';
 
 /**
- * The Enter feature. Handles the <kbd>Enter</kbd> key in the editor.
+ * The enter plugin. Handles the <kbd>Enter</kbd> key (hard line break) in the editor.
  *
  * @extends module:core/plugin~Plugin
  */
@@ -33,9 +33,8 @@ export default class Enter extends Plugin {
 
 		editor.commands.add( 'enter', new EnterCommand( editor ) );
 
-		// TODO We may use the keystroke handler for that.
 		this.listenTo( viewDocument, 'enter', ( evt, data ) => {
-			// The 'Enter + Shift' keys are handled by the ShiftEnter plugin.
+			// The soft enter key is handled by the ShiftEnter plugin.
 			if ( data.isSoft ) {
 				return;
 			}

+ 5 - 4
packages/ckeditor5-enter/src/enterobserver.js

@@ -20,15 +20,15 @@ export default class EnterObserver extends Observer {
 	constructor( view ) {
 		super( view );
 
-		const document = this.document;
+		const doc = this.document;
 
-		document.on( 'keydown', ( evt, data ) => {
+		doc.on( 'keydown', ( evt, data ) => {
 			if ( this.isEnabled && data.keyCode == keyCodes.enter ) {
 				// Save the event object to check later if it was stopped or not.
 				let event;
-				document.once( 'enter', evt => ( event = evt ), { priority: 'highest' } );
+				doc.once( 'enter', evt => ( event = evt ), { priority: 'highest' } );
 
-				document.fire( 'enter', new DomEventData( document, data.domEvent, {
+				doc.fire( 'enter', new DomEventData( doc, data.domEvent, {
 					isSoft: data.shiftKey
 				} ) );
 
@@ -56,4 +56,5 @@ export default class EnterObserver extends Observer {
  *
  * @event module:engine/view/document~Document#event:enter
  * @param {module:engine/view/observer/domeventdata~DomEventData} data
+ * @param {Boolean} data.isSoft Whether it's a soft enter (<kbd>Shift</kbd>+<kbd>Enter</kbd>) or hard enter (<kbd>Enter</kbd>).
  */

+ 3 - 4
packages/ckeditor5-enter/src/shiftenter.js

@@ -14,7 +14,7 @@ import { upcastElementToElement } from '@ckeditor/ckeditor5-engine/src/conversio
 import { downcastElementToElement } from '@ckeditor/ckeditor5-engine/src/conversion/downcast-converters';
 
 /**
- * The ShiftEnter feature. Handles the <kbd>Shift + Enter</kbd> keys in the editor.
+ * The Shift+Enter plugin. Handles the <kbd>Shift</kbd>+<kbd>Enter</kbd> keys (soft line break) in the editor.
  *
  * @extends module:core/plugin~Plugin
  */
@@ -33,7 +33,7 @@ export default class ShiftEnter extends Plugin {
 		const view = editor.editing.view;
 		const viewDocument = view.document;
 
-		// Configure schema.
+		// Configure the schema.
 		schema.register( 'break', {
 			allowWhere: '$text'
 		} );
@@ -55,9 +55,8 @@ export default class ShiftEnter extends Plugin {
 
 		editor.commands.add( 'shiftEnter', new ShiftEnterCommand( editor ) );
 
-		// TODO We may use the keystroke handler for that.
 		this.listenTo( viewDocument, 'enter', ( evt, data ) => {
-			// The 'Enter' key is handled by the Enter plugin.
+			// The hard enter key is handled by the Enter plugin.
 			if ( !data.isSoft ) {
 				return;
 			}