delete.js 6.1 KB

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