widgetresize.js 10 KB

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