widgetresize.js 11 KB

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