widgetresize.js 9.5 KB

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