imageresizehandles.js 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442
  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. /* global document */
  6. // ClassicTestEditor can't be used, as it doesn't handle the focus, which is needed to test resizer visual cues.
  7. import ClassicEditor from '@ckeditor/ckeditor5-editor-classic/src/classiceditor';
  8. import Image from '../../src/image';
  9. import ImageToolbar from '../../src/imagetoolbar';
  10. import ImageResizeEditing from '../../src/imageresize/imageresizeediting';
  11. import ImageResizeHandles from '../../src/imageresize/imageresizehandles';
  12. import ImageTextAlternative from '../../src/imagetextalternative';
  13. import Paragraph from '@ckeditor/ckeditor5-paragraph/src/paragraph';
  14. import ImageStyle from '../../src/imagestyle';
  15. import Undo from '@ckeditor/ckeditor5-undo/src/undo';
  16. import Table from '@ckeditor/ckeditor5-table/src/table';
  17. import Rect from '@ckeditor/ckeditor5-utils/src/dom/rect';
  18. import { setData } from '@ckeditor/ckeditor5-engine/src/dev-utils/model';
  19. import {
  20. focusEditor,
  21. resizerMouseSimulator,
  22. getWidgetDomParts,
  23. getHandleCenterPoint
  24. } from '@ckeditor/ckeditor5-widget/tests/widgetresize/_utils/utils';
  25. import WidgetResize from '@ckeditor/ckeditor5-widget/src/widgetresize';
  26. describe( 'ImageResizeHandles', () => {
  27. // 100x50 black png image
  28. const IMAGE_SRC_FIXTURE = 'data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAGQAAAAyCAQAAAAAPLY1AAAAQklEQVR42u3PQREAAAgDoK1/' +
  29. 'aM3g14MGNJMXKiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiJysRFNMgH0RpujAAAAAElFTkSuQmCC';
  30. let absoluteContainer, widget, editor, view, viewDocument, editorElement;
  31. before( () => {
  32. // This container is required to position editor element in a reliable element.
  33. // @todo ensure whether it's required after migrating the tests.
  34. absoluteContainer = document.createElement( 'div' );
  35. absoluteContainer.style.top = '50px';
  36. absoluteContainer.style.left = '50px';
  37. absoluteContainer.style.height = '1000px';
  38. absoluteContainer.style.width = '500px';
  39. absoluteContainer.style.position = 'absolute';
  40. document.body.appendChild( absoluteContainer );
  41. } );
  42. after( () => {
  43. absoluteContainer.remove();
  44. } );
  45. beforeEach( () => createEditor() );
  46. afterEach( () => {
  47. const wrappers = Array.from( document.querySelectorAll( '.ck-body-wrapper' ) );
  48. // We need to remove all leftovers manually.
  49. for ( const wrapper of wrappers ) {
  50. wrapper.remove();
  51. }
  52. if ( editorElement ) {
  53. editorElement.remove();
  54. }
  55. if ( editor ) {
  56. editor.destroy();
  57. }
  58. } );
  59. it( 'should be named', () => {
  60. expect( ImageResizeHandles.pluginName ).to.equal( 'ImageResizeHandles' );
  61. } );
  62. it( 'uses percents by default', async () => {
  63. const localEditor = await createEditor( {
  64. plugins: [ Image, ImageResizeEditing, ImageResizeHandles ]
  65. } );
  66. const attachToSpy = sinon.spy( localEditor.plugins.get( WidgetResize ), 'attachTo' );
  67. setData( localEditor.model, `[<image imageStyle="side" src="${ IMAGE_SRC_FIXTURE }"></image>]` );
  68. expect( attachToSpy.args[ 0 ][ 0 ] ).to.have.a.property( 'unit', '%' );
  69. attachToSpy.restore();
  70. } );
  71. describe( 'command', () => {
  72. it( 'uses the command on commit', () => {
  73. const spy = sinon.spy( editor.commands.get( 'imageResize' ), 'execute' );
  74. setData( editor.model, `<paragraph>foo</paragraph>[<image src="${ IMAGE_SRC_FIXTURE }"></image>]` );
  75. widget = viewDocument.getRoot().getChild( 1 );
  76. const domParts = getWidgetDomParts( editor, widget, 'bottom-left' );
  77. const finalPointerPosition = getHandleCenterPoint( domParts.widget, 'bottom-left' ).moveBy( 10, -10 );
  78. resizerMouseSimulator.dragTo( editor, domParts.resizeHandle, finalPointerPosition );
  79. expect( spy.calledOnce ).to.be.true;
  80. expect( spy.args[ 0 ][ 0 ] ).to.deep.equal( { width: '80px' } );
  81. } );
  82. it( 'disables the resizer if the command is disabled', () => {
  83. setData( editor.model, `<paragraph>foo</paragraph>[<image src="${ IMAGE_SRC_FIXTURE }"></image>]` );
  84. const resizer = getSelectedImageResizer( editor );
  85. let isEnabled = false;
  86. editor.commands.get( 'imageResize' ).on( 'set:isEnabled', evt => {
  87. evt.return = isEnabled;
  88. evt.stop();
  89. }, { priority: 'highest' } );
  90. editor.commands.get( 'imageResize' ).refresh();
  91. expect( resizer.isEnabled ).to.be.false;
  92. isEnabled = true;
  93. editor.commands.get( 'imageResize' ).refresh();
  94. expect( resizer.isEnabled ).to.be.true;
  95. } );
  96. it( 'the resizer is disabled from the beginning when the command is disabled when the image is inserted', () => {
  97. setData( editor.model, '<paragraph>foo[]</paragraph>' );
  98. editor.commands.get( 'imageResize' ).on( 'set:isEnabled', evt => {
  99. evt.return = false;
  100. evt.stop();
  101. }, { priority: 'highest' } );
  102. editor.commands.get( 'imageResize' ).refresh();
  103. editor.model.change( writer => {
  104. editor.model.insertContent( writer.createElement( 'image', { src: IMAGE_SRC_FIXTURE } ) );
  105. } );
  106. const resizer = getSelectedImageResizer( editor );
  107. const resizerWrapper = editor.ui.getEditableElement().querySelector( '.ck-widget__resizer' );
  108. expect( resizer.isEnabled ).to.be.false;
  109. expect( resizerWrapper.style.display ).to.equal( 'none' );
  110. } );
  111. } );
  112. describe( 'side image resizing', () => {
  113. beforeEach( async () => {
  114. await createEditor();
  115. setData( editor.model, `<paragraph>foo</paragraph>[<image imageStyle="side" src="${ IMAGE_SRC_FIXTURE }"></image>]` );
  116. widget = viewDocument.getRoot().getChild( 1 );
  117. } );
  118. it( 'doesn\'t flicker at the beginning of the resize', async () => {
  119. // (#5189)
  120. const resizerPosition = 'bottom-left';
  121. const domParts = getWidgetDomParts( editor, widget, resizerPosition );
  122. const initialPointerPosition = getHandleCenterPoint( domParts.widget, resizerPosition );
  123. const resizeWrapperView = widget.getChild( 2 );
  124. resizerMouseSimulator.down( editor, domParts.resizeHandle );
  125. resizerMouseSimulator.move( editor, domParts.resizeHandle, null, initialPointerPosition );
  126. expect( resizeWrapperView.getStyle( 'width' ) ).to.equal( '100px' );
  127. resizerMouseSimulator.up( editor );
  128. } );
  129. it( 'makes no change when clicking the handle without drag', () => {
  130. const resizerPosition = 'bottom-left';
  131. const expectedWidth = 100;
  132. const domParts = getWidgetDomParts( editor, widget, resizerPosition );
  133. resizerMouseSimulator.down( editor, domParts.resizeHandle );
  134. expect( getDomWidth( domParts.widget ), 'DOM width check' ).to.be.closeTo( expectedWidth, 2 );
  135. resizerMouseSimulator.up( editor );
  136. const modelItem = editor.model.document.getRoot().getChild( 1 );
  137. expect( modelItem.getAttribute( 'width' ), 'model width attribute' ).to.be.undefined;
  138. } );
  139. } );
  140. describe( 'undo integration', () => {
  141. beforeEach( async () => {
  142. await createEditor();
  143. setData( editor.model, `<paragraph>foo</paragraph>[<image src="${ IMAGE_SRC_FIXTURE }"></image>]` );
  144. widget = viewDocument.getRoot().getChild( 1 );
  145. } );
  146. it( 'has correct border size after undo', async () => {
  147. const domParts = getWidgetDomParts( editor, widget, 'bottom-left' );
  148. const initialPosition = getHandleCenterPoint( domParts.widget, 'bottom-left' );
  149. const finalPointerPosition = initialPosition.clone().moveBy( 0, 10 );
  150. const plugin = editor.plugins.get( 'WidgetResize' );
  151. resizerMouseSimulator.dragTo( editor, domParts.resizeHandle, {
  152. from: initialPosition,
  153. to: finalPointerPosition
  154. } );
  155. expect( '120px' ).to.equal( domParts.widget.style.width );
  156. editor.commands.get( 'undo' ).execute();
  157. // Toggle _visibleResizer to force synchronous redraw. Otherwise you'd need to wait ~200ms for
  158. // throttled redraw to take place, making tests slower.
  159. const visibleResizer = plugin._visibleResizer;
  160. plugin._visibleResizer = null;
  161. plugin._visibleResizer = visibleResizer;
  162. const resizerWrapper = document.querySelector( '.ck-widget__resizer' );
  163. const shadowBoundingRect = resizerWrapper.getBoundingClientRect();
  164. expect( shadowBoundingRect.width ).to.equal( 100 );
  165. expect( shadowBoundingRect.height ).to.equal( 50 );
  166. } );
  167. } );
  168. describe( 'table integration', () => {
  169. beforeEach( () => createEditor() );
  170. it( 'works when resizing in a table', () => {
  171. setData( editor.model,
  172. '<table>' +
  173. `<tableRow><tableCell>[<image src="${ IMAGE_SRC_FIXTURE }"></image>]</tableCell></tableRow>` +
  174. '</table>'
  175. );
  176. widget = viewDocument.getRoot().getChild( 0 ).getChild( 1 ).getChild( 0 ).getChild( 0 ).getChild( 0 ).getChild( 0 );
  177. const model = editor.model.document.getRoot().getChild( 0 ).getChild( 0 ).getChild( 0 ).getChild( 0 );
  178. const domParts = getWidgetDomParts( editor, widget, 'bottom-right' );
  179. const initialPosition = getHandleCenterPoint( domParts.widget, 'bottom-right' );
  180. const finalPointerPosition = initialPosition.clone().moveBy( -40, -20 );
  181. resizerMouseSimulator.dragTo( editor, domParts.resizeHandle, {
  182. from: initialPosition,
  183. to: finalPointerPosition
  184. } );
  185. expect( model.getAttribute( 'width' ) ).to.equal( '60px' );
  186. } );
  187. } );
  188. describe( 'srcset integration', () => {
  189. // The image is 96x96 pixels.
  190. const imageBaseUrl = '/assets/sample.png';
  191. let model;
  192. let images = [];
  193. before( async () => {
  194. images = await Promise.all( [
  195. preloadImage( imageBaseUrl ),
  196. preloadImage( imageBaseUrl + '?a' ),
  197. preloadImage( imageBaseUrl + '?b' ),
  198. preloadImage( imageBaseUrl + '?c' )
  199. ] );
  200. } );
  201. after( () => {
  202. for ( const image of images ) {
  203. image.remove();
  204. }
  205. } );
  206. beforeEach( async () => {
  207. await createEditor();
  208. editor.setData(
  209. `<figure class="image">
  210. <img src="${ imageBaseUrl }"
  211. srcset="${ imageBaseUrl }?a 110w,
  212. ${ imageBaseUrl }?b 440w,
  213. ${ imageBaseUrl }?c 1025w"
  214. sizes="100vw" width="96">
  215. </figure>`
  216. );
  217. widget = viewDocument.getRoot().getChild( 0 );
  218. model = editor.model.document.getRoot().getChild( 0 );
  219. } );
  220. it( 'works with images containing srcset', () => {
  221. const domParts = getWidgetDomParts( editor, widget, 'bottom-right' );
  222. const initialPosition = getHandleCenterPoint( domParts.widget, 'bottom-right' );
  223. const finalPointerPosition = initialPosition.clone().moveBy( -20, -20 );
  224. resizerMouseSimulator.dragTo( editor, domParts.resizeHandle, {
  225. from: initialPosition,
  226. to: finalPointerPosition
  227. } );
  228. expect( model.getAttribute( 'width' ) ).to.equal( '76px' );
  229. } );
  230. it( 'retains width after removing srcset', () => {
  231. const domParts = getWidgetDomParts( editor, widget, 'bottom-right' );
  232. const initialPosition = getHandleCenterPoint( domParts.widget, 'bottom-right' );
  233. const finalPointerPosition = initialPosition.clone().moveBy( -16, -16 );
  234. resizerMouseSimulator.dragTo( editor, domParts.resizeHandle, {
  235. from: initialPosition,
  236. to: finalPointerPosition
  237. } );
  238. editor.model.change( writer => {
  239. writer.removeAttribute( 'srcset', model );
  240. } );
  241. const expectedHtml = '<figure class="image image_resized" style="width:80px;"><img src="/assets/sample.png"></figure>';
  242. expect( editor.getData() ).to.equal( expectedHtml );
  243. } );
  244. async function preloadImage( imageUrl ) {
  245. const image = document.createElement( 'img' );
  246. image.src = imageUrl;
  247. return new Promise( ( resolve, reject ) => {
  248. image.addEventListener( 'load', () => resolve( image ) );
  249. image.addEventListener( 'error', () => reject( image ) );
  250. document.body.appendChild( image );
  251. } );
  252. }
  253. } );
  254. describe( 'widget toolbar integration', () => {
  255. let widgetToolbarRepository;
  256. beforeEach( async () => {
  257. await createEditor( {
  258. plugins: [
  259. Paragraph,
  260. Image,
  261. ImageResizeEditing,
  262. ImageResizeHandles,
  263. ImageToolbar,
  264. ImageTextAlternative
  265. ],
  266. image: {
  267. toolbar: [ 'imageTextAlternative' ],
  268. resizeUnit: 'px'
  269. }
  270. } );
  271. setData( editor.model, `<paragraph>foo</paragraph>[<image src="${ IMAGE_SRC_FIXTURE }"></image>]` );
  272. widget = viewDocument.getRoot().getChild( 1 );
  273. widgetToolbarRepository = editor.plugins.get( 'WidgetToolbarRepository' );
  274. } );
  275. it( 'default toolbar visibility', async () => {
  276. expect( widgetToolbarRepository.isEnabled ).to.be.true;
  277. } );
  278. it( 'visibility during the resize', async () => {
  279. const domResizeHandle = getWidgetDomParts( editor, widget, 'bottom-left' ).resizeHandle;
  280. resizerMouseSimulator.down( editor, domResizeHandle );
  281. expect( widgetToolbarRepository.isEnabled ).to.be.false;
  282. resizerMouseSimulator.up( editor, domResizeHandle );
  283. } );
  284. it( 'visibility after the resize', async () => {
  285. const domResizeHandle = getWidgetDomParts( editor, widget, 'bottom-left' ).resizeHandle;
  286. resizerMouseSimulator.down( editor, domResizeHandle );
  287. resizerMouseSimulator.up( editor, domResizeHandle );
  288. expect( widgetToolbarRepository.isEnabled ).to.be.true;
  289. } );
  290. it( 'visibility after the resize was canceled', async () => {
  291. const resizer = getSelectedImageResizer( editor );
  292. const domResizeHandle = getWidgetDomParts( editor, widget, 'bottom-left' ).resizeHandle;
  293. resizerMouseSimulator.down( editor, domResizeHandle );
  294. resizer.cancel();
  295. expect( widgetToolbarRepository.isEnabled ).to.be.true;
  296. } );
  297. it( 'restores toolbar when clicking the handle without drag', () => {
  298. // (https://github.com/ckeditor/ckeditor5-widget/pull/112#pullrequestreview-337725256).
  299. const domResizeHandle = getWidgetDomParts( editor, widget, 'bottom-left' ).resizeHandle;
  300. resizerMouseSimulator.down( editor, domResizeHandle );
  301. resizerMouseSimulator.up( editor, domResizeHandle );
  302. expect( widgetToolbarRepository.isEnabled ).to.be.true;
  303. } );
  304. } );
  305. function getDomWidth( domElement ) {
  306. return new Rect( domElement ).width;
  307. }
  308. function getSelectedImageResizer( editor ) {
  309. return editor.plugins.get( 'WidgetResize' )._getResizerByViewElement(
  310. editor.editing.view.document.selection.getSelectedElement()
  311. );
  312. }
  313. function createEditor( config ) {
  314. editorElement = document.createElement( 'div' );
  315. absoluteContainer.appendChild( editorElement );
  316. return ClassicEditor
  317. .create( editorElement, config || {
  318. plugins: [ Image, ImageStyle, Paragraph, Undo, Table, ImageResizeEditing, ImageResizeHandles ],
  319. image: {
  320. resizeUnit: 'px'
  321. }
  322. } )
  323. .then( newEditor => {
  324. editor = newEditor;
  325. view = editor.editing.view;
  326. viewDocument = view.document;
  327. widget = viewDocument.getRoot().getChild( 1 );
  328. focusEditor( editor );
  329. return newEditor;
  330. } );
  331. }
  332. } );