widgetresize.js 10 KB

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