8
0
فهرست منبع

Renamed isSafeKeystroke() to isNonTypingKeystroke(). Added docs for the helper.

Aleksander Nowodzinski 5 سال پیش
والد
کامیت
18f68f0b50

+ 8 - 3
packages/ckeditor5-typing/src/utils/injectunsafekeystrokeshandling.js

@@ -65,7 +65,7 @@ export default function injectUnsafeKeystrokesHandling( editor ) {
 			return;
 		}
 
-		if ( isSafeKeystroke( evtData ) || doc.selection.isCollapsed ) {
+		if ( isNonTypingKeystroke( evtData ) || doc.selection.isCollapsed ) {
 			return;
 		}
 
@@ -155,14 +155,19 @@ for ( let code = 112; code <= 135; code++ ) {
 }
 
 /**
- * Returns `true` if a keystroke will not result in "typing".
+ * Returns `true` if a keystroke will **not** result in "typing".
+ *
+ * For instance, keystrokes that result in typing are letters "a-zA-Z", numbers "0-9", delete, backspace, etc.
+ *
+ * Keystrokes that do not cause typing are, for instance, Fn keys (F5, F8, etc.), arrow keys (←, →, ↑, ↓),
+ * Tab (↹), "Windows logo key" (⊞ Win), etc.
  *
  * Note: This implementation is very simple and will need to be refined with time.
  *
  * @param {module:engine/view/observer/keyobserver~KeyEventData} keyData
  * @returns {Boolean}
  */
-export function isSafeKeystroke( keyData ) {
+export function isNonTypingKeystroke( keyData ) {
 	// Keystrokes which contain Ctrl don't represent typing.
 	if ( keyData.ctrlKey ) {
 		return true;

+ 59 - 59
packages/ckeditor5-typing/tests/utils/injectunsafekeystrokeshandling.js

@@ -6,80 +6,80 @@
 import {
 	keyCodes
 } from '@ckeditor/ckeditor5-utils/src/keyboard';
-import { isSafeKeystroke } from '../../src/utils/injectunsafekeystrokeshandling';
+import { isNonTypingKeystroke } from '../../src/utils/injectunsafekeystrokeshandling';
 
 describe( 'unsafe keystroke handling utils', () => {
-	describe( 'isSafeKeystroke()', () => {
+	describe( 'isNonTypingKeystroke()', () => {
 		it( 'should return "true" for any keystroke with the Ctrl key', () => {
-			expect( isSafeKeystroke( { keyCode: keyCodes.a, ctrlKey: true } ), 'Ctrl+a' ).to.be.true;
-			expect( isSafeKeystroke( { keyCode: keyCodes[ 0 ], ctrlKey: true } ), 'Ctrl+0' ).to.be.true;
+			expect( isNonTypingKeystroke( { keyCode: keyCodes.a, ctrlKey: true } ), 'Ctrl+a' ).to.be.true;
+			expect( isNonTypingKeystroke( { keyCode: keyCodes[ 0 ], ctrlKey: true } ), 'Ctrk+0' ).to.be.true;
 		} );
 
 		it( 'should return "true" for all arrow keys', () => {
-			expect( isSafeKeystroke( { keyCode: keyCodes.arrowup } ), 'arrow up' ).to.be.true;
-			expect( isSafeKeystroke( { keyCode: keyCodes.arrowdown } ), 'arrow down' ).to.be.true;
-			expect( isSafeKeystroke( { keyCode: keyCodes.arrowleft } ), 'arrow left' ).to.be.true;
-			expect( isSafeKeystroke( { keyCode: keyCodes.arrowright } ), 'arrow right' ).to.be.true;
+			expect( isNonTypingKeystroke( { keyCode: keyCodes.arrowup } ), 'arrow up' ).to.be.true;
+			expect( isNonTypingKeystroke( { keyCode: keyCodes.arrowdown } ), 'arrow down' ).to.be.true;
+			expect( isNonTypingKeystroke( { keyCode: keyCodes.arrowleft } ), 'arrow left' ).to.be.true;
+			expect( isNonTypingKeystroke( { keyCode: keyCodes.arrowright } ), 'arrow right' ).to.be.true;
 		} );
 
 		it( 'should return "true" for function (Fn) keystrokes', () => {
-			expect( isSafeKeystroke( { keyCode: 112 } ), 'F1' ).to.be.true;
-			expect( isSafeKeystroke( { keyCode: 113 } ), 'F2' ).to.be.true;
-			expect( isSafeKeystroke( { keyCode: 114 } ), 'F3' ).to.be.true;
-			expect( isSafeKeystroke( { keyCode: 115 } ), 'F4' ).to.be.true;
-			expect( isSafeKeystroke( { keyCode: 116 } ), 'F5' ).to.be.true;
-			expect( isSafeKeystroke( { keyCode: 117 } ), 'F6' ).to.be.true;
-			expect( isSafeKeystroke( { keyCode: 118 } ), 'F7' ).to.be.true;
-			expect( isSafeKeystroke( { keyCode: 119 } ), 'F8' ).to.be.true;
-			expect( isSafeKeystroke( { keyCode: 120 } ), 'F9' ).to.be.true;
-			expect( isSafeKeystroke( { keyCode: 121 } ), 'F10' ).to.be.true;
-			expect( isSafeKeystroke( { keyCode: 122 } ), 'F11' ).to.be.true;
-			expect( isSafeKeystroke( { keyCode: 123 } ), 'F12' ).to.be.true;
-			expect( isSafeKeystroke( { keyCode: 124 } ), 'F13' ).to.be.true;
-			expect( isSafeKeystroke( { keyCode: 125 } ), 'F14' ).to.be.true;
-			expect( isSafeKeystroke( { keyCode: 126 } ), 'F15' ).to.be.true;
-			expect( isSafeKeystroke( { keyCode: 127 } ), 'F16' ).to.be.true;
-			expect( isSafeKeystroke( { keyCode: 128 } ), 'F17' ).to.be.true;
-			expect( isSafeKeystroke( { keyCode: 129 } ), 'F18' ).to.be.true;
-			expect( isSafeKeystroke( { keyCode: 130 } ), 'F19' ).to.be.true;
-			expect( isSafeKeystroke( { keyCode: 131 } ), 'F20' ).to.be.true;
-			expect( isSafeKeystroke( { keyCode: 132 } ), 'F21' ).to.be.true;
-			expect( isSafeKeystroke( { keyCode: 133 } ), 'F22' ).to.be.true;
-			expect( isSafeKeystroke( { keyCode: 134 } ), 'F23' ).to.be.true;
-			expect( isSafeKeystroke( { keyCode: 135 } ), 'F24' ).to.be.true;
+			expect( isNonTypingKeystroke( { keyCode: 112 } ), 'F1' ).to.be.true;
+			expect( isNonTypingKeystroke( { keyCode: 113 } ), 'F2' ).to.be.true;
+			expect( isNonTypingKeystroke( { keyCode: 114 } ), 'F3' ).to.be.true;
+			expect( isNonTypingKeystroke( { keyCode: 115 } ), 'F4' ).to.be.true;
+			expect( isNonTypingKeystroke( { keyCode: 116 } ), 'F5' ).to.be.true;
+			expect( isNonTypingKeystroke( { keyCode: 117 } ), 'F6' ).to.be.true;
+			expect( isNonTypingKeystroke( { keyCode: 118 } ), 'F7' ).to.be.true;
+			expect( isNonTypingKeystroke( { keyCode: 119 } ), 'F8' ).to.be.true;
+			expect( isNonTypingKeystroke( { keyCode: 120 } ), 'F9' ).to.be.true;
+			expect( isNonTypingKeystroke( { keyCode: 121 } ), 'F10' ).to.be.true;
+			expect( isNonTypingKeystroke( { keyCode: 122 } ), 'F11' ).to.be.true;
+			expect( isNonTypingKeystroke( { keyCode: 123 } ), 'F12' ).to.be.true;
+			expect( isNonTypingKeystroke( { keyCode: 124 } ), 'F13' ).to.be.true;
+			expect( isNonTypingKeystroke( { keyCode: 125 } ), 'F14' ).to.be.true;
+			expect( isNonTypingKeystroke( { keyCode: 126 } ), 'F15' ).to.be.true;
+			expect( isNonTypingKeystroke( { keyCode: 127 } ), 'F16' ).to.be.true;
+			expect( isNonTypingKeystroke( { keyCode: 128 } ), 'F17' ).to.be.true;
+			expect( isNonTypingKeystroke( { keyCode: 129 } ), 'F18' ).to.be.true;
+			expect( isNonTypingKeystroke( { keyCode: 130 } ), 'F19' ).to.be.true;
+			expect( isNonTypingKeystroke( { keyCode: 131 } ), 'F20' ).to.be.true;
+			expect( isNonTypingKeystroke( { keyCode: 132 } ), 'F21' ).to.be.true;
+			expect( isNonTypingKeystroke( { keyCode: 133 } ), 'F22' ).to.be.true;
+			expect( isNonTypingKeystroke( { keyCode: 134 } ), 'F23' ).to.be.true;
+			expect( isNonTypingKeystroke( { keyCode: 135 } ), 'F24' ).to.be.true;
 		} );
 
 		it( 'should return "true" for other safe keystrokes', () => {
-			expect( isSafeKeystroke( { keyCode: 9 } ), 'Tab' ).to.be.true;
-			expect( isSafeKeystroke( { keyCode: 16 } ), 'Shift' ).to.be.true;
-			expect( isSafeKeystroke( { keyCode: 17 } ), 'Ctrl' ).to.be.true;
-			expect( isSafeKeystroke( { keyCode: 18 } ), 'Alt' ).to.be.true;
-			expect( isSafeKeystroke( { keyCode: 19 } ), 'Pause' ).to.be.true;
-			expect( isSafeKeystroke( { keyCode: 20 } ), 'CapsLock' ).to.be.true;
-			expect( isSafeKeystroke( { keyCode: 27 } ), 'Escape' ).to.be.true;
-			expect( isSafeKeystroke( { keyCode: 33 } ), 'PageUp' ).to.be.true;
-			expect( isSafeKeystroke( { keyCode: 34 } ), 'PageDown' ).to.be.true;
-			expect( isSafeKeystroke( { keyCode: 35 } ), 'Home' ).to.be.true;
-			expect( isSafeKeystroke( { keyCode: 36 } ), 'End,' ).to.be.true;
-			expect( isSafeKeystroke( { keyCode: 45 } ), 'Insert' ).to.be.true;
-			expect( isSafeKeystroke( { keyCode: 91 } ), 'Windows' ).to.be.true;
-			expect( isSafeKeystroke( { keyCode: 93 } ), 'Menu key' ).to.be.true;
-			expect( isSafeKeystroke( { keyCode: 144 } ), 'NumLock' ).to.be.true;
-			expect( isSafeKeystroke( { keyCode: 145 } ), 'ScrollLock' ).to.be.true;
-			expect( isSafeKeystroke( { keyCode: 173 } ), 'Mute/Unmute' ).to.be.true;
-			expect( isSafeKeystroke( { keyCode: 174 } ), 'Volume up' ).to.be.true;
-			expect( isSafeKeystroke( { keyCode: 175 } ), 'Volume down' ).to.be.true;
-			expect( isSafeKeystroke( { keyCode: 176 } ), 'Next song' ).to.be.true;
-			expect( isSafeKeystroke( { keyCode: 177 } ), 'Previous song' ).to.be.true;
-			expect( isSafeKeystroke( { keyCode: 178 } ), 'Stop' ).to.be.true;
-			expect( isSafeKeystroke( { keyCode: 179 } ), 'Play/Pause' ).to.be.true;
-			expect( isSafeKeystroke( { keyCode: 255 } ), 'Display brightness (increase and decrease)' ).to.be.true;
+			expect( isNonTypingKeystroke( { keyCode: 9 } ), 'Tab' ).to.be.true;
+			expect( isNonTypingKeystroke( { keyCode: 16 } ), 'Shift' ).to.be.true;
+			expect( isNonTypingKeystroke( { keyCode: 17 } ), 'Ctrl' ).to.be.true;
+			expect( isNonTypingKeystroke( { keyCode: 18 } ), 'Alt' ).to.be.true;
+			expect( isNonTypingKeystroke( { keyCode: 19 } ), 'Pause' ).to.be.true;
+			expect( isNonTypingKeystroke( { keyCode: 20 } ), 'CapsLock' ).to.be.true;
+			expect( isNonTypingKeystroke( { keyCode: 27 } ), 'Escape' ).to.be.true;
+			expect( isNonTypingKeystroke( { keyCode: 33 } ), 'PageUp' ).to.be.true;
+			expect( isNonTypingKeystroke( { keyCode: 34 } ), 'PageDown' ).to.be.true;
+			expect( isNonTypingKeystroke( { keyCode: 35 } ), 'Home' ).to.be.true;
+			expect( isNonTypingKeystroke( { keyCode: 36 } ), 'End,' ).to.be.true;
+			expect( isNonTypingKeystroke( { keyCode: 45 } ), 'Insert' ).to.be.true;
+			expect( isNonTypingKeystroke( { keyCode: 91 } ), 'Windows' ).to.be.true;
+			expect( isNonTypingKeystroke( { keyCode: 93 } ), 'Menu key' ).to.be.true;
+			expect( isNonTypingKeystroke( { keyCode: 144 } ), 'NumLock' ).to.be.true;
+			expect( isNonTypingKeystroke( { keyCode: 145 } ), 'ScrollLock' ).to.be.true;
+			expect( isNonTypingKeystroke( { keyCode: 173 } ), 'Mute/Unmute' ).to.be.true;
+			expect( isNonTypingKeystroke( { keyCode: 174 } ), 'Volume up' ).to.be.true;
+			expect( isNonTypingKeystroke( { keyCode: 175 } ), 'Volume down' ).to.be.true;
+			expect( isNonTypingKeystroke( { keyCode: 176 } ), 'Next song' ).to.be.true;
+			expect( isNonTypingKeystroke( { keyCode: 177 } ), 'Previous song' ).to.be.true;
+			expect( isNonTypingKeystroke( { keyCode: 178 } ), 'Stop' ).to.be.true;
+			expect( isNonTypingKeystroke( { keyCode: 179 } ), 'Play/Pause' ).to.be.true;
+			expect( isNonTypingKeystroke( { keyCode: 255 } ), 'Display brightness (increase and decrease)' ).to.be.true;
 		} );
 
 		it( 'should return "false" for the keystrokes that result in typing', () => {
-			expect( isSafeKeystroke( { keyCode: keyCodes.a } ), 'a' ).to.be.false;
-			expect( isSafeKeystroke( { keyCode: keyCodes[ 0 ] } ), '0' ).to.be.false;
-			expect( isSafeKeystroke( { keyCode: keyCodes.a, altKey: true } ), 'Alt+a' ).to.be.false;
+			expect( isNonTypingKeystroke( { keyCode: keyCodes.a } ), 'a' ).to.be.false;
+			expect( isNonTypingKeystroke( { keyCode: keyCodes[ 0 ] } ), '0' ).to.be.false;
+			expect( isNonTypingKeystroke( { keyCode: keyCodes.a, altKey: true } ), 'Alt+a' ).to.be.false;
 		} );
 	} );
 } );

+ 2 - 2
packages/ckeditor5-widget/src/widgettypearound/widgettypearound.js

@@ -27,7 +27,7 @@ import {
 } from './utils';
 
 import {
-	isSafeKeystroke
+	isNonTypingKeystroke
 } from '@ckeditor/ckeditor5-typing/src/utils/injectunsafekeystrokeshandling';
 
 import returnIcon from '../../theme/icons/return-arrow.svg';
@@ -484,7 +484,7 @@ export default class WidgetTypeAround extends Plugin {
 		// Note: The priority must precede the default Widget class keydown handler.
 		editingView.document.on( 'keydown', ( evt, domEventData ) => {
 			// Don't handle enter/backspace/delete here. They are handled in dedicated listeners.
-			if ( !keyCodesHandledSomewhereElse.includes( domEventData.keyCode ) && !isSafeKeystroke( domEventData ) ) {
+			if ( !keyCodesHandledSomewhereElse.includes( domEventData.keyCode ) && !isNonTypingKeystroke( domEventData ) ) {
 				this._insertParagraphAccordingToSelectionAttribute();
 			}
 		}, { priority: priorities.get( 'high' ) + 1 } );