widgetresize.js 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378
  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. beforeEach( () => {
  46. for ( const stub of Object.values( mouseListenerStubs ) ) {
  47. stub.resetHistory();
  48. }
  49. } );
  50. after( () => {
  51. for ( const stub of Object.values( mouseListenerStubs ) ) {
  52. stub.restore();
  53. }
  54. } );
  55. beforeEach( async () => {
  56. editorElement = createEditorElement();
  57. editor = await createEditor( editorElement, customConfig );
  58. view = editor.editing.view;
  59. setModelData( editor.model, '[<widget></widget>]' );
  60. widget = view.document.getRoot().getChild( 0 );
  61. widgetModel = editor.model.document.getRoot().getChild( 0 );
  62. } );
  63. afterEach( () => {
  64. editorElement.remove();
  65. if ( editor ) {
  66. return editor.destroy();
  67. }
  68. } );
  69. describe( 'plugin', () => {
  70. it( 'is loaded', () => {
  71. expect( editor.plugins.get( WidgetResize ) ).to.be.instanceOf( WidgetResize );
  72. } );
  73. } );
  74. describe( 'mouse listeners', () => {
  75. let resizer, resizerOptions;
  76. beforeEach( () => {
  77. resizerOptions = {
  78. unit: 'px',
  79. modelElement: widgetModel,
  80. viewElement: widget,
  81. editor,
  82. getHandleHost( domWidgetElement ) {
  83. return domWidgetElement;
  84. },
  85. getResizeHost( domWidgetElement ) {
  86. return domWidgetElement;
  87. },
  88. isCentered: () => false,
  89. onCommit: sinon.stub()
  90. };
  91. resizer = editor.plugins.get( WidgetResize )
  92. .attachTo( resizerOptions );
  93. } );
  94. it( 'doesnt break when called with unexpected element', async () => {
  95. const unrelatedElement = document.createElement( 'div' );
  96. focusEditor( editor );
  97. resizer.redraw(); // @todo this shouldn't be necessary.
  98. // await wait( 40 );
  99. editor.plugins.get( WidgetResize )._mouseDownListener( {}, {
  100. target: unrelatedElement
  101. } );
  102. } );
  103. it( 'passes new width to the options.onCommit()', async () => {
  104. focusEditor( editor );
  105. resizer.redraw(); // @todo this shouldn't be necessary.
  106. const usedResizer = 'top-right';
  107. const domParts = getWidgetDomParts( widget, usedResizer );
  108. const initialPointerPosition = getElementCenterPoint( domParts.widget, usedResizer );
  109. const finalPointerPosition = Object.assign( {}, initialPointerPosition );
  110. finalPointerPosition.pageX += 20;
  111. mouseMock.down( editor, domParts.resizeHandle );
  112. await wait( 40 );
  113. mouseMock.move( editor, domParts.resizeHandle, finalPointerPosition );
  114. mouseMock.up();
  115. expect( resizerOptions.onCommit.callCount ).to.be.equal( 1 );
  116. sinon.assert.calledWithExactly( resizerOptions.onCommit, '120px' );
  117. } );
  118. } );
  119. describe( 'mouse listeners (stubbed)', () => {
  120. it( 'are detached when plugin is destroyed', async () => {
  121. await editor.destroy();
  122. const plugin = editor.plugins.get( WidgetResize );
  123. editor = null;
  124. // Trigger mouse event.
  125. fireMouseEvent( document.body, 'mousedown', {} );
  126. // Ensure nothing got called.
  127. expect( plugin._mouseDownListener.callCount ).to.be.equal( 0 );
  128. } );
  129. } );
  130. describe( '_proposeNewSize()', () => {
  131. let resizer, resizerOptions;
  132. beforeEach( async () => {
  133. resizerOptions = {
  134. unit: 'px',
  135. modelElement: widgetModel,
  136. viewElement: widget,
  137. editor,
  138. getHandleHost( domWidgetElement ) {
  139. return domWidgetElement;
  140. },
  141. getResizeHost( domWidgetElement ) {
  142. return domWidgetElement;
  143. },
  144. onCommit: sinon.stub()
  145. };
  146. resizer = editor.plugins.get( WidgetResize )
  147. .attachTo( resizerOptions );
  148. } );
  149. it( 'assumes a centered image if no isCentered option is provided', async () => {
  150. focusEditor( editor );
  151. resizer.redraw(); // @todo this shouldn't be necessary.
  152. const usedResizer = 'top-right';
  153. const domParts = getWidgetDomParts( widget, usedResizer, editor.editing.view );
  154. const initialPointerPosition = getElementCenterPoint( domParts.widget, usedResizer );
  155. const finalPointerPosition = Object.assign( {}, initialPointerPosition );
  156. finalPointerPosition.pageX += 20;
  157. mouseMock.down( editor, domParts.resizeHandle );
  158. await wait( 40 );
  159. mouseMock.move( editor, domParts.resizeHandle, finalPointerPosition );
  160. mouseMock.up();
  161. await wait( 40 );
  162. // THe image should be enlarged by a twice of the mouse movement distance.
  163. sinon.assert.calledWithExactly( resizerOptions.onCommit, '140px' );
  164. } );
  165. } );
  166. describe( 'Integration (pixels)', () => {
  167. let resizer, resizerOptions;
  168. beforeEach( async () => {
  169. resizerOptions = {
  170. unit: 'px',
  171. modelElement: widgetModel,
  172. viewElement: widget,
  173. editor,
  174. getHandleHost( domWidgetElement ) {
  175. return domWidgetElement;
  176. },
  177. getResizeHost( domWidgetElement ) {
  178. return domWidgetElement;
  179. },
  180. isCentered: () => false,
  181. onCommit: sinon.stub()
  182. };
  183. resizer = editor.plugins.get( WidgetResize )
  184. .attachTo( resizerOptions );
  185. } );
  186. it( 'properly sets the state for subsequent resizes', async () => {
  187. focusEditor( editor );
  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 += 50;
  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 += 50;
  202. mouseMock.move( editor, domParts.resizeHandle, finalPointerPosition );
  203. mouseMock.up();
  204. expect( resizerOptions.onCommit.callCount ).to.be.equal( 2 );
  205. sinon.assert.calledWithExactly( resizerOptions.onCommit.firstCall, '150px' );
  206. sinon.assert.calledWithExactly( resizerOptions.onCommit.secondCall, '200px' );
  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', '100px', div );
  228. viewWriter.setStyle( 'position', 'absolute', div );
  229. viewWriter.setStyle( 'top', '10px', div );
  230. viewWriter.setStyle( 'bottom', '10px', div );
  231. return toWidget( div, viewWriter, {
  232. label: 'element label'
  233. } );
  234. }
  235. } );
  236. }
  237. }
  238. function createEditorElement() {
  239. const element = document.createElement( 'div' );
  240. document.body.appendChild( element );
  241. return element;
  242. }
  243. function fireMouseEvent( target, eventType, eventData ) {
  244. // Id of the left mouse button.
  245. const MOUSE_BUTTON_MAIN = 0;
  246. // Using initMouseEvent instead of MouseEvent constructor, as MouseEvent constructor doesn't support passing pageX
  247. // and pageY. See https://stackoverflow.com/questions/45843458/setting-click-events-pagex-and-pagey-always-reverts-to-0
  248. // However there's still a problem, that events created with `initMouseEvent` have **floored** pageX, pageY numbers.
  249. const event = document.createEvent( 'MouseEvent' );
  250. event.initMouseEvent( eventType, true, true, window, null, 0, 0, eventData.pageX, eventData.pageY, false, false, false, false,
  251. MOUSE_BUTTON_MAIN, null );
  252. target.dispatchEvent( event );
  253. }
  254. function getWidgetDomParts( widget, resizerPosition, localView ) {
  255. const resizeWrapper = ( localView || view ).domConverter.mapViewToDom( widget.getChild( 0 ) );
  256. return {
  257. resizeWrapper,
  258. resizeHandle: resizeWrapper.querySelector( `.ck-widget__resizer__handle-${ resizerPosition }` ),
  259. widget: view.domConverter.mapViewToDom( widget )
  260. };
  261. }
  262. function getElementCenterPoint( domWrapper, cornerPosition ) {
  263. const wrapperRect = new Rect( domWrapper );
  264. const initialPointerPosition = {
  265. pageX: wrapperRect.left,
  266. pageY: wrapperRect.top
  267. };
  268. const cornerPositionParts = cornerPosition.split( '-' );
  269. if ( cornerPositionParts.includes( 'right' ) ) {
  270. initialPointerPosition.pageX = wrapperRect.right;
  271. }
  272. if ( cornerPositionParts.includes( 'bottom' ) ) {
  273. initialPointerPosition.pageY = wrapperRect.bottom;
  274. }
  275. return initialPointerPosition;
  276. }
  277. function focusEditor( editor ) {
  278. editor.editing.view.focus();
  279. editor.ui.focusTracker.isFocused = true;
  280. }
  281. function wait( delay ) {
  282. return new Promise( resolve => window.setTimeout( () => resolve(), delay ) );
  283. }
  284. } );