widget.js 43 KB

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