8
0

deleteobserver.js 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408
  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. /* globals window, document */
  6. import DeleteObserver from '../src/deleteobserver';
  7. import View from '@ckeditor/ckeditor5-engine/src/view/view';
  8. import DomEventData from '@ckeditor/ckeditor5-engine/src/view/observer/domeventdata';
  9. import createViewRoot from '@ckeditor/ckeditor5-engine/tests/view/_utils/createroot';
  10. import { getCode } from '@ckeditor/ckeditor5-utils/src/keyboard';
  11. import env from '@ckeditor/ckeditor5-utils/src/env';
  12. import testUtils from '@ckeditor/ckeditor5-core/tests/_utils/utils';
  13. describe( 'DeleteObserver', () => {
  14. let view, viewDocument;
  15. testUtils.createSinonSandbox();
  16. beforeEach( () => {
  17. view = new View();
  18. viewDocument = view.document;
  19. view.addObserver( DeleteObserver );
  20. } );
  21. afterEach( () => {
  22. view.destroy();
  23. } );
  24. // See ckeditor/ckeditor5-enter#10.
  25. it( 'can be initialized', () => {
  26. expect( () => {
  27. createViewRoot( viewDocument );
  28. view.attachDomRoot( document.createElement( 'div' ) );
  29. } ).to.not.throw();
  30. } );
  31. describe( 'delete event', () => {
  32. it( 'is fired on keydown', () => {
  33. const spy = sinon.spy();
  34. viewDocument.on( 'delete', spy );
  35. viewDocument.fire( 'keydown', new DomEventData( viewDocument, getDomEvent(), {
  36. keyCode: getCode( 'delete' )
  37. } ) );
  38. expect( spy.calledOnce ).to.be.true;
  39. const data = spy.args[ 0 ][ 1 ];
  40. expect( data ).to.have.property( 'direction', 'forward' );
  41. expect( data ).to.have.property( 'unit', 'character' );
  42. expect( data ).to.have.property( 'sequence', 1 );
  43. } );
  44. it( 'is fired with a proper direction and unit (on Mac)', () => {
  45. const spy = sinon.spy();
  46. testUtils.sinon.stub( env, 'isMac' ).value( true );
  47. viewDocument.on( 'delete', spy );
  48. viewDocument.fire( 'keydown', new DomEventData( viewDocument, getDomEvent(), {
  49. keyCode: getCode( 'backspace' ),
  50. altKey: true
  51. } ) );
  52. expect( spy.calledOnce ).to.be.true;
  53. const data = spy.args[ 0 ][ 1 ];
  54. expect( data ).to.have.property( 'direction', 'backward' );
  55. expect( data ).to.have.property( 'unit', 'word' );
  56. expect( data ).to.have.property( 'sequence', 1 );
  57. } );
  58. it( 'is fired with a proper direction and unit (on non-Mac)', () => {
  59. const spy = sinon.spy();
  60. testUtils.sinon.stub( env, 'isMac' ).value( false );
  61. viewDocument.on( 'delete', spy );
  62. viewDocument.fire( 'keydown', new DomEventData( viewDocument, getDomEvent(), {
  63. keyCode: getCode( 'backspace' ),
  64. ctrlKey: true
  65. } ) );
  66. expect( spy.calledOnce ).to.be.true;
  67. const data = spy.args[ 0 ][ 1 ];
  68. expect( data ).to.have.property( 'direction', 'backward' );
  69. expect( data ).to.have.property( 'unit', 'word' );
  70. expect( data ).to.have.property( 'sequence', 1 );
  71. } );
  72. it( 'is not fired on keydown when keyCode does not match backspace or delete', () => {
  73. const spy = sinon.spy();
  74. viewDocument.on( 'delete', spy );
  75. viewDocument.fire( 'keydown', new DomEventData( viewDocument, getDomEvent(), {
  76. keyCode: 1
  77. } ) );
  78. expect( spy.calledOnce ).to.be.false;
  79. } );
  80. it( 'is fired with a proper sequence number', () => {
  81. const spy = sinon.spy();
  82. viewDocument.on( 'delete', spy );
  83. // Simulate that a user keeps the "Delete" key.
  84. for ( let i = 0; i < 5; ++i ) {
  85. viewDocument.fire( 'keydown', new DomEventData( viewDocument, getDomEvent(), {
  86. keyCode: getCode( 'delete' )
  87. } ) );
  88. viewDocument.fire( 'input', getDomEvent() );
  89. }
  90. expect( spy.callCount ).to.equal( 5 );
  91. expect( spy.args[ 0 ][ 1 ] ).to.have.property( 'sequence', 1 );
  92. expect( spy.args[ 1 ][ 1 ] ).to.have.property( 'sequence', 2 );
  93. expect( spy.args[ 2 ][ 1 ] ).to.have.property( 'sequence', 3 );
  94. expect( spy.args[ 3 ][ 1 ] ).to.have.property( 'sequence', 4 );
  95. expect( spy.args[ 4 ][ 1 ] ).to.have.property( 'sequence', 5 );
  96. } );
  97. it( 'clears the sequence when the key was released', () => {
  98. const spy = sinon.spy();
  99. viewDocument.on( 'delete', spy );
  100. // Simulate that a user keeps the "Delete" key.
  101. for ( let i = 0; i < 3; ++i ) {
  102. viewDocument.fire( 'keydown', new DomEventData( viewDocument, getDomEvent(), {
  103. keyCode: getCode( 'delete' )
  104. } ) );
  105. viewDocument.fire( 'input', getDomEvent() );
  106. }
  107. // Then the user has released the key.
  108. viewDocument.fire( 'keyup', new DomEventData( viewDocument, getDomEvent(), {
  109. keyCode: getCode( 'delete' )
  110. } ) );
  111. // And pressed it once again.
  112. viewDocument.fire( 'keydown', new DomEventData( viewDocument, getDomEvent(), {
  113. keyCode: getCode( 'delete' )
  114. } ) );
  115. viewDocument.fire( 'input', getDomEvent() );
  116. expect( spy.callCount ).to.equal( 4 );
  117. expect( spy.args[ 0 ][ 1 ] ).to.have.property( 'sequence', 1 );
  118. expect( spy.args[ 1 ][ 1 ] ).to.have.property( 'sequence', 2 );
  119. expect( spy.args[ 2 ][ 1 ] ).to.have.property( 'sequence', 3 );
  120. expect( spy.args[ 3 ][ 1 ] ).to.have.property( 'sequence', 1 );
  121. } );
  122. it( 'works fine with Backspace key', () => {
  123. const spy = sinon.spy();
  124. viewDocument.on( 'delete', spy );
  125. viewDocument.fire( 'keydown', new DomEventData( viewDocument, getDomEvent(), {
  126. keyCode: getCode( 'backspace' )
  127. } ) );
  128. viewDocument.fire( 'input', getDomEvent() );
  129. viewDocument.fire( 'keyup', new DomEventData( viewDocument, getDomEvent(), {
  130. keyCode: getCode( 'backspace' )
  131. } ) );
  132. viewDocument.fire( 'keydown', new DomEventData( viewDocument, getDomEvent(), {
  133. keyCode: getCode( 'backspace' )
  134. } ) );
  135. viewDocument.fire( 'input', getDomEvent() );
  136. expect( spy.callCount ).to.equal( 2 );
  137. expect( spy.args[ 0 ][ 1 ] ).to.have.property( 'sequence', 1 );
  138. expect( spy.args[ 1 ][ 1 ] ).to.have.property( 'sequence', 1 );
  139. } );
  140. it( 'does not reset the sequence if other than Backspace or Delete key was released', () => {
  141. const spy = sinon.spy();
  142. viewDocument.on( 'delete', spy );
  143. viewDocument.fire( 'keydown', new DomEventData( viewDocument, getDomEvent(), {
  144. keyCode: getCode( 'delete' )
  145. } ) );
  146. viewDocument.fire( 'input', getDomEvent() );
  147. viewDocument.fire( 'keyup', new DomEventData( viewDocument, getDomEvent(), {
  148. keyCode: getCode( 'A' )
  149. } ) );
  150. viewDocument.fire( 'keydown', new DomEventData( viewDocument, getDomEvent(), {
  151. keyCode: getCode( 'delete' )
  152. } ) );
  153. viewDocument.fire( 'input', getDomEvent() );
  154. expect( spy.args[ 0 ][ 1 ] ).to.have.property( 'sequence', 1 );
  155. expect( spy.args[ 1 ][ 1 ] ).to.have.property( 'sequence', 2 );
  156. } );
  157. it( 'should stop keydown event when delete event is stopped', () => {
  158. const keydownSpy = sinon.spy();
  159. viewDocument.on( 'keydown', keydownSpy );
  160. viewDocument.on( 'delete', evt => evt.stop() );
  161. viewDocument.fire( 'keydown', new DomEventData( viewDocument, getDomEvent(), {
  162. keyCode: getCode( 'delete' )
  163. } ) );
  164. sinon.assert.notCalled( keydownSpy );
  165. } );
  166. // https://github.com/ckeditor/ckeditor5-typing/issues/186
  167. it( 'should stop keydown event when delete event is stopped (delete event with highest priority)', () => {
  168. const keydownSpy = sinon.spy();
  169. viewDocument.on( 'keydown', keydownSpy );
  170. viewDocument.on( 'delete', evt => evt.stop(), { priority: 'highest' } );
  171. viewDocument.fire( 'keydown', new DomEventData( viewDocument, getDomEvent(), {
  172. keyCode: getCode( 'delete' )
  173. } ) );
  174. sinon.assert.notCalled( keydownSpy );
  175. } );
  176. it( 'should not stop keydown event when delete event is not stopped', () => {
  177. const keydownSpy = sinon.spy();
  178. viewDocument.on( 'keydown', keydownSpy );
  179. viewDocument.on( 'delete', evt => evt.stop() );
  180. viewDocument.fire( 'keydown', new DomEventData( viewDocument, getDomEvent(), {
  181. keyCode: getCode( 'x' )
  182. } ) );
  183. sinon.assert.calledOnce( keydownSpy );
  184. } );
  185. } );
  186. function getDomEvent() {
  187. return {
  188. preventDefault: sinon.spy()
  189. };
  190. }
  191. } );
  192. describe( 'DeleteObserver - Android', () => {
  193. let view, viewDocument, oldEnvIsAndroid, domElement, viewRoot, domText;
  194. testUtils.createSinonSandbox();
  195. before( () => {
  196. oldEnvIsAndroid = env.isAndroid;
  197. env.isAndroid = true;
  198. } );
  199. beforeEach( () => {
  200. domElement = document.createElement( 'div' );
  201. domElement.contenteditable = true;
  202. document.body.appendChild( domElement );
  203. view = new View();
  204. viewDocument = view.document;
  205. view.addObserver( DeleteObserver );
  206. viewRoot = createViewRoot( viewDocument );
  207. view.attachDomRoot( domElement );
  208. view.change( writer => {
  209. const p = writer.createContainerElement( 'p' );
  210. writer.insert( writer.createPositionAt( viewRoot, 0 ), p );
  211. const text = writer.createText( 'foo' );
  212. writer.insert( writer.createPositionAt( p, 0 ), text );
  213. } );
  214. domText = domElement.childNodes[ 0 ].childNodes[ 0 ];
  215. } );
  216. afterEach( () => {
  217. view.destroy();
  218. domElement.remove();
  219. } );
  220. after( () => {
  221. env.isAndroid = oldEnvIsAndroid;
  222. } );
  223. describe( 'delete event', () => {
  224. it( 'is fired on beforeinput', () => {
  225. const spy = sinon.spy();
  226. viewDocument.on( 'delete', spy );
  227. setDomSelection( domText, 1, domText, 2 );
  228. viewDocument.fire( 'beforeinput', new DomEventData( viewDocument, getDomEvent( 'deleteContentBackward' ), {
  229. domTarget: domElement
  230. } ) );
  231. expect( spy.calledOnce ).to.be.true;
  232. const data = spy.args[ 0 ][ 1 ];
  233. expect( data ).to.have.property( 'direction', 'backward' );
  234. expect( data ).to.have.property( 'unit', 'codepoint' );
  235. expect( data ).to.have.property( 'sequence', 1 );
  236. expect( data ).not.to.have.property( 'selectionToRemove' );
  237. } );
  238. it( 'should set selectionToRemove if DOM selection size is different than 1', () => {
  239. // In real scenarios, before `beforeinput` is fired, browser changes DOM selection to a selection that contains
  240. // all content that should be deleted. If the selection is big (> 1 character) we need to pass special parameter
  241. // so that `DeleteCommand` will know what to delete. This test checks that case.
  242. const spy = sinon.spy();
  243. viewDocument.on( 'delete', spy );
  244. setDomSelection( domText, 0, domText, 3 );
  245. viewDocument.fire( 'beforeinput', new DomEventData( viewDocument, getDomEvent( 'deleteContentBackward' ), {
  246. domTarget: domElement
  247. } ) );
  248. expect( spy.calledOnce ).to.be.true;
  249. const data = spy.args[ 0 ][ 1 ];
  250. expect( data ).to.have.property( 'selectionToRemove' );
  251. const viewText = viewRoot.getChild( 0 ).getChild( 0 );
  252. const range = data.selectionToRemove.getFirstRange();
  253. expect( range.start.offset ).to.equal( 0 );
  254. expect( range.start.parent ).to.equal( viewText );
  255. expect( range.end.offset ).to.equal( 3 );
  256. expect( range.end.parent ).to.equal( viewText );
  257. } );
  258. it( 'is not fired on beforeinput when event type is other than deleteContentBackward', () => {
  259. const spy = sinon.spy();
  260. viewDocument.on( 'delete', spy );
  261. viewDocument.fire( 'keydown', new DomEventData( viewDocument, getDomEvent( 'insertText' ), {
  262. domTarget: domElement
  263. } ) );
  264. expect( spy.calledOnce ).to.be.false;
  265. } );
  266. it( 'should stop beforeinput event when delete event is stopped', () => {
  267. const keydownSpy = sinon.spy();
  268. viewDocument.on( 'beforeinput', keydownSpy );
  269. viewDocument.on( 'delete', evt => evt.stop() );
  270. viewDocument.fire( 'beforeinput', new DomEventData( viewDocument, getDomEvent( 'deleteContentBackward' ), {
  271. domTarget: domElement
  272. } ) );
  273. sinon.assert.notCalled( keydownSpy );
  274. } );
  275. it( 'should not stop keydown event when delete event is not stopped', () => {
  276. const keydownSpy = sinon.spy();
  277. viewDocument.on( 'beforeinput', keydownSpy );
  278. viewDocument.on( 'delete', evt => evt.stop() );
  279. viewDocument.fire( 'beforeinput', new DomEventData( viewDocument, getDomEvent( 'insertText' ), {
  280. domTarget: domElement
  281. } ) );
  282. sinon.assert.calledOnce( keydownSpy );
  283. } );
  284. } );
  285. function getDomEvent( inputType ) {
  286. return {
  287. inputType,
  288. preventDefault: sinon.spy()
  289. };
  290. }
  291. function setDomSelection( anchorNode, anchorOffset, focusNode, focusOffset ) {
  292. const selection = window.getSelection();
  293. selection.collapse( anchorNode, anchorOffset );
  294. selection.extend( focusNode, focusOffset );
  295. }
  296. } );