clipboardobserver.js 8.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297
  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 document */
  6. import ClipboardObserver from '../src/clipboardobserver';
  7. import View from '@ckeditor/ckeditor5-engine/src/view/view';
  8. import DowncastWriter from '@ckeditor/ckeditor5-engine/src/view/downcastwriter';
  9. import DataTransfer from '../src/datatransfer';
  10. import createViewRoot from '@ckeditor/ckeditor5-engine/tests/view/_utils/createroot';
  11. describe( 'ClipboardObserver', () => {
  12. let view, doc, writer, observer, root, el, range, eventSpy, preventDefaultSpy, stopPropagationSpy;
  13. beforeEach( () => {
  14. view = new View();
  15. doc = view.document;
  16. writer = new DowncastWriter( doc );
  17. root = createViewRoot( doc );
  18. // Create view and DOM structures.
  19. el = writer.createContainerElement( 'p' );
  20. writer.insert( writer.createPositionAt( root, 0 ), el );
  21. view.domConverter.viewToDom( root, document, { withChildren: true, bind: true } );
  22. doc.selection._setTo( el, 0 );
  23. range = writer.createRange( writer.createPositionAt( root, 1 ) );
  24. // Just making sure that the following tests will check anything.
  25. expect( range.isEqual( doc.selection.getFirstRange() ) ).to.be.false;
  26. observer = view.addObserver( ClipboardObserver );
  27. eventSpy = sinon.spy();
  28. preventDefaultSpy = sinon.spy();
  29. stopPropagationSpy = sinon.spy();
  30. } );
  31. it( 'should define domEventType', () => {
  32. expect( observer.domEventType ).to.deep.equal( [ 'paste', 'copy', 'cut', 'drop', 'dragover' ] );
  33. } );
  34. describe( 'paste event', () => {
  35. it( 'should be fired with the right event data', () => {
  36. const dataTransfer = mockDomDataTransfer();
  37. const targetElement = mockDomTargetElement( {} );
  38. doc.on( 'paste', eventSpy );
  39. observer.onDomEvent( {
  40. type: 'paste',
  41. target: targetElement,
  42. clipboardData: dataTransfer,
  43. preventDefault: preventDefaultSpy
  44. } );
  45. expect( eventSpy.calledOnce ).to.be.true;
  46. const data = eventSpy.args[ 0 ][ 1 ];
  47. expect( data.domTarget ).to.equal( targetElement );
  48. expect( data.dataTransfer ).to.be.instanceOf( DataTransfer );
  49. expect( data.dataTransfer.getData( 'x/y' ) ).to.equal( 'foo:x/y' );
  50. expect( preventDefaultSpy.calledOnce ).to.be.true;
  51. } );
  52. } );
  53. describe( 'drop event', () => {
  54. it( 'should be fired with the right event data - basics', () => {
  55. const dataTransfer = mockDomDataTransfer();
  56. const targetElement = mockDomTargetElement( {} );
  57. doc.on( 'drop', eventSpy );
  58. observer.onDomEvent( {
  59. type: 'drop',
  60. target: targetElement,
  61. dataTransfer,
  62. preventDefault: preventDefaultSpy
  63. } );
  64. expect( eventSpy.calledOnce ).to.be.true;
  65. const data = eventSpy.args[ 0 ][ 1 ];
  66. expect( data.domTarget ).to.equal( targetElement );
  67. expect( data.dataTransfer ).to.be.instanceOf( DataTransfer );
  68. expect( data.dataTransfer.getData( 'x/y' ) ).to.equal( 'foo:x/y' );
  69. expect( data.dropRange.isEqual( doc.selection.getFirstRange() ) ).to.be.true;
  70. expect( preventDefaultSpy.calledOnce ).to.be.true;
  71. } );
  72. it( 'should be fired with the right event data – dropRange (when no info about it in the drop event)', () => {
  73. const dataTransfer = mockDomDataTransfer();
  74. const targetElement = mockDomTargetElement( {} );
  75. doc.on( 'drop', eventSpy );
  76. observer.onDomEvent( {
  77. type: 'drop',
  78. target: targetElement,
  79. dataTransfer,
  80. preventDefault() {}
  81. } );
  82. expect( eventSpy.calledOnce ).to.be.true;
  83. const data = eventSpy.args[ 0 ][ 1 ];
  84. expect( data.dropRange.isEqual( doc.selection.getFirstRange() ) ).to.be.true;
  85. } );
  86. it( 'should be fired with the right event data – dropRange (when document.caretRangeFromPoint present)', () => {
  87. let caretRangeFromPointCalledWith;
  88. const domRange = view.domConverter.viewRangeToDom( range );
  89. const dataTransfer = mockDomDataTransfer();
  90. const targetElement = mockDomTargetElement( {
  91. caretRangeFromPoint( x, y ) {
  92. caretRangeFromPointCalledWith = [ x, y ];
  93. return domRange;
  94. }
  95. } );
  96. doc.on( 'drop', eventSpy );
  97. observer.onDomEvent( {
  98. type: 'drop',
  99. target: targetElement,
  100. dataTransfer,
  101. clientX: 10,
  102. clientY: 20,
  103. preventDefault() {}
  104. } );
  105. expect( eventSpy.calledOnce ).to.be.true;
  106. const data = eventSpy.args[ 0 ][ 1 ];
  107. expect( data.dropRange.isEqual( range ) ).to.be.true;
  108. expect( caretRangeFromPointCalledWith ).to.deep.equal( [ 10, 20 ] );
  109. } );
  110. it( 'should be fired with the right event data – dropRange (when evt.rangeParent|Offset present)', () => {
  111. const domRange = view.domConverter.viewRangeToDom( range );
  112. const dataTransfer = mockDomDataTransfer();
  113. const targetElement = mockDomTargetElement( {
  114. createRange() {
  115. return document.createRange();
  116. }
  117. } );
  118. doc.on( 'drop', eventSpy );
  119. observer.onDomEvent( {
  120. type: 'drop',
  121. target: targetElement,
  122. dataTransfer,
  123. rangeParent: domRange.startContainer,
  124. rangeOffset: domRange.startOffset,
  125. preventDefault() {}
  126. } );
  127. expect( eventSpy.calledOnce ).to.be.true;
  128. const data = eventSpy.args[ 0 ][ 1 ];
  129. expect( data.dropRange.isEqual( range ) ).to.be.true;
  130. } );
  131. } );
  132. describe( 'clipboardInput event', () => {
  133. it( 'should be fired on paste', () => {
  134. const dataTransfer = new DataTransfer( mockDomDataTransfer() );
  135. const normalPrioritySpy = sinon.spy();
  136. doc.on( 'clipboardInput', eventSpy );
  137. doc.on( 'paste', normalPrioritySpy );
  138. doc.fire( 'paste', {
  139. dataTransfer,
  140. preventDefault: preventDefaultSpy
  141. } );
  142. expect( eventSpy.calledOnce ).to.be.true;
  143. expect( preventDefaultSpy.calledOnce ).to.be.true;
  144. const data = eventSpy.args[ 0 ][ 1 ];
  145. expect( data.dataTransfer ).to.equal( dataTransfer );
  146. expect( data.targetRanges ).to.have.length( 1 );
  147. expect( data.targetRanges[ 0 ].isEqual( doc.selection.getFirstRange() ) ).to.be.true;
  148. expect( sinon.assert.callOrder( normalPrioritySpy, eventSpy ) );
  149. } );
  150. it( 'should be fired on drop', () => {
  151. const dataTransfer = new DataTransfer( mockDomDataTransfer() );
  152. const normalPrioritySpy = sinon.spy();
  153. doc.on( 'clipboardInput', eventSpy );
  154. doc.on( 'drop', normalPrioritySpy );
  155. doc.fire( 'drop', {
  156. dataTransfer,
  157. preventDefault: preventDefaultSpy,
  158. dropRange: range
  159. } );
  160. expect( eventSpy.calledOnce ).to.be.true;
  161. expect( preventDefaultSpy.calledOnce ).to.be.true;
  162. const data = eventSpy.args[ 0 ][ 1 ];
  163. expect( data.dataTransfer ).to.equal( dataTransfer );
  164. expect( data.targetRanges ).to.have.length( 1 );
  165. expect( data.targetRanges[ 0 ].isEqual( range ) ).to.be.true;
  166. expect( sinon.assert.callOrder( normalPrioritySpy, eventSpy ) );
  167. } );
  168. // https://github.com/ckeditor/ckeditor5-upload/issues/92
  169. it( 'should stop propagation of the original event if handled by the editor', () => {
  170. const dataTransfer = new DataTransfer( mockDomDataTransfer() );
  171. doc.fire( 'drop', {
  172. dataTransfer,
  173. preventDefault: preventDefaultSpy,
  174. stopPropagation: stopPropagationSpy,
  175. dropRange: range
  176. } );
  177. sinon.assert.notCalled( stopPropagationSpy );
  178. doc.on( 'clipboardInput', evt => {
  179. // E.g. some feature handled the input.
  180. evt.stop();
  181. } );
  182. doc.fire( 'drop', {
  183. dataTransfer,
  184. preventDefault: preventDefaultSpy,
  185. stopPropagation: stopPropagationSpy,
  186. dropRange: range
  187. } );
  188. sinon.assert.calledOnce( stopPropagationSpy );
  189. } );
  190. } );
  191. describe( 'dragover event', () => {
  192. it( 'should fire when a file is dragging over the document', () => {
  193. const targetElement = mockDomTargetElement( {} );
  194. const dataTransfer = mockDomDataTransfer();
  195. doc.on( 'dragover', eventSpy );
  196. observer.onDomEvent( {
  197. type: 'dragover',
  198. target: targetElement,
  199. dataTransfer
  200. } );
  201. expect( eventSpy.calledOnce ).to.equal( true );
  202. const data = eventSpy.args[ 0 ][ 1 ];
  203. expect( data.document ).to.equal( doc );
  204. expect( data.domTarget ).to.equal( targetElement );
  205. expect( data.domEvent.type ).to.equal( 'dragover' );
  206. expect( data.dataTransfer.files ).to.deep.equal( dataTransfer.files );
  207. } );
  208. } );
  209. } );
  210. // Returns a super simple mock of HTMLElement (we use only ownerDocument from it).
  211. function mockDomTargetElement( documentMock ) {
  212. return {
  213. ownerDocument: documentMock
  214. };
  215. }
  216. function mockDomDataTransfer() {
  217. return {
  218. files: [],
  219. getData( type ) {
  220. return 'foo:' + type;
  221. }
  222. };
  223. }