widget.js 47 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543
  1. /**
  2. * @license Copyright (c) 2003-2020, CKSource - Frederico Knabben. All rights reserved.
  3. * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
  4. */
  5. /* global document */
  6. import ClassicTestEditor from '@ckeditor/ckeditor5-core/tests/_utils/classictesteditor';
  7. import Widget from '../src/widget';
  8. import Typing from '@ckeditor/ckeditor5-typing/src/typing';
  9. import MouseObserver from '@ckeditor/ckeditor5-engine/src/view/observer/mouseobserver';
  10. import { toWidget } from '../src/utils';
  11. import DomEventData from '@ckeditor/ckeditor5-engine/src/view/observer/domeventdata';
  12. import { setData as setModelData, getData as getModelData } from '@ckeditor/ckeditor5-engine/src/dev-utils/model';
  13. import { getData as getViewData } from '@ckeditor/ckeditor5-engine/src/dev-utils/view';
  14. import { keyCodes } from '@ckeditor/ckeditor5-utils/src/keyboard';
  15. import testUtils from '@ckeditor/ckeditor5-core/tests/_utils/utils';
  16. describe( 'Widget', () => {
  17. let element, editor, model, view, viewDocument;
  18. testUtils.createSinonSandbox();
  19. beforeEach( () => {
  20. element = document.createElement( 'div' );
  21. document.body.appendChild( element );
  22. return ClassicTestEditor
  23. .create( element, {
  24. plugins: [ Widget, Typing ]
  25. } )
  26. .then( newEditor => {
  27. editor = newEditor;
  28. model = editor.model;
  29. view = editor.editing.view;
  30. viewDocument = view.document;
  31. model.schema.register( 'widget', {
  32. inheritAllFrom: '$block',
  33. isObject: true
  34. } );
  35. model.schema.extend( 'paragraph', {
  36. allowIn: 'div'
  37. } );
  38. model.schema.register( 'inline', {
  39. allowWhere: '$text',
  40. isObject: true
  41. } );
  42. model.schema.register( 'nested', {
  43. allowIn: 'widget',
  44. isLimit: true
  45. } );
  46. model.schema.extend( '$text', {
  47. allowIn: [ 'nested', 'editable' ]
  48. } );
  49. model.schema.register( 'editable', {
  50. allowIn: [ 'widget', '$root' ]
  51. } );
  52. model.schema.register( 'inline-widget', {
  53. allowWhere: '$text',
  54. isObject: true,
  55. isInline: true
  56. } );
  57. // Image feature.
  58. model.schema.register( 'image', {
  59. allowIn: '$root',
  60. isObject: true,
  61. isBlock: true
  62. } );
  63. // Block-quote feature.
  64. model.schema.register( 'blockQuote', {
  65. allowIn: '$root'
  66. } );
  67. model.schema.extend( '$block', { allowIn: 'blockQuote' } );
  68. // Div element which helps nesting elements.
  69. model.schema.register( 'div', {
  70. allowIn: [ 'blockQuote', 'div' ]
  71. } );
  72. editor.conversion.for( 'downcast' )
  73. // .elementToElement( { model: 'paragraph', view: 'p' } )
  74. .elementToElement( { model: 'inline', view: 'figure' } )
  75. .elementToElement( { model: 'image', view: 'img' } )
  76. .elementToElement( { model: 'blockQuote', view: 'blockquote' } )
  77. .elementToElement( { model: 'div', view: 'div' } )
  78. .elementToElement( {
  79. model: 'widget',
  80. view: ( modelItem, viewWriter ) => {
  81. const b = viewWriter.createAttributeElement( 'b' );
  82. const div = viewWriter.createContainerElement( 'div' );
  83. viewWriter.insert( viewWriter.createPositionAt( div, 0 ), b );
  84. return toWidget( div, viewWriter, { label: 'element label' } );
  85. }
  86. } )
  87. .elementToElement( {
  88. model: 'inline-widget',
  89. view: ( modelItem, viewWriter ) => {
  90. const span = viewWriter.createContainerElement( 'span' );
  91. return toWidget( span, viewWriter );
  92. }
  93. } )
  94. .elementToElement( {
  95. model: 'nested',
  96. view: ( modelItem, viewWriter ) => viewWriter.createEditableElement( 'figcaption', { contenteditable: true } )
  97. } )
  98. .elementToElement( {
  99. model: 'editable',
  100. view: ( modelItem, viewWriter ) => viewWriter.createEditableElement( 'figcaption', { contenteditable: true } )
  101. } );
  102. } );
  103. } );
  104. afterEach( () => {
  105. element.remove();
  106. return editor.destroy();
  107. } );
  108. it( 'should be loaded', () => {
  109. expect( editor.plugins.get( Widget ) ).to.be.instanceOf( Widget );
  110. } );
  111. it( 'should add MouseObserver', () => {
  112. expect( view.getObserver( MouseObserver ) ).to.be.instanceof( MouseObserver );
  113. } );
  114. it( 'should create selection over clicked widget', () => {
  115. setModelData( model, '[]<widget></widget>' );
  116. const viewDiv = viewDocument.getRoot().getChild( 0 );
  117. const domEventDataMock = new DomEventData( view, {
  118. target: view.domConverter.mapViewToDom( viewDiv ),
  119. preventDefault: sinon.spy()
  120. } );
  121. viewDocument.fire( 'mousedown', domEventDataMock );
  122. expect( getModelData( model ) ).to.equal( '[<widget></widget>]' );
  123. sinon.assert.calledOnce( domEventDataMock.domEvent.preventDefault );
  124. } );
  125. it( 'should create selection when clicked in nested element', () => {
  126. setModelData( model, '[]<widget></widget>' );
  127. const viewDiv = viewDocument.getRoot().getChild( 0 );
  128. const viewB = viewDiv.getChild( 0 );
  129. const domEventDataMock = new DomEventData( view, {
  130. target: view.domConverter.mapViewToDom( viewB ),
  131. preventDefault: sinon.spy()
  132. } );
  133. viewDocument.fire( 'mousedown', domEventDataMock );
  134. expect( getModelData( model ) ).to.equal( '[<widget></widget>]' );
  135. sinon.assert.calledOnce( domEventDataMock.domEvent.preventDefault );
  136. } );
  137. it( 'should do nothing if clicked in non-widget element', () => {
  138. setModelData( model, '<paragraph>[]foo bar</paragraph><widget></widget>' );
  139. const viewP = viewDocument.getRoot().getChild( 0 );
  140. const domEventDataMock = new DomEventData( view, {
  141. target: view.domConverter.mapViewToDom( viewP ),
  142. preventDefault: sinon.spy()
  143. } );
  144. view.focus();
  145. viewDocument.fire( 'mousedown', domEventDataMock );
  146. expect( getModelData( model ) ).to.equal( '<paragraph>[]foo bar</paragraph><widget></widget>' );
  147. sinon.assert.notCalled( domEventDataMock.domEvent.preventDefault );
  148. } );
  149. it( 'should not focus editable if already is focused', () => {
  150. setModelData( model, '<widget></widget>' );
  151. const widget = viewDocument.getRoot().getChild( 0 );
  152. const domEventDataMock = new DomEventData( view, {
  153. target: view.domConverter.mapViewToDom( widget ),
  154. preventDefault: sinon.spy()
  155. } );
  156. const focusSpy = sinon.spy( view, 'focus' );
  157. viewDocument.isFocused = true;
  158. viewDocument.fire( 'mousedown', domEventDataMock );
  159. sinon.assert.calledOnce( domEventDataMock.domEvent.preventDefault );
  160. sinon.assert.notCalled( focusSpy );
  161. expect( getModelData( model ) ).to.equal( '[<widget></widget>]' );
  162. } );
  163. it( 'should apply fake view selection if model selection is on widget element', () => {
  164. setModelData( model, '[<widget>foo bar</widget>]' );
  165. expect( getViewData( view ) ).to.equal(
  166. '[<div class="ck-widget ck-widget_can-type-around_after ck-widget_can-type-around_before ck-widget_selected" ' +
  167. 'contenteditable="false">' +
  168. 'foo bar' +
  169. '<b></b>' +
  170. '<div class="ck ck-reset_all ck-widget__type-around"></div>' +
  171. '</div>]'
  172. );
  173. expect( viewDocument.selection.isFake ).to.be.true;
  174. } );
  175. it( 'should use element\'s label to set fake selection if one is provided', () => {
  176. setModelData( model, '[<widget>foo bar</widget>]' );
  177. expect( viewDocument.selection.fakeSelectionLabel ).to.equal( 'element label' );
  178. } );
  179. it( 'should add selected class when other content is selected with widget', () => {
  180. setModelData( model, '[<paragraph>foo</paragraph><widget></widget><widget></widget>]' );
  181. expect( viewDocument.selection.isFake ).to.be.false;
  182. expect( getViewData( view ) ).to.equal(
  183. '<p>{foo</p>' +
  184. '<div class="ck-widget ck-widget_can-type-around_after ck-widget_selected" contenteditable="false">' +
  185. '<b></b>' +
  186. '<div class="ck ck-reset_all ck-widget__type-around"></div>' +
  187. '</div>' +
  188. '<div class="ck-widget ck-widget_can-type-around_after ck-widget_can-type-around_before ck-widget_selected" ' +
  189. 'contenteditable="false">' +
  190. '<b></b>' +
  191. '<div class="ck ck-reset_all ck-widget__type-around"></div>' +
  192. '</div>]'
  193. );
  194. } );
  195. it( 'fake selection should be empty if widget is not selected', () => {
  196. setModelData( model, '<paragraph>foo</paragraph><widget>foo bar</widget>' );
  197. expect( viewDocument.selection.fakeSelectionLabel ).to.equal( '' );
  198. } );
  199. it( 'should toggle selected class', () => {
  200. setModelData( model, '<paragraph>foo</paragraph>[<widget>foo</widget>]' );
  201. expect( getViewData( view ) ).to.equal(
  202. '<p>foo</p>' +
  203. '[<div class="ck-widget ck-widget_can-type-around_after ck-widget_selected" contenteditable="false">' +
  204. 'foo' +
  205. '<b></b>' +
  206. '<div class="ck ck-reset_all ck-widget__type-around"></div>' +
  207. '</div>]'
  208. );
  209. model.change( writer => {
  210. writer.setSelection( null );
  211. } );
  212. expect( getViewData( view ) ).to.equal(
  213. '<p>{}foo</p>' +
  214. '<div class="ck-widget ck-widget_can-type-around_after" contenteditable="false">' +
  215. 'foo' +
  216. '<b></b>' +
  217. '<div class="ck ck-reset_all ck-widget__type-around"></div>' +
  218. '</div>'
  219. );
  220. } );
  221. it( 'should do nothing when selection is placed in other editable', () => {
  222. setModelData( model, '<widget><editable>foo bar</editable></widget><editable>[baz]</editable>' );
  223. expect( getViewData( view ) ).to.equal(
  224. '<div class="ck-widget ck-widget_can-type-around_before" contenteditable="false">' +
  225. '<figcaption contenteditable="true">foo bar</figcaption>' +
  226. '<b></b>' +
  227. '<div class="ck ck-reset_all ck-widget__type-around"></div>' +
  228. '</div>' +
  229. '<figcaption contenteditable="true">{baz}</figcaption>'
  230. );
  231. } );
  232. describe( 'keys handling', () => {
  233. describe( 'arrows', () => {
  234. test(
  235. 'should move selection forward from selected object - right arrow',
  236. '[<widget></widget>]<paragraph>foo</paragraph>',
  237. keyCodes.arrowright,
  238. '<widget></widget><paragraph>[]foo</paragraph>'
  239. );
  240. test(
  241. 'should move selection forward from selected object - down arrow',
  242. '[<widget></widget>]<paragraph>foo</paragraph>',
  243. keyCodes.arrowdown,
  244. '<widget></widget><paragraph>[]foo</paragraph>'
  245. );
  246. test(
  247. 'should move selection backward from selected object - left arrow',
  248. '<paragraph>foo</paragraph>[<widget></widget>]',
  249. keyCodes.arrowleft,
  250. '<paragraph>foo[]</paragraph><widget></widget>'
  251. );
  252. test(
  253. 'should move selection backward from selected object - up arrow',
  254. '<paragraph>foo</paragraph>[<widget></widget>]',
  255. keyCodes.arrowup,
  256. '<paragraph>foo[]</paragraph><widget></widget>'
  257. );
  258. test(
  259. 'should move selection to next widget - right arrow',
  260. '[<widget></widget>]<widget></widget>',
  261. keyCodes.arrowright,
  262. '<widget></widget>[<widget></widget>]'
  263. );
  264. test(
  265. 'should move selection to next widget - down arrow',
  266. '[<widget></widget>]<widget></widget>',
  267. keyCodes.arrowdown,
  268. '<widget></widget>[<widget></widget>]'
  269. );
  270. test(
  271. 'should move selection to previous widget - left arrow',
  272. '<widget></widget>[<widget></widget>]',
  273. keyCodes.arrowleft,
  274. '[<widget></widget>]<widget></widget>'
  275. );
  276. test(
  277. 'should move selection to previous widget - up arrow',
  278. '<widget></widget>[<widget></widget>]',
  279. keyCodes.arrowup,
  280. '[<widget></widget>]<widget></widget>'
  281. );
  282. test(
  283. 'should do nothing on non-collapsed selection next to object - right arrow',
  284. '<paragraph>ba[r]</paragraph><widget></widget>',
  285. keyCodes.arrowright,
  286. '<paragraph>ba[r]</paragraph><widget></widget>'
  287. );
  288. test(
  289. 'should do nothing on non-collapsed selection next to object - down arrow',
  290. '<paragraph>ba[r]</paragraph><widget></widget>',
  291. keyCodes.arrowdown,
  292. '<paragraph>ba[r]</paragraph><widget></widget>'
  293. );
  294. test(
  295. 'should do nothing on non-collapsed selection next to object - left arrow',
  296. '<widget></widget><paragraph>[b]ar</paragraph>',
  297. keyCodes.arrowleft,
  298. '<widget></widget><paragraph>[b]ar</paragraph>'
  299. );
  300. test(
  301. 'should do nothing on non-collapsed selection next to object - up arrow',
  302. '<widget></widget><paragraph>[b]ar</paragraph>',
  303. keyCodes.arrowup,
  304. '<widget></widget><paragraph>[b]ar</paragraph>'
  305. );
  306. test(
  307. 'should not move selection if there is no correct location - right arrow',
  308. '<paragraph>foo</paragraph>[<widget></widget>]',
  309. keyCodes.arrowright,
  310. '<paragraph>foo</paragraph>[<widget></widget>]'
  311. );
  312. test(
  313. 'should not move selection if there is no correct location - down arrow',
  314. '<paragraph>foo</paragraph>[<widget></widget>]',
  315. keyCodes.arrowdown,
  316. '<paragraph>foo</paragraph>[<widget></widget>]'
  317. );
  318. test(
  319. 'should not move selection if there is no correct location - left arrow',
  320. '[<widget></widget>]<paragraph>foo</paragraph>',
  321. keyCodes.arrowleft,
  322. '[<widget></widget>]<paragraph>foo</paragraph>'
  323. );
  324. test(
  325. 'should not move selection if there is no correct location - up arrow',
  326. '[<widget></widget>]<paragraph>foo</paragraph>',
  327. keyCodes.arrowup,
  328. '[<widget></widget>]<paragraph>foo</paragraph>'
  329. );
  330. test(
  331. 'should do nothing if other key is pressed',
  332. '[<widget></widget>]<paragraph>foo</paragraph>',
  333. // Use a safe key (alt) to not trigger the Input features "unsafe keys" handler.
  334. 18,
  335. '[<widget></widget>]<paragraph>foo</paragraph>'
  336. );
  337. it( 'should prevent default behaviour when there is no correct location - document end', () => {
  338. const keydownHandler = sinon.spy();
  339. const domEventDataMock = {
  340. keyCode: keyCodes.arrowright,
  341. preventDefault: sinon.spy()
  342. };
  343. setModelData( model, '<paragraph>foo</paragraph>[<widget></widget>]' );
  344. viewDocument.on( 'keydown', keydownHandler );
  345. viewDocument.fire( 'keydown', domEventDataMock );
  346. expect( getModelData( model ) ).to.equal( '<paragraph>foo</paragraph>[<widget></widget>]' );
  347. sinon.assert.calledOnce( domEventDataMock.preventDefault );
  348. sinon.assert.notCalled( keydownHandler );
  349. } );
  350. it( 'should prevent default behaviour when there is no correct location - document start', () => {
  351. const keydownHandler = sinon.spy();
  352. const domEventDataMock = {
  353. keyCode: keyCodes.arrowleft,
  354. preventDefault: sinon.spy()
  355. };
  356. setModelData( model, '[<widget></widget>]<paragraph>foo</paragraph>' );
  357. viewDocument.on( 'keydown', keydownHandler );
  358. viewDocument.fire( 'keydown', domEventDataMock );
  359. expect( getModelData( model ) ).to.equal( '[<widget></widget>]<paragraph>foo</paragraph>' );
  360. sinon.assert.calledOnce( domEventDataMock.preventDefault );
  361. sinon.assert.notCalled( keydownHandler );
  362. } );
  363. test(
  364. 'should move selection to object element - right arrow',
  365. '<paragraph>foo[]</paragraph><widget></widget>',
  366. keyCodes.arrowright,
  367. '<paragraph>foo</paragraph>[<widget></widget>]'
  368. );
  369. test(
  370. 'should move selection to object element - down arrow',
  371. '<paragraph>foo[]</paragraph><widget></widget>',
  372. keyCodes.arrowdown,
  373. '<paragraph>foo</paragraph>[<widget></widget>]'
  374. );
  375. test(
  376. 'should move selection to object element - left arrow',
  377. '<widget></widget><paragraph>[]foo</paragraph>',
  378. keyCodes.arrowleft,
  379. '[<widget></widget>]<paragraph>foo</paragraph>'
  380. );
  381. test(
  382. 'should move selection to object element - up arrow',
  383. '<widget></widget><paragraph>[]foo</paragraph>',
  384. keyCodes.arrowup,
  385. '[<widget></widget>]<paragraph>foo</paragraph>'
  386. );
  387. test(
  388. 'do nothing on non objects - right arrow',
  389. '<paragraph>foo[]</paragraph><paragraph>bar</paragraph>',
  390. keyCodes.arrowright,
  391. '<paragraph>foo[]</paragraph><paragraph>bar</paragraph>'
  392. );
  393. test(
  394. 'do nothing on non objects - down arrow',
  395. '<paragraph>foo[]</paragraph><paragraph>bar</paragraph>',
  396. keyCodes.arrowdown,
  397. '<paragraph>foo[]</paragraph><paragraph>bar</paragraph>'
  398. );
  399. test(
  400. 'do nothing on non objects - left arrow',
  401. '<paragraph>foo</paragraph><paragraph>[]bar</paragraph>',
  402. keyCodes.arrowleft,
  403. '<paragraph>foo</paragraph><paragraph>[]bar</paragraph>'
  404. );
  405. test(
  406. 'do nothing on non objects - up arrow',
  407. '<paragraph>foo</paragraph><paragraph>[]bar</paragraph>',
  408. keyCodes.arrowup,
  409. '<paragraph>foo</paragraph><paragraph>[]bar</paragraph>'
  410. );
  411. test(
  412. 'should work correctly with modifier key: right arrow + ctrl',
  413. '[<widget></widget>]<paragraph>foo</paragraph>',
  414. { keyCode: keyCodes.arrowright, ctrlKey: true },
  415. '<widget></widget><paragraph>[]foo</paragraph>'
  416. );
  417. test(
  418. 'should work correctly with modifier key: right arrow + alt',
  419. '[<widget></widget>]<paragraph>foo</paragraph>',
  420. { keyCode: keyCodes.arrowright, altKey: true },
  421. '<widget></widget><paragraph>[]foo</paragraph>'
  422. );
  423. test(
  424. 'should work correctly with modifier key: right arrow + shift',
  425. '[<widget></widget>]<paragraph>foo</paragraph>',
  426. { keyCode: keyCodes.arrowright, shiftKey: true },
  427. '<widget></widget><paragraph>[]foo</paragraph>'
  428. );
  429. test(
  430. 'should work correctly with modifier key: down arrow + ctrl',
  431. '[<widget></widget>]<paragraph>foo</paragraph>',
  432. { keyCode: keyCodes.arrowdown, ctrlKey: true },
  433. '<widget></widget><paragraph>[]foo</paragraph>'
  434. );
  435. test(
  436. 'should work correctly with modifier key: down arrow + alt',
  437. '[<widget></widget>]<paragraph>foo</paragraph>',
  438. { keyCode: keyCodes.arrowdown, altKey: true },
  439. '<widget></widget><paragraph>[]foo</paragraph>'
  440. );
  441. test(
  442. 'should work correctly with modifier key: down arrow + shift',
  443. '[<widget></widget>]<paragraph>foo</paragraph>',
  444. { keyCode: keyCodes.arrowdown, shiftKey: true },
  445. '<widget></widget><paragraph>[]foo</paragraph>'
  446. );
  447. test(
  448. 'should work correctly with modifier key: left arrow + ctrl',
  449. '<paragraph>foo</paragraph>[<widget></widget>]',
  450. { keyCode: keyCodes.arrowleft, ctrlKey: true },
  451. '<paragraph>foo[]</paragraph><widget></widget>'
  452. );
  453. test(
  454. 'should work correctly with modifier key: left arrow + alt',
  455. '<paragraph>foo</paragraph>[<widget></widget>]',
  456. { keyCode: keyCodes.arrowleft, altKey: true },
  457. '<paragraph>foo[]</paragraph><widget></widget>'
  458. );
  459. test(
  460. 'should work correctly with modifier key: left arrow + shift',
  461. '<paragraph>foo</paragraph>[<widget></widget>]',
  462. { keyCode: keyCodes.arrowleft, shiftKey: true },
  463. '<paragraph>foo[]</paragraph><widget></widget>'
  464. );
  465. test(
  466. 'should work correctly with modifier key: up arrow + ctrl',
  467. '<paragraph>foo</paragraph>[<widget></widget>]',
  468. { keyCode: keyCodes.arrowup, ctrlKey: true },
  469. '<paragraph>foo[]</paragraph><widget></widget>'
  470. );
  471. test(
  472. 'should work correctly with modifier key: up arrow + alt',
  473. '<paragraph>foo</paragraph>[<widget></widget>]',
  474. { keyCode: keyCodes.arrowup, altKey: true },
  475. '<paragraph>foo[]</paragraph><widget></widget>'
  476. );
  477. test(
  478. 'should work correctly with modifier key: up arrow + shift',
  479. '<paragraph>foo</paragraph>[<widget></widget>]',
  480. { keyCode: keyCodes.arrowup, shiftKey: true },
  481. '<paragraph>foo[]</paragraph><widget></widget>'
  482. );
  483. test(
  484. 'should do nothing if there is more than one selection in model',
  485. '<paragraph>[foo]</paragraph><widget></widget><paragraph>[bar]</paragraph>',
  486. keyCodes.arrowright,
  487. '<paragraph>[foo]</paragraph><widget></widget><paragraph>[bar]</paragraph>'
  488. );
  489. test(
  490. 'should work if selection is in nested element (left arrow)',
  491. '<paragraph>foo</paragraph>' +
  492. '<image></image>' +
  493. '<blockQuote>' +
  494. '<div>' +
  495. '<div>' +
  496. '<paragraph>[]</paragraph>' +
  497. '</div>' +
  498. '</div>' +
  499. '</blockQuote>' +
  500. '<paragraph>foo</paragraph>',
  501. keyCodes.arrowleft,
  502. '<paragraph>foo</paragraph>' +
  503. '[<image></image>]' +
  504. '<blockQuote>' +
  505. '<div>' +
  506. '<div>' +
  507. '<paragraph></paragraph>' +
  508. '</div>' +
  509. '</div>' +
  510. '</blockQuote>' +
  511. '<paragraph>foo</paragraph>'
  512. );
  513. test(
  514. 'should work if selection is in nested element (up arrow)',
  515. '<paragraph>foo</paragraph>' +
  516. '<image></image>' +
  517. '<blockQuote>' +
  518. '<div>' +
  519. '<div>' +
  520. '<paragraph>[]</paragraph>' +
  521. '</div>' +
  522. '</div>' +
  523. '</blockQuote>' +
  524. '<paragraph>foo</paragraph>',
  525. keyCodes.arrowup,
  526. '<paragraph>foo</paragraph>' +
  527. '[<image></image>]' +
  528. '<blockQuote>' +
  529. '<div>' +
  530. '<div>' +
  531. '<paragraph></paragraph>' +
  532. '</div>' +
  533. '</div>' +
  534. '</blockQuote>' +
  535. '<paragraph>foo</paragraph>'
  536. );
  537. test(
  538. 'should work if selection is in nested element (right arrow)',
  539. '<paragraph>foo</paragraph>' +
  540. '<blockQuote>' +
  541. '<div>' +
  542. '<div>' +
  543. '<paragraph>[]</paragraph>' +
  544. '</div>' +
  545. '</div>' +
  546. '</blockQuote>' +
  547. '<image></image>' +
  548. '<paragraph>foo</paragraph>',
  549. keyCodes.arrowright,
  550. '<paragraph>foo</paragraph>' +
  551. '<blockQuote>' +
  552. '<div>' +
  553. '<div>' +
  554. '<paragraph></paragraph>' +
  555. '</div>' +
  556. '</div>' +
  557. '</blockQuote>' +
  558. '[<image></image>]' +
  559. '<paragraph>foo</paragraph>'
  560. );
  561. test(
  562. 'should work if selection is in nested element (down arrow)',
  563. '<paragraph>foo</paragraph>' +
  564. '<blockQuote>' +
  565. '<div>' +
  566. '<div>' +
  567. '<paragraph>[]</paragraph>' +
  568. '</div>' +
  569. '</div>' +
  570. '</blockQuote>' +
  571. '<image></image>' +
  572. '<paragraph>foo</paragraph>',
  573. keyCodes.arrowdown,
  574. '<paragraph>foo</paragraph>' +
  575. '<blockQuote>' +
  576. '<div>' +
  577. '<div>' +
  578. '<paragraph></paragraph>' +
  579. '</div>' +
  580. '</div>' +
  581. '</blockQuote>' +
  582. '[<image></image>]' +
  583. '<paragraph>foo</paragraph>'
  584. );
  585. describe( 'RTL (right-to-left) content', () => {
  586. test(
  587. 'should move selection forward from selected object - left arrow',
  588. '[<widget></widget>]<paragraph>foo</paragraph>',
  589. keyCodes.arrowleft,
  590. '<widget></widget><paragraph>[]foo</paragraph>',
  591. null,
  592. 'rtl'
  593. );
  594. test(
  595. 'should move selection backward from selected object - right arrow',
  596. '<paragraph>foo</paragraph>[<widget></widget>]',
  597. keyCodes.arrowright,
  598. '<paragraph>foo[]</paragraph><widget></widget>',
  599. null,
  600. 'rtl'
  601. );
  602. test(
  603. 'should move selection to next widget - left arrow',
  604. '[<widget></widget>]<widget></widget>',
  605. keyCodes.arrowleft,
  606. '<widget></widget>[<widget></widget>]',
  607. null,
  608. 'rtl'
  609. );
  610. test(
  611. 'should move selection to previous widget - right arrow',
  612. '<widget></widget>[<widget></widget>]',
  613. keyCodes.arrowright,
  614. '[<widget></widget>]<widget></widget>',
  615. null,
  616. 'rtl'
  617. );
  618. } );
  619. } );
  620. describe( 'enter', () => {
  621. test(
  622. 'should insert a paragraph after the selected widget upon Enter',
  623. '[<widget></widget>]',
  624. keyCodes.enter,
  625. '<widget></widget><paragraph>[]</paragraph>'
  626. );
  627. test(
  628. 'should insert a paragraph before the selected widget upon Shift+Enter',
  629. '[<widget></widget>]',
  630. { keyCode: keyCodes.enter, shiftKey: true },
  631. '<paragraph>[]</paragraph><widget></widget>'
  632. );
  633. test(
  634. 'should insert a paragraph when not a first-child of the root',
  635. '[<widget></widget>]<paragraph>foo</paragraph>',
  636. keyCodes.enter,
  637. '<widget></widget><paragraph>[]</paragraph><paragraph>foo</paragraph>'
  638. );
  639. test(
  640. 'should insert a paragraph when not a last-child of the root',
  641. '<paragraph>foo</paragraph>[<widget></widget>]',
  642. { keyCode: keyCodes.enter, shiftKey: true },
  643. '<paragraph>foo</paragraph><paragraph>[]</paragraph><widget></widget>'
  644. );
  645. test(
  646. 'should insert a paragraph only when an entire widget is selected (#1)',
  647. '<widget><nested>[foo] bar</nested></widget>',
  648. keyCodes.enter,
  649. '<widget><nested>[] bar</nested></widget>'
  650. );
  651. test(
  652. 'should insert a paragraph only when an entire widget is selected (#2)',
  653. '<paragraph>f[oo</paragraph><widget></widget><paragraph>b]ar</paragraph>',
  654. keyCodes.enter,
  655. '<paragraph>f[]ar</paragraph>'
  656. );
  657. // https://github.com/ckeditor/ckeditor5/issues/1529
  658. it( 'should split parent when widget is inside a block element', () => {
  659. model.schema.register( 'allowP', {
  660. inheritAllFrom: '$block'
  661. } );
  662. model.schema.register( 'disallowP', {
  663. inheritAllFrom: '$block',
  664. allowIn: [ 'allowP' ]
  665. } );
  666. model.schema.extend( 'widget', {
  667. allowIn: [ 'allowP', 'disallowP' ]
  668. } );
  669. model.schema.extend( 'paragraph', {
  670. allowIn: [ 'allowP' ]
  671. } );
  672. editor.conversion.for( 'downcast' ).elementToElement( { model: 'parent', view: 'parent' } );
  673. editor.conversion.for( 'downcast' ).elementToElement( { model: 'allowP', view: 'allowP' } );
  674. editor.conversion.for( 'downcast' ).elementToElement( { model: 'disallowP', view: 'disallowP' } );
  675. setModelData( model, '<allowP><disallowP>[<widget></widget>]</disallowP></allowP>' );
  676. viewDocument.fire( 'keydown', new DomEventData(
  677. viewDocument,
  678. { target: document.createElement( 'div' ), preventDefault() {} },
  679. { keyCode: keyCodes.enter }
  680. ) );
  681. expect( getModelData( model ) ).to.equal(
  682. '<allowP><disallowP><widget></widget></disallowP><paragraph>[]</paragraph><disallowP></disallowP></allowP>'
  683. );
  684. } );
  685. test(
  686. 'should do nothing if selected is inline object',
  687. '<paragraph>foo[<inline-widget></inline-widget>]bar</paragraph>',
  688. keyCodes.enter,
  689. '<paragraph>foo[]bar</paragraph>'
  690. );
  691. test(
  692. 'should insert a paragraph after the selected widget inside an element that is not a block upon Enter',
  693. '<blockQuote>[<widget></widget>]</blockQuote>',
  694. keyCodes.enter,
  695. '<blockQuote><widget></widget><paragraph>[]</paragraph></blockQuote>'
  696. );
  697. test(
  698. 'should insert a paragraph before the selected widget inside an element that is not a block upon Shift+Enter',
  699. '<blockQuote>[<widget></widget>]</blockQuote>',
  700. { keyCode: keyCodes.enter, shiftKey: true },
  701. '<blockQuote><paragraph>[]</paragraph><widget></widget></blockQuote>'
  702. );
  703. } );
  704. function test( name, data, keyCodeOrMock, expected, expectedView, contentLanguageDirection = 'ltr' ) {
  705. it( name, () => {
  706. testUtils.sinon.stub( editor.locale, 'contentLanguageDirection' ).value( contentLanguageDirection );
  707. const domEventDataMock = ( typeof keyCodeOrMock == 'object' ) ? keyCodeOrMock : {
  708. keyCode: keyCodeOrMock
  709. };
  710. setModelData( model, data );
  711. viewDocument.fire( 'keydown', new DomEventData(
  712. viewDocument,
  713. { target: document.createElement( 'div' ), preventDefault() {} },
  714. domEventDataMock
  715. ) );
  716. expect( getModelData( model ) ).to.equal( expected );
  717. if ( expectedView ) {
  718. expect( getViewData( view ) ).to.equal( expectedView );
  719. }
  720. } );
  721. }
  722. } );
  723. describe( 'delete integration', () => {
  724. function test( name, input, direction, expected ) {
  725. it( name, () => {
  726. setModelData( model, input );
  727. const scrollStub = sinon.stub( view, 'scrollToTheSelection' );
  728. const domEventDataMock = {
  729. keyCode: direction == 'backward' ? keyCodes.backspace : keyCodes.delete
  730. };
  731. viewDocument.fire( 'keydown', new DomEventData(
  732. viewDocument,
  733. { target: document.createElement( 'div' ), preventDefault() {} },
  734. domEventDataMock
  735. ) );
  736. expect( getModelData( model ) ).to.equal( expected );
  737. scrollStub.restore();
  738. } );
  739. }
  740. // Let's make this integration tests real which will help covering
  741. // cases like https://github.com/ckeditor/ckeditor5/issues/753.
  742. // Originally, this test file used the Delete feature only which was not "integrational" enough.
  743. it( 'tests are executed with the Typing feature', () => {
  744. expect( editor.plugins.get( 'Typing' ) ).to.not.be.undefined;
  745. } );
  746. test(
  747. 'should select widget when backspace is pressed',
  748. '<widget></widget><paragraph>[]foo</paragraph>',
  749. 'backward',
  750. '[<widget></widget>]<paragraph>foo</paragraph>'
  751. );
  752. test(
  753. 'should remove empty element after selecting widget when backspace is pressed',
  754. '<widget></widget><paragraph>[]</paragraph>',
  755. 'backward',
  756. '[<widget></widget>]'
  757. );
  758. test(
  759. 'should select widget when delete is pressed',
  760. '<paragraph>foo[]</paragraph><widget></widget>',
  761. 'forward',
  762. '<paragraph>foo</paragraph>[<widget></widget>]'
  763. );
  764. test(
  765. 'should remove empty element after selecting widget when delete is pressed',
  766. '<paragraph>[]</paragraph><widget></widget>',
  767. 'forward',
  768. '[<widget></widget>]'
  769. );
  770. test(
  771. 'should not select widget on non-collapsed selection',
  772. '<widget></widget><paragraph>[f]oo</paragraph>',
  773. 'backward',
  774. '<widget></widget><paragraph>[]oo</paragraph>'
  775. );
  776. test(
  777. 'should not affect non-object elements',
  778. '<paragraph>foo</paragraph><paragraph>[]bar</paragraph>',
  779. 'backward',
  780. '<paragraph>foo[]bar</paragraph>'
  781. );
  782. test(
  783. 'should not modify backward delete default behaviour in single paragraph boundaries',
  784. '<paragraph>[]foo</paragraph>',
  785. 'backward',
  786. '<paragraph>[]foo</paragraph>'
  787. );
  788. test(
  789. 'should not modify forward delete default behaviour in single paragraph boundaries',
  790. '<paragraph>foo[]</paragraph>',
  791. 'forward',
  792. '<paragraph>foo[]</paragraph>'
  793. );
  794. test(
  795. 'should delete selected widget with paragraph before - backward',
  796. '<paragraph>foo</paragraph>[<widget></widget>]',
  797. 'backward',
  798. '<paragraph>foo</paragraph><paragraph>[]</paragraph>'
  799. );
  800. test(
  801. 'should delete selected widget with paragraph before - forward',
  802. '<paragraph>foo</paragraph>[<widget></widget>]',
  803. 'forward',
  804. '<paragraph>foo</paragraph><paragraph>[]</paragraph>'
  805. );
  806. test(
  807. 'should delete selected widget with paragraph after - backward',
  808. '[<widget></widget>]<paragraph>foo</paragraph>',
  809. 'backward',
  810. '<paragraph>[]</paragraph><paragraph>foo</paragraph>'
  811. );
  812. test(
  813. 'should delete selected widget with paragraph after - forward',
  814. '[<widget></widget>]<paragraph>foo</paragraph>',
  815. 'forward',
  816. '<paragraph>[]</paragraph><paragraph>foo</paragraph>'
  817. );
  818. test(
  819. 'should delete selected widget between paragraphs - backward',
  820. '<paragraph>bar</paragraph>[<widget></widget>]<paragraph>foo</paragraph>',
  821. 'backward',
  822. '<paragraph>bar</paragraph><paragraph>[]</paragraph><paragraph>foo</paragraph>'
  823. );
  824. test(
  825. 'should delete selected widget between paragraphs - forward',
  826. '<paragraph>bar</paragraph>[<widget></widget>]<paragraph>foo</paragraph>',
  827. 'forward',
  828. '<paragraph>bar</paragraph><paragraph>[]</paragraph><paragraph>foo</paragraph>'
  829. );
  830. test(
  831. 'should delete selected widget preceded by another widget - backward',
  832. '<widget></widget>[<widget></widget>]',
  833. 'backward',
  834. '<widget></widget><paragraph>[]</paragraph>'
  835. );
  836. test(
  837. 'should delete selected widget preceded by another widget - forward',
  838. '<widget></widget>[<widget></widget>]',
  839. 'forward',
  840. '<widget></widget><paragraph>[]</paragraph>'
  841. );
  842. test(
  843. 'should delete selected widget before another widget - forward',
  844. '[<widget></widget>]<widget></widget>',
  845. 'forward',
  846. '<paragraph>[]</paragraph><widget></widget>'
  847. );
  848. test(
  849. 'should delete selected widget before another widget - backward',
  850. '[<widget></widget>]<widget></widget>',
  851. 'backward',
  852. '<paragraph>[]</paragraph><widget></widget>'
  853. );
  854. test(
  855. 'should delete selected widget between other widgets - forward',
  856. '<widget></widget>[<widget></widget>]<widget></widget>',
  857. 'forward',
  858. '<widget></widget><paragraph>[]</paragraph><widget></widget>'
  859. );
  860. test(
  861. 'should delete selected widget between other widgets - backward',
  862. '<widget></widget>[<widget></widget>]<widget></widget>',
  863. 'backward',
  864. '<widget></widget><paragraph>[]</paragraph><widget></widget>'
  865. );
  866. test(
  867. 'should select inline objects - backward',
  868. '<paragraph>foo<inline></inline>[]bar</paragraph>',
  869. 'backward',
  870. '<paragraph>foo[<inline></inline>]bar</paragraph>'
  871. );
  872. test(
  873. 'should select inline objects - forward',
  874. '<paragraph>foo[]<inline></inline>bar</paragraph>',
  875. 'forward',
  876. '<paragraph>foo[<inline></inline>]bar</paragraph>'
  877. );
  878. test(
  879. 'should delete selected inline objects - backward',
  880. '<paragraph>foo[<inline></inline>]bar</paragraph>',
  881. 'backward',
  882. '<paragraph>foo[]bar</paragraph>'
  883. );
  884. test(
  885. 'should delete selected inline objects - forward',
  886. '<paragraph>foo[<inline></inline>]bar</paragraph>',
  887. 'forward',
  888. '<paragraph>foo[]bar</paragraph>'
  889. );
  890. test(
  891. 'should use standard delete behaviour when after first letter - backward',
  892. '<paragraph>a[]</paragraph>',
  893. 'backward',
  894. '<paragraph>[]</paragraph>'
  895. );
  896. test(
  897. 'should use standard delete behaviour when before first letter - forward',
  898. '<paragraph>[]a</paragraph>',
  899. 'forward',
  900. '<paragraph>[]</paragraph>'
  901. );
  902. it( 'should prevent default behaviour and stop event propagation', () => {
  903. setModelData( model, '<paragraph>foo[]</paragraph><widget></widget>' );
  904. const scrollStub = sinon.stub( view, 'scrollToTheSelection' );
  905. const deleteSpy = sinon.spy();
  906. viewDocument.on( 'delete', deleteSpy );
  907. const domEventDataMock = { target: document.createElement( 'div' ), preventDefault: sinon.spy() };
  908. viewDocument.fire( 'delete', new DomEventData(
  909. viewDocument,
  910. domEventDataMock,
  911. { direction: 'forward', unit: 'character', sequence: 0 }
  912. ) );
  913. sinon.assert.calledOnce( domEventDataMock.preventDefault );
  914. sinon.assert.notCalled( deleteSpy );
  915. scrollStub.restore();
  916. } );
  917. test(
  918. 'should remove the entire empty element if it is next to a widget',
  919. '<paragraph>foo</paragraph>' +
  920. '<image></image>' +
  921. '<blockQuote><paragraph>[]</paragraph></blockQuote>' +
  922. '<paragraph>foo</paragraph>',
  923. 'backward',
  924. '<paragraph>foo</paragraph>[<image></image>]<paragraph>foo</paragraph>'
  925. );
  926. test(
  927. 'should remove the entire empty element (deeper structure) if it is next to a widget',
  928. '<paragraph>foo</paragraph>' +
  929. '<image></image>' +
  930. '<blockQuote><div><div><paragraph>[]</paragraph></div></div></blockQuote>' +
  931. '<paragraph>foo</paragraph>',
  932. 'backward',
  933. '<paragraph>foo</paragraph>' +
  934. '[<image></image>]' +
  935. '<paragraph>foo</paragraph>'
  936. );
  937. test(
  938. 'should remove the entire empty element (deeper structure) if it is next to a widget (forward delete)',
  939. '<paragraph>foo</paragraph>' +
  940. '<blockQuote><div><div><paragraph>[]</paragraph></div></div></blockQuote>' +
  941. '<image></image>' +
  942. '<paragraph>foo</paragraph>',
  943. 'forward',
  944. '<paragraph>foo</paragraph>' +
  945. '[<image></image>]' +
  946. '<paragraph>foo</paragraph>'
  947. );
  948. test(
  949. 'should not remove the entire element which is not empty and the element is next to a widget',
  950. '<paragraph>foo</paragraph>' +
  951. '<image></image>' +
  952. '<blockQuote><paragraph>[]</paragraph><paragraph></paragraph></blockQuote>' +
  953. '<paragraph>foo</paragraph>',
  954. 'backward',
  955. '<paragraph>foo</paragraph>' +
  956. '[<image></image>]' +
  957. '<blockQuote><paragraph></paragraph></blockQuote>' +
  958. '<paragraph>foo</paragraph>'
  959. );
  960. test(
  961. 'should not remove the entire element which is not empty and the element is next to a widget (forward delete)',
  962. '<paragraph>foo</paragraph>' +
  963. '<blockQuote><paragraph>Foo</paragraph><paragraph>[]</paragraph></blockQuote>' +
  964. '<image></image>' +
  965. '<paragraph>foo</paragraph>',
  966. 'forward',
  967. '<paragraph>foo</paragraph>' +
  968. '<blockQuote><paragraph>Foo</paragraph></blockQuote>' +
  969. '[<image></image>]' +
  970. '<paragraph>foo</paragraph>'
  971. );
  972. test(
  973. 'should not remove the entire element (deeper structure) which is not empty and the element is next to a widget',
  974. '<paragraph>foo</paragraph>' +
  975. '<image></image>' +
  976. '<blockQuote>' +
  977. '<div>' +
  978. '<div>' +
  979. '<paragraph>[]</paragraph>' +
  980. '</div>' +
  981. '</div>' +
  982. '<paragraph></paragraph>' +
  983. '</blockQuote>' +
  984. '<paragraph>foo</paragraph>',
  985. 'backward',
  986. '<paragraph>foo</paragraph>' +
  987. '[<image></image>]' +
  988. '<blockQuote>' +
  989. '<paragraph></paragraph>' +
  990. '</blockQuote>' +
  991. '<paragraph>foo</paragraph>'
  992. );
  993. test(
  994. 'should do nothing if the nested element is not empty and the element is next to a widget',
  995. '<paragraph>foo</paragraph>' +
  996. '<image></image>' +
  997. '<blockQuote>' +
  998. '<div>' +
  999. '<div>' +
  1000. '<paragraph>Foo[]</paragraph>' +
  1001. '</div>' +
  1002. '</div>' +
  1003. '</blockQuote>' +
  1004. '<paragraph>foo</paragraph>',
  1005. 'backward',
  1006. '<paragraph>foo</paragraph>' +
  1007. '<image></image>' +
  1008. '<blockQuote>' +
  1009. '<div>' +
  1010. '<div>' +
  1011. '<paragraph>Fo[]</paragraph>' +
  1012. '</div>' +
  1013. '</div>' +
  1014. '</blockQuote>' +
  1015. '<paragraph>foo</paragraph>'
  1016. );
  1017. it( 'does nothing when editor when read only mode is enabled (delete)', () => {
  1018. const scrollStub = sinon.stub( view, 'scrollToTheSelection' );
  1019. setModelData( model,
  1020. '<paragraph>foo</paragraph>' +
  1021. '<image></image>' +
  1022. '<blockQuote><paragraph>[]</paragraph></blockQuote>' +
  1023. '<paragraph>foo</paragraph>'
  1024. );
  1025. editor.isReadOnly = true;
  1026. const domEventDataMock = { target: document.createElement( 'div' ), preventDefault: sinon.spy() };
  1027. viewDocument.fire( 'delete', new DomEventData(
  1028. viewDocument,
  1029. domEventDataMock,
  1030. { direction: 'backward', unit: 'character', sequence: 0 }
  1031. ) );
  1032. expect( getModelData( model ) ).to.equal(
  1033. '<paragraph>foo</paragraph>' +
  1034. '<image></image>' +
  1035. '<blockQuote><paragraph>[]</paragraph></blockQuote>' +
  1036. '<paragraph>foo</paragraph>'
  1037. );
  1038. scrollStub.restore();
  1039. } );
  1040. it( 'does nothing when editor when read only mode is enabled (forward delete)', () => {
  1041. const scrollStub = sinon.stub( view, 'scrollToTheSelection' );
  1042. setModelData( model,
  1043. '<paragraph>foo</paragraph>' +
  1044. '<image></image>' +
  1045. '<blockQuote><paragraph>[]</paragraph></blockQuote>' +
  1046. '<paragraph>foo</paragraph>'
  1047. );
  1048. editor.isReadOnly = true;
  1049. const domEventDataMock = { target: document.createElement( 'div' ), preventDefault: sinon.spy() };
  1050. viewDocument.fire( 'delete', new DomEventData(
  1051. viewDocument,
  1052. domEventDataMock,
  1053. { direction: 'forward', unit: 'character', sequence: 0 }
  1054. ) );
  1055. expect( getModelData( model ) ).to.equal(
  1056. '<paragraph>foo</paragraph>' +
  1057. '<image></image>' +
  1058. '<blockQuote><paragraph>[]</paragraph></blockQuote>' +
  1059. '<paragraph>foo</paragraph>'
  1060. );
  1061. scrollStub.restore();
  1062. } );
  1063. } );
  1064. describe( 'selection handle', () => {
  1065. let element, editor;
  1066. beforeEach( () => {
  1067. element = document.createElement( 'div' );
  1068. document.body.appendChild( element );
  1069. return ClassicTestEditor
  1070. .create( element, {
  1071. plugins: [ Widget, Typing ]
  1072. } )
  1073. .then( newEditor => {
  1074. editor = newEditor;
  1075. model = editor.model;
  1076. view = editor.editing.view;
  1077. viewDocument = view.document;
  1078. model.schema.register( 'widget', {
  1079. inheritAllFrom: '$block',
  1080. allowIn: 'widget',
  1081. isObject: true
  1082. } );
  1083. model.schema.register( 'nested', {
  1084. allowIn: 'widget',
  1085. isLimit: true
  1086. } );
  1087. model.schema.extend( '$text', {
  1088. allowIn: 'nested'
  1089. } );
  1090. editor.conversion.for( 'downcast' )
  1091. .elementToElement( { model: 'paragraph', view: 'p' } )
  1092. .elementToElement( {
  1093. model: 'widget',
  1094. view: ( modelItem, viewWriter ) => {
  1095. const widget = viewWriter.createContainerElement( 'div' );
  1096. return toWidget( widget, viewWriter, { hasSelectionHandle: true } );
  1097. }
  1098. } )
  1099. .elementToElement( {
  1100. model: 'nested',
  1101. view: ( modelItem, viewWriter ) => viewWriter.createEditableElement( 'figcaption', { contenteditable: true } )
  1102. } );
  1103. } );
  1104. } );
  1105. afterEach( () => {
  1106. element.remove();
  1107. return editor.destroy();
  1108. } );
  1109. it( 'should select a widget on mouse click', () => {
  1110. setModelData( model, '<paragraph>bar</paragraph><widget></widget><paragraph>foo[]</paragraph>' );
  1111. const viewWidgetSelectionHandle = viewDocument.getRoot().getChild( 1 ).getChild( 0 );
  1112. const domEventDataMock = new DomEventData( view, {
  1113. target: view.domConverter.mapViewToDom( viewWidgetSelectionHandle ),
  1114. preventDefault: sinon.spy()
  1115. } );
  1116. viewDocument.fire( 'mousedown', domEventDataMock );
  1117. expect( getModelData( model ) ).to.equal( '<paragraph>bar</paragraph>[<widget></widget>]<paragraph>foo</paragraph>' );
  1118. } );
  1119. it( 'should select the most top-outer widget if widgets are nested', () => {
  1120. setModelData( model, '<widget><widget></widget><widget></widget></widget>' );
  1121. // The top-outer widget.
  1122. const viewWidgetSelectionHandle = viewDocument.getRoot().getChild( 0 );
  1123. const domEventDataMock = new DomEventData( view, {
  1124. target: view.domConverter.mapViewToDom( viewWidgetSelectionHandle ),
  1125. preventDefault: sinon.spy()
  1126. } );
  1127. viewDocument.fire( 'mousedown', domEventDataMock );
  1128. expect( getViewData( view ) ).to.equal(
  1129. '[<div class="' +
  1130. 'ck-widget ' +
  1131. 'ck-widget_can-type-around_after ck-widget_can-type-around_before ' +
  1132. 'ck-widget_selected ck-widget_with-selection-handle" contenteditable="false"' +
  1133. '>' +
  1134. '<div class="' +
  1135. 'ck-widget ' +
  1136. 'ck-widget_can-type-around_after ck-widget_can-type-around_before ' +
  1137. 'ck-widget_with-selection-handle" contenteditable="false"' +
  1138. '>' +
  1139. '<div class="ck ck-widget__selection-handle"></div>' +
  1140. '<div class="ck ck-reset_all ck-widget__type-around"></div>' +
  1141. '</div>' +
  1142. '<div class="ck-widget ck-widget_can-type-around_before ck-widget_with-selection-handle" contenteditable="false">' +
  1143. '<div class="ck ck-widget__selection-handle"></div>' +
  1144. '<div class="ck ck-reset_all ck-widget__type-around"></div>' +
  1145. '</div>' +
  1146. '<div class="ck ck-widget__selection-handle"></div>' +
  1147. '<div class="ck ck-reset_all ck-widget__type-around"></div>' +
  1148. '</div>]'
  1149. );
  1150. } );
  1151. it( 'should select a proper widget if they are nested and multiplied', () => {
  1152. setModelData( model,
  1153. '<widget></widget>' +
  1154. '<widget>' +
  1155. '<widget></widget>' +
  1156. '<widget></widget>' +
  1157. '</widget>' +
  1158. '<widget></widget>'
  1159. );
  1160. const viewWidgetSelectionHandle = viewDocument.getRoot().getChild( 1 );
  1161. const domEventDataMock = new DomEventData( view, {
  1162. target: view.domConverter.mapViewToDom( viewWidgetSelectionHandle ),
  1163. preventDefault: sinon.spy()
  1164. } );
  1165. viewDocument.fire( 'mousedown', domEventDataMock );
  1166. expect( getViewData( view ) ).to.equal(
  1167. '<div class="ck-widget ck-widget_can-type-around_after ck-widget_can-type-around_before ck-widget_with-selection-handle" ' +
  1168. 'contenteditable="false">' +
  1169. '<div class="ck ck-widget__selection-handle"></div>' +
  1170. '<div class="ck ck-reset_all ck-widget__type-around"></div>' +
  1171. '</div>' +
  1172. '[<div class="' +
  1173. 'ck-widget ' +
  1174. 'ck-widget_can-type-around_after ck-widget_can-type-around_before ' +
  1175. 'ck-widget_selected ck-widget_with-selection-handle" contenteditable="false"' +
  1176. '>' +
  1177. '<div ' +
  1178. 'class="ck-widget ck-widget_can-type-around_after ck-widget_can-type-around_before ck-widget_with-selection-handle" ' +
  1179. 'contenteditable="false">' +
  1180. '<div class="ck ck-widget__selection-handle"></div>' +
  1181. '<div class="ck ck-reset_all ck-widget__type-around"></div>' +
  1182. '</div>' +
  1183. '<div class="ck-widget ck-widget_can-type-around_before ck-widget_with-selection-handle" ' +
  1184. 'contenteditable="false">' +
  1185. '<div class="ck ck-widget__selection-handle"></div>' +
  1186. '<div class="ck ck-reset_all ck-widget__type-around"></div>' +
  1187. '</div>' +
  1188. '<div class="ck ck-widget__selection-handle"></div>' +
  1189. '<div class="ck ck-reset_all ck-widget__type-around"></div>' +
  1190. '</div>]' +
  1191. '<div ' +
  1192. 'class="ck-widget ck-widget_can-type-around_after ck-widget_can-type-around_before ck-widget_with-selection-handle" ' +
  1193. 'contenteditable="false">' +
  1194. '<div class="ck ck-widget__selection-handle"></div>' +
  1195. '<div class="ck ck-reset_all ck-widget__type-around"></div>' +
  1196. '</div>'
  1197. );
  1198. } );
  1199. it( 'works fine with a widget that contains more children', () => {
  1200. setModelData( model,
  1201. '<widget>' +
  1202. '<nested>foo bar</nested>' +
  1203. '<widget></widget>' +
  1204. '</widget>'
  1205. );
  1206. const viewWidgetSelectionHandle = viewDocument.getRoot().getChild( 0 );
  1207. const domEventDataMock = new DomEventData( view, {
  1208. target: view.domConverter.mapViewToDom( viewWidgetSelectionHandle ),
  1209. preventDefault: sinon.spy()
  1210. } );
  1211. viewDocument.fire( 'mousedown', domEventDataMock );
  1212. expect( getViewData( view ) ).to.equal(
  1213. '[<div class="' +
  1214. 'ck-widget ' +
  1215. 'ck-widget_can-type-around_after ck-widget_can-type-around_before ' +
  1216. 'ck-widget_selected ck-widget_with-selection-handle" contenteditable="false"' +
  1217. '>' +
  1218. '<figcaption contenteditable="true">foo bar</figcaption>' +
  1219. '<div class="ck-widget ck-widget_with-selection-handle" contenteditable="false">' +
  1220. '<div class="ck ck-widget__selection-handle"></div>' +
  1221. '<div class="ck ck-reset_all ck-widget__type-around"></div>' +
  1222. '</div>' +
  1223. '<div class="ck ck-widget__selection-handle"></div>' +
  1224. '<div class="ck ck-reset_all ck-widget__type-around"></div>' +
  1225. '</div>]'
  1226. );
  1227. } );
  1228. it( 'should select a proper widget for more complex structures', () => {
  1229. setModelData( model,
  1230. '<widget>' +
  1231. '<widget></widget>' +
  1232. '<widget>' +
  1233. '<widget></widget>' +
  1234. '</widget>' +
  1235. '</widget>'
  1236. );
  1237. const viewWidgetSelectionHandle = viewDocument.getRoot().getChild( 0 ).getChild( 1 );
  1238. const domEventDataMock = new DomEventData( view, {
  1239. target: view.domConverter.mapViewToDom( viewWidgetSelectionHandle ),
  1240. preventDefault: sinon.spy()
  1241. } );
  1242. viewDocument.fire( 'mousedown', domEventDataMock );
  1243. expect( getViewData( view ) ).to.equal(
  1244. '<div class="' +
  1245. 'ck-widget ' +
  1246. 'ck-widget_can-type-around_after ck-widget_can-type-around_before ' +
  1247. 'ck-widget_with-selection-handle" contenteditable="false"' +
  1248. '>' +
  1249. '<div class="' +
  1250. 'ck-widget ' +
  1251. 'ck-widget_can-type-around_after ck-widget_can-type-around_before ' +
  1252. 'ck-widget_with-selection-handle" contenteditable="false"' +
  1253. '>' +
  1254. '<div class="ck ck-widget__selection-handle"></div>' +
  1255. '<div class="ck ck-reset_all ck-widget__type-around"></div>' +
  1256. '</div>' +
  1257. '[<div class="' +
  1258. 'ck-widget ' +
  1259. 'ck-widget_can-type-around_before ' +
  1260. 'ck-widget_selected ck-widget_with-selection-handle" contenteditable="false"' +
  1261. '>' +
  1262. '<div class="ck-widget ck-widget_can-type-around_before ck-widget_with-selection-handle" contenteditable="false">' +
  1263. '<div class="ck ck-widget__selection-handle"></div>' +
  1264. '<div class="ck ck-reset_all ck-widget__type-around"></div>' +
  1265. '</div>' +
  1266. '<div class="ck ck-widget__selection-handle"></div>' +
  1267. '<div class="ck ck-reset_all ck-widget__type-around"></div>' +
  1268. '</div>]' +
  1269. '<div class="ck ck-widget__selection-handle"></div>' +
  1270. '<div class="ck ck-reset_all ck-widget__type-around"></div>' +
  1271. '</div>'
  1272. );
  1273. } );
  1274. it( 'should select widget in editable', () => {
  1275. model.schema.extend( 'widget', { allowIn: 'nested' } );
  1276. setModelData( model, '[]<widget><nested><widget></widget></nested></widget>' );
  1277. const widgetInEditable = viewDocument.getRoot().getChild( 0 ).getChild( 0 ).getChild( 0 );
  1278. const domEventDataMock = new DomEventData( view, {
  1279. target: view.domConverter.mapViewToDom( widgetInEditable ),
  1280. preventDefault: sinon.spy()
  1281. } );
  1282. viewDocument.fire( 'mousedown', domEventDataMock );
  1283. expect( getViewData( view ) ).to.equal(
  1284. '<div class="' +
  1285. 'ck-widget ' +
  1286. 'ck-widget_can-type-around_after ck-widget_can-type-around_before ' +
  1287. 'ck-widget_with-selection-handle" contenteditable="false"' +
  1288. '>' +
  1289. '<figcaption contenteditable="true">[' +
  1290. '<div class="' +
  1291. 'ck-widget ' +
  1292. 'ck-widget_can-type-around_after ck-widget_can-type-around_before ' +
  1293. 'ck-widget_selected ck-widget_with-selection-handle" contenteditable="false"' +
  1294. '>' +
  1295. '<div class="ck ck-widget__selection-handle"></div>' +
  1296. '<div class="ck ck-reset_all ck-widget__type-around"></div>' +
  1297. '</div>]' +
  1298. '</figcaption>' +
  1299. '<div class="ck ck-widget__selection-handle"></div>' +
  1300. '<div class="ck ck-reset_all ck-widget__type-around"></div>' +
  1301. '</div>'
  1302. );
  1303. } );
  1304. } );
  1305. } );