widgetresize.js 9.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347
  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;
  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. beforeEach( async () => {
  39. editorElement = createEditorElement();
  40. editor = await createEditor( editorElement );
  41. view = editor.editing.view;
  42. setModelData( editor.model, '[<widget></widget>]' );
  43. widget = view.document.getRoot().getChild( 0 );
  44. widgetModel = editor.model.document.getRoot().getChild( 0 );
  45. } );
  46. afterEach( () => {
  47. editorElement.remove();
  48. return editor.destroy();
  49. } );
  50. describe( 'plugin', () => {
  51. it( 'is loaded', () => {
  52. expect( editor.plugins.get( WidgetResize ) ).to.be.instanceOf( WidgetResize );
  53. } );
  54. } );
  55. describe( 'mouse listeners', () => {
  56. let resizer, resizerOptions;
  57. beforeEach( () => {
  58. resizerOptions = {
  59. unit: 'px',
  60. modelElement: widgetModel,
  61. viewElement: widget,
  62. editor,
  63. getHandleHost( domWidgetElement ) {
  64. return domWidgetElement;
  65. },
  66. getResizeHost( domWidgetElement ) {
  67. return domWidgetElement;
  68. },
  69. isCentered: () => false,
  70. onCommit: sinon.stub()
  71. };
  72. resizer = editor.plugins.get( WidgetResize )
  73. .attachTo( resizerOptions );
  74. } );
  75. it( 'doesnt break when called with unexpected element', async () => {
  76. const unrelatedElement = document.createElement( 'div' );
  77. focusEditor( editor );
  78. resizer.redraw(); // @todo this shouldn't be necessary.
  79. // await wait( 40 );
  80. editor.plugins.get( WidgetResize )._mouseDownListener( {}, {
  81. target: unrelatedElement
  82. } );
  83. } );
  84. it( 'passes new width to the options.onCommit()', async () => {
  85. focusEditor( editor );
  86. resizer.redraw(); // @todo this shouldn't be necessary.
  87. const usedResizer = 'top-right';
  88. const domParts = getWidgetDomParts( widget, usedResizer );
  89. const initialPointerPosition = getElementCenterPoint( domParts.widget, usedResizer );
  90. const finalPointerPosition = Object.assign( {}, initialPointerPosition );
  91. finalPointerPosition.pageX += 20;
  92. mouseMock.down( editor, domParts.resizeHandle );
  93. await wait( 40 );
  94. mouseMock.move( editor, domParts.resizeHandle, finalPointerPosition );
  95. mouseMock.up();
  96. expect( resizerOptions.onCommit.callCount ).to.be.equal( 1 );
  97. sinon.assert.calledWithExactly( resizerOptions.onCommit, '120px' );
  98. } );
  99. } );
  100. describe( 'mouse listeners (stubbed)', () => {
  101. let mouseListenerStubs, localEditor, localElement;
  102. beforeEach( async () => {
  103. mouseListenerStubs = {
  104. down: sinon.stub( WidgetResize.prototype, '_mouseDownListener' ),
  105. move: sinon.stub( WidgetResize.prototype, '_mouseMoveListener' ),
  106. up: sinon.stub( WidgetResize.prototype, '_mouseUpListener' )
  107. };
  108. localElement = createEditorElement();
  109. localEditor = await createEditor( localElement );
  110. } );
  111. afterEach( () => {
  112. for ( const stub of Object.values( mouseListenerStubs ) ) {
  113. stub.restore();
  114. }
  115. localElement.remove();
  116. if ( localEditor ) {
  117. return localEditor.destroy();
  118. }
  119. } );
  120. it( 'are detached when plugin is destroyed', async () => {
  121. await localEditor.destroy();
  122. localEditor = null;
  123. // Trigger mouse event.
  124. fireMouseEvent( document.body, 'mousedown', {} );
  125. // Ensure nothing got called.
  126. expect( mouseListenerStubs.down.callCount ).to.be.equal( 0 );
  127. } );
  128. } );
  129. describe.only( 'Integration (percents)', () => {
  130. let localEditor, localElement, widget, widgetModel;
  131. beforeEach( async () => {
  132. localElement = createEditorElement();
  133. localEditor = await createEditor( localElement );
  134. setModelData( localEditor.model, '[<widget></widget>]' );
  135. widget = localEditor.editing.view.document.getRoot().getChild( 0 );
  136. widgetModel = localEditor.model.document.getRoot().getChild( 0 );
  137. editor.plugins.get( WidgetResize )
  138. .attachTo( {
  139. unit: 'px',
  140. modelElement: widgetModel,
  141. viewElement: widget,
  142. editor,
  143. getHandleHost( domWidgetElement ) {
  144. return domWidgetElement;
  145. },
  146. getResizeHost( domWidgetElement ) {
  147. return domWidgetElement;
  148. },
  149. isCentered: () => false,
  150. onCommit: sinon.stub()
  151. } );
  152. } );
  153. afterEach( () => {
  154. localElement.remove();
  155. if ( localEditor ) {
  156. return localEditor.destroy();
  157. }
  158. } );
  159. it( 'properly sets the state for subsequent resizes', async () => {
  160. // focusEditor( editor );
  161. // resizer.redraw(); // @todo this shouldn't be necessary.
  162. // const usedResizer = 'top-right';
  163. // const domParts = getWidgetDomParts( widget, usedResizer, localEditor.editing.view );
  164. // const initialPointerPosition = getElementCenterPoint( domParts.widget, usedResizer );
  165. // const finalPointerPosition = Object.assign( {}, initialPointerPosition );
  166. // finalPointerPosition.pageX += 50;
  167. // mouseMock.down( editor, domParts.resizeHandle );
  168. // await wait( 40 );
  169. // mouseMock.move( editor, domParts.resizeHandle, finalPointerPosition );
  170. // mouseMock.up();
  171. // await wait( 40 );
  172. // mouseMock.down( editor, domParts.resizeHandle );
  173. // await wait( 40 );
  174. // finalPointerPosition.pageX += 50;
  175. // mouseMock.move( editor, domParts.resizeHandle, finalPointerPosition );
  176. // mouseMock.up();
  177. // expect( resizerOptions.onCommit.callCount ).to.be.equal( 1 );
  178. // sinon.assert.calledWithExactly( resizerOptions.onCommit, '200px' );
  179. expect( true ).to.be.true;
  180. } );
  181. } );
  182. function createEditor( element, config ) {
  183. return new Promise( ( resolve, reject ) => {
  184. ClassicEditor
  185. .create( element, Object.assign( {
  186. plugins: [
  187. ArticlePluginSet, WidgetResize, simpleWidgetPlugin
  188. ]
  189. }, config ) )
  190. .then( newEditor => {
  191. resolve( newEditor );
  192. } )
  193. .catch( reject );
  194. } );
  195. function simpleWidgetPlugin( editor ) {
  196. editor.model.schema.register( 'widget', {
  197. inheritAllFrom: '$block',
  198. isObject: true
  199. } );
  200. editor.conversion.for( 'downcast' )
  201. .elementToElement( {
  202. model: 'widget',
  203. view: ( modelItem, viewWriter ) => {
  204. const div = viewWriter.createContainerElement( 'div' );
  205. viewWriter.setStyle( 'height', '100px', div );
  206. viewWriter.setStyle( 'width', '100px', div );
  207. viewWriter.setStyle( 'position', 'absolute', div );
  208. viewWriter.setStyle( 'top', '10px', div );
  209. viewWriter.setStyle( 'bottom', '10px', div );
  210. return toWidget( div, viewWriter, {
  211. label: 'element label'
  212. } );
  213. }
  214. } );
  215. }
  216. }
  217. function createEditorElement() {
  218. const element = document.createElement( 'div' );
  219. document.body.appendChild( element );
  220. return element;
  221. }
  222. function fireMouseEvent( target, eventType, eventData ) {
  223. // Id of the left mouse button.
  224. const MOUSE_BUTTON_MAIN = 0;
  225. // Using initMouseEvent instead of MouseEvent constructor, as MouseEvent constructor doesn't support passing pageX
  226. // and pageY. See https://stackoverflow.com/questions/45843458/setting-click-events-pagex-and-pagey-always-reverts-to-0
  227. // However there's still a problem, that events created with `initMouseEvent` have **floored** pageX, pageY numbers.
  228. const event = document.createEvent( 'MouseEvent' );
  229. event.initMouseEvent( eventType, true, true, window, null, 0, 0, eventData.pageX, eventData.pageY, false, false, false, false,
  230. MOUSE_BUTTON_MAIN, null );
  231. target.dispatchEvent( event );
  232. }
  233. function getWidgetDomParts( widget, resizerPosition, localView ) {
  234. const resizeWrapper = ( localView || view ).domConverter.mapViewToDom( widget.getChild( 0 ) );
  235. return {
  236. resizeWrapper,
  237. resizeHandle: resizeWrapper.querySelector( `.ck-widget__resizer__handle-${ resizerPosition }` ),
  238. widget: view.domConverter.mapViewToDom( widget )
  239. };
  240. }
  241. function getElementCenterPoint( domWrapper, cornerPosition ) {
  242. const wrapperRect = new Rect( domWrapper );
  243. const initialPointerPosition = {
  244. pageX: wrapperRect.left,
  245. pageY: wrapperRect.top
  246. };
  247. const cornerPositionParts = cornerPosition.split( '-' );
  248. if ( cornerPositionParts.includes( 'right' ) ) {
  249. initialPointerPosition.pageX = wrapperRect.right;
  250. }
  251. if ( cornerPositionParts.includes( 'bottom' ) ) {
  252. initialPointerPosition.pageY = wrapperRect.bottom;
  253. }
  254. return initialPointerPosition;
  255. }
  256. function focusEditor( editor ) {
  257. editor.editing.view.focus();
  258. editor.ui.focusTracker.isFocused = true;
  259. }
  260. function wait( delay ) {
  261. return new Promise( resolve => window.setTimeout( () => resolve(), delay ) );
  262. }
  263. } );