delete.js 6.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220
  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 Delete from '../src/delete';
  6. import Paragraph from '@ckeditor/ckeditor5-paragraph/src/paragraph';
  7. import DomEventData from '@ckeditor/ckeditor5-engine/src/view/observer/domeventdata';
  8. import ClassicTestEditor from '@ckeditor/ckeditor5-core/tests/_utils/classictesteditor';
  9. import env from '@ckeditor/ckeditor5-utils/src/env';
  10. import { getCode } from '@ckeditor/ckeditor5-utils/src/keyboard';
  11. /* globals window, document */
  12. describe( 'Delete feature', () => {
  13. let element, editor, viewDocument;
  14. beforeEach( () => {
  15. element = document.createElement( 'div' );
  16. document.body.appendChild( element );
  17. return ClassicTestEditor
  18. .create( element, { plugins: [ Delete ] } )
  19. .then( newEditor => {
  20. editor = newEditor;
  21. viewDocument = editor.editing.view.document;
  22. } );
  23. } );
  24. afterEach( () => {
  25. element.remove();
  26. return editor.destroy();
  27. } );
  28. it( 'creates two commands', () => {
  29. expect( editor.commands.get( 'delete' ) ).to.have.property( 'direction', 'backward' );
  30. expect( editor.commands.get( 'forwardDelete' ) ).to.have.property( 'direction', 'forward' );
  31. } );
  32. it( 'listens to the editing view document delete event', () => {
  33. const spy = editor.execute = sinon.spy();
  34. const viewDocument = editor.editing.view.document;
  35. const domEvt = getDomEvent();
  36. viewDocument.fire( 'delete', new DomEventData( viewDocument, domEvt, {
  37. direction: 'forward',
  38. unit: 'character',
  39. sequence: 1
  40. } ) );
  41. expect( spy.calledOnce ).to.be.true;
  42. expect( spy.calledWithMatch( 'forwardDelete', { unit: 'character', sequence: 1 } ) ).to.be.true;
  43. expect( domEvt.preventDefault.calledOnce ).to.be.true;
  44. viewDocument.fire( 'delete', new DomEventData( viewDocument, getDomEvent(), {
  45. direction: 'backward',
  46. unit: 'character',
  47. sequence: 5
  48. } ) );
  49. expect( spy.calledTwice ).to.be.true;
  50. expect( spy.calledWithMatch( 'delete', { unit: 'character', sequence: 5 } ) ).to.be.true;
  51. } );
  52. it( 'passes options.selection parameter to delete command if selection to remove was specified', () => {
  53. editor.setData( '<p>Foobar</p>' );
  54. const spy = editor.execute = sinon.spy();
  55. const view = editor.editing.view;
  56. const viewDocument = view.document;
  57. const domEvt = getDomEvent();
  58. const viewSelection = view.createSelection( view.createRangeIn( viewDocument.getRoot() ) );
  59. viewDocument.fire( 'delete', new DomEventData( viewDocument, domEvt, {
  60. direction: 'backward',
  61. unit: 'character',
  62. sequence: 1,
  63. selectionToRemove: viewSelection
  64. } ) );
  65. expect( spy.calledOnce ).to.be.true;
  66. const commandName = spy.args[ 0 ][ 0 ];
  67. const options = spy.args[ 0 ][ 1 ];
  68. const expectedSelection = editor.model.createSelection( editor.model.createRangeIn( editor.model.document.getRoot() ) );
  69. expect( commandName ).to.equal( 'delete' );
  70. expect( options.selection.isEqual( expectedSelection ) ).to.be.true;
  71. } );
  72. it( 'scrolls the editing document to the selection after executing the command', () => {
  73. const scrollSpy = sinon.stub( editor.editing.view, 'scrollToTheSelection' );
  74. const executeSpy = editor.execute = sinon.spy();
  75. viewDocument.fire( 'delete', new DomEventData( viewDocument, getDomEvent(), {
  76. direction: 'backward',
  77. unit: 'character'
  78. } ) );
  79. sinon.assert.calledOnce( scrollSpy );
  80. sinon.assert.callOrder( executeSpy, scrollSpy );
  81. } );
  82. function getDomEvent() {
  83. return {
  84. preventDefault: sinon.spy()
  85. };
  86. }
  87. } );
  88. describe( 'Delete feature - Android', () => {
  89. let element, editor, oldEnvIsAndroid;
  90. before( () => {
  91. oldEnvIsAndroid = env.isAndroid;
  92. env.isAndroid = true;
  93. } );
  94. beforeEach( () => {
  95. element = document.createElement( 'div' );
  96. document.body.appendChild( element );
  97. return ClassicTestEditor
  98. .create( element, { plugins: [ Delete, Paragraph ] } )
  99. .then( newEditor => {
  100. editor = newEditor;
  101. const modelRoot = editor.model.document.getRoot();
  102. editor.model.change( writer => {
  103. writer.insertElement( 'paragraph', modelRoot, 0 );
  104. writer.insertText( 'Foobar', modelRoot.getChild( 0 ), 0 );
  105. writer.setSelection( modelRoot.getChild( 0 ), 3 );
  106. } );
  107. } );
  108. } );
  109. afterEach( () => {
  110. element.remove();
  111. return editor.destroy();
  112. } );
  113. after( () => {
  114. env.isAndroid = oldEnvIsAndroid;
  115. } );
  116. it( 'should re-set selection on keyup event if it was changed after deletion but before the input was fired', () => {
  117. // This test covers a quirk on Android. We will recreate what browser does in this scenario.
  118. // The test is not perfect because there are difficulties converting model selection to DOM in unit tests.
  119. const view = editor.editing.view;
  120. const viewDocument = view.document;
  121. const domEvt = {
  122. preventDefault: sinon.spy()
  123. };
  124. const domRoot = view.getDomRoot();
  125. const domSelection = window.getSelection();
  126. const domText = domRoot.childNodes[ 0 ].childNodes[ 0 ];
  127. // Change the selection ("manual conversion").
  128. // Because it all works quite bad the selection will be moved to quite a random place after delete is fired but all we care is
  129. // checking if the selection is reversed on `keyup` event.
  130. domSelection.collapse( domText, 3 );
  131. // On `delete` the selection is saved.
  132. viewDocument.fire( 'delete', new DomEventData( viewDocument, domEvt, {
  133. direction: 'backward',
  134. unit: 'character',
  135. sequence: 1,
  136. domTarget: domRoot
  137. } ) );
  138. // Store what was the selection when it was saved in `delete`.
  139. const anchorNodeBefore = domSelection.anchorNode;
  140. const anchorOffsetBefore = domSelection.anchorOffset;
  141. const focusNodeBefore = domSelection.focusNode;
  142. const focusOffsetBefore = domSelection.focusOffset;
  143. // Change the selection.
  144. domSelection.collapse( domText, 0 );
  145. // On `keyup` it should be reversed.
  146. viewDocument.fire( 'keyup', new DomEventData( viewDocument, domEvt, {
  147. domTarget: domRoot
  148. } ) );
  149. expect( domSelection.anchorNode ).to.equal( anchorNodeBefore );
  150. expect( domSelection.anchorOffset ).to.equal( anchorOffsetBefore );
  151. expect( domSelection.focusNode ).to.equal( focusNodeBefore );
  152. expect( domSelection.focusOffset ).to.equal( focusOffsetBefore );
  153. } );
  154. it( 'should not crash on keyup event if it was not changed after typing', () => {
  155. // This test covers a quirk on Android. We will recreate what browser does in this scenario.
  156. const view = editor.editing.view;
  157. const viewDocument = view.document;
  158. const domEvt = {
  159. preventDefault: sinon.spy()
  160. };
  161. const domRoot = view.getDomRoot();
  162. const domEvent = {
  163. preventDefault: sinon.spy()
  164. };
  165. viewDocument.fire( 'input', domEvent );
  166. viewDocument.fire( 'keydown', new DomEventData( viewDocument, domEvent, { keyCode: getCode( 'A' ) } ) );
  167. expect( () => {
  168. viewDocument.fire( 'keyup', new DomEventData( viewDocument, domEvt, {
  169. domTarget: domRoot
  170. } ) );
  171. } ).not.to.throw();
  172. } );
  173. } );