widget.js 33 KB

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