downcast-converters.js 51 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660
  1. /**
  2. * @license Copyright (c) 2003-2018, CKSource - Frederico Knabben. All rights reserved.
  3. * For licensing, see LICENSE.md.
  4. */
  5. import EditingController from '../../src/controller/editingcontroller';
  6. import Conversion from '../../src/conversion/conversion';
  7. import Model from '../../src/model/model';
  8. import ModelElement from '../../src/model/element';
  9. import ModelText from '../../src/model/text';
  10. import ModelRange from '../../src/model/range';
  11. import ModelPosition from '../../src/model/position';
  12. import ViewElement from '../../src/view/element';
  13. import ViewContainerElement from '../../src/view/containerelement';
  14. import ViewUIElement from '../../src/view/uielement';
  15. import ViewText from '../../src/view/text';
  16. import {
  17. downcastElementToElement, downcastAttributeToElement, downcastAttributeToAttribute, downcastMarkerToElement, downcastMarkerToHighlight,
  18. insertElement, insertUIElement, changeAttribute, wrap, removeUIElement,
  19. highlightElement, highlightText, removeHighlight, createViewElementFromHighlightDescriptor
  20. } from '../../src/conversion/downcast-converters';
  21. import { stringify } from '../../src/dev-utils/view';
  22. describe( 'downcast-helpers', () => {
  23. let conversion, model, modelRoot, viewRoot;
  24. beforeEach( () => {
  25. model = new Model();
  26. const modelDoc = model.document;
  27. modelRoot = modelDoc.createRoot();
  28. const controller = new EditingController( model );
  29. // Set name of view root the same as dom root.
  30. // This is a mock of attaching view root to dom root.
  31. controller.view.document.getRoot()._name = 'div';
  32. viewRoot = controller.view.document.getRoot();
  33. conversion = new Conversion();
  34. conversion.register( 'downcast', [ controller.downcastDispatcher ] );
  35. } );
  36. describe( 'downcastElementToElement', () => {
  37. it( 'config.view is a string', () => {
  38. const helper = downcastElementToElement( { model: 'paragraph', view: 'p' } );
  39. conversion.for( 'downcast' ).add( helper );
  40. model.change( writer => {
  41. writer.insertElement( 'paragraph', modelRoot, 0 );
  42. } );
  43. expectResult( '<p></p>' );
  44. } );
  45. it( 'can be overwritten using priority', () => {
  46. const helperA = downcastElementToElement( { model: 'paragraph', view: 'p' } );
  47. const helperB = downcastElementToElement( { model: 'paragraph', view: 'foo', priority: 'high' } );
  48. conversion.for( 'downcast' ).add( helperA ).add( helperB );
  49. model.change( writer => {
  50. writer.insertElement( 'paragraph', modelRoot, 0 );
  51. } );
  52. expectResult( '<foo></foo>' );
  53. } );
  54. it( 'config.view is a view element definition', () => {
  55. const helper = downcastElementToElement( {
  56. model: 'fancyParagraph',
  57. view: {
  58. name: 'p',
  59. class: 'fancy'
  60. }
  61. } );
  62. conversion.for( 'downcast' ).add( helper );
  63. model.change( writer => {
  64. writer.insertElement( 'fancyParagraph', modelRoot, 0 );
  65. } );
  66. expectResult( '<p class="fancy"></p>' );
  67. } );
  68. it( 'config.view is a function', () => {
  69. const helper = downcastElementToElement( {
  70. model: 'heading',
  71. view: ( modelElement, viewWriter ) => viewWriter.createContainerElement( 'h' + modelElement.getAttribute( 'level' ) )
  72. } );
  73. conversion.for( 'downcast' ).add( helper );
  74. model.change( writer => {
  75. writer.insertElement( 'heading', { level: 2 }, modelRoot, 0 );
  76. } );
  77. expectResult( '<h2></h2>' );
  78. } );
  79. } );
  80. describe( 'downcastAttributeToElement', () => {
  81. it( 'config.view is a string', () => {
  82. const helper = downcastAttributeToElement( { model: 'bold', view: 'strong' } );
  83. conversion.for( 'downcast' ).add( helper );
  84. model.change( writer => {
  85. writer.insertText( 'foo', { bold: true }, modelRoot, 0 );
  86. } );
  87. expectResult( '<strong>foo</strong>' );
  88. } );
  89. it( 'can be overwritten using priority', () => {
  90. const helperA = downcastAttributeToElement( { model: 'bold', view: 'strong' } );
  91. const helperB = downcastAttributeToElement( { model: 'bold', view: 'b', priority: 'high' } );
  92. conversion.for( 'downcast' ).add( helperA ).add( helperB );
  93. model.change( writer => {
  94. writer.insertText( 'foo', { bold: true }, modelRoot, 0 );
  95. } );
  96. expectResult( '<b>foo</b>' );
  97. } );
  98. it( 'config.view is a view element definition', () => {
  99. const helper = downcastAttributeToElement( {
  100. model: 'invert',
  101. view: {
  102. name: 'span',
  103. class: [ 'font-light', 'bg-dark' ]
  104. }
  105. } );
  106. conversion.for( 'downcast' ).add( helper );
  107. model.change( writer => {
  108. writer.insertText( 'foo', { invert: true }, modelRoot, 0 );
  109. } );
  110. expectResult( '<span class="bg-dark font-light">foo</span>' );
  111. } );
  112. it( 'model attribute value is enum', () => {
  113. const helper = downcastAttributeToElement( {
  114. model: {
  115. key: 'fontSize',
  116. values: [ 'big', 'small' ]
  117. },
  118. view: {
  119. big: {
  120. name: 'span',
  121. style: {
  122. 'font-size': '1.2em'
  123. }
  124. },
  125. small: {
  126. name: 'span',
  127. style: {
  128. 'font-size': '0.8em'
  129. }
  130. }
  131. }
  132. } );
  133. conversion.for( 'downcast' ).add( helper );
  134. model.change( writer => {
  135. writer.insertText( 'foo', { fontSize: 'big' }, modelRoot, 0 );
  136. } );
  137. expectResult( '<span style="font-size:1.2em">foo</span>' );
  138. model.change( writer => {
  139. writer.setAttribute( 'fontSize', 'small', modelRoot.getChild( 0 ) );
  140. } );
  141. expectResult( '<span style="font-size:0.8em">foo</span>' );
  142. model.change( writer => {
  143. writer.removeAttribute( 'fontSize', modelRoot.getChild( 0 ) );
  144. } );
  145. expectResult( 'foo' );
  146. } );
  147. it( 'config.view is a function', () => {
  148. const helper = downcastAttributeToElement( {
  149. model: 'bold',
  150. view: ( modelAttributeValue, viewWriter ) => {
  151. return viewWriter.createAttributeElement( 'span', { style: 'font-weight:' + modelAttributeValue } );
  152. }
  153. } );
  154. conversion.for( 'downcast' ).add( helper );
  155. model.change( writer => {
  156. writer.insertText( 'foo', { bold: '500' }, modelRoot, 0 );
  157. } );
  158. expectResult( '<span style="font-weight:500">foo</span>' );
  159. } );
  160. it( 'config.model.name is given', () => {
  161. const helper = downcastAttributeToElement( {
  162. model: {
  163. key: 'color',
  164. name: '$text'
  165. },
  166. view: ( modelAttributeValue, viewWriter ) => {
  167. return viewWriter.createAttributeElement( 'span', { style: 'color:' + modelAttributeValue } );
  168. }
  169. } );
  170. conversion.for( 'downcast' )
  171. .add( helper )
  172. .add( downcastElementToElement( {
  173. model: 'smiley',
  174. view: ( modelElement, viewWriter ) => {
  175. return viewWriter.createEmptyElement( 'img', {
  176. src: 'smile.jpg',
  177. class: 'smiley'
  178. } );
  179. }
  180. } ) );
  181. model.change( writer => {
  182. writer.insertText( 'foo', { color: '#FF0000' }, modelRoot, 0 );
  183. writer.insertElement( 'smiley', { color: '#FF0000' }, modelRoot, 3 );
  184. } );
  185. expectResult( '<span style="color:#FF0000">foo</span><img class="smiley" src="smile.jpg"></img>' );
  186. } );
  187. } );
  188. describe( 'downcastAttributeToAttribute', () => {
  189. beforeEach( () => {
  190. conversion.for( 'downcast' ).add( downcastElementToElement( { model: 'image', view: 'img' } ) );
  191. } );
  192. it( 'config.view is a string', () => {
  193. const helper = downcastAttributeToAttribute( { model: 'source', view: 'src' } );
  194. conversion.for( 'downcast' ).add( helper );
  195. model.change( writer => {
  196. writer.insertElement( 'image', { source: 'foo.jpg' }, modelRoot, 0 );
  197. } );
  198. expectResult( '<img src="foo.jpg"></img>' );
  199. model.change( writer => {
  200. writer.removeAttribute( 'source', modelRoot.getChild( 0 ) );
  201. } );
  202. expectResult( '<img></img>' );
  203. } );
  204. it( 'can be overwritten using priority', () => {
  205. const helperA = downcastAttributeToAttribute( { model: 'source', view: 'href' } );
  206. const helperB = downcastAttributeToAttribute( { model: 'source', view: 'src', priority: 'high' } );
  207. conversion.for( 'downcast' ).add( helperA ).add( helperB );
  208. model.change( writer => {
  209. writer.insertElement( 'image', { source: 'foo.jpg' }, modelRoot, 0 );
  210. } );
  211. expectResult( '<img src="foo.jpg"></img>' );
  212. } );
  213. it( 'model element name specified', () => {
  214. conversion.for( 'downcast' ).add( downcastElementToElement( { model: 'paragraph', view: 'p' } ) );
  215. const helper = downcastAttributeToAttribute( {
  216. model: {
  217. name: 'image',
  218. key: 'source'
  219. },
  220. view: 'src'
  221. } );
  222. conversion.for( 'downcast' ).add( helper );
  223. model.change( writer => {
  224. writer.insertElement( 'image', { source: 'foo.jpg' }, modelRoot, 0 );
  225. } );
  226. expectResult( '<img src="foo.jpg"></img>' );
  227. model.change( writer => {
  228. writer.rename( modelRoot.getChild( 0 ), 'paragraph' );
  229. } );
  230. expectResult( '<p></p>' );
  231. } );
  232. it( 'config.view is an object, model attribute value is enum', () => {
  233. conversion.for( 'downcast' ).add( downcastElementToElement( { model: 'paragraph', view: 'p' } ) );
  234. const helper = downcastAttributeToAttribute( {
  235. model: {
  236. key: 'styled',
  237. values: [ 'dark', 'light' ]
  238. },
  239. view: {
  240. dark: {
  241. key: 'class',
  242. value: [ 'styled', 'styled-dark' ]
  243. },
  244. light: {
  245. key: 'class',
  246. value: [ 'styled', 'styled-light' ]
  247. }
  248. }
  249. } );
  250. conversion.for( 'downcast' ).add( helper );
  251. model.change( writer => {
  252. writer.insertElement( 'paragraph', { styled: 'dark' }, modelRoot, 0 );
  253. } );
  254. expectResult( '<p class="styled styled-dark"></p>' );
  255. model.change( writer => {
  256. writer.setAttribute( 'styled', 'light', modelRoot.getChild( 0 ) );
  257. } );
  258. expectResult( '<p class="styled styled-light"></p>' );
  259. model.change( writer => {
  260. writer.removeAttribute( 'styled', modelRoot.getChild( 0 ) );
  261. } );
  262. expectResult( '<p></p>' );
  263. } );
  264. it( 'config.view is an object, model attribute value is enum, view has style', () => {
  265. conversion.for( 'downcast' ).add( downcastElementToElement( { model: 'paragraph', view: 'p' } ) );
  266. const helper = downcastAttributeToAttribute( {
  267. model: {
  268. key: 'align',
  269. values: [ 'right', 'center' ]
  270. },
  271. view: {
  272. right: {
  273. key: 'style',
  274. value: {
  275. 'text-align': 'right'
  276. }
  277. },
  278. center: {
  279. key: 'style',
  280. value: {
  281. 'text-align': 'center'
  282. }
  283. }
  284. }
  285. } );
  286. conversion.for( 'downcast' ).add( helper );
  287. model.change( writer => {
  288. writer.insertElement( 'paragraph', { align: 'right' }, modelRoot, 0 );
  289. } );
  290. expectResult( '<p style="text-align:right"></p>' );
  291. model.change( writer => {
  292. writer.setAttribute( 'align', 'center', modelRoot.getChild( 0 ) );
  293. } );
  294. expectResult( '<p style="text-align:center"></p>' );
  295. model.change( writer => {
  296. writer.removeAttribute( 'align', modelRoot.getChild( 0 ) );
  297. } );
  298. expectResult( '<p></p>' );
  299. } );
  300. it( 'config.view is a function', () => {
  301. const helper = downcastAttributeToAttribute( {
  302. model: 'styled',
  303. view: attributeValue => ( { key: 'class', value: 'styled-' + attributeValue } )
  304. } );
  305. conversion.for( 'downcast' ).add( helper );
  306. model.change( writer => {
  307. writer.insertElement( 'image', { styled: 'pull-out' }, modelRoot, 0 );
  308. } );
  309. expectResult( '<img class="styled-pull-out"></img>' );
  310. } );
  311. } );
  312. describe( 'downcastMarkerToElement', () => {
  313. it( 'config.view is a string', () => {
  314. const helper = downcastMarkerToElement( { model: 'search', view: 'marker-search' } );
  315. conversion.for( 'downcast' ).add( helper );
  316. model.change( writer => {
  317. writer.insertText( 'foo', modelRoot, 0 );
  318. writer.setMarker( 'search', ModelRange.createFromParentsAndOffsets( modelRoot, 1, modelRoot, 2 ) );
  319. } );
  320. expectResult( 'f<marker-search></marker-search>o<marker-search></marker-search>o' );
  321. } );
  322. it( 'can be overwritten using priority', () => {
  323. const helperA = downcastMarkerToElement( { model: 'search', view: 'marker-search' } );
  324. const helperB = downcastMarkerToElement( { model: 'search', view: 'search', priority: 'high' } );
  325. conversion.for( 'downcast' ).add( helperA ).add( helperB );
  326. model.change( writer => {
  327. writer.insertText( 'foo', modelRoot, 0 );
  328. writer.setMarker( 'search', ModelRange.createFromParentsAndOffsets( modelRoot, 1, modelRoot, 2 ) );
  329. } );
  330. expectResult( 'f<search></search>o<search></search>o' );
  331. } );
  332. it( 'config.view is a view element definition', () => {
  333. const helper = downcastMarkerToElement( {
  334. model: 'search',
  335. view: {
  336. name: 'span',
  337. attribute: {
  338. 'data-marker': 'search'
  339. }
  340. }
  341. } );
  342. conversion.for( 'downcast' ).add( helper );
  343. model.change( writer => {
  344. writer.insertText( 'foo', modelRoot, 0 );
  345. writer.setMarker( 'search', ModelRange.createFromParentsAndOffsets( modelRoot, 1, modelRoot, 2 ) );
  346. } );
  347. expectResult( 'f<span data-marker="search"></span>o<span data-marker="search"></span>o' );
  348. } );
  349. it( 'config.view is a function', () => {
  350. const helper = downcastMarkerToElement( {
  351. model: 'search',
  352. view: ( data, viewWriter ) => {
  353. return viewWriter.createUIElement( 'span', { 'data-marker': 'search', 'data-start': data.isOpening } );
  354. }
  355. } );
  356. conversion.for( 'downcast' ).add( helper );
  357. model.change( writer => {
  358. writer.insertText( 'foo', modelRoot, 0 );
  359. writer.setMarker( 'search', ModelRange.createFromParentsAndOffsets( modelRoot, 1, modelRoot, 2 ) );
  360. } );
  361. expectResult( 'f<span data-marker="search" data-start="true"></span>o<span data-marker="search" data-start="false"></span>o' );
  362. } );
  363. } );
  364. describe( 'downcastMarkerToHighlight', () => {
  365. it( 'config.view is a highlight descriptor', () => {
  366. const helper = downcastMarkerToHighlight( { model: 'comment', view: { class: 'comment' } } );
  367. conversion.for( 'downcast' ).add( helper );
  368. model.change( writer => {
  369. writer.insertText( 'foo', modelRoot, 0 );
  370. writer.setMarker( 'comment', ModelRange.createFromParentsAndOffsets( modelRoot, 0, modelRoot, 3 ) );
  371. } );
  372. expectResult( '<span class="comment">foo</span>' );
  373. } );
  374. it( 'can be overwritten using priority', () => {
  375. const helperA = downcastMarkerToHighlight( { model: 'comment', view: { class: 'comment' } } );
  376. const helperB = downcastMarkerToHighlight( { model: 'comment', view: { class: 'new-comment' }, priority: 'high' } );
  377. conversion.for( 'downcast' ).add( helperA ).add( helperB );
  378. model.change( writer => {
  379. writer.insertText( 'foo', modelRoot, 0 );
  380. writer.setMarker( 'comment', ModelRange.createFromParentsAndOffsets( modelRoot, 0, modelRoot, 3 ) );
  381. } );
  382. expectResult( '<span class="new-comment">foo</span>' );
  383. } );
  384. it( 'config.view is a function', () => {
  385. const helper = downcastMarkerToHighlight( {
  386. model: 'comment',
  387. view: data => {
  388. const commentType = data.markerName.split( ':' )[ 1 ];
  389. return {
  390. class: [ 'comment', 'comment-' + commentType ]
  391. };
  392. }
  393. } );
  394. conversion.for( 'downcast' ).add( helper );
  395. model.change( writer => {
  396. writer.insertText( 'foo', modelRoot, 0 );
  397. writer.setMarker( 'comment:abc', ModelRange.createFromParentsAndOffsets( modelRoot, 0, modelRoot, 3 ) );
  398. } );
  399. expectResult( '<span class="comment comment-abc">foo</span>' );
  400. } );
  401. } );
  402. function expectResult( string ) {
  403. expect( stringify( viewRoot, null, { ignoreRoot: true } ) ).to.equal( string );
  404. }
  405. } );
  406. describe( 'downcast-converters', () => {
  407. let dispatcher, modelDoc, modelRoot, viewRoot, controller, modelRootStart, model;
  408. beforeEach( () => {
  409. model = new Model();
  410. modelDoc = model.document;
  411. modelRoot = modelDoc.createRoot();
  412. controller = new EditingController( model );
  413. viewRoot = controller.view.document.getRoot();
  414. // Set name of view root the same as dom root.
  415. // This is a mock of attaching view root to dom root.
  416. controller.view.document.getRoot()._name = 'div';
  417. dispatcher = controller.downcastDispatcher;
  418. dispatcher.on(
  419. 'insert:paragraph',
  420. insertElement(
  421. ( modelItem, viewWriter ) => viewWriter.createContainerElement( 'p' )
  422. )
  423. );
  424. dispatcher.on( 'attribute:class', changeAttribute() );
  425. modelRootStart = ModelPosition.createAt( modelRoot, 0 );
  426. } );
  427. function viewAttributesToString( item ) {
  428. let result = '';
  429. for ( const key of item.getAttributeKeys() ) {
  430. const value = item.getAttribute( key );
  431. if ( value ) {
  432. result += ' ' + key + '="' + value + '"';
  433. }
  434. }
  435. return result;
  436. }
  437. function viewToString( item ) {
  438. let result = '';
  439. if ( item instanceof ViewText ) {
  440. result = item.data;
  441. } else {
  442. // ViewElement or ViewDocumentFragment.
  443. for ( const child of item.getChildren() ) {
  444. result += viewToString( child );
  445. }
  446. if ( item instanceof ViewElement ) {
  447. result = '<' + item.name + viewAttributesToString( item ) + '>' + result + '</' + item.name + '>';
  448. }
  449. }
  450. return result;
  451. }
  452. describe( 'insertText', () => {
  453. it( 'should downcast text', () => {
  454. model.change( writer => {
  455. writer.insert( new ModelText( 'foobar' ), modelRootStart );
  456. } );
  457. expect( viewToString( viewRoot ) ).to.equal( '<div>foobar</div>' );
  458. } );
  459. it( 'should support unicode', () => {
  460. model.change( writer => {
  461. writer.insert( new ModelText( 'நிலைக்கு' ), modelRootStart );
  462. } );
  463. expect( viewToString( viewRoot ) ).to.equal( '<div>நிலைக்கு</div>' );
  464. } );
  465. it( 'should be possible to override it', () => {
  466. dispatcher.on( 'insert:$text', ( evt, data, conversionApi ) => {
  467. conversionApi.consumable.consume( data.item, 'insert' );
  468. }, { priority: 'high' } );
  469. model.change( writer => {
  470. writer.insert( new ModelText( 'foobar' ), modelRootStart );
  471. } );
  472. expect( viewToString( viewRoot ) ).to.equal( '<div></div>' );
  473. } );
  474. } );
  475. describe( 'insertElement', () => {
  476. it( 'should convert element insertion in model', () => {
  477. const modelElement = new ModelElement( 'paragraph', null, new ModelText( 'foobar' ) );
  478. model.change( writer => {
  479. writer.insert( modelElement, modelRootStart );
  480. } );
  481. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  482. } );
  483. it( 'should not convert if creator returned null', () => {
  484. dispatcher.on( 'insert:div', insertElement( () => null ) );
  485. const modelElement = new ModelElement( 'div' );
  486. model.change( writer => {
  487. writer.insert( modelElement, modelRootStart );
  488. } );
  489. expect( viewToString( viewRoot ) ).to.equal( '<div></div>' );
  490. } );
  491. } );
  492. describe( 'setAttribute', () => {
  493. it( 'should convert attribute insert/change/remove on a model node', () => {
  494. const modelElement = new ModelElement( 'paragraph', { class: 'foo' }, new ModelText( 'foobar' ) );
  495. model.change( writer => {
  496. writer.insert( modelElement, modelRootStart );
  497. } );
  498. expect( viewToString( viewRoot ) ).to.equal( '<div><p class="foo">foobar</p></div>' );
  499. model.change( writer => {
  500. writer.setAttribute( 'class', 'bar', modelElement );
  501. } );
  502. expect( viewToString( viewRoot ) ).to.equal( '<div><p class="bar">foobar</p></div>' );
  503. model.change( writer => {
  504. writer.removeAttribute( 'class', modelElement );
  505. } );
  506. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  507. } );
  508. it( 'should convert insert/change/remove with attribute generating function as a parameter', () => {
  509. const themeConverter = ( value, data ) => {
  510. if ( data.item instanceof ModelElement && data.item.childCount > 0 ) {
  511. value += ' fix-content';
  512. }
  513. return { key: 'class', value };
  514. };
  515. dispatcher.on( 'insert:div', insertElement( ( modelElement, viewWriter ) => viewWriter.createContainerElement( 'div' ) ) );
  516. dispatcher.on( 'attribute:theme', changeAttribute( themeConverter ) );
  517. const modelParagraph = new ModelElement( 'paragraph', { theme: 'nice' }, new ModelText( 'foobar' ) );
  518. const modelDiv = new ModelElement( 'div', { theme: 'nice' } );
  519. model.change( writer => {
  520. writer.insert( [ modelParagraph, modelDiv ], modelRootStart );
  521. } );
  522. expect( viewToString( viewRoot ) ).to.equal( '<div><p class="nice fix-content">foobar</p><div class="nice"></div></div>' );
  523. model.change( writer => {
  524. writer.setAttribute( 'theme', 'awesome', modelParagraph );
  525. } );
  526. expect( viewToString( viewRoot ) ).to.equal( '<div><p class="awesome fix-content">foobar</p><div class="nice"></div></div>' );
  527. model.change( writer => {
  528. writer.removeAttribute( 'theme', modelParagraph );
  529. } );
  530. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p><div class="nice"></div></div>' );
  531. } );
  532. it( 'should be possible to override setAttribute', () => {
  533. const modelElement = new ModelElement( 'paragraph', { class: 'foo' }, new ModelText( 'foobar' ) );
  534. dispatcher.on( 'attribute:class', ( evt, data, conversionApi ) => {
  535. conversionApi.consumable.consume( data.item, 'attribute:class' );
  536. }, { priority: 'high' } );
  537. model.change( writer => {
  538. writer.insert( modelElement, modelRootStart );
  539. } );
  540. // No attribute set.
  541. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  542. } );
  543. } );
  544. describe( 'wrap', () => {
  545. it( 'should convert insert/change/remove of attribute in model into wrapping element in a view', () => {
  546. const modelElement = new ModelElement( 'paragraph', null, new ModelText( 'foobar', { bold: true } ) );
  547. const creator = ( modelAttributeValue, viewWriter ) => viewWriter.createAttributeElement( 'b' );
  548. dispatcher.on( 'attribute:bold', wrap( creator ) );
  549. model.change( writer => {
  550. writer.insert( modelElement, modelRootStart );
  551. } );
  552. expect( viewToString( viewRoot ) ).to.equal( '<div><p><b>foobar</b></p></div>' );
  553. model.change( writer => {
  554. writer.removeAttribute( 'bold', ModelRange.createIn( modelElement ) );
  555. } );
  556. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  557. } );
  558. it( 'should convert insert/remove of attribute in model with wrapping element generating function as a parameter', () => {
  559. const modelElement = new ModelElement( 'paragraph', null, new ModelText( 'foobar', { style: 'bold' } ) );
  560. const elementGenerator = ( modelAttributeValue, viewWriter ) => {
  561. if ( modelAttributeValue == 'bold' ) {
  562. return viewWriter.createAttributeElement( 'b' );
  563. }
  564. };
  565. dispatcher.on( 'attribute:style', wrap( elementGenerator ) );
  566. model.change( writer => {
  567. writer.insert( modelElement, modelRootStart );
  568. } );
  569. expect( viewToString( viewRoot ) ).to.equal( '<div><p><b>foobar</b></p></div>' );
  570. model.change( writer => {
  571. writer.removeAttribute( 'style', ModelRange.createIn( modelElement ) );
  572. } );
  573. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  574. } );
  575. it( 'should update range on re-wrapping attribute (#475)', () => {
  576. const modelElement = new ModelElement( 'paragraph', null, [
  577. new ModelText( 'x' ),
  578. new ModelText( 'foo', { link: 'http://foo.com' } ),
  579. new ModelText( 'x' )
  580. ] );
  581. const elementGenerator = ( modelAttributeValue, viewWriter ) => {
  582. return viewWriter.createAttributeElement( 'a', { href: modelAttributeValue } );
  583. };
  584. dispatcher.on( 'attribute:link', wrap( elementGenerator ) );
  585. model.change( writer => {
  586. writer.insert( modelElement, modelRootStart );
  587. } );
  588. expect( viewToString( viewRoot ) ).to.equal( '<div><p>x<a href="http://foo.com">foo</a>x</p></div>' );
  589. // Set new attribute on old link but also on non-linked characters.
  590. model.change( writer => {
  591. writer.setAttribute( 'link', 'http://foobar.com', ModelRange.createIn( modelElement ) );
  592. } );
  593. expect( viewToString( viewRoot ) ).to.equal( '<div><p><a href="http://foobar.com">xfoox</a></p></div>' );
  594. } );
  595. it( 'should support unicode', () => {
  596. const modelElement = new ModelElement( 'paragraph', null, [ 'நி', new ModelText( 'லைக்', { bold: true } ), 'கு' ] );
  597. const creator = ( modelAttributeValue, viewWriter ) => viewWriter.createAttributeElement( 'b' );
  598. dispatcher.on( 'attribute:bold', wrap( creator ) );
  599. model.change( writer => {
  600. writer.insert( modelElement, modelRootStart );
  601. } );
  602. expect( viewToString( viewRoot ) ).to.equal( '<div><p>நி<b>லைக்</b>கு</p></div>' );
  603. model.change( writer => {
  604. writer.removeAttribute( 'bold', ModelRange.createIn( modelElement ) );
  605. } );
  606. expect( viewToString( viewRoot ) ).to.equal( '<div><p>நிலைக்கு</p></div>' );
  607. } );
  608. it( 'should be possible to override wrap', () => {
  609. const modelElement = new ModelElement( 'paragraph', null, new ModelText( 'foobar', { bold: true } ) );
  610. dispatcher.on( 'attribute:bold', wrap( ( modelAttributeValue, viewWriter ) => viewWriter.createAttributeElement( 'b' ) ) );
  611. dispatcher.on(
  612. 'attribute:bold',
  613. wrap( ( modelAttributeValue, viewWriter ) => viewWriter.createAttributeElement( 'strong' ) ),
  614. { priority: 'high' }
  615. );
  616. model.change( writer => {
  617. writer.insert( modelElement, modelRootStart );
  618. } );
  619. expect( viewToString( viewRoot ) ).to.equal( '<div><p><strong>foobar</strong></p></div>' );
  620. } );
  621. it( 'should not convert and not consume if creator function returned null', () => {
  622. const elementGenerator = () => null;
  623. sinon.spy( dispatcher, 'fire' );
  624. const modelElement = new ModelElement( 'paragraph', null, new ModelText( 'foobar', { italic: true } ) );
  625. dispatcher.on( 'attribute:italic', wrap( elementGenerator ) );
  626. const spy = sinon.spy();
  627. dispatcher.on( 'attribute:italic', spy );
  628. model.change( writer => {
  629. writer.insert( modelElement, modelRootStart );
  630. } );
  631. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  632. expect( dispatcher.fire.calledWith( 'attribute:italic:$text' ) ).to.be.true;
  633. expect( spy.called ).to.be.true;
  634. } );
  635. } );
  636. describe( 'insertUIElement/removeUIElement', () => {
  637. let modelText, modelElement, range;
  638. beforeEach( () => {
  639. modelText = new ModelText( 'foobar' );
  640. modelElement = new ModelElement( 'paragraph', null, modelText );
  641. model.change( writer => {
  642. writer.insert( modelElement, modelRootStart );
  643. } );
  644. } );
  645. describe( 'collapsed range', () => {
  646. beforeEach( () => {
  647. range = ModelRange.createFromParentsAndOffsets( modelElement, 3, modelElement, 3 );
  648. } );
  649. it( 'should insert and remove ui element', () => {
  650. const creator = ( data, viewWriter ) => viewWriter.createUIElement( 'span', { 'class': 'marker' } );
  651. dispatcher.on( 'addMarker:marker', insertUIElement( creator ) );
  652. dispatcher.on( 'removeMarker:marker', removeUIElement( creator ) );
  653. model.change( writer => {
  654. writer.setMarker( 'marker', range );
  655. } );
  656. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foo<span class="marker"></span>bar</p></div>' );
  657. model.change( writer => {
  658. writer.removeMarker( 'marker' );
  659. } );
  660. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  661. } );
  662. it( 'should not convert if consumable was consumed', () => {
  663. sinon.spy( dispatcher, 'fire' );
  664. dispatcher.on( 'addMarker:marker', insertUIElement(
  665. ( data, viewWriter ) => viewWriter.createUIElement( 'span', { 'class': 'marker' } ) )
  666. );
  667. dispatcher.on( 'addMarker:marker', ( evt, data, conversionApi ) => {
  668. conversionApi.consumable.consume( data.markerRange, 'addMarker:marker' );
  669. }, { priority: 'high' } );
  670. model.change( writer => {
  671. writer.setMarker( 'marker', range );
  672. } );
  673. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  674. expect( dispatcher.fire.calledWith( 'addMarker:marker' ) );
  675. } );
  676. it( 'should not convert if creator returned null', () => {
  677. dispatcher.on( 'addMarker:marker', insertUIElement( () => null ) );
  678. dispatcher.on( 'removeMarker:marker', removeUIElement( () => null ) );
  679. model.change( writer => {
  680. writer.setMarker( 'marker', range );
  681. } );
  682. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  683. model.change( writer => {
  684. writer.removeMarker( 'marker' );
  685. } );
  686. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  687. } );
  688. } );
  689. describe( 'non-collapsed range', () => {
  690. beforeEach( () => {
  691. range = ModelRange.createFromParentsAndOffsets( modelElement, 2, modelElement, 5 );
  692. } );
  693. it( 'should insert and remove ui element - element as a creator', () => {
  694. const creator = ( data, viewWriter ) => viewWriter.createUIElement( 'span', { 'class': 'marker' } );
  695. dispatcher.on( 'addMarker:marker', insertUIElement( creator ) );
  696. dispatcher.on( 'removeMarker:marker', removeUIElement( creator ) );
  697. model.change( writer => {
  698. writer.setMarker( 'marker', range );
  699. } );
  700. expect( viewToString( viewRoot ) )
  701. .to.equal( '<div><p>fo<span class="marker"></span>oba<span class="marker"></span>r</p></div>' );
  702. model.change( writer => {
  703. writer.removeMarker( 'marker' );
  704. } );
  705. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  706. } );
  707. it( 'should insert and remove ui element - function as a creator', () => {
  708. const creator = ( data, viewWriter ) => viewWriter.createUIElement( 'span', { 'class': data.markerName } );
  709. dispatcher.on( 'addMarker:marker', insertUIElement( creator ) );
  710. dispatcher.on( 'removeMarker:marker', removeUIElement( creator ) );
  711. model.change( writer => {
  712. writer.setMarker( 'marker', range );
  713. } );
  714. expect( viewToString( viewRoot ) )
  715. .to.equal( '<div><p>fo<span class="marker"></span>oba<span class="marker"></span>r</p></div>' );
  716. model.change( writer => {
  717. writer.removeMarker( 'marker' );
  718. } );
  719. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  720. } );
  721. it( 'should insert and remove different opening and ending element', () => {
  722. function creator( data, viewWriter ) {
  723. if ( data.isOpening ) {
  724. return viewWriter.createUIElement( 'span', { 'class': data.markerName, 'data-start': true } );
  725. }
  726. return viewWriter.createUIElement( 'span', { 'class': data.markerName, 'data-end': true } );
  727. }
  728. dispatcher.on( 'addMarker:marker', insertUIElement( creator ) );
  729. dispatcher.on( 'removeMarker:marker', removeUIElement( creator ) );
  730. model.change( writer => {
  731. writer.setMarker( 'marker', range );
  732. } );
  733. expect( viewToString( viewRoot ) ).to.equal(
  734. '<div><p>fo<span class="marker" data-start="true"></span>oba<span class="marker" data-end="true"></span>r</p></div>'
  735. );
  736. model.change( writer => {
  737. writer.removeMarker( 'marker' );
  738. } );
  739. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  740. } );
  741. it( 'should not convert if consumable was consumed', () => {
  742. const creator = ( data, viewWriter ) => viewWriter.createUIElement( 'span', { 'class': 'marker' } );
  743. sinon.spy( dispatcher, 'fire' );
  744. dispatcher.on( 'addMarker:marker', insertUIElement( creator ) );
  745. dispatcher.on( 'addMarker:marker', ( evt, data, conversionApi ) => {
  746. conversionApi.consumable.consume( data.item, 'addMarker:marker' );
  747. }, { priority: 'high' } );
  748. model.change( writer => {
  749. writer.setMarker( 'marker', range );
  750. } );
  751. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  752. expect( dispatcher.fire.calledWith( 'addMarker:marker' ) );
  753. } );
  754. } );
  755. } );
  756. // Remove converter is by default already added in `EditingController` instance.
  757. describe( 'remove', () => {
  758. it( 'should remove items from view accordingly to changes in model #1', () => {
  759. const modelElement = new ModelElement( 'paragraph', null, new ModelText( 'foobar' ) );
  760. model.change( writer => {
  761. writer.insert( modelElement, modelRootStart );
  762. } );
  763. model.change( writer => {
  764. writer.remove( ModelRange.createFromParentsAndOffsets( modelElement, 2, modelElement, 4 ) );
  765. } );
  766. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foar</p></div>' );
  767. } );
  768. it( 'should be possible to overwrite', () => {
  769. dispatcher.on( 'remove', evt => evt.stop(), { priority: 'high' } );
  770. const modelElement = new ModelElement( 'paragraph', null, new ModelText( 'foobar' ) );
  771. model.change( writer => {
  772. writer.insert( modelElement, modelRootStart );
  773. } );
  774. model.change( writer => {
  775. writer.remove( ModelRange.createFromParentsAndOffsets( modelElement, 2, modelElement, 4 ) );
  776. } );
  777. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  778. } );
  779. it( 'should support unicode', () => {
  780. const modelElement = new ModelElement( 'paragraph', null, 'நிலைக்கு' );
  781. model.change( writer => {
  782. writer.insert( modelElement, modelRootStart );
  783. } );
  784. model.change( writer => {
  785. writer.remove( ModelRange.createFromParentsAndOffsets( modelElement, 0, modelElement, 6 ) );
  786. } );
  787. expect( viewToString( viewRoot ) ).to.equal( '<div><p>கு</p></div>' );
  788. } );
  789. it( 'should not remove view ui elements that are placed next to removed content', () => {
  790. modelRoot._appendChildren( new ModelText( 'fozbar' ) );
  791. viewRoot._appendChildren( [
  792. new ViewText( 'foz' ),
  793. new ViewUIElement( 'span' ),
  794. new ViewText( 'bar' )
  795. ] );
  796. // Remove 'b'.
  797. model.change( writer => {
  798. writer.remove( ModelRange.createFromParentsAndOffsets( modelRoot, 3, modelRoot, 4 ) );
  799. } );
  800. expect( viewToString( viewRoot ) ).to.equal( '<div>foz<span></span>ar</div>' );
  801. // Remove 'z'.
  802. model.change( writer => {
  803. writer.remove( ModelRange.createFromParentsAndOffsets( modelRoot, 2, modelRoot, 3 ) );
  804. } );
  805. expect( viewToString( viewRoot ) ).to.equal( '<div>fo<span></span>ar</div>' );
  806. } );
  807. it( 'should remove correct amount of text when it is split by view ui element', () => {
  808. modelRoot._appendChildren( new ModelText( 'fozbar' ) );
  809. viewRoot._appendChildren( [
  810. new ViewText( 'foz' ),
  811. new ViewUIElement( 'span' ),
  812. new ViewText( 'bar' )
  813. ] );
  814. // Remove 'z<span></span>b'.
  815. model.change( writer => {
  816. writer.remove( ModelRange.createFromParentsAndOffsets( modelRoot, 2, modelRoot, 4 ) );
  817. } );
  818. expect( viewToString( viewRoot ) ).to.equal( '<div>foar</div>' );
  819. } );
  820. it( 'should unbind elements', () => {
  821. const modelElement = new ModelElement( 'paragraph' );
  822. model.change( writer => {
  823. writer.insert( modelElement, modelRootStart );
  824. } );
  825. const viewElement = controller.mapper.toViewElement( modelElement );
  826. expect( viewElement ).not.to.be.undefined;
  827. expect( controller.mapper.toModelElement( viewElement ) ).to.equal( modelElement );
  828. model.change( writer => {
  829. writer.remove( modelElement );
  830. } );
  831. expect( controller.mapper.toViewElement( modelElement ) ).to.be.undefined;
  832. expect( controller.mapper.toModelElement( viewElement ) ).to.be.undefined;
  833. } );
  834. it( 'should not break when remove() is used as part of unwrapping', () => {
  835. const modelP = new ModelElement( 'paragraph', null, new ModelText( 'foo' ) );
  836. const modelWidget = new ModelElement( 'widget', null, modelP );
  837. dispatcher.on( 'insert:widget', insertElement(
  838. ( modelElement, viewWriter ) => viewWriter.createContainerElement( 'widget' ) )
  839. );
  840. model.change( writer => {
  841. writer.insert( modelWidget, modelRootStart );
  842. } );
  843. expect( viewToString( viewRoot ) ).to.equal( '<div><widget><p>foo</p></widget></div>' );
  844. const viewP = controller.mapper.toViewElement( modelP );
  845. expect( viewP ).not.to.be.undefined;
  846. model.change( writer => {
  847. writer.unwrap( modelWidget );
  848. } );
  849. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foo</p></div>' );
  850. // `modelP` is now bound with newly created view element.
  851. expect( controller.mapper.toViewElement( modelP ) ).not.to.equal( viewP );
  852. // `viewP` is no longer bound with model element.
  853. expect( controller.mapper.toModelElement( viewP ) ).to.be.undefined;
  854. // View element from view root is bound to `modelP`.
  855. expect( controller.mapper.toModelElement( viewRoot.getChild( 0 ) ) ).to.equal( modelP );
  856. } );
  857. it( 'should work correctly if container element after ui element is removed', () => {
  858. // Prepare a model and view structure.
  859. // This is done outside of conversion to put view ui elements inside easily.
  860. const modelP1 = new ModelElement( 'paragraph' );
  861. const modelP2 = new ModelElement( 'paragraph' );
  862. const viewP1 = new ViewContainerElement( 'p' );
  863. const viewUi1 = new ViewUIElement( 'span' );
  864. const viewUi2 = new ViewUIElement( 'span' );
  865. const viewP2 = new ViewContainerElement( 'p' );
  866. modelRoot._appendChildren( [ modelP1, modelP2 ] );
  867. viewRoot._appendChildren( [ viewP1, viewUi1, viewUi2, viewP2 ] );
  868. controller.mapper.bindElements( modelP1, viewP1 );
  869. controller.mapper.bindElements( modelP2, viewP2 );
  870. // Remove second paragraph element.
  871. model.change( writer => {
  872. writer.remove( ModelRange.createFromParentsAndOffsets( modelRoot, 1, modelRoot, 2 ) );
  873. } );
  874. expect( viewToString( viewRoot ) ).to.equal( '<div><p></p><span></span><span></span></div>' );
  875. } );
  876. it( 'should work correctly if container element after text node is removed', () => {
  877. const modelText = new ModelText( 'foo' );
  878. const modelP = new ModelElement( 'paragraph' );
  879. model.change( writer => {
  880. writer.insert( [ modelText, modelP ], modelRootStart );
  881. } );
  882. model.change( writer => {
  883. writer.remove( modelP );
  884. } );
  885. expect( viewToString( viewRoot ) ).to.equal( '<div>foo</div>' );
  886. } );
  887. } );
  888. describe( 'highlight', () => {
  889. describe( 'on text', () => {
  890. const highlightDescriptor = {
  891. class: 'highlight-class',
  892. priority: 7,
  893. attributes: { title: 'title' }
  894. };
  895. let markerRange;
  896. beforeEach( () => {
  897. const modelElement1 = new ModelElement( 'paragraph', null, new ModelText( 'foo' ) );
  898. const modelElement2 = new ModelElement( 'paragraph', null, new ModelText( 'bar' ) );
  899. model.change( writer => {
  900. writer.insert( [ modelElement1, modelElement2 ], modelRootStart );
  901. } );
  902. markerRange = ModelRange.createIn( modelRoot );
  903. } );
  904. it( 'should wrap and unwrap text nodes', () => {
  905. dispatcher.on( 'addMarker:marker', highlightText( highlightDescriptor ) );
  906. dispatcher.on( 'addMarker:marker', highlightElement( highlightDescriptor ) );
  907. dispatcher.on( 'removeMarker:marker', removeHighlight( highlightDescriptor ) );
  908. model.change( writer => {
  909. writer.setMarker( 'marker', markerRange );
  910. } );
  911. expect( viewToString( viewRoot ) ).to.equal(
  912. '<div>' +
  913. '<p>' +
  914. '<span class="highlight-class" title="title">foo</span>' +
  915. '</p>' +
  916. '<p>' +
  917. '<span class="highlight-class" title="title">bar</span>' +
  918. '</p>' +
  919. '</div>'
  920. );
  921. model.change( writer => {
  922. writer.removeMarker( 'marker' );
  923. } );
  924. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foo</p><p>bar</p></div>' );
  925. } );
  926. it( 'should be possible to overwrite', () => {
  927. dispatcher.on( 'addMarker:marker', highlightText( highlightDescriptor ) );
  928. dispatcher.on( 'addMarker:marker', highlightElement( highlightDescriptor ) );
  929. dispatcher.on( 'removeMarker:marker', removeHighlight( highlightDescriptor ) );
  930. const newDescriptor = { class: 'override-class' };
  931. dispatcher.on( 'addMarker:marker', highlightText( newDescriptor ), { priority: 'high' } );
  932. dispatcher.on( 'addMarker:marker', highlightElement( newDescriptor ), { priority: 'high' } );
  933. dispatcher.on( 'removeMarker:marker', removeHighlight( newDescriptor ), { priority: 'high' } );
  934. model.change( writer => {
  935. writer.setMarker( 'marker', markerRange );
  936. } );
  937. expect( viewToString( viewRoot ) ).to.equal(
  938. '<div>' +
  939. '<p>' +
  940. '<span class="override-class">foo</span>' +
  941. '</p>' +
  942. '<p>' +
  943. '<span class="override-class">bar</span>' +
  944. '</p>' +
  945. '</div>'
  946. );
  947. model.change( writer => {
  948. writer.removeMarker( 'marker' );
  949. } );
  950. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foo</p><p>bar</p></div>' );
  951. } );
  952. it( 'should do nothing if descriptor is not provided or generating function returns null', () => {
  953. dispatcher.on( 'addMarker:marker', highlightText( () => null ), { priority: 'high' } );
  954. dispatcher.on( 'addMarker:marker', highlightElement( () => null ), { priority: 'high' } );
  955. dispatcher.on( 'removeMarker:marker', removeHighlight( () => null ), { priority: 'high' } );
  956. model.change( writer => {
  957. writer.setMarker( 'marker', markerRange );
  958. } );
  959. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foo</p><p>bar</p></div>' );
  960. model.change( writer => {
  961. writer.removeMarker( 'marker' );
  962. } );
  963. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foo</p><p>bar</p></div>' );
  964. } );
  965. it( 'should do nothing if collapsed marker is converted', () => {
  966. const descriptor = { class: 'foo' };
  967. dispatcher.on( 'addMarker:marker', highlightText( descriptor ), { priority: 'high' } );
  968. dispatcher.on( 'addMarker:marker', highlightElement( descriptor ), { priority: 'high' } );
  969. dispatcher.on( 'removeMarker:marker', removeHighlight( descriptor ), { priority: 'high' } );
  970. markerRange = ModelRange.createFromParentsAndOffsets( modelRoot, 0, modelRoot, 0 );
  971. model.change( () => {
  972. model.markers._set( 'marker', markerRange );
  973. } );
  974. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foo</p><p>bar</p></div>' );
  975. model.change( () => {
  976. model.markers._remove( 'marker' );
  977. } );
  978. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foo</p><p>bar</p></div>' );
  979. } );
  980. it( 'should correctly wrap and unwrap multiple, intersecting markers', () => {
  981. const descriptorFoo = { class: 'foo' };
  982. const descriptorBar = { class: 'bar' };
  983. const descriptorXyz = { class: 'xyz' };
  984. dispatcher.on( 'addMarker:markerFoo', highlightText( descriptorFoo ) );
  985. dispatcher.on( 'addMarker:markerBar', highlightText( descriptorBar ) );
  986. dispatcher.on( 'addMarker:markerXyz', highlightText( descriptorXyz ) );
  987. dispatcher.on( 'removeMarker:markerFoo', removeHighlight( descriptorFoo ) );
  988. dispatcher.on( 'removeMarker:markerBar', removeHighlight( descriptorBar ) );
  989. dispatcher.on( 'removeMarker:markerXyz', removeHighlight( descriptorXyz ) );
  990. const p1 = modelRoot.getChild( 0 );
  991. const p2 = modelRoot.getChild( 1 );
  992. model.change( writer => {
  993. writer.setMarker( 'markerFoo', ModelRange.createFromParentsAndOffsets( p1, 0, p1, 3 ) );
  994. } );
  995. expect( viewToString( viewRoot ) ).to.equal(
  996. '<div>' +
  997. '<p>' +
  998. '<span class="foo">foo</span>' +
  999. '</p>' +
  1000. '<p>bar</p>' +
  1001. '</div>'
  1002. );
  1003. model.change( writer => {
  1004. writer.setMarker( 'markerBar', ModelRange.createFromParentsAndOffsets( p1, 1, p2, 2 ) );
  1005. } );
  1006. expect( viewToString( viewRoot ) ).to.equal(
  1007. '<div>' +
  1008. '<p>' +
  1009. '<span class="foo">f</span>' +
  1010. '<span class="bar">' +
  1011. '<span class="foo">oo</span>' +
  1012. '</span>' +
  1013. '</p>' +
  1014. '<p>' +
  1015. '<span class="bar">ba</span>' +
  1016. 'r' +
  1017. '</p>' +
  1018. '</div>'
  1019. );
  1020. model.change( writer => {
  1021. writer.setMarker( 'markerXyz', ModelRange.createFromParentsAndOffsets( p1, 2, p2, 3 ) );
  1022. } );
  1023. expect( viewToString( viewRoot ) ).to.equal(
  1024. '<div>' +
  1025. '<p>' +
  1026. '<span class="foo">f</span>' +
  1027. '<span class="bar">' +
  1028. '<span class="foo">' +
  1029. 'o' +
  1030. '<span class="xyz">o</span>' +
  1031. '</span>' +
  1032. '</span>' +
  1033. '</p>' +
  1034. '<p>' +
  1035. '<span class="bar">' +
  1036. '<span class="xyz">ba</span>' +
  1037. '</span>' +
  1038. '<span class="xyz">r</span>' +
  1039. '</p>' +
  1040. '</div>'
  1041. );
  1042. model.change( writer => {
  1043. writer.removeMarker( 'markerBar' );
  1044. } );
  1045. expect( viewToString( viewRoot ) ).to.equal(
  1046. '<div>' +
  1047. '<p>' +
  1048. '<span class="foo">' +
  1049. 'fo' +
  1050. '<span class="xyz">o</span>' +
  1051. '</span>' +
  1052. '</p>' +
  1053. '<p>' +
  1054. '<span class="xyz">bar</span>' +
  1055. '</p>' +
  1056. '</div>'
  1057. );
  1058. model.change( writer => {
  1059. writer.removeMarker( 'markerFoo' );
  1060. } );
  1061. expect( viewToString( viewRoot ) ).to.equal(
  1062. '<div>' +
  1063. '<p>' +
  1064. 'fo' +
  1065. '<span class="xyz">o</span>' +
  1066. '</p>' +
  1067. '<p>' +
  1068. '<span class="xyz">bar</span>' +
  1069. '</p>' +
  1070. '</div>'
  1071. );
  1072. model.change( writer => {
  1073. writer.removeMarker( 'markerXyz' );
  1074. } );
  1075. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foo</p><p>bar</p></div>' );
  1076. } );
  1077. it( 'should do nothing if marker is applied and removed on empty-ish range', () => {
  1078. dispatcher.on( 'addMarker:marker', highlightText( highlightDescriptor ) );
  1079. dispatcher.on( 'removeMarker:marker', removeHighlight( highlightDescriptor ) );
  1080. const p1 = modelRoot.getChild( 0 );
  1081. const p2 = modelRoot.getChild( 1 );
  1082. const markerRange = ModelRange.createFromParentsAndOffsets( p1, 3, p2, 0 );
  1083. model.change( writer => {
  1084. writer.setMarker( 'marker', markerRange );
  1085. } );
  1086. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foo</p><p>bar</p></div>' );
  1087. model.change( writer => {
  1088. writer.removeMarker( 'marker', markerRange );
  1089. } );
  1090. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foo</p><p>bar</p></div>' );
  1091. } );
  1092. } );
  1093. describe( 'on element', () => {
  1094. const highlightDescriptor = {
  1095. class: 'highlight-class',
  1096. priority: 7,
  1097. attributes: { title: 'title' },
  1098. id: 'customId'
  1099. };
  1100. let markerRange;
  1101. beforeEach( () => {
  1102. // Provide converter for div element. View div element will have custom highlight handling.
  1103. dispatcher.on( 'insert:div', insertElement( () => {
  1104. const viewContainer = new ViewContainerElement( 'div' );
  1105. viewContainer._setCustomProperty( 'addHighlight', ( element, descriptor, writer ) => {
  1106. writer.addClass( descriptor.class, element );
  1107. } );
  1108. viewContainer._setCustomProperty( 'removeHighlight', ( element, id, writer ) => {
  1109. writer.setAttribute( 'class', '', element );
  1110. } );
  1111. return viewContainer;
  1112. } ) );
  1113. const modelElement = new ModelElement( 'div', null, new ModelText( 'foo' ) );
  1114. model.change( writer => {
  1115. writer.insert( modelElement, modelRootStart );
  1116. } );
  1117. markerRange = ModelRange.createOn( modelElement );
  1118. dispatcher.on( 'addMarker:marker', highlightText( highlightDescriptor ) );
  1119. dispatcher.on( 'addMarker:marker', highlightElement( highlightDescriptor ) );
  1120. dispatcher.on( 'removeMarker:marker', removeHighlight( highlightDescriptor ) );
  1121. } );
  1122. it( 'should use addHighlight and removeHighlight on elements and not convert children nodes', () => {
  1123. model.change( writer => {
  1124. writer.setMarker( 'marker', markerRange );
  1125. } );
  1126. expect( viewToString( viewRoot ) ).to.equal(
  1127. '<div>' +
  1128. '<div class="highlight-class">' +
  1129. 'foo' +
  1130. '</div>' +
  1131. '</div>'
  1132. );
  1133. model.change( writer => {
  1134. writer.removeMarker( 'marker' );
  1135. } );
  1136. expect( viewToString( viewRoot ) ).to.equal( '<div><div>foo</div></div>' );
  1137. } );
  1138. it( 'should be possible to override', () => {
  1139. const newDescriptor = { class: 'override-class' };
  1140. dispatcher.on( 'addMarker:marker', highlightText( newDescriptor ), { priority: 'high' } );
  1141. dispatcher.on( 'addMarker:marker', highlightElement( newDescriptor ), { priority: 'high' } );
  1142. dispatcher.on( 'removeMarker:marker', removeHighlight( newDescriptor ), { priority: 'high' } );
  1143. model.change( writer => {
  1144. writer.setMarker( 'marker', markerRange );
  1145. } );
  1146. expect( viewToString( viewRoot ) ).to.equal(
  1147. '<div>' +
  1148. '<div class="override-class">' +
  1149. 'foo' +
  1150. '</div>' +
  1151. '</div>'
  1152. );
  1153. model.change( writer => {
  1154. writer.removeMarker( 'marker' );
  1155. } );
  1156. expect( viewToString( viewRoot ) ).to.equal( '<div><div>foo</div></div>' );
  1157. } );
  1158. it( 'should use default priority and id if not provided', () => {
  1159. const viewDiv = viewRoot.getChild( 0 );
  1160. dispatcher.on( 'addMarker:marker2', highlightText( () => null ) );
  1161. dispatcher.on( 'addMarker:marker2', highlightElement( () => null ) );
  1162. dispatcher.on( 'removeMarker:marker2', removeHighlight( () => null ) );
  1163. viewDiv._setCustomProperty( 'addHighlight', ( element, descriptor ) => {
  1164. expect( descriptor.priority ).to.equal( 10 );
  1165. expect( descriptor.id ).to.equal( 'marker:foo-bar-baz' );
  1166. } );
  1167. viewDiv._setCustomProperty( 'removeHighlight', ( element, id ) => {
  1168. expect( id ).to.equal( 'marker:foo-bar-baz' );
  1169. } );
  1170. model.change( writer => {
  1171. writer.setMarker( 'marker2', markerRange );
  1172. } );
  1173. } );
  1174. it( 'should do nothing if descriptor is not provided', () => {
  1175. dispatcher.on( 'addMarker:marker2', highlightText( () => null ) );
  1176. dispatcher.on( 'addMarker:marker2', highlightElement( () => null ) );
  1177. dispatcher.on( 'removeMarker:marker2', removeHighlight( () => null ) );
  1178. model.change( writer => {
  1179. writer.setMarker( 'marker2', markerRange );
  1180. } );
  1181. expect( viewToString( viewRoot ) ).to.equal( '<div><div>foo</div></div>' );
  1182. model.change( writer => {
  1183. writer.removeMarker( 'marker2' );
  1184. } );
  1185. expect( viewToString( viewRoot ) ).to.equal( '<div><div>foo</div></div>' );
  1186. } );
  1187. } );
  1188. } );
  1189. describe( 'createViewElementFromHighlightDescriptor()', () => {
  1190. it( 'should return attribute element from descriptor object', () => {
  1191. const descriptor = {
  1192. class: 'foo-class',
  1193. attributes: { one: '1', two: '2' },
  1194. priority: 7,
  1195. };
  1196. const element = createViewElementFromHighlightDescriptor( descriptor );
  1197. expect( element.is( 'attributeElement' ) ).to.be.true;
  1198. expect( element.name ).to.equal( 'span' );
  1199. expect( element.priority ).to.equal( 7 );
  1200. expect( element.hasClass( 'foo-class' ) ).to.be.true;
  1201. for ( const key of Object.keys( descriptor.attributes ) ) {
  1202. expect( element.getAttribute( key ) ).to.equal( descriptor.attributes[ key ] );
  1203. }
  1204. } );
  1205. it( 'should return attribute element from descriptor object - array with classes', () => {
  1206. const descriptor = {
  1207. class: [ 'foo-class', 'bar-class' ],
  1208. attributes: { one: '1', two: '2' },
  1209. priority: 7,
  1210. };
  1211. const element = createViewElementFromHighlightDescriptor( descriptor );
  1212. expect( element.is( 'attributeElement' ) ).to.be.true;
  1213. expect( element.name ).to.equal( 'span' );
  1214. expect( element.priority ).to.equal( 7 );
  1215. expect( element.hasClass( 'foo-class' ) ).to.be.true;
  1216. expect( element.hasClass( 'bar-class' ) ).to.be.true;
  1217. for ( const key of Object.keys( descriptor.attributes ) ) {
  1218. expect( element.getAttribute( key ) ).to.equal( descriptor.attributes[ key ] );
  1219. }
  1220. } );
  1221. it( 'should create element without class', () => {
  1222. const descriptor = {
  1223. attributes: { one: '1', two: '2' },
  1224. priority: 7,
  1225. };
  1226. const element = createViewElementFromHighlightDescriptor( descriptor );
  1227. expect( element.is( 'attributeElement' ) ).to.be.true;
  1228. expect( element.name ).to.equal( 'span' );
  1229. expect( element.priority ).to.equal( 7 );
  1230. for ( const key of Object.keys( descriptor.attributes ) ) {
  1231. expect( element.getAttribute( key ) ).to.equal( descriptor.attributes[ key ] );
  1232. }
  1233. } );
  1234. it( 'should create element without priority', () => {
  1235. const descriptor = {
  1236. class: 'foo-class',
  1237. attributes: { one: '1', two: '2' },
  1238. };
  1239. const element = createViewElementFromHighlightDescriptor( descriptor );
  1240. expect( element.is( 'attributeElement' ) ).to.be.true;
  1241. expect( element.name ).to.equal( 'span' );
  1242. expect( element.priority ).to.equal( 10 );
  1243. expect( element.hasClass( 'foo-class' ) ).to.be.true;
  1244. for ( const key of Object.keys( descriptor.attributes ) ) {
  1245. expect( element.getAttribute( key ) ).to.equal( descriptor.attributes[ key ] );
  1246. }
  1247. } );
  1248. it( 'should create element without attributes', () => {
  1249. const descriptor = {
  1250. class: 'foo-class',
  1251. priority: 7
  1252. };
  1253. const element = createViewElementFromHighlightDescriptor( descriptor );
  1254. expect( element.is( 'attributeElement' ) ).to.be.true;
  1255. expect( element.name ).to.equal( 'span' );
  1256. expect( element.priority ).to.equal( 7 );
  1257. expect( element.hasClass( 'foo-class' ) ).to.be.true;
  1258. } );
  1259. } );
  1260. } );