widgetresize.js 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441
  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. /* globals window, document */
  6. import WidgetResize from '../src/widgetresize';
  7. // ClassicTestEditor can't be used, as it doesn't handle the focus, which is needed to test resizer visual cues.
  8. import ClassicEditor from '@ckeditor/ckeditor5-editor-classic/src/classiceditor';
  9. import ArticlePluginSet from '@ckeditor/ckeditor5-core/tests/_utils/articlepluginset';
  10. import {
  11. toWidget
  12. } from '../src/utils';
  13. import {
  14. setData as setModelData
  15. } from '@ckeditor/ckeditor5-engine/src/dev-utils/model';
  16. import Rect from '@ckeditor/ckeditor5-utils/src/dom/rect';
  17. describe( 'WidgetResize', () => {
  18. let editor, editorElement, view, widget, widgetModel, customConfig, mouseListenerStubs;
  19. const mouseMock = {
  20. down( editor, domTarget ) {
  21. this._getPlugin( editor )._mouseDownListener( {}, {
  22. target: domTarget
  23. } );
  24. },
  25. move( editor, domTarget, eventData ) {
  26. const combinedEventData = Object.assign( {}, eventData, {
  27. target: domTarget
  28. } );
  29. this._getPlugin( editor )._mouseMoveListener( {}, combinedEventData );
  30. },
  31. up() {
  32. this._getPlugin( editor )._mouseUpListener();
  33. },
  34. _getPlugin( editor ) {
  35. return editor.plugins.get( WidgetResize );
  36. }
  37. };
  38. before( () => {
  39. mouseListenerStubs = {
  40. down: sinon.spy( WidgetResize.prototype, '_mouseDownListener' ),
  41. move: sinon.spy( WidgetResize.prototype, '_mouseMoveListener' ),
  42. up: sinon.spy( WidgetResize.prototype, '_mouseUpListener' )
  43. };
  44. } );
  45. after( () => {
  46. for ( const stub of Object.values( mouseListenerStubs ) ) {
  47. stub.restore();
  48. }
  49. } );
  50. beforeEach( async () => {
  51. editorElement = createEditorElement();
  52. editor = await createEditor( editorElement, customConfig );
  53. view = editor.editing.view;
  54. setModelData( editor.model, '[<widget></widget>]' );
  55. widget = view.document.getRoot().getChild( 0 );
  56. widgetModel = editor.model.document.getRoot().getChild( 0 );
  57. for ( const stub of Object.values( mouseListenerStubs ) ) {
  58. stub.resetHistory();
  59. }
  60. // It's crucial to have a precisely defined editor size for this test suite.
  61. editor.editing.view.change( writer => {
  62. const viewEditableRoot = editor.editing.view.document.getRoot();
  63. writer.setAttribute( 'style', 'width: 400px; padding: 0px; overflow: hidden', viewEditableRoot );
  64. } );
  65. } );
  66. afterEach( () => {
  67. editorElement.remove();
  68. if ( editor ) {
  69. return editor.destroy();
  70. }
  71. } );
  72. describe( 'plugin', () => {
  73. it( 'is loaded', () => {
  74. expect( editor.plugins.get( WidgetResize ) ).to.be.instanceOf( WidgetResize );
  75. } );
  76. } );
  77. describe( 'mouse listeners', () => {
  78. let resizer, resizerOptions;
  79. beforeEach( () => {
  80. resizerOptions = {
  81. unit: 'px',
  82. modelElement: widgetModel,
  83. viewElement: widget,
  84. editor,
  85. getHandleHost( domWidgetElement ) {
  86. return domWidgetElement;
  87. },
  88. getResizeHost( domWidgetElement ) {
  89. return domWidgetElement;
  90. },
  91. isCentered: () => false,
  92. onCommit: sinon.stub()
  93. };
  94. resizer = editor.plugins.get( WidgetResize )
  95. .attachTo( resizerOptions );
  96. } );
  97. it( 'doesnt break when called with unexpected element', async () => {
  98. const unrelatedElement = document.createElement( 'div' );
  99. focusEditor( editor );
  100. resizer.redraw(); // @todo this shouldn't be necessary.
  101. // await wait( 40 );
  102. editor.plugins.get( WidgetResize )._mouseDownListener( {}, {
  103. target: unrelatedElement
  104. } );
  105. } );
  106. it( 'passes new width to the options.onCommit()', async () => {
  107. focusEditor( editor );
  108. resizer.redraw(); // @todo this shouldn't be necessary.
  109. const usedResizer = 'top-right';
  110. const domParts = getWidgetDomParts( widget, usedResizer );
  111. const initialPointerPosition = getElementCenterPoint( domParts.widget, usedResizer );
  112. const finalPointerPosition = Object.assign( {}, initialPointerPosition );
  113. finalPointerPosition.pageX += 20;
  114. mouseMock.down( editor, domParts.resizeHandle );
  115. await wait( 40 );
  116. mouseMock.move( editor, domParts.resizeHandle, finalPointerPosition );
  117. mouseMock.up();
  118. expect( resizerOptions.onCommit.callCount ).to.be.equal( 1 );
  119. sinon.assert.calledWithExactly( resizerOptions.onCommit, '120px' );
  120. } );
  121. } );
  122. describe( 'mouse listeners (stubbed)', () => {
  123. it( 'are detached when plugin is destroyed', async () => {
  124. await editor.destroy();
  125. const plugin = editor.plugins.get( WidgetResize );
  126. editor = null;
  127. // Trigger mouse event.
  128. fireMouseEvent( document.body, 'mousedown', {} );
  129. // Ensure nothing got called.
  130. expect( plugin._mouseDownListener.callCount ).to.be.equal( 0 );
  131. } );
  132. } );
  133. describe( '_proposeNewSize()', () => {
  134. let resizer, resizerOptions;
  135. beforeEach( async () => {
  136. resizerOptions = {
  137. unit: 'px',
  138. modelElement: widgetModel,
  139. viewElement: widget,
  140. editor,
  141. getHandleHost( domWidgetElement ) {
  142. return domWidgetElement;
  143. },
  144. getResizeHost( domWidgetElement ) {
  145. return domWidgetElement;
  146. },
  147. onCommit: sinon.stub()
  148. };
  149. resizer = editor.plugins.get( WidgetResize )
  150. .attachTo( resizerOptions );
  151. } );
  152. it( 'assumes a centered image if no isCentered option is provided', async () => {
  153. focusEditor( editor );
  154. resizer.redraw(); // @todo this shouldn't be necessary.
  155. const usedResizer = 'top-right';
  156. const domParts = getWidgetDomParts( widget, usedResizer, editor.editing.view );
  157. const initialPointerPosition = getElementCenterPoint( domParts.widget, usedResizer );
  158. const finalPointerPosition = Object.assign( {}, initialPointerPosition );
  159. finalPointerPosition.pageX += 20;
  160. mouseMock.down( editor, domParts.resizeHandle );
  161. await wait( 40 );
  162. mouseMock.move( editor, domParts.resizeHandle, finalPointerPosition );
  163. mouseMock.up();
  164. await wait( 40 );
  165. // THe image should be enlarged by a twice of the mouse movement distance.
  166. sinon.assert.calledWithExactly( resizerOptions.onCommit, '140px' );
  167. } );
  168. } );
  169. describe( 'Integration (pixels)', () => {
  170. let resizer, resizerOptions;
  171. beforeEach( async () => {
  172. resizerOptions = {
  173. unit: 'px',
  174. modelElement: widgetModel,
  175. viewElement: widget,
  176. editor,
  177. getHandleHost( domWidgetElement ) {
  178. return domWidgetElement;
  179. },
  180. getResizeHost( domWidgetElement ) {
  181. return domWidgetElement;
  182. },
  183. isCentered: () => false,
  184. onCommit: sinon.stub()
  185. };
  186. resizer = editor.plugins.get( WidgetResize )
  187. .attachTo( resizerOptions );
  188. } );
  189. it( 'properly sets the state for subsequent resizes', async () => {
  190. focusEditor( editor );
  191. resizer.redraw(); // @todo this shouldn't be necessary.
  192. const usedResizer = 'top-right';
  193. const domParts = getWidgetDomParts( widget, usedResizer, editor.editing.view );
  194. const initialPointerPosition = getElementCenterPoint( domParts.widget, usedResizer );
  195. const finalPointerPosition = Object.assign( {}, initialPointerPosition );
  196. finalPointerPosition.pageX += 50;
  197. mouseMock.down( editor, domParts.resizeHandle );
  198. await wait( 40 );
  199. mouseMock.move( editor, domParts.resizeHandle, finalPointerPosition );
  200. mouseMock.up();
  201. await wait( 40 );
  202. mouseMock.down( editor, domParts.resizeHandle );
  203. await wait( 40 );
  204. finalPointerPosition.pageX += 50;
  205. mouseMock.move( editor, domParts.resizeHandle, finalPointerPosition );
  206. mouseMock.up();
  207. expect( resizerOptions.onCommit.callCount ).to.be.equal( 2 );
  208. sinon.assert.calledWithExactly( resizerOptions.onCommit.firstCall, '150px' );
  209. sinon.assert.calledWithExactly( resizerOptions.onCommit.secondCall, '200px' );
  210. } );
  211. } );
  212. describe( 'Integration (percents)', () => {
  213. let resizer, resizerOptions;
  214. beforeEach( async () => {
  215. resizerOptions = {
  216. modelElement: widgetModel,
  217. viewElement: widget,
  218. editor,
  219. getHandleHost( domWidgetElement ) {
  220. return domWidgetElement;
  221. },
  222. getResizeHost( domWidgetElement ) {
  223. return domWidgetElement;
  224. },
  225. isCentered: () => false,
  226. onCommit: sinon.stub()
  227. };
  228. resizer = editor.plugins.get( WidgetResize )
  229. .attachTo( resizerOptions );
  230. } );
  231. it( 'properly sets the state for subsequent resizes', async function() {
  232. this.timeout( 45000 );
  233. focusEditor( editor );
  234. resizer.redraw(); // @todo this shouldn't be necessary.
  235. const usedResizer = 'top-right';
  236. const domParts = getWidgetDomParts( widget, usedResizer, editor.editing.view );
  237. const initialPointerPosition = getElementCenterPoint( domParts.widget, usedResizer );
  238. const finalPointerPosition = Object.assign( {}, initialPointerPosition );
  239. finalPointerPosition.pageX += 100;
  240. mouseMock.down( editor, domParts.resizeHandle );
  241. await wait( 40 );
  242. mouseMock.move( editor, domParts.resizeHandle, finalPointerPosition );
  243. mouseMock.up();
  244. await wait( 40 );
  245. mouseMock.down( editor, domParts.resizeHandle );
  246. await wait( 40 );
  247. finalPointerPosition.pageX += 100;
  248. mouseMock.move( editor, domParts.resizeHandle, finalPointerPosition );
  249. mouseMock.up();
  250. expect( resizerOptions.onCommit.callCount ).to.be.equal( 2 );
  251. sinon.assert.calledWithExactly( resizerOptions.onCommit.firstCall, '50%' );
  252. sinon.assert.calledWithExactly( resizerOptions.onCommit.secondCall, '75%' );
  253. } );
  254. } );
  255. function createEditor( element, config ) {
  256. return ClassicEditor
  257. .create( element, Object.assign( {
  258. plugins: [
  259. ArticlePluginSet, WidgetResize, simpleWidgetPlugin
  260. ]
  261. }, config ) );
  262. function simpleWidgetPlugin( editor ) {
  263. editor.model.schema.register( 'widget', {
  264. inheritAllFrom: '$block',
  265. isObject: true
  266. } );
  267. editor.conversion.for( 'downcast' )
  268. .elementToElement( {
  269. model: 'widget',
  270. view: ( modelItem, viewWriter ) => {
  271. const div = viewWriter.createContainerElement( 'div' );
  272. viewWriter.setStyle( 'height', '100px', div );
  273. viewWriter.setStyle( 'width', '100px', div );
  274. return toWidget( div, viewWriter, {
  275. label: 'element label'
  276. } );
  277. }
  278. } );
  279. }
  280. }
  281. function createEditorElement() {
  282. const element = document.createElement( 'div' );
  283. document.body.appendChild( element );
  284. return element;
  285. }
  286. function fireMouseEvent( target, eventType, eventData ) {
  287. // Id of the left mouse button.
  288. const MOUSE_BUTTON_MAIN = 0;
  289. // Using initMouseEvent instead of MouseEvent constructor, as MouseEvent constructor doesn't support passing pageX
  290. // and pageY. See https://stackoverflow.com/questions/45843458/setting-click-events-pagex-and-pagey-always-reverts-to-0
  291. // However there's still a problem, that events created with `initMouseEvent` have **floored** pageX, pageY numbers.
  292. const event = document.createEvent( 'MouseEvent' );
  293. event.initMouseEvent( eventType, true, true, window, null, 0, 0, eventData.pageX, eventData.pageY, false, false, false, false,
  294. MOUSE_BUTTON_MAIN, null );
  295. target.dispatchEvent( event );
  296. }
  297. function getWidgetDomParts( widget, resizerPosition, localView ) {
  298. const resizeWrapper = ( localView || view ).domConverter.mapViewToDom( widget.getChild( 0 ) );
  299. return {
  300. resizeWrapper,
  301. resizeHandle: resizeWrapper.querySelector( `.ck-widget__resizer__handle-${ resizerPosition }` ),
  302. widget: view.domConverter.mapViewToDom( widget )
  303. };
  304. }
  305. function getElementCenterPoint( domWrapper, cornerPosition ) {
  306. const wrapperRect = new Rect( domWrapper );
  307. const initialPointerPosition = {
  308. pageX: wrapperRect.left,
  309. pageY: wrapperRect.top
  310. };
  311. const cornerPositionParts = cornerPosition.split( '-' );
  312. if ( cornerPositionParts.includes( 'right' ) ) {
  313. initialPointerPosition.pageX = wrapperRect.right;
  314. }
  315. if ( cornerPositionParts.includes( 'bottom' ) ) {
  316. initialPointerPosition.pageY = wrapperRect.bottom;
  317. }
  318. return initialPointerPosition;
  319. }
  320. function focusEditor( editor ) {
  321. editor.editing.view.focus();
  322. editor.ui.focusTracker.isFocused = true;
  323. }
  324. function wait( delay ) {
  325. return new Promise( resolve => window.setTimeout( () => resolve(), delay ) );
  326. }
  327. } );