widgetresize.js 11 KB

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