widget.js 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388
  1. /**
  2. * @license Copyright (c) 2003-2016, CKSource - Frederico Knabben. All rights reserved.
  3. * For licensing, see LICENSE.md.
  4. */
  5. import VirtualTestEditor from 'tests/core/_utils/virtualtesteditor.js';
  6. import Widget from 'ckeditor5/image/widget/widget.js';
  7. import MouseObserver from 'ckeditor5/engine/view/observer/mouseobserver.js';
  8. import buildModelConverter from 'ckeditor5/engine/conversion/buildmodelconverter.js';
  9. import { widgetize } from 'ckeditor5/image/widget/utils.js';
  10. import ViewContainer from 'ckeditor5/engine/view/containerelement.js';
  11. import DomEventData from 'ckeditor5/engine/view/observer/domeventdata.js';
  12. import AttributeContainer from 'ckeditor5/engine/view/attributeelement.js';
  13. import { setData as setModelData, getData as getModelData } from 'ckeditor5/engine/dev-utils/model.js';
  14. import { keyCodes } from 'ckeditor5/utils/keyboard.js';
  15. describe( 'Widget', () => {
  16. let editor, document, viewDocument;
  17. beforeEach( () => {
  18. return VirtualTestEditor.create( {
  19. plugins: [ Widget ]
  20. } )
  21. .then( newEditor => {
  22. editor = newEditor;
  23. document = editor.document;
  24. viewDocument = editor.editing.view;
  25. document.schema.registerItem( 'widget', '$block' );
  26. document.schema.objects.add( 'widget' );
  27. document.schema.registerItem( 'paragraph', '$block' );
  28. document.schema.registerItem( 'inline', '$inline' );
  29. document.schema.objects.add( 'inline' );
  30. buildModelConverter().for( editor.editing.modelToView )
  31. .fromElement( 'paragraph' )
  32. .toElement( 'p' );
  33. buildModelConverter().for( editor.editing.modelToView )
  34. .fromElement( 'widget' )
  35. .toElement( () => {
  36. const b = new AttributeContainer( 'b' );
  37. const div = new ViewContainer( 'div', null, b );
  38. return widgetize( div );
  39. } );
  40. buildModelConverter().for( editor.editing.modelToView )
  41. .fromElement( 'inline' )
  42. .toElement( 'figure' );
  43. } );
  44. } );
  45. it( 'should be loaded', () => {
  46. expect( editor.plugins.get( Widget ) ).to.be.instanceOf( Widget );
  47. } );
  48. it( 'should add MouseObserver', () => {
  49. expect( editor.editing.view.getObserver( MouseObserver ) ).to.be.instanceof( MouseObserver );
  50. } );
  51. it( 'should create selection over clicked widget', () => {
  52. setModelData( document, '[]<widget></widget>' );
  53. const viewDiv = viewDocument.getRoot().getChild( 0 );
  54. const domEventDataMock = {
  55. target: viewDiv,
  56. preventDefault: sinon.spy()
  57. };
  58. viewDocument.fire( 'mousedown', domEventDataMock );
  59. expect( getModelData( document ) ).to.equal( '[<widget></widget>]' );
  60. sinon.assert.calledOnce( domEventDataMock.preventDefault );
  61. } );
  62. it( 'should create selection when clicked in nested element', () => {
  63. setModelData( document, '[]<widget></widget>' );
  64. const viewDiv = viewDocument.getRoot().getChild( 0 );
  65. const viewB = viewDiv.getChild( 0 );
  66. const domEventDataMock = {
  67. target: viewB,
  68. preventDefault: sinon.spy()
  69. };
  70. viewDocument.fire( 'mousedown', domEventDataMock );
  71. expect( getModelData( document ) ).to.equal( '[<widget></widget>]' );
  72. sinon.assert.calledOnce( domEventDataMock.preventDefault );
  73. } );
  74. it( 'should do nothing if clicked in non-widget element', () => {
  75. setModelData( document, '<paragraph>[]foo bar</paragraph><widget></widget>' );
  76. const viewP = viewDocument.getRoot().getChild( 0 );
  77. const domEventDataMock = {
  78. target: viewP,
  79. preventDefault: sinon.spy()
  80. };
  81. viewDocument.focus();
  82. viewDocument.fire( 'mousedown', domEventDataMock );
  83. expect( getModelData( document ) ).to.equal( '<paragraph>[]foo bar</paragraph><widget></widget>' );
  84. sinon.assert.notCalled( domEventDataMock.preventDefault );
  85. } );
  86. it( 'should not focus editable if already is focused', () => {
  87. setModelData( document, '<widget></widget>' );
  88. const widget = viewDocument.getRoot().getChild( 0 );
  89. const domEventDataMock = {
  90. target: widget,
  91. preventDefault: sinon.spy()
  92. };
  93. const focusSpy = sinon.spy( viewDocument, 'focus' );
  94. viewDocument.isFocused = true;
  95. viewDocument.fire( 'mousedown', domEventDataMock );
  96. sinon.assert.calledOnce( domEventDataMock.preventDefault );
  97. sinon.assert.notCalled( focusSpy );
  98. expect( getModelData( document ) ).to.equal( '[<widget></widget>]' );
  99. } );
  100. describe( 'delete and backspace handling', () => {
  101. test(
  102. 'should select widget when backspace is pressed',
  103. '<widget></widget><paragraph>[]foo</paragraph>',
  104. keyCodes.backspace,
  105. '[<widget></widget>]<paragraph>foo</paragraph>'
  106. );
  107. test(
  108. 'should remove empty element after selecting widget when backspace is pressed',
  109. '<widget></widget><paragraph>[]</paragraph>',
  110. keyCodes.backspace,
  111. '[<widget></widget>]'
  112. );
  113. test(
  114. 'should select widget when delete is pressed',
  115. '<paragraph>foo[]</paragraph><widget></widget>',
  116. keyCodes.delete,
  117. '<paragraph>foo</paragraph>[<widget></widget>]'
  118. );
  119. test(
  120. 'should remove empty element after selecting widget when delete is pressed',
  121. '<paragraph>[]</paragraph><widget></widget>',
  122. keyCodes.delete,
  123. '[<widget></widget>]'
  124. );
  125. test(
  126. 'should not respond to other keys',
  127. '<widget></widget><paragraph>[]foo</paragraph>',
  128. 65,
  129. '<widget></widget><paragraph>[]foo</paragraph>'
  130. );
  131. test(
  132. 'should do nothing on non-collapsed selection',
  133. '<widget></widget><paragraph>[f]oo</paragraph>',
  134. keyCodes.backspace,
  135. '<widget></widget><paragraph>[f]oo</paragraph>'
  136. );
  137. test(
  138. 'should do nothing on non-object elements',
  139. '<paragraph>foo</paragraph><paragraph>[]bar</paragraph>',
  140. keyCodes.backspace,
  141. '<paragraph>foo</paragraph><paragraph>[]bar</paragraph>'
  142. );
  143. test(
  144. 'should work correctly with modifier key: backspace + ctrl',
  145. '<widget></widget><paragraph>[]foo</paragraph>',
  146. { keyCode: keyCodes.backspace, ctrlKey: true, preventDefault: () => {} },
  147. '[<widget></widget>]<paragraph>foo</paragraph>'
  148. );
  149. test(
  150. 'should work correctly with modifier key: backspace + alt',
  151. '<widget></widget><paragraph>[]foo</paragraph>',
  152. { keyCode: keyCodes.backspace, altKey: true, preventDefault: () => {} },
  153. '[<widget></widget>]<paragraph>foo</paragraph>'
  154. );
  155. test(
  156. 'should work correctly with modifier key: backspace + shift',
  157. '<widget></widget><paragraph>[]foo</paragraph>',
  158. { keyCode: keyCodes.backspace, shiftKey: true, preventDefault: () => {} },
  159. '[<widget></widget>]<paragraph>foo</paragraph>'
  160. );
  161. test(
  162. 'should work correctly with modifier key: delete + ctrl',
  163. '<paragraph>foo[]</paragraph><widget></widget>',
  164. { keyCode: keyCodes.delete, ctrlKey: true, preventDefault: () => {} },
  165. '<paragraph>foo</paragraph>[<widget></widget>]'
  166. );
  167. test(
  168. 'should work correctly with modifier key: delete + alt',
  169. '<paragraph>foo[]</paragraph><widget></widget>',
  170. { keyCode: keyCodes.delete, altKey: true, preventDefault: () => {} },
  171. '<paragraph>foo</paragraph>[<widget></widget>]'
  172. );
  173. test(
  174. 'should work correctly with modifier key: delete + shift',
  175. '<paragraph>foo[]</paragraph><widget></widget>',
  176. { keyCode: keyCodes.delete, shiftKey: true, preventDefault: () => {} },
  177. '<paragraph>foo</paragraph>[<widget></widget>]'
  178. );
  179. test(
  180. 'should not modify backspace default behaviour in single paragraph boundaries',
  181. '<paragraph>[]foo</paragraph>',
  182. keyCodes.backspace,
  183. '<paragraph>[]foo</paragraph>'
  184. );
  185. test(
  186. 'should not modify delete default behaviour in single paragraph boundaries',
  187. '<paragraph>foo[]</paragraph>',
  188. keyCodes.delete,
  189. '<paragraph>foo[]</paragraph>'
  190. );
  191. test(
  192. 'should do nothing on selected widget preceded by a paragraph - backspace',
  193. '<paragraph>foo</paragraph>[<widget></widget>]',
  194. keyCodes.backspace,
  195. '<paragraph>foo</paragraph>[<widget></widget>]'
  196. );
  197. test(
  198. 'should do nothing on selected widget preceded by another widget - backspace',
  199. '<widget></widget>[<widget></widget>]',
  200. keyCodes.backspace,
  201. '<widget></widget>[<widget></widget>]'
  202. );
  203. test(
  204. 'should do nothing on selected widget before paragraph - backspace',
  205. '[<widget></widget>]<paragraph>foo</paragraph>',
  206. keyCodes.backspace,
  207. '[<widget></widget>]<paragraph>foo</paragraph>'
  208. );
  209. test(
  210. 'should do nothing on selected widget before another widget - backspace',
  211. '[<widget></widget>]<widget></widget>',
  212. keyCodes.backspace,
  213. '[<widget></widget>]<widget></widget>'
  214. );
  215. test(
  216. 'should do nothing on selected widget between paragraphs - backspace',
  217. '<paragraph>bar</paragraph>[<widget></widget>]<paragraph>foo</paragraph>',
  218. keyCodes.backspace,
  219. '<paragraph>bar</paragraph>[<widget></widget>]<paragraph>foo</paragraph>'
  220. );
  221. test(
  222. 'should do nothing on selected widget between other widgets - backspace',
  223. '<widget></widget>[<widget></widget>]<widget></widget>',
  224. keyCodes.backspace,
  225. '<widget></widget>[<widget></widget>]<widget></widget>'
  226. );
  227. test(
  228. 'should do nothing on selected widget preceded by a paragraph - delete',
  229. '<paragraph>foo</paragraph>[<widget></widget>]',
  230. keyCodes.delete,
  231. '<paragraph>foo</paragraph>[<widget></widget>]'
  232. );
  233. test(
  234. 'should do nothing on selected widget preceded by another widget - delete',
  235. '<widget></widget>[<widget></widget>]',
  236. keyCodes.delete,
  237. '<widget></widget>[<widget></widget>]'
  238. );
  239. test(
  240. 'should do nothing on selected widget before paragraph - delete',
  241. '[<widget></widget>]<paragraph>foo</paragraph>',
  242. keyCodes.delete,
  243. '[<widget></widget>]<paragraph>foo</paragraph>'
  244. );
  245. test(
  246. 'should do nothing on selected widget before another widget - delete',
  247. '[<widget></widget>]<widget></widget>',
  248. keyCodes.delete,
  249. '[<widget></widget>]<widget></widget>'
  250. );
  251. test(
  252. 'should do nothing on selected widget between paragraphs - delete',
  253. '<paragraph>bar</paragraph>[<widget></widget>]<paragraph>foo</paragraph>',
  254. keyCodes.delete,
  255. '<paragraph>bar</paragraph>[<widget></widget>]<paragraph>foo</paragraph>'
  256. );
  257. test(
  258. 'should do nothing on selected widget between other widgets - delete',
  259. '<widget></widget>[<widget></widget>]<widget></widget>',
  260. keyCodes.delete,
  261. '<widget></widget>[<widget></widget>]<widget></widget>'
  262. );
  263. test(
  264. 'should select inline objects - backspace',
  265. '<paragraph>foo<inline></inline>[]bar</paragraph>',
  266. keyCodes.backspace,
  267. '<paragraph>foo[<inline></inline>]bar</paragraph>'
  268. );
  269. test(
  270. 'should select inline objects - delete',
  271. '<paragraph>foo[]<inline></inline>bar</paragraph>',
  272. keyCodes.delete,
  273. '<paragraph>foo[<inline></inline>]bar</paragraph>'
  274. );
  275. test(
  276. 'should do nothing on selected inline objects - backspace',
  277. '<paragraph>foo[<inline></inline>]bar</paragraph>',
  278. keyCodes.backspace,
  279. '<paragraph>foo[<inline></inline>]bar</paragraph>'
  280. );
  281. test(
  282. 'should do nothing on selected inline objects - delete',
  283. '<paragraph>foo[<inline></inline>]bar</paragraph>',
  284. keyCodes.delete,
  285. '<paragraph>foo[<inline></inline>]bar</paragraph>'
  286. );
  287. test(
  288. 'should do nothing if selection is placed after first letter - backspace',
  289. '<paragraph>a[]</paragraph>',
  290. keyCodes.backspace,
  291. '<paragraph>a[]</paragraph>'
  292. );
  293. test(
  294. 'should do nothing if selection is placed before first letter - delete',
  295. '<paragraph>[]a</paragraph>',
  296. keyCodes.delete,
  297. '<paragraph>[]a</paragraph>'
  298. );
  299. it( 'should prevent default behaviour and stop event propagation', () => {
  300. const keydownHandler = sinon.spy();
  301. const domEventDataMock = {
  302. keyCode: keyCodes.delete,
  303. preventDefault: sinon.spy(),
  304. };
  305. setModelData( document, '<paragraph>foo[]</paragraph><widget></widget>' );
  306. viewDocument.on( 'keydown', keydownHandler );
  307. viewDocument.fire( 'keydown', domEventDataMock );
  308. expect( getModelData( document ) ).to.equal( '<paragraph>foo</paragraph>[<widget></widget>]' );
  309. sinon.assert.calledOnce( domEventDataMock.preventDefault );
  310. sinon.assert.notCalled( keydownHandler );
  311. } );
  312. function test( name, data, keyCodeOrMock, expected ) {
  313. it( name, () => {
  314. const domEventDataMock = ( typeof keyCodeOrMock == 'object' ) ? keyCodeOrMock : {
  315. keyCode: keyCodeOrMock
  316. };
  317. setModelData( document, data );
  318. viewDocument.fire( 'keydown', new DomEventData(
  319. viewDocument,
  320. { target: null, preventDefault: () => {} },
  321. domEventDataMock
  322. ) );
  323. expect( getModelData( document ) ).to.equal( expected );
  324. } );
  325. }
  326. } );
  327. } );