widget.js 33 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118
  1. /**
  2. * @license Copyright (c) 2003-2018, CKSource - Frederico Knabben. All rights reserved.
  3. * For licensing, see LICENSE.md.
  4. */
  5. import VirtualTestEditor from '@ckeditor/ckeditor5-core/tests/_utils/virtualtesteditor';
  6. import Widget from '../src/widget';
  7. import Typing from '@ckeditor/ckeditor5-typing/src/typing';
  8. import MouseObserver from '@ckeditor/ckeditor5-engine/src/view/observer/mouseobserver';
  9. import { downcastElementToElement } from '@ckeditor/ckeditor5-engine/src/conversion/downcast-converters';
  10. import { toWidget } from '../src/utils';
  11. import DomEventData from '@ckeditor/ckeditor5-engine/src/view/observer/domeventdata';
  12. import ViewPosition from '@ckeditor/ckeditor5-engine/src/view/position';
  13. import { setData as setModelData, getData as getModelData } from '@ckeditor/ckeditor5-engine/src/dev-utils/model';
  14. import { getData as getViewData } from '@ckeditor/ckeditor5-engine/src/dev-utils/view';
  15. import { keyCodes } from '@ckeditor/ckeditor5-utils/src/keyboard';
  16. /* global document */
  17. describe( 'Widget', () => {
  18. let editor, model, view, viewDocument;
  19. beforeEach( () => {
  20. return VirtualTestEditor.create( { plugins: [ Widget, Typing ] } )
  21. .then( newEditor => {
  22. editor = newEditor;
  23. model = editor.model;
  24. view = editor.editing.view;
  25. viewDocument = view.document;
  26. model.schema.register( 'widget', {
  27. inheritAllFrom: '$block',
  28. isObject: true
  29. } );
  30. model.schema.register( 'paragraph', {
  31. inheritAllFrom: '$block',
  32. allowIn: 'div'
  33. } );
  34. model.schema.register( 'inline', {
  35. allowWhere: '$text',
  36. isObject: true
  37. } );
  38. model.schema.register( 'nested', {
  39. allowIn: 'widget',
  40. isLimit: true
  41. } );
  42. model.schema.extend( '$text', {
  43. allowIn: [ 'nested', 'editable' ]
  44. } );
  45. model.schema.register( 'editable', {
  46. allowIn: [ 'widget', '$root' ]
  47. } );
  48. // Image feature.
  49. model.schema.register( 'image', {
  50. allowIn: '$root',
  51. isObject: true,
  52. isBlock: true
  53. } );
  54. // Block-quote feature.
  55. model.schema.register( 'blockQuote', {
  56. allowIn: '$root'
  57. } );
  58. model.schema.extend( '$block', { allowIn: 'blockQuote' } );
  59. // Div element which helps nesting elements.
  60. model.schema.register( 'div', {
  61. allowIn: [ 'blockQuote', 'div' ]
  62. } );
  63. editor.conversion.for( 'downcast' )
  64. .add( downcastElementToElement( { model: 'paragraph', view: 'p' } ) )
  65. .add( downcastElementToElement( { model: 'inline', view: 'figure' } ) )
  66. .add( downcastElementToElement( { model: 'image', view: 'img' } ) )
  67. .add( downcastElementToElement( { model: 'blockQuote', view: 'blockquote' } ) )
  68. .add( downcastElementToElement( { model: 'div', view: 'div' } ) )
  69. .add( downcastElementToElement( {
  70. model: 'widget',
  71. view: ( modelItem, viewWriter ) => {
  72. const b = viewWriter.createAttributeElement( 'b' );
  73. const div = viewWriter.createContainerElement( 'div' );
  74. viewWriter.insert( ViewPosition.createAt( div ), b );
  75. return toWidget( div, viewWriter, { label: 'element label' } );
  76. }
  77. } ) )
  78. .add( downcastElementToElement( {
  79. model: 'nested',
  80. view: ( modelItem, viewWriter ) => viewWriter.createEditableElement( 'figcaption', { contenteditable: true } )
  81. } ) )
  82. .add( downcastElementToElement( {
  83. model: 'editable',
  84. view: ( modelItem, viewWriter ) => viewWriter.createEditableElement( 'figcaption', { contenteditable: true } )
  85. } ) );
  86. } );
  87. } );
  88. it( 'should be loaded', () => {
  89. expect( editor.plugins.get( Widget ) ).to.be.instanceOf( Widget );
  90. } );
  91. it( 'should add MouseObserver', () => {
  92. expect( view.getObserver( MouseObserver ) ).to.be.instanceof( MouseObserver );
  93. } );
  94. it( 'should create selection over clicked widget', () => {
  95. setModelData( model, '[]<widget></widget>' );
  96. const viewDiv = viewDocument.getRoot().getChild( 0 );
  97. const domEventDataMock = {
  98. target: viewDiv,
  99. preventDefault: sinon.spy()
  100. };
  101. viewDocument.fire( 'mousedown', domEventDataMock );
  102. expect( getModelData( model ) ).to.equal( '[<widget></widget>]' );
  103. sinon.assert.calledOnce( domEventDataMock.preventDefault );
  104. } );
  105. it( 'should create selection when clicked in nested element', () => {
  106. setModelData( model, '[]<widget></widget>' );
  107. const viewDiv = viewDocument.getRoot().getChild( 0 );
  108. const viewB = viewDiv.getChild( 0 );
  109. const domEventDataMock = {
  110. target: viewB,
  111. preventDefault: sinon.spy()
  112. };
  113. viewDocument.fire( 'mousedown', domEventDataMock );
  114. expect( getModelData( model ) ).to.equal( '[<widget></widget>]' );
  115. sinon.assert.calledOnce( domEventDataMock.preventDefault );
  116. } );
  117. it( 'should do nothing if clicked inside nested editable', () => {
  118. setModelData( model, '[]<widget><nested>foo bar</nested></widget>' );
  119. const viewDiv = viewDocument.getRoot().getChild( 0 );
  120. const viewFigcaption = viewDiv.getChild( 0 );
  121. const domEventDataMock = {
  122. target: viewFigcaption,
  123. preventDefault: sinon.spy()
  124. };
  125. viewDocument.fire( 'mousedown', domEventDataMock );
  126. sinon.assert.notCalled( domEventDataMock.preventDefault );
  127. } );
  128. it( 'should do nothing if clicked in non-widget element', () => {
  129. setModelData( model, '<paragraph>[]foo bar</paragraph><widget></widget>' );
  130. const viewP = viewDocument.getRoot().getChild( 0 );
  131. const domEventDataMock = {
  132. target: viewP,
  133. preventDefault: sinon.spy()
  134. };
  135. view.focus();
  136. viewDocument.fire( 'mousedown', domEventDataMock );
  137. expect( getModelData( model ) ).to.equal( '<paragraph>[]foo bar</paragraph><widget></widget>' );
  138. sinon.assert.notCalled( domEventDataMock.preventDefault );
  139. } );
  140. it( 'should not focus editable if already is focused', () => {
  141. setModelData( model, '<widget></widget>' );
  142. const widget = viewDocument.getRoot().getChild( 0 );
  143. const domEventDataMock = {
  144. target: widget,
  145. preventDefault: sinon.spy()
  146. };
  147. const focusSpy = sinon.spy( view, 'focus' );
  148. viewDocument.isFocused = true;
  149. viewDocument.fire( 'mousedown', domEventDataMock );
  150. sinon.assert.calledOnce( domEventDataMock.preventDefault );
  151. sinon.assert.notCalled( focusSpy );
  152. expect( getModelData( model ) ).to.equal( '[<widget></widget>]' );
  153. } );
  154. it( 'should apply fake view selection if model selection is on widget element', () => {
  155. setModelData( model, '[<widget>foo bar</widget>]' );
  156. expect( getViewData( view ) ).to.equal(
  157. '[<div class="ck-widget ck-widget_selected" contenteditable="false">foo bar<b></b></div>]'
  158. );
  159. expect( viewDocument.selection.isFake ).to.be.true;
  160. } );
  161. it( 'should use element\'s label to set fake selection if one is provided', () => {
  162. setModelData( model, '[<widget>foo bar</widget>]' );
  163. expect( viewDocument.selection.fakeSelectionLabel ).to.equal( 'element label' );
  164. } );
  165. it( 'should add selected class when no only a widget is selected', () => {
  166. setModelData( model, '[<paragraph>foo</paragraph><widget></widget><widget></widget>]' );
  167. expect( viewDocument.selection.isFake ).to.be.false;
  168. expect( getViewData( view ) ).to.equal(
  169. '[' +
  170. '<p>foo</p>' +
  171. '<div class="ck-widget ck-widget_selected" contenteditable="false"><b></b></div>' +
  172. '<div class="ck-widget ck-widget_selected" contenteditable="false"><b></b></div>' +
  173. ']'
  174. );
  175. } );
  176. it( 'fake selection should be empty if widget is not selected', () => {
  177. setModelData( model, '<paragraph>foo</paragraph><widget>foo bar</widget>' );
  178. expect( viewDocument.selection.fakeSelectionLabel ).to.equal( '' );
  179. } );
  180. it( 'should toggle selected class', () => {
  181. setModelData( model, '<paragraph>foo</paragraph>[<widget>foo</widget>]' );
  182. expect( getViewData( view ) ).to.equal(
  183. '<p>foo</p>[<div class="ck-widget ck-widget_selected" contenteditable="false">foo<b></b></div>]'
  184. );
  185. model.change( writer => {
  186. writer.setSelection( null );
  187. } );
  188. expect( getViewData( view ) ).to.equal(
  189. '<p>{}foo</p><div class="ck-widget" contenteditable="false">foo<b></b></div>'
  190. );
  191. } );
  192. it( 'should do nothing when selection is placed in other editable', () => {
  193. setModelData( model, '<widget><editable>foo bar</editable></widget><editable>[baz]</editable>' );
  194. expect( getViewData( view ) ).to.equal(
  195. '<div class="ck-widget" contenteditable="false">' +
  196. '<figcaption contenteditable="true">foo bar</figcaption>' +
  197. '<b></b>' +
  198. '</div>' +
  199. '<figcaption contenteditable="true">{baz}</figcaption>'
  200. );
  201. } );
  202. describe( 'keys handling', () => {
  203. describe( 'arrows', () => {
  204. test(
  205. 'should move selection forward from selected object - right arrow',
  206. '[<widget></widget>]<paragraph>foo</paragraph>',
  207. keyCodes.arrowright,
  208. '<widget></widget><paragraph>[]foo</paragraph>'
  209. );
  210. test(
  211. 'should move selection forward from selected object - down arrow',
  212. '[<widget></widget>]<paragraph>foo</paragraph>',
  213. keyCodes.arrowdown,
  214. '<widget></widget><paragraph>[]foo</paragraph>'
  215. );
  216. test(
  217. 'should move selection backward from selected object - left arrow',
  218. '<paragraph>foo</paragraph>[<widget></widget>]',
  219. keyCodes.arrowleft,
  220. '<paragraph>foo[]</paragraph><widget></widget>'
  221. );
  222. test(
  223. 'should move selection backward from selected object - up arrow',
  224. '<paragraph>foo</paragraph>[<widget></widget>]',
  225. keyCodes.arrowup,
  226. '<paragraph>foo[]</paragraph><widget></widget>'
  227. );
  228. test(
  229. 'should move selection to next widget - right arrow',
  230. '[<widget></widget>]<widget></widget>',
  231. keyCodes.arrowright,
  232. '<widget></widget>[<widget></widget>]'
  233. );
  234. test(
  235. 'should move selection to next widget - down arrow',
  236. '[<widget></widget>]<widget></widget>',
  237. keyCodes.arrowdown,
  238. '<widget></widget>[<widget></widget>]'
  239. );
  240. test(
  241. 'should move selection to previous widget - left arrow',
  242. '<widget></widget>[<widget></widget>]',
  243. keyCodes.arrowleft,
  244. '[<widget></widget>]<widget></widget>'
  245. );
  246. test(
  247. 'should move selection to previous widget - up arrow',
  248. '<widget></widget>[<widget></widget>]',
  249. keyCodes.arrowup,
  250. '[<widget></widget>]<widget></widget>'
  251. );
  252. test(
  253. 'should do nothing on non-collapsed selection next to object - right arrow',
  254. '<paragraph>ba[r]</paragraph><widget></widget>',
  255. keyCodes.arrowright,
  256. '<paragraph>ba[r]</paragraph><widget></widget>'
  257. );
  258. test(
  259. 'should do nothing on non-collapsed selection next to object - down arrow',
  260. '<paragraph>ba[r]</paragraph><widget></widget>',
  261. keyCodes.arrowdown,
  262. '<paragraph>ba[r]</paragraph><widget></widget>'
  263. );
  264. test(
  265. 'should do nothing on non-collapsed selection next to object - left arrow',
  266. '<widget></widget><paragraph>[b]ar</paragraph>',
  267. keyCodes.arrowleft,
  268. '<widget></widget><paragraph>[b]ar</paragraph>'
  269. );
  270. test(
  271. 'should do nothing on non-collapsed selection next to object - up arrow',
  272. '<widget></widget><paragraph>[b]ar</paragraph>',
  273. keyCodes.arrowup,
  274. '<widget></widget><paragraph>[b]ar</paragraph>'
  275. );
  276. test(
  277. 'should not move selection if there is no correct location - right arrow',
  278. '<paragraph>foo</paragraph>[<widget></widget>]',
  279. keyCodes.arrowright,
  280. '<paragraph>foo</paragraph>[<widget></widget>]'
  281. );
  282. test(
  283. 'should not move selection if there is no correct location - down arrow',
  284. '<paragraph>foo</paragraph>[<widget></widget>]',
  285. keyCodes.arrowdown,
  286. '<paragraph>foo</paragraph>[<widget></widget>]'
  287. );
  288. test(
  289. 'should not move selection if there is no correct location - left arrow',
  290. '[<widget></widget>]<paragraph>foo</paragraph>',
  291. keyCodes.arrowleft,
  292. '[<widget></widget>]<paragraph>foo</paragraph>'
  293. );
  294. test(
  295. 'should not move selection if there is no correct location - up arrow',
  296. '[<widget></widget>]<paragraph>foo</paragraph>',
  297. keyCodes.arrowup,
  298. '[<widget></widget>]<paragraph>foo</paragraph>'
  299. );
  300. test(
  301. 'should do nothing if other key is pressed',
  302. '[<widget></widget>]<paragraph>foo</paragraph>',
  303. // Use a safe key (alt) to not trigger the Input features "unsafe keys" handler.
  304. 18,
  305. '[<widget></widget>]<paragraph>foo</paragraph>'
  306. );
  307. it( 'should prevent default behaviour when there is no correct location - document end', () => {
  308. const keydownHandler = sinon.spy();
  309. const domEventDataMock = {
  310. keyCode: keyCodes.arrowright,
  311. preventDefault: sinon.spy(),
  312. };
  313. setModelData( model, '<paragraph>foo</paragraph>[<widget></widget>]' );
  314. viewDocument.on( 'keydown', keydownHandler );
  315. viewDocument.fire( 'keydown', domEventDataMock );
  316. expect( getModelData( model ) ).to.equal( '<paragraph>foo</paragraph>[<widget></widget>]' );
  317. sinon.assert.calledOnce( domEventDataMock.preventDefault );
  318. sinon.assert.notCalled( keydownHandler );
  319. } );
  320. it( 'should prevent default behaviour when there is no correct location - document start', () => {
  321. const keydownHandler = sinon.spy();
  322. const domEventDataMock = {
  323. keyCode: keyCodes.arrowleft,
  324. preventDefault: sinon.spy(),
  325. };
  326. setModelData( model, '[<widget></widget>]<paragraph>foo</paragraph>' );
  327. viewDocument.on( 'keydown', keydownHandler );
  328. viewDocument.fire( 'keydown', domEventDataMock );
  329. expect( getModelData( model ) ).to.equal( '[<widget></widget>]<paragraph>foo</paragraph>' );
  330. sinon.assert.calledOnce( domEventDataMock.preventDefault );
  331. sinon.assert.notCalled( keydownHandler );
  332. } );
  333. test(
  334. 'should move selection to object element - right arrow',
  335. '<paragraph>foo[]</paragraph><widget></widget>',
  336. keyCodes.arrowright,
  337. '<paragraph>foo</paragraph>[<widget></widget>]'
  338. );
  339. test(
  340. 'should move selection to object element - down arrow',
  341. '<paragraph>foo[]</paragraph><widget></widget>',
  342. keyCodes.arrowdown,
  343. '<paragraph>foo</paragraph>[<widget></widget>]'
  344. );
  345. test(
  346. 'should move selection to object element - left arrow',
  347. '<widget></widget><paragraph>[]foo</paragraph>',
  348. keyCodes.arrowleft,
  349. '[<widget></widget>]<paragraph>foo</paragraph>'
  350. );
  351. test(
  352. 'should move selection to object element - up arrow',
  353. '<widget></widget><paragraph>[]foo</paragraph>',
  354. keyCodes.arrowup,
  355. '[<widget></widget>]<paragraph>foo</paragraph>'
  356. );
  357. test(
  358. 'do nothing on non objects - right arrow',
  359. '<paragraph>foo[]</paragraph><paragraph>bar</paragraph>',
  360. keyCodes.arrowright,
  361. '<paragraph>foo[]</paragraph><paragraph>bar</paragraph>'
  362. );
  363. test(
  364. 'do nothing on non objects - down arrow',
  365. '<paragraph>foo[]</paragraph><paragraph>bar</paragraph>',
  366. keyCodes.arrowdown,
  367. '<paragraph>foo[]</paragraph><paragraph>bar</paragraph>'
  368. );
  369. test(
  370. 'do nothing on non objects - left arrow',
  371. '<paragraph>foo</paragraph><paragraph>[]bar</paragraph>',
  372. keyCodes.arrowleft,
  373. '<paragraph>foo</paragraph><paragraph>[]bar</paragraph>'
  374. );
  375. test(
  376. 'do nothing on non objects - up arrow',
  377. '<paragraph>foo</paragraph><paragraph>[]bar</paragraph>',
  378. keyCodes.arrowup,
  379. '<paragraph>foo</paragraph><paragraph>[]bar</paragraph>'
  380. );
  381. test(
  382. 'should work correctly with modifier key: right arrow + ctrl',
  383. '[<widget></widget>]<paragraph>foo</paragraph>',
  384. { keyCode: keyCodes.arrowright, ctrlKey: true },
  385. '<widget></widget><paragraph>[]foo</paragraph>'
  386. );
  387. test(
  388. 'should work correctly with modifier key: right arrow + alt',
  389. '[<widget></widget>]<paragraph>foo</paragraph>',
  390. { keyCode: keyCodes.arrowright, altKey: true },
  391. '<widget></widget><paragraph>[]foo</paragraph>'
  392. );
  393. test(
  394. 'should work correctly with modifier key: right arrow + shift',
  395. '[<widget></widget>]<paragraph>foo</paragraph>',
  396. { keyCode: keyCodes.arrowright, shiftKey: true },
  397. '<widget></widget><paragraph>[]foo</paragraph>'
  398. );
  399. test(
  400. 'should work correctly with modifier key: down arrow + ctrl',
  401. '[<widget></widget>]<paragraph>foo</paragraph>',
  402. { keyCode: keyCodes.arrowdown, ctrlKey: true },
  403. '<widget></widget><paragraph>[]foo</paragraph>'
  404. );
  405. test(
  406. 'should work correctly with modifier key: down arrow + alt',
  407. '[<widget></widget>]<paragraph>foo</paragraph>',
  408. { keyCode: keyCodes.arrowdown, altKey: true },
  409. '<widget></widget><paragraph>[]foo</paragraph>'
  410. );
  411. test(
  412. 'should work correctly with modifier key: down arrow + shift',
  413. '[<widget></widget>]<paragraph>foo</paragraph>',
  414. { keyCode: keyCodes.arrowdown, shiftKey: true },
  415. '<widget></widget><paragraph>[]foo</paragraph>'
  416. );
  417. test(
  418. 'should work correctly with modifier key: left arrow + ctrl',
  419. '<paragraph>foo</paragraph>[<widget></widget>]',
  420. { keyCode: keyCodes.arrowleft, ctrlKey: true },
  421. '<paragraph>foo[]</paragraph><widget></widget>'
  422. );
  423. test(
  424. 'should work correctly with modifier key: left arrow + alt',
  425. '<paragraph>foo</paragraph>[<widget></widget>]',
  426. { keyCode: keyCodes.arrowleft, altKey: true },
  427. '<paragraph>foo[]</paragraph><widget></widget>'
  428. );
  429. test(
  430. 'should work correctly with modifier key: left arrow + shift',
  431. '<paragraph>foo</paragraph>[<widget></widget>]',
  432. { keyCode: keyCodes.arrowleft, shiftKey: true },
  433. '<paragraph>foo[]</paragraph><widget></widget>'
  434. );
  435. test(
  436. 'should work correctly with modifier key: up arrow + ctrl',
  437. '<paragraph>foo</paragraph>[<widget></widget>]',
  438. { keyCode: keyCodes.arrowup, ctrlKey: true },
  439. '<paragraph>foo[]</paragraph><widget></widget>'
  440. );
  441. test(
  442. 'should work correctly with modifier key: up arrow + alt',
  443. '<paragraph>foo</paragraph>[<widget></widget>]',
  444. { keyCode: keyCodes.arrowup, altKey: true },
  445. '<paragraph>foo[]</paragraph><widget></widget>'
  446. );
  447. test(
  448. 'should work correctly with modifier key: up arrow + shift',
  449. '<paragraph>foo</paragraph>[<widget></widget>]',
  450. { keyCode: keyCodes.arrowup, shiftKey: true },
  451. '<paragraph>foo[]</paragraph><widget></widget>'
  452. );
  453. test(
  454. 'should do nothing if there is more than one selection in model',
  455. '<paragraph>[foo]</paragraph><widget></widget><paragraph>[bar]</paragraph>',
  456. keyCodes.arrowright,
  457. '<paragraph>[foo]</paragraph><widget></widget><paragraph>[bar]</paragraph>'
  458. );
  459. test(
  460. 'should work if selection is in nested element (left arrow)',
  461. '<paragraph>foo</paragraph>' +
  462. '<image></image>' +
  463. '<blockQuote>' +
  464. '<div>' +
  465. '<div>' +
  466. '<paragraph>[]</paragraph>' +
  467. '</div>' +
  468. '</div>' +
  469. '</blockQuote>' +
  470. '<paragraph>foo</paragraph>',
  471. keyCodes.arrowleft,
  472. '<paragraph>foo</paragraph>' +
  473. '[<image></image>]' +
  474. '<blockQuote>' +
  475. '<div>' +
  476. '<div>' +
  477. '<paragraph></paragraph>' +
  478. '</div>' +
  479. '</div>' +
  480. '</blockQuote>' +
  481. '<paragraph>foo</paragraph>'
  482. );
  483. test(
  484. 'should work if selection is in nested element (up arrow)',
  485. '<paragraph>foo</paragraph>' +
  486. '<image></image>' +
  487. '<blockQuote>' +
  488. '<div>' +
  489. '<div>' +
  490. '<paragraph>[]</paragraph>' +
  491. '</div>' +
  492. '</div>' +
  493. '</blockQuote>' +
  494. '<paragraph>foo</paragraph>',
  495. keyCodes.arrowup,
  496. '<paragraph>foo</paragraph>' +
  497. '[<image></image>]' +
  498. '<blockQuote>' +
  499. '<div>' +
  500. '<div>' +
  501. '<paragraph></paragraph>' +
  502. '</div>' +
  503. '</div>' +
  504. '</blockQuote>' +
  505. '<paragraph>foo</paragraph>'
  506. );
  507. test(
  508. 'should work if selection is in nested element (right arrow)',
  509. '<paragraph>foo</paragraph>' +
  510. '<blockQuote>' +
  511. '<div>' +
  512. '<div>' +
  513. '<paragraph>[]</paragraph>' +
  514. '</div>' +
  515. '</div>' +
  516. '</blockQuote>' +
  517. '<image></image>' +
  518. '<paragraph>foo</paragraph>',
  519. keyCodes.arrowright,
  520. '<paragraph>foo</paragraph>' +
  521. '<blockQuote>' +
  522. '<div>' +
  523. '<div>' +
  524. '<paragraph></paragraph>' +
  525. '</div>' +
  526. '</div>' +
  527. '</blockQuote>' +
  528. '[<image></image>]' +
  529. '<paragraph>foo</paragraph>'
  530. );
  531. test(
  532. 'should work if selection is in nested element (down arrow)',
  533. '<paragraph>foo</paragraph>' +
  534. '<blockQuote>' +
  535. '<div>' +
  536. '<div>' +
  537. '<paragraph>[]</paragraph>' +
  538. '</div>' +
  539. '</div>' +
  540. '</blockQuote>' +
  541. '<image></image>' +
  542. '<paragraph>foo</paragraph>',
  543. keyCodes.arrowdown,
  544. '<paragraph>foo</paragraph>' +
  545. '<blockQuote>' +
  546. '<div>' +
  547. '<div>' +
  548. '<paragraph></paragraph>' +
  549. '</div>' +
  550. '</div>' +
  551. '</blockQuote>' +
  552. '[<image></image>]' +
  553. '<paragraph>foo</paragraph>'
  554. );
  555. } );
  556. describe( 'Ctrl+A', () => {
  557. test(
  558. 'should select the entire content of the nested editable',
  559. '<widget><nested>foo[]</nested></widget><paragraph>bar</paragraph>',
  560. { keyCode: keyCodes.a, ctrlKey: true },
  561. '<widget><nested>[foo]</nested></widget><paragraph>bar</paragraph>'
  562. );
  563. test(
  564. 'should not change the selection if outside of the nested editable',
  565. '<widget><nested>foo</nested></widget><paragraph>[]bar</paragraph>',
  566. { keyCode: keyCodes.a, ctrlKey: true },
  567. '<widget><nested>foo</nested></widget><paragraph>[]bar</paragraph>'
  568. );
  569. test(
  570. 'should selected whole content when widget is selected',
  571. '<paragraph>foo</paragraph>[<widget></widget>]<paragraph>bar</paragraph>',
  572. { keyCode: keyCodes.a, ctrlKey: true },
  573. '[<paragraph>foo</paragraph><widget></widget><paragraph>bar</paragraph>]',
  574. '[<p>foo</p><div class="ck-widget ck-widget_selected" contenteditable="false"><b></b></div><p>bar</p>]'
  575. );
  576. } );
  577. function test( name, data, keyCodeOrMock, expected, expectedView ) {
  578. it( name, () => {
  579. const domEventDataMock = ( typeof keyCodeOrMock == 'object' ) ? keyCodeOrMock : {
  580. keyCode: keyCodeOrMock
  581. };
  582. setModelData( model, data );
  583. viewDocument.fire( 'keydown', new DomEventData(
  584. viewDocument,
  585. { target: document.createElement( 'div' ), preventDefault() {} },
  586. domEventDataMock
  587. ) );
  588. expect( getModelData( model ) ).to.equal( expected );
  589. if ( expectedView ) {
  590. expect( getViewData( view ) ).to.equal( expectedView );
  591. }
  592. } );
  593. }
  594. } );
  595. describe( 'delete integration', () => {
  596. function test( name, input, direction, expected ) {
  597. it( name, () => {
  598. setModelData( model, input );
  599. const scrollStub = sinon.stub( view, 'scrollToTheSelection' );
  600. const domEventDataMock = {
  601. keyCode: direction == 'backward' ? keyCodes.backspace : keyCodes.delete,
  602. };
  603. viewDocument.fire( 'keydown', new DomEventData(
  604. viewDocument,
  605. { target: document.createElement( 'div' ), preventDefault() {} },
  606. domEventDataMock
  607. ) );
  608. expect( getModelData( model ) ).to.equal( expected );
  609. scrollStub.restore();
  610. } );
  611. }
  612. // Let's make this integration tests real which will help covering
  613. // cases like https://github.com/ckeditor/ckeditor5/issues/753.
  614. // Originally, this test file used the Delete feature only which was not "integrational" enough.
  615. it( 'tests are executed with the Typing feature', () => {
  616. expect( editor.plugins.get( 'Typing' ) ).to.not.be.undefined;
  617. } );
  618. test(
  619. 'should select widget when backspace is pressed',
  620. '<widget></widget><paragraph>[]foo</paragraph>',
  621. 'backward',
  622. '[<widget></widget>]<paragraph>foo</paragraph>'
  623. );
  624. test(
  625. 'should remove empty element after selecting widget when backspace is pressed',
  626. '<widget></widget><paragraph>[]</paragraph>',
  627. 'backward',
  628. '[<widget></widget>]'
  629. );
  630. test(
  631. 'should select widget when delete is pressed',
  632. '<paragraph>foo[]</paragraph><widget></widget>',
  633. 'forward',
  634. '<paragraph>foo</paragraph>[<widget></widget>]'
  635. );
  636. test(
  637. 'should remove empty element after selecting widget when delete is pressed',
  638. '<paragraph>[]</paragraph><widget></widget>',
  639. 'forward',
  640. '[<widget></widget>]'
  641. );
  642. test(
  643. 'should not select widget on non-collapsed selection',
  644. '<widget></widget><paragraph>[f]oo</paragraph>',
  645. 'backward',
  646. '<widget></widget><paragraph>[]oo</paragraph>'
  647. );
  648. test(
  649. 'should not affect non-object elements',
  650. '<paragraph>foo</paragraph><paragraph>[]bar</paragraph>',
  651. 'backward',
  652. '<paragraph>foo[]bar</paragraph>'
  653. );
  654. test(
  655. 'should not modify backward delete default behaviour in single paragraph boundaries',
  656. '<paragraph>[]foo</paragraph>',
  657. 'backward',
  658. '<paragraph>[]foo</paragraph>'
  659. );
  660. test(
  661. 'should not modify forward delete default behaviour in single paragraph boundaries',
  662. '<paragraph>foo[]</paragraph>',
  663. 'forward',
  664. '<paragraph>foo[]</paragraph>'
  665. );
  666. test(
  667. 'should delete selected widget with paragraph before - backward',
  668. '<paragraph>foo</paragraph>[<widget></widget>]',
  669. 'backward',
  670. '<paragraph>foo</paragraph><paragraph>[]</paragraph>'
  671. );
  672. test(
  673. 'should delete selected widget with paragraph before - forward',
  674. '<paragraph>foo</paragraph>[<widget></widget>]',
  675. 'forward',
  676. '<paragraph>foo</paragraph><paragraph>[]</paragraph>'
  677. );
  678. test(
  679. 'should delete selected widget with paragraph after - backward',
  680. '[<widget></widget>]<paragraph>foo</paragraph>',
  681. 'backward',
  682. '<paragraph>[]</paragraph><paragraph>foo</paragraph>'
  683. );
  684. test(
  685. 'should delete selected widget with paragraph after - forward',
  686. '[<widget></widget>]<paragraph>foo</paragraph>',
  687. 'forward',
  688. '<paragraph>[]</paragraph><paragraph>foo</paragraph>'
  689. );
  690. test(
  691. 'should delete selected widget between paragraphs - backward',
  692. '<paragraph>bar</paragraph>[<widget></widget>]<paragraph>foo</paragraph>',
  693. 'backward',
  694. '<paragraph>bar</paragraph><paragraph>[]</paragraph><paragraph>foo</paragraph>'
  695. );
  696. test(
  697. 'should delete selected widget between paragraphs - forward',
  698. '<paragraph>bar</paragraph>[<widget></widget>]<paragraph>foo</paragraph>',
  699. 'forward',
  700. '<paragraph>bar</paragraph><paragraph>[]</paragraph><paragraph>foo</paragraph>'
  701. );
  702. test(
  703. 'should delete selected widget preceded by another widget - backward',
  704. '<widget></widget>[<widget></widget>]',
  705. 'backward',
  706. '<widget></widget><paragraph>[]</paragraph>'
  707. );
  708. test(
  709. 'should delete selected widget preceded by another widget - forward',
  710. '<widget></widget>[<widget></widget>]',
  711. 'forward',
  712. '<widget></widget><paragraph>[]</paragraph>'
  713. );
  714. test(
  715. 'should delete selected widget before another widget - forward',
  716. '[<widget></widget>]<widget></widget>',
  717. 'forward',
  718. '<paragraph>[]</paragraph><widget></widget>'
  719. );
  720. test(
  721. 'should delete selected widget before another widget - backward',
  722. '[<widget></widget>]<widget></widget>',
  723. 'backward',
  724. '<paragraph>[]</paragraph><widget></widget>'
  725. );
  726. test(
  727. 'should delete selected widget between other widgets - forward',
  728. '<widget></widget>[<widget></widget>]<widget></widget>',
  729. 'forward',
  730. '<widget></widget><paragraph>[]</paragraph><widget></widget>'
  731. );
  732. test(
  733. 'should delete selected widget between other widgets - backward',
  734. '<widget></widget>[<widget></widget>]<widget></widget>',
  735. 'backward',
  736. '<widget></widget><paragraph>[]</paragraph><widget></widget>'
  737. );
  738. test(
  739. 'should select inline objects - backward',
  740. '<paragraph>foo<inline></inline>[]bar</paragraph>',
  741. 'backward',
  742. '<paragraph>foo[<inline></inline>]bar</paragraph>'
  743. );
  744. test(
  745. 'should select inline objects - forward',
  746. '<paragraph>foo[]<inline></inline>bar</paragraph>',
  747. 'forward',
  748. '<paragraph>foo[<inline></inline>]bar</paragraph>'
  749. );
  750. test(
  751. 'should delete selected inline objects - backward',
  752. '<paragraph>foo[<inline></inline>]bar</paragraph>',
  753. 'backward',
  754. '<paragraph>foo[]bar</paragraph>'
  755. );
  756. test(
  757. 'should delete selected inline objects - forward',
  758. '<paragraph>foo[<inline></inline>]bar</paragraph>',
  759. 'forward',
  760. '<paragraph>foo[]bar</paragraph>'
  761. );
  762. test(
  763. 'should use standard delete behaviour when after first letter - backward',
  764. '<paragraph>a[]</paragraph>',
  765. 'backward',
  766. '<paragraph>[]</paragraph>'
  767. );
  768. test(
  769. 'should use standard delete behaviour when before first letter - forward',
  770. '<paragraph>[]a</paragraph>',
  771. 'forward',
  772. '<paragraph>[]</paragraph>'
  773. );
  774. it( 'should prevent default behaviour and stop event propagation', () => {
  775. setModelData( model, '<paragraph>foo[]</paragraph><widget></widget>' );
  776. const scrollStub = sinon.stub( view, 'scrollToTheSelection' );
  777. const deleteSpy = sinon.spy();
  778. viewDocument.on( 'delete', deleteSpy );
  779. const domEventDataMock = { target: document.createElement( 'div' ), preventDefault: sinon.spy() };
  780. viewDocument.fire( 'delete', new DomEventData(
  781. viewDocument,
  782. domEventDataMock,
  783. { direction: 'forward', unit: 'character', sequence: 0 }
  784. ) );
  785. sinon.assert.calledOnce( domEventDataMock.preventDefault );
  786. sinon.assert.notCalled( deleteSpy );
  787. scrollStub.restore();
  788. } );
  789. test(
  790. 'should remove the entire empty element if it is next to a widget',
  791. '<paragraph>foo</paragraph>' +
  792. '<image></image>' +
  793. '<blockQuote><paragraph>[]</paragraph></blockQuote>' +
  794. '<paragraph>foo</paragraph>',
  795. 'backward',
  796. '<paragraph>foo</paragraph>[<image></image>]<paragraph>foo</paragraph>'
  797. );
  798. test(
  799. 'should remove the entire empty element (deeper structure) if it is next to a widget',
  800. '<paragraph>foo</paragraph>' +
  801. '<image></image>' +
  802. '<blockQuote><div><div><paragraph>[]</paragraph></div></div></blockQuote>' +
  803. '<paragraph>foo</paragraph>',
  804. 'backward',
  805. '<paragraph>foo</paragraph>' +
  806. '[<image></image>]' +
  807. '<paragraph>foo</paragraph>'
  808. );
  809. test(
  810. 'should remove the entire empty element (deeper structure) if it is next to a widget (forward delete)',
  811. '<paragraph>foo</paragraph>' +
  812. '<blockQuote><div><div><paragraph>[]</paragraph></div></div></blockQuote>' +
  813. '<image></image>' +
  814. '<paragraph>foo</paragraph>',
  815. 'forward',
  816. '<paragraph>foo</paragraph>' +
  817. '[<image></image>]' +
  818. '<paragraph>foo</paragraph>'
  819. );
  820. test(
  821. 'should not remove the entire element which is not empty and the element is next to a widget',
  822. '<paragraph>foo</paragraph>' +
  823. '<image></image>' +
  824. '<blockQuote><paragraph>[]</paragraph><paragraph></paragraph></blockQuote>' +
  825. '<paragraph>foo</paragraph>',
  826. 'backward',
  827. '<paragraph>foo</paragraph>' +
  828. '[<image></image>]' +
  829. '<blockQuote><paragraph></paragraph></blockQuote>' +
  830. '<paragraph>foo</paragraph>'
  831. );
  832. test(
  833. 'should not remove the entire element which is not empty and the element is next to a widget (forward delete)',
  834. '<paragraph>foo</paragraph>' +
  835. '<blockQuote><paragraph>Foo</paragraph><paragraph>[]</paragraph></blockQuote>' +
  836. '<image></image>' +
  837. '<paragraph>foo</paragraph>',
  838. 'forward',
  839. '<paragraph>foo</paragraph>' +
  840. '<blockQuote><paragraph>Foo</paragraph></blockQuote>' +
  841. '[<image></image>]' +
  842. '<paragraph>foo</paragraph>'
  843. );
  844. test(
  845. 'should not remove the entire element (deeper structure) which is not empty and the element is next to a widget',
  846. '<paragraph>foo</paragraph>' +
  847. '<image></image>' +
  848. '<blockQuote>' +
  849. '<div>' +
  850. '<div>' +
  851. '<paragraph>[]</paragraph>' +
  852. '</div>' +
  853. '</div>' +
  854. '<paragraph></paragraph>' +
  855. '</blockQuote>' +
  856. '<paragraph>foo</paragraph>',
  857. 'backward',
  858. '<paragraph>foo</paragraph>' +
  859. '[<image></image>]' +
  860. '<blockQuote>' +
  861. '<paragraph></paragraph>' +
  862. '</blockQuote>' +
  863. '<paragraph>foo</paragraph>'
  864. );
  865. test(
  866. 'should do nothing if the nested element is not empty and the element is next to a widget',
  867. '<paragraph>foo</paragraph>' +
  868. '<image></image>' +
  869. '<blockQuote>' +
  870. '<div>' +
  871. '<div>' +
  872. '<paragraph>Foo[]</paragraph>' +
  873. '</div>' +
  874. '</div>' +
  875. '</blockQuote>' +
  876. '<paragraph>foo</paragraph>',
  877. 'backward',
  878. '<paragraph>foo</paragraph>' +
  879. '<image></image>' +
  880. '<blockQuote>' +
  881. '<div>' +
  882. '<div>' +
  883. '<paragraph>Fo[]</paragraph>' +
  884. '</div>' +
  885. '</div>' +
  886. '</blockQuote>' +
  887. '<paragraph>foo</paragraph>'
  888. );
  889. it( 'does nothing when editor when read only mode is enabled (delete)', () => {
  890. const scrollStub = sinon.stub( view, 'scrollToTheSelection' );
  891. setModelData( model,
  892. '<paragraph>foo</paragraph>' +
  893. '<image></image>' +
  894. '<blockQuote><paragraph>[]</paragraph></blockQuote>' +
  895. '<paragraph>foo</paragraph>'
  896. );
  897. editor.isReadOnly = true;
  898. const domEventDataMock = { target: document.createElement( 'div' ), preventDefault: sinon.spy() };
  899. viewDocument.fire( 'delete', new DomEventData(
  900. viewDocument,
  901. domEventDataMock,
  902. { direction: 'backward', unit: 'character', sequence: 0 }
  903. ) );
  904. expect( getModelData( model ) ).to.equal(
  905. '<paragraph>foo</paragraph>' +
  906. '<image></image>' +
  907. '<blockQuote><paragraph>[]</paragraph></blockQuote>' +
  908. '<paragraph>foo</paragraph>'
  909. );
  910. scrollStub.restore();
  911. } );
  912. it( 'does nothing when editor when read only mode is enabled (forward delete)', () => {
  913. const scrollStub = sinon.stub( view, 'scrollToTheSelection' );
  914. setModelData( model,
  915. '<paragraph>foo</paragraph>' +
  916. '<image></image>' +
  917. '<blockQuote><paragraph>[]</paragraph></blockQuote>' +
  918. '<paragraph>foo</paragraph>'
  919. );
  920. editor.isReadOnly = true;
  921. const domEventDataMock = { target: document.createElement( 'div' ), preventDefault: sinon.spy() };
  922. viewDocument.fire( 'delete', new DomEventData(
  923. viewDocument,
  924. domEventDataMock,
  925. { direction: 'forward', unit: 'character', sequence: 0 }
  926. ) );
  927. expect( getModelData( model ) ).to.equal(
  928. '<paragraph>foo</paragraph>' +
  929. '<image></image>' +
  930. '<blockQuote><paragraph>[]</paragraph></blockQuote>' +
  931. '<paragraph>foo</paragraph>'
  932. );
  933. scrollStub.restore();
  934. } );
  935. } );
  936. } );