injectunsafekeystrokeshandling.js 6.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128
  1. /**
  2. * @license Copyright (c) 2003-2020, CKSource - Frederico Knabben. All rights reserved.
  3. * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
  4. */
  5. import ModelTestEditor from '@ckeditor/ckeditor5-core/tests/_utils/modeltesteditor';
  6. import DomEventData from '@ckeditor/ckeditor5-engine/src/view/observer/domeventdata';
  7. import { getData, setData } from '@ckeditor/ckeditor5-engine/src/dev-utils/model';
  8. import { keyCodes, getCode } from '@ckeditor/ckeditor5-utils/src/keyboard';
  9. import { isNonTypingKeystroke } from '../../src/utils/injectunsafekeystrokeshandling';
  10. import Typing from '../../src/typing';
  11. describe( 'unsafe keystroke handling utils', () => {
  12. describe( 'isNonTypingKeystroke()', () => {
  13. it( 'should return "true" for any keystroke with the Ctrl key', () => {
  14. expect( isNonTypingKeystroke( { keyCode: keyCodes.a, ctrlKey: true } ), 'Ctrl+a' ).to.be.true;
  15. expect( isNonTypingKeystroke( { keyCode: keyCodes[ 0 ], ctrlKey: true } ), 'Ctrl+0' ).to.be.true;
  16. } );
  17. it( 'should return "true" for all arrow keys', () => {
  18. expect( isNonTypingKeystroke( { keyCode: keyCodes.arrowup } ), 'arrow up' ).to.be.true;
  19. expect( isNonTypingKeystroke( { keyCode: keyCodes.arrowdown } ), 'arrow down' ).to.be.true;
  20. expect( isNonTypingKeystroke( { keyCode: keyCodes.arrowleft } ), 'arrow left' ).to.be.true;
  21. expect( isNonTypingKeystroke( { keyCode: keyCodes.arrowright } ), 'arrow right' ).to.be.true;
  22. } );
  23. it( 'should return "true" for function (Fn) keystrokes', () => {
  24. expect( isNonTypingKeystroke( { keyCode: keyCodes.f1 } ), 'F1' ).to.be.true;
  25. expect( isNonTypingKeystroke( { keyCode: keyCodes.f2 } ), 'F2' ).to.be.true;
  26. expect( isNonTypingKeystroke( { keyCode: keyCodes.f3 } ), 'F3' ).to.be.true;
  27. expect( isNonTypingKeystroke( { keyCode: keyCodes.f4 } ), 'F4' ).to.be.true;
  28. expect( isNonTypingKeystroke( { keyCode: keyCodes.f5 } ), 'F5' ).to.be.true;
  29. expect( isNonTypingKeystroke( { keyCode: keyCodes.f6 } ), 'F6' ).to.be.true;
  30. expect( isNonTypingKeystroke( { keyCode: keyCodes.f7 } ), 'F7' ).to.be.true;
  31. expect( isNonTypingKeystroke( { keyCode: keyCodes.f8 } ), 'F8' ).to.be.true;
  32. expect( isNonTypingKeystroke( { keyCode: keyCodes.f9 } ), 'F9' ).to.be.true;
  33. expect( isNonTypingKeystroke( { keyCode: keyCodes.f10 } ), 'F10' ).to.be.true;
  34. expect( isNonTypingKeystroke( { keyCode: keyCodes.f11 } ), 'F11' ).to.be.true;
  35. expect( isNonTypingKeystroke( { keyCode: keyCodes.f12 } ), 'F12' ).to.be.true;
  36. expect( isNonTypingKeystroke( { keyCode: 124 } ), 'F13' ).to.be.true;
  37. expect( isNonTypingKeystroke( { keyCode: 125 } ), 'F14' ).to.be.true;
  38. expect( isNonTypingKeystroke( { keyCode: 126 } ), 'F15' ).to.be.true;
  39. expect( isNonTypingKeystroke( { keyCode: 127 } ), 'F16' ).to.be.true;
  40. expect( isNonTypingKeystroke( { keyCode: 128 } ), 'F17' ).to.be.true;
  41. expect( isNonTypingKeystroke( { keyCode: 129 } ), 'F18' ).to.be.true;
  42. expect( isNonTypingKeystroke( { keyCode: 130 } ), 'F19' ).to.be.true;
  43. expect( isNonTypingKeystroke( { keyCode: 131 } ), 'F20' ).to.be.true;
  44. expect( isNonTypingKeystroke( { keyCode: 132 } ), 'F21' ).to.be.true;
  45. expect( isNonTypingKeystroke( { keyCode: 133 } ), 'F22' ).to.be.true;
  46. expect( isNonTypingKeystroke( { keyCode: 134 } ), 'F23' ).to.be.true;
  47. expect( isNonTypingKeystroke( { keyCode: 135 } ), 'F24' ).to.be.true;
  48. } );
  49. it( 'should return "true" for other safe keystrokes', () => {
  50. expect( isNonTypingKeystroke( { keyCode: keyCodes.tab } ), 'Tab' ).to.be.true;
  51. expect( isNonTypingKeystroke( { keyCode: 16 } ), 'Shift' ).to.be.true;
  52. expect( isNonTypingKeystroke( { keyCode: 17 } ), 'Ctrl' ).to.be.true;
  53. expect( isNonTypingKeystroke( { keyCode: 18 } ), 'Alt' ).to.be.true;
  54. expect( isNonTypingKeystroke( { keyCode: 19 } ), 'Pause' ).to.be.true;
  55. expect( isNonTypingKeystroke( { keyCode: 20 } ), 'CapsLock' ).to.be.true;
  56. expect( isNonTypingKeystroke( { keyCode: keyCodes.esc } ), 'Escape' ).to.be.true;
  57. expect( isNonTypingKeystroke( { keyCode: 33 } ), 'PageUp' ).to.be.true;
  58. expect( isNonTypingKeystroke( { keyCode: 34 } ), 'PageDown' ).to.be.true;
  59. expect( isNonTypingKeystroke( { keyCode: 35 } ), 'Home' ).to.be.true;
  60. expect( isNonTypingKeystroke( { keyCode: 36 } ), 'End' ).to.be.true;
  61. expect( isNonTypingKeystroke( { keyCode: 45 } ), 'Insert' ).to.be.true;
  62. expect( isNonTypingKeystroke( { keyCode: 91 } ), 'Windows' ).to.be.true;
  63. expect( isNonTypingKeystroke( { keyCode: 93 } ), 'Menu key' ).to.be.true;
  64. expect( isNonTypingKeystroke( { keyCode: 144 } ), 'NumLock' ).to.be.true;
  65. expect( isNonTypingKeystroke( { keyCode: 145 } ), 'ScrollLock' ).to.be.true;
  66. expect( isNonTypingKeystroke( { keyCode: 173 } ), 'Mute/Unmute' ).to.be.true;
  67. expect( isNonTypingKeystroke( { keyCode: 174 } ), 'Volume up' ).to.be.true;
  68. expect( isNonTypingKeystroke( { keyCode: 175 } ), 'Volume down' ).to.be.true;
  69. expect( isNonTypingKeystroke( { keyCode: 176 } ), 'Next song' ).to.be.true;
  70. expect( isNonTypingKeystroke( { keyCode: 177 } ), 'Previous song' ).to.be.true;
  71. expect( isNonTypingKeystroke( { keyCode: 178 } ), 'Stop' ).to.be.true;
  72. expect( isNonTypingKeystroke( { keyCode: 179 } ), 'Play/Pause' ).to.be.true;
  73. expect( isNonTypingKeystroke( { keyCode: 255 } ), 'Display brightness (increase and decrease)' ).to.be.true;
  74. } );
  75. it( 'should return "false" for the keystrokes that result in typing', () => {
  76. expect( isNonTypingKeystroke( { keyCode: keyCodes.a } ), 'a' ).to.be.false;
  77. expect( isNonTypingKeystroke( { keyCode: keyCodes[ 0 ] } ), '0' ).to.be.false;
  78. expect( isNonTypingKeystroke( { keyCode: keyCodes.a, altKey: true } ), 'Alt+a' ).to.be.false;
  79. } );
  80. } );
  81. describe( 'injectUnsafeKeystrokesHandling()', () => {
  82. let editor, model;
  83. beforeEach( () => {
  84. return ModelTestEditor.create( { plugins: [ Typing ] } )
  85. .then( newEditor => {
  86. editor = newEditor;
  87. model = editor.model;
  88. model.schema.register( 'paragraph', { inheritAllFrom: '$block' } );
  89. } );
  90. } );
  91. afterEach( () => {
  92. return editor.destroy();
  93. } );
  94. it( 'uses typing batch while removing the content', () => {
  95. const inputCommand = editor.commands.get( 'input' );
  96. expect( inputCommand._batches.has( getCurrentBatch() ), 'batch before typing' ).to.equal( false );
  97. model.on( 'deleteContent', () => {
  98. expect( inputCommand._batches.has( getCurrentBatch() ), 'batch when deleting content' ).to.equal( true );
  99. }, { priority: 'highest' } );
  100. setData( model, '<paragraph>[foo]</paragraph>' );
  101. editor.editing.view.document.fire( 'keydown', new DomEventData( editor.editing.view.document, {
  102. preventDefault: () => {},
  103. keyCode: getCode( 'A' )
  104. } ) );
  105. expect( getData( model ) ).to.equal( '<paragraph>[]</paragraph>' );
  106. function getCurrentBatch() {
  107. return editor.model.change( writer => writer.batch );
  108. }
  109. } );
  110. } );
  111. } );