downcast-converters.js 52 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676
  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( 'changeAttribute', () => {
  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. it( 'should not convert or consume if element creator returned null', () => {
  544. const callback = sinon.stub().returns( null );
  545. dispatcher.on( 'attribute:class', changeAttribute( callback ) );
  546. const modelElement = new ModelElement( 'paragraph', { class: 'foo' }, new ModelText( 'foobar' ) );
  547. model.change( writer => {
  548. writer.insert( modelElement, modelRootStart );
  549. } );
  550. expect( viewToString( viewRoot ) ).to.equal( '<div><p class="foo">foobar</p></div>' );
  551. sinon.assert.called( callback );
  552. } );
  553. } );
  554. describe( 'wrap', () => {
  555. it( 'should convert insert/change/remove of attribute in model into wrapping element in a view', () => {
  556. const modelElement = new ModelElement( 'paragraph', null, new ModelText( 'foobar', { bold: true } ) );
  557. const creator = ( modelAttributeValue, viewWriter ) => viewWriter.createAttributeElement( 'b' );
  558. dispatcher.on( 'attribute:bold', wrap( creator ) );
  559. model.change( writer => {
  560. writer.insert( modelElement, modelRootStart );
  561. } );
  562. expect( viewToString( viewRoot ) ).to.equal( '<div><p><b>foobar</b></p></div>' );
  563. model.change( writer => {
  564. writer.removeAttribute( 'bold', ModelRange.createIn( modelElement ) );
  565. } );
  566. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  567. } );
  568. it( 'should convert insert/remove of attribute in model with wrapping element generating function as a parameter', () => {
  569. const modelElement = new ModelElement( 'paragraph', null, new ModelText( 'foobar', { style: 'bold' } ) );
  570. const elementGenerator = ( modelAttributeValue, viewWriter ) => {
  571. if ( modelAttributeValue == 'bold' ) {
  572. return viewWriter.createAttributeElement( 'b' );
  573. }
  574. };
  575. dispatcher.on( 'attribute:style', wrap( elementGenerator ) );
  576. model.change( writer => {
  577. writer.insert( modelElement, modelRootStart );
  578. } );
  579. expect( viewToString( viewRoot ) ).to.equal( '<div><p><b>foobar</b></p></div>' );
  580. model.change( writer => {
  581. writer.removeAttribute( 'style', ModelRange.createIn( modelElement ) );
  582. } );
  583. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  584. } );
  585. it( 'should update range on re-wrapping attribute (#475)', () => {
  586. const modelElement = new ModelElement( 'paragraph', null, [
  587. new ModelText( 'x' ),
  588. new ModelText( 'foo', { link: 'http://foo.com' } ),
  589. new ModelText( 'x' )
  590. ] );
  591. const elementGenerator = ( modelAttributeValue, viewWriter ) => {
  592. return viewWriter.createAttributeElement( 'a', { href: modelAttributeValue } );
  593. };
  594. dispatcher.on( 'attribute:link', wrap( elementGenerator ) );
  595. model.change( writer => {
  596. writer.insert( modelElement, modelRootStart );
  597. } );
  598. expect( viewToString( viewRoot ) ).to.equal( '<div><p>x<a href="http://foo.com">foo</a>x</p></div>' );
  599. // Set new attribute on old link but also on non-linked characters.
  600. model.change( writer => {
  601. writer.setAttribute( 'link', 'http://foobar.com', ModelRange.createIn( modelElement ) );
  602. } );
  603. expect( viewToString( viewRoot ) ).to.equal( '<div><p><a href="http://foobar.com">xfoox</a></p></div>' );
  604. } );
  605. it( 'should support unicode', () => {
  606. const modelElement = new ModelElement( 'paragraph', null, [ 'நி', new ModelText( 'லைக்', { bold: true } ), 'கு' ] );
  607. const creator = ( modelAttributeValue, viewWriter ) => viewWriter.createAttributeElement( 'b' );
  608. dispatcher.on( 'attribute:bold', wrap( creator ) );
  609. model.change( writer => {
  610. writer.insert( modelElement, modelRootStart );
  611. } );
  612. expect( viewToString( viewRoot ) ).to.equal( '<div><p>நி<b>லைக்</b>கு</p></div>' );
  613. model.change( writer => {
  614. writer.removeAttribute( 'bold', ModelRange.createIn( modelElement ) );
  615. } );
  616. expect( viewToString( viewRoot ) ).to.equal( '<div><p>நிலைக்கு</p></div>' );
  617. } );
  618. it( 'should be possible to override wrap', () => {
  619. const modelElement = new ModelElement( 'paragraph', null, new ModelText( 'foobar', { bold: true } ) );
  620. dispatcher.on( 'attribute:bold', wrap( ( modelAttributeValue, viewWriter ) => viewWriter.createAttributeElement( 'b' ) ) );
  621. dispatcher.on(
  622. 'attribute:bold',
  623. wrap( ( modelAttributeValue, viewWriter ) => viewWriter.createAttributeElement( 'strong' ) ),
  624. { priority: 'high' }
  625. );
  626. model.change( writer => {
  627. writer.insert( modelElement, modelRootStart );
  628. } );
  629. expect( viewToString( viewRoot ) ).to.equal( '<div><p><strong>foobar</strong></p></div>' );
  630. } );
  631. it( 'should not convert and not consume if creator function returned null', () => {
  632. const elementGenerator = () => null;
  633. sinon.spy( dispatcher, 'fire' );
  634. const modelElement = new ModelElement( 'paragraph', null, new ModelText( 'foobar', { italic: true } ) );
  635. dispatcher.on( 'attribute:italic', wrap( elementGenerator ) );
  636. const spy = sinon.spy();
  637. dispatcher.on( 'attribute:italic', spy );
  638. model.change( writer => {
  639. writer.insert( modelElement, modelRootStart );
  640. } );
  641. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  642. expect( dispatcher.fire.calledWith( 'attribute:italic:$text' ) ).to.be.true;
  643. expect( spy.called ).to.be.true;
  644. } );
  645. } );
  646. describe( 'insertUIElement/removeUIElement', () => {
  647. let modelText, modelElement, range;
  648. beforeEach( () => {
  649. modelText = new ModelText( 'foobar' );
  650. modelElement = new ModelElement( 'paragraph', null, modelText );
  651. model.change( writer => {
  652. writer.insert( modelElement, modelRootStart );
  653. } );
  654. } );
  655. describe( 'collapsed range', () => {
  656. beforeEach( () => {
  657. range = ModelRange.createFromParentsAndOffsets( modelElement, 3, modelElement, 3 );
  658. } );
  659. it( 'should insert and remove ui element', () => {
  660. const creator = ( data, viewWriter ) => viewWriter.createUIElement( 'span', { 'class': 'marker' } );
  661. dispatcher.on( 'addMarker:marker', insertUIElement( creator ) );
  662. dispatcher.on( 'removeMarker:marker', removeUIElement( creator ) );
  663. model.change( writer => {
  664. writer.setMarker( 'marker', range );
  665. } );
  666. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foo<span class="marker"></span>bar</p></div>' );
  667. model.change( writer => {
  668. writer.removeMarker( 'marker' );
  669. } );
  670. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  671. } );
  672. it( 'should not convert if consumable was consumed', () => {
  673. sinon.spy( dispatcher, 'fire' );
  674. dispatcher.on( 'addMarker:marker', insertUIElement(
  675. ( data, viewWriter ) => viewWriter.createUIElement( 'span', { 'class': 'marker' } ) )
  676. );
  677. dispatcher.on( 'addMarker:marker', ( evt, data, conversionApi ) => {
  678. conversionApi.consumable.consume( data.markerRange, 'addMarker:marker' );
  679. }, { priority: 'high' } );
  680. model.change( writer => {
  681. writer.setMarker( 'marker', range );
  682. } );
  683. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  684. expect( dispatcher.fire.calledWith( 'addMarker:marker' ) );
  685. } );
  686. it( 'should not convert if creator returned null', () => {
  687. dispatcher.on( 'addMarker:marker', insertUIElement( () => null ) );
  688. dispatcher.on( 'removeMarker:marker', removeUIElement( () => null ) );
  689. model.change( writer => {
  690. writer.setMarker( 'marker', range );
  691. } );
  692. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  693. model.change( writer => {
  694. writer.removeMarker( 'marker' );
  695. } );
  696. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  697. } );
  698. } );
  699. describe( 'non-collapsed range', () => {
  700. beforeEach( () => {
  701. range = ModelRange.createFromParentsAndOffsets( modelElement, 2, modelElement, 5 );
  702. } );
  703. it( 'should insert and remove ui element - element as a creator', () => {
  704. const creator = ( data, viewWriter ) => viewWriter.createUIElement( 'span', { 'class': 'marker' } );
  705. dispatcher.on( 'addMarker:marker', insertUIElement( creator ) );
  706. dispatcher.on( 'removeMarker:marker', removeUIElement( creator ) );
  707. model.change( writer => {
  708. writer.setMarker( 'marker', range );
  709. } );
  710. expect( viewToString( viewRoot ) )
  711. .to.equal( '<div><p>fo<span class="marker"></span>oba<span class="marker"></span>r</p></div>' );
  712. model.change( writer => {
  713. writer.removeMarker( 'marker' );
  714. } );
  715. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  716. } );
  717. it( 'should insert and remove ui element - function as a creator', () => {
  718. const creator = ( data, viewWriter ) => viewWriter.createUIElement( 'span', { 'class': data.markerName } );
  719. dispatcher.on( 'addMarker:marker', insertUIElement( creator ) );
  720. dispatcher.on( 'removeMarker:marker', removeUIElement( creator ) );
  721. model.change( writer => {
  722. writer.setMarker( 'marker', range );
  723. } );
  724. expect( viewToString( viewRoot ) )
  725. .to.equal( '<div><p>fo<span class="marker"></span>oba<span class="marker"></span>r</p></div>' );
  726. model.change( writer => {
  727. writer.removeMarker( 'marker' );
  728. } );
  729. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  730. } );
  731. it( 'should insert and remove different opening and ending element', () => {
  732. function creator( data, viewWriter ) {
  733. if ( data.isOpening ) {
  734. return viewWriter.createUIElement( 'span', { 'class': data.markerName, 'data-start': true } );
  735. }
  736. return viewWriter.createUIElement( 'span', { 'class': data.markerName, 'data-end': true } );
  737. }
  738. dispatcher.on( 'addMarker:marker', insertUIElement( creator ) );
  739. dispatcher.on( 'removeMarker:marker', removeUIElement( creator ) );
  740. model.change( writer => {
  741. writer.setMarker( 'marker', range );
  742. } );
  743. expect( viewToString( viewRoot ) ).to.equal(
  744. '<div><p>fo<span class="marker" data-start="true"></span>oba<span class="marker" data-end="true"></span>r</p></div>'
  745. );
  746. model.change( writer => {
  747. writer.removeMarker( 'marker' );
  748. } );
  749. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  750. } );
  751. it( 'should not convert if consumable was consumed', () => {
  752. const creator = ( data, viewWriter ) => viewWriter.createUIElement( 'span', { 'class': 'marker' } );
  753. sinon.spy( dispatcher, 'fire' );
  754. dispatcher.on( 'addMarker:marker', insertUIElement( creator ) );
  755. dispatcher.on( 'addMarker:marker', ( evt, data, conversionApi ) => {
  756. conversionApi.consumable.consume( data.item, 'addMarker:marker' );
  757. }, { priority: 'high' } );
  758. model.change( writer => {
  759. writer.setMarker( 'marker', range );
  760. } );
  761. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  762. expect( dispatcher.fire.calledWith( 'addMarker:marker' ) );
  763. } );
  764. } );
  765. } );
  766. // Remove converter is by default already added in `EditingController` instance.
  767. describe( 'remove', () => {
  768. it( 'should remove items from view accordingly to changes in model #1', () => {
  769. const modelElement = new ModelElement( 'paragraph', null, new ModelText( 'foobar' ) );
  770. model.change( writer => {
  771. writer.insert( modelElement, modelRootStart );
  772. } );
  773. model.change( writer => {
  774. writer.remove( ModelRange.createFromParentsAndOffsets( modelElement, 2, modelElement, 4 ) );
  775. } );
  776. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foar</p></div>' );
  777. } );
  778. it( 'should be possible to overwrite', () => {
  779. dispatcher.on( 'remove', evt => evt.stop(), { priority: 'high' } );
  780. const modelElement = new ModelElement( 'paragraph', null, new ModelText( 'foobar' ) );
  781. model.change( writer => {
  782. writer.insert( modelElement, modelRootStart );
  783. } );
  784. model.change( writer => {
  785. writer.remove( ModelRange.createFromParentsAndOffsets( modelElement, 2, modelElement, 4 ) );
  786. } );
  787. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  788. } );
  789. it( 'should support unicode', () => {
  790. const modelElement = new ModelElement( 'paragraph', null, 'நிலைக்கு' );
  791. model.change( writer => {
  792. writer.insert( modelElement, modelRootStart );
  793. } );
  794. model.change( writer => {
  795. writer.remove( ModelRange.createFromParentsAndOffsets( modelElement, 0, modelElement, 6 ) );
  796. } );
  797. expect( viewToString( viewRoot ) ).to.equal( '<div><p>கு</p></div>' );
  798. } );
  799. it( 'should not remove view ui elements that are placed next to removed content', () => {
  800. modelRoot._appendChildren( new ModelText( 'fozbar' ) );
  801. viewRoot._appendChildren( [
  802. new ViewText( 'foz' ),
  803. new ViewUIElement( 'span' ),
  804. new ViewText( 'bar' )
  805. ] );
  806. // Remove 'b'.
  807. model.change( writer => {
  808. writer.remove( ModelRange.createFromParentsAndOffsets( modelRoot, 3, modelRoot, 4 ) );
  809. } );
  810. expect( viewToString( viewRoot ) ).to.equal( '<div>foz<span></span>ar</div>' );
  811. // Remove 'z'.
  812. model.change( writer => {
  813. writer.remove( ModelRange.createFromParentsAndOffsets( modelRoot, 2, modelRoot, 3 ) );
  814. } );
  815. expect( viewToString( viewRoot ) ).to.equal( '<div>fo<span></span>ar</div>' );
  816. } );
  817. it( 'should remove correct amount of text when it is split by view ui element', () => {
  818. modelRoot._appendChildren( new ModelText( 'fozbar' ) );
  819. viewRoot._appendChildren( [
  820. new ViewText( 'foz' ),
  821. new ViewUIElement( 'span' ),
  822. new ViewText( 'bar' )
  823. ] );
  824. // Remove 'z<span></span>b'.
  825. model.change( writer => {
  826. writer.remove( ModelRange.createFromParentsAndOffsets( modelRoot, 2, modelRoot, 4 ) );
  827. } );
  828. expect( viewToString( viewRoot ) ).to.equal( '<div>foar</div>' );
  829. } );
  830. it( 'should unbind elements', () => {
  831. const modelElement = new ModelElement( 'paragraph' );
  832. model.change( writer => {
  833. writer.insert( modelElement, modelRootStart );
  834. } );
  835. const viewElement = controller.mapper.toViewElement( modelElement );
  836. expect( viewElement ).not.to.be.undefined;
  837. expect( controller.mapper.toModelElement( viewElement ) ).to.equal( modelElement );
  838. model.change( writer => {
  839. writer.remove( modelElement );
  840. } );
  841. expect( controller.mapper.toViewElement( modelElement ) ).to.be.undefined;
  842. expect( controller.mapper.toModelElement( viewElement ) ).to.be.undefined;
  843. } );
  844. it( 'should not break when remove() is used as part of unwrapping', () => {
  845. const modelP = new ModelElement( 'paragraph', null, new ModelText( 'foo' ) );
  846. const modelWidget = new ModelElement( 'widget', null, modelP );
  847. dispatcher.on( 'insert:widget', insertElement(
  848. ( modelElement, viewWriter ) => viewWriter.createContainerElement( 'widget' ) )
  849. );
  850. model.change( writer => {
  851. writer.insert( modelWidget, modelRootStart );
  852. } );
  853. expect( viewToString( viewRoot ) ).to.equal( '<div><widget><p>foo</p></widget></div>' );
  854. const viewP = controller.mapper.toViewElement( modelP );
  855. expect( viewP ).not.to.be.undefined;
  856. model.change( writer => {
  857. writer.unwrap( modelWidget );
  858. } );
  859. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foo</p></div>' );
  860. // `modelP` is now bound with newly created view element.
  861. expect( controller.mapper.toViewElement( modelP ) ).not.to.equal( viewP );
  862. // `viewP` is no longer bound with model element.
  863. expect( controller.mapper.toModelElement( viewP ) ).to.be.undefined;
  864. // View element from view root is bound to `modelP`.
  865. expect( controller.mapper.toModelElement( viewRoot.getChild( 0 ) ) ).to.equal( modelP );
  866. } );
  867. it( 'should work correctly if container element after ui element is removed', () => {
  868. // Prepare a model and view structure.
  869. // This is done outside of conversion to put view ui elements inside easily.
  870. const modelP1 = new ModelElement( 'paragraph' );
  871. const modelP2 = new ModelElement( 'paragraph' );
  872. const viewP1 = new ViewContainerElement( 'p' );
  873. const viewUi1 = new ViewUIElement( 'span' );
  874. const viewUi2 = new ViewUIElement( 'span' );
  875. const viewP2 = new ViewContainerElement( 'p' );
  876. modelRoot._appendChildren( [ modelP1, modelP2 ] );
  877. viewRoot._appendChildren( [ viewP1, viewUi1, viewUi2, viewP2 ] );
  878. controller.mapper.bindElements( modelP1, viewP1 );
  879. controller.mapper.bindElements( modelP2, viewP2 );
  880. // Remove second paragraph element.
  881. model.change( writer => {
  882. writer.remove( ModelRange.createFromParentsAndOffsets( modelRoot, 1, modelRoot, 2 ) );
  883. } );
  884. expect( viewToString( viewRoot ) ).to.equal( '<div><p></p><span></span><span></span></div>' );
  885. } );
  886. it( 'should work correctly if container element after text node is removed', () => {
  887. const modelText = new ModelText( 'foo' );
  888. const modelP = new ModelElement( 'paragraph' );
  889. model.change( writer => {
  890. writer.insert( [ modelText, modelP ], modelRootStart );
  891. } );
  892. model.change( writer => {
  893. writer.remove( modelP );
  894. } );
  895. expect( viewToString( viewRoot ) ).to.equal( '<div>foo</div>' );
  896. } );
  897. } );
  898. describe( 'highlight', () => {
  899. describe( 'on text', () => {
  900. const highlightDescriptor = {
  901. class: 'highlight-class',
  902. priority: 7,
  903. attributes: { title: 'title' }
  904. };
  905. let markerRange;
  906. beforeEach( () => {
  907. const modelElement1 = new ModelElement( 'paragraph', null, new ModelText( 'foo' ) );
  908. const modelElement2 = new ModelElement( 'paragraph', null, new ModelText( 'bar' ) );
  909. model.change( writer => {
  910. writer.insert( [ modelElement1, modelElement2 ], modelRootStart );
  911. } );
  912. markerRange = ModelRange.createIn( modelRoot );
  913. } );
  914. it( 'should wrap and unwrap text nodes', () => {
  915. dispatcher.on( 'addMarker:marker', highlightText( highlightDescriptor ) );
  916. dispatcher.on( 'addMarker:marker', highlightElement( highlightDescriptor ) );
  917. dispatcher.on( 'removeMarker:marker', removeHighlight( highlightDescriptor ) );
  918. model.change( writer => {
  919. writer.setMarker( 'marker', markerRange );
  920. } );
  921. expect( viewToString( viewRoot ) ).to.equal(
  922. '<div>' +
  923. '<p>' +
  924. '<span class="highlight-class" title="title">foo</span>' +
  925. '</p>' +
  926. '<p>' +
  927. '<span class="highlight-class" title="title">bar</span>' +
  928. '</p>' +
  929. '</div>'
  930. );
  931. model.change( writer => {
  932. writer.removeMarker( 'marker' );
  933. } );
  934. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foo</p><p>bar</p></div>' );
  935. } );
  936. it( 'should be possible to overwrite', () => {
  937. dispatcher.on( 'addMarker:marker', highlightText( highlightDescriptor ) );
  938. dispatcher.on( 'addMarker:marker', highlightElement( highlightDescriptor ) );
  939. dispatcher.on( 'removeMarker:marker', removeHighlight( highlightDescriptor ) );
  940. const newDescriptor = { class: 'override-class' };
  941. dispatcher.on( 'addMarker:marker', highlightText( newDescriptor ), { priority: 'high' } );
  942. dispatcher.on( 'addMarker:marker', highlightElement( newDescriptor ), { priority: 'high' } );
  943. dispatcher.on( 'removeMarker:marker', removeHighlight( newDescriptor ), { priority: 'high' } );
  944. model.change( writer => {
  945. writer.setMarker( 'marker', markerRange );
  946. } );
  947. expect( viewToString( viewRoot ) ).to.equal(
  948. '<div>' +
  949. '<p>' +
  950. '<span class="override-class">foo</span>' +
  951. '</p>' +
  952. '<p>' +
  953. '<span class="override-class">bar</span>' +
  954. '</p>' +
  955. '</div>'
  956. );
  957. model.change( writer => {
  958. writer.removeMarker( 'marker' );
  959. } );
  960. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foo</p><p>bar</p></div>' );
  961. } );
  962. it( 'should do nothing if descriptor is not provided or generating function returns null', () => {
  963. dispatcher.on( 'addMarker:marker', highlightText( () => null ), { priority: 'high' } );
  964. dispatcher.on( 'addMarker:marker', highlightElement( () => null ), { priority: 'high' } );
  965. dispatcher.on( 'removeMarker:marker', removeHighlight( () => null ), { priority: 'high' } );
  966. model.change( writer => {
  967. writer.setMarker( 'marker', markerRange );
  968. } );
  969. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foo</p><p>bar</p></div>' );
  970. model.change( writer => {
  971. writer.removeMarker( 'marker' );
  972. } );
  973. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foo</p><p>bar</p></div>' );
  974. } );
  975. it( 'should do nothing if collapsed marker is converted', () => {
  976. const descriptor = { class: 'foo' };
  977. dispatcher.on( 'addMarker:marker', highlightText( descriptor ), { priority: 'high' } );
  978. dispatcher.on( 'addMarker:marker', highlightElement( descriptor ), { priority: 'high' } );
  979. dispatcher.on( 'removeMarker:marker', removeHighlight( descriptor ), { priority: 'high' } );
  980. markerRange = ModelRange.createFromParentsAndOffsets( modelRoot, 0, modelRoot, 0 );
  981. model.change( () => {
  982. model.markers._set( 'marker', markerRange );
  983. } );
  984. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foo</p><p>bar</p></div>' );
  985. model.change( () => {
  986. model.markers._remove( 'marker' );
  987. } );
  988. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foo</p><p>bar</p></div>' );
  989. } );
  990. it( 'should correctly wrap and unwrap multiple, intersecting markers', () => {
  991. const descriptorFoo = { class: 'foo' };
  992. const descriptorBar = { class: 'bar' };
  993. const descriptorXyz = { class: 'xyz' };
  994. dispatcher.on( 'addMarker:markerFoo', highlightText( descriptorFoo ) );
  995. dispatcher.on( 'addMarker:markerBar', highlightText( descriptorBar ) );
  996. dispatcher.on( 'addMarker:markerXyz', highlightText( descriptorXyz ) );
  997. dispatcher.on( 'removeMarker:markerFoo', removeHighlight( descriptorFoo ) );
  998. dispatcher.on( 'removeMarker:markerBar', removeHighlight( descriptorBar ) );
  999. dispatcher.on( 'removeMarker:markerXyz', removeHighlight( descriptorXyz ) );
  1000. const p1 = modelRoot.getChild( 0 );
  1001. const p2 = modelRoot.getChild( 1 );
  1002. model.change( writer => {
  1003. writer.setMarker( 'markerFoo', ModelRange.createFromParentsAndOffsets( p1, 0, p1, 3 ) );
  1004. } );
  1005. expect( viewToString( viewRoot ) ).to.equal(
  1006. '<div>' +
  1007. '<p>' +
  1008. '<span class="foo">foo</span>' +
  1009. '</p>' +
  1010. '<p>bar</p>' +
  1011. '</div>'
  1012. );
  1013. model.change( writer => {
  1014. writer.setMarker( 'markerBar', ModelRange.createFromParentsAndOffsets( p1, 1, p2, 2 ) );
  1015. } );
  1016. expect( viewToString( viewRoot ) ).to.equal(
  1017. '<div>' +
  1018. '<p>' +
  1019. '<span class="foo">f</span>' +
  1020. '<span class="bar">' +
  1021. '<span class="foo">oo</span>' +
  1022. '</span>' +
  1023. '</p>' +
  1024. '<p>' +
  1025. '<span class="bar">ba</span>' +
  1026. 'r' +
  1027. '</p>' +
  1028. '</div>'
  1029. );
  1030. model.change( writer => {
  1031. writer.setMarker( 'markerXyz', ModelRange.createFromParentsAndOffsets( p1, 2, p2, 3 ) );
  1032. } );
  1033. expect( viewToString( viewRoot ) ).to.equal(
  1034. '<div>' +
  1035. '<p>' +
  1036. '<span class="foo">f</span>' +
  1037. '<span class="bar">' +
  1038. '<span class="foo">' +
  1039. 'o' +
  1040. '<span class="xyz">o</span>' +
  1041. '</span>' +
  1042. '</span>' +
  1043. '</p>' +
  1044. '<p>' +
  1045. '<span class="bar">' +
  1046. '<span class="xyz">ba</span>' +
  1047. '</span>' +
  1048. '<span class="xyz">r</span>' +
  1049. '</p>' +
  1050. '</div>'
  1051. );
  1052. model.change( writer => {
  1053. writer.removeMarker( 'markerBar' );
  1054. } );
  1055. expect( viewToString( viewRoot ) ).to.equal(
  1056. '<div>' +
  1057. '<p>' +
  1058. '<span class="foo">' +
  1059. 'fo' +
  1060. '<span class="xyz">o</span>' +
  1061. '</span>' +
  1062. '</p>' +
  1063. '<p>' +
  1064. '<span class="xyz">bar</span>' +
  1065. '</p>' +
  1066. '</div>'
  1067. );
  1068. model.change( writer => {
  1069. writer.removeMarker( 'markerFoo' );
  1070. } );
  1071. expect( viewToString( viewRoot ) ).to.equal(
  1072. '<div>' +
  1073. '<p>' +
  1074. 'fo' +
  1075. '<span class="xyz">o</span>' +
  1076. '</p>' +
  1077. '<p>' +
  1078. '<span class="xyz">bar</span>' +
  1079. '</p>' +
  1080. '</div>'
  1081. );
  1082. model.change( writer => {
  1083. writer.removeMarker( 'markerXyz' );
  1084. } );
  1085. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foo</p><p>bar</p></div>' );
  1086. } );
  1087. it( 'should do nothing if marker is applied and removed on empty-ish range', () => {
  1088. dispatcher.on( 'addMarker:marker', highlightText( highlightDescriptor ) );
  1089. dispatcher.on( 'removeMarker:marker', removeHighlight( highlightDescriptor ) );
  1090. const p1 = modelRoot.getChild( 0 );
  1091. const p2 = modelRoot.getChild( 1 );
  1092. const markerRange = ModelRange.createFromParentsAndOffsets( p1, 3, p2, 0 );
  1093. model.change( writer => {
  1094. writer.setMarker( 'marker', markerRange );
  1095. } );
  1096. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foo</p><p>bar</p></div>' );
  1097. model.change( writer => {
  1098. writer.removeMarker( 'marker', markerRange );
  1099. } );
  1100. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foo</p><p>bar</p></div>' );
  1101. } );
  1102. } );
  1103. describe( 'on element', () => {
  1104. const highlightDescriptor = {
  1105. class: 'highlight-class',
  1106. priority: 7,
  1107. attributes: { title: 'title' },
  1108. id: 'customId'
  1109. };
  1110. let markerRange;
  1111. beforeEach( () => {
  1112. // Provide converter for div element. View div element will have custom highlight handling.
  1113. dispatcher.on( 'insert:div', insertElement( () => {
  1114. const viewContainer = new ViewContainerElement( 'div' );
  1115. viewContainer._setCustomProperty( 'addHighlight', ( element, descriptor, writer ) => {
  1116. writer.addClass( descriptor.class, element );
  1117. } );
  1118. viewContainer._setCustomProperty( 'removeHighlight', ( element, id, writer ) => {
  1119. writer.setAttribute( 'class', '', element );
  1120. } );
  1121. return viewContainer;
  1122. } ) );
  1123. const modelElement = new ModelElement( 'div', null, new ModelText( 'foo' ) );
  1124. model.change( writer => {
  1125. writer.insert( modelElement, modelRootStart );
  1126. } );
  1127. markerRange = ModelRange.createOn( modelElement );
  1128. dispatcher.on( 'addMarker:marker', highlightText( highlightDescriptor ) );
  1129. dispatcher.on( 'addMarker:marker', highlightElement( highlightDescriptor ) );
  1130. dispatcher.on( 'removeMarker:marker', removeHighlight( highlightDescriptor ) );
  1131. } );
  1132. it( 'should use addHighlight and removeHighlight on elements and not convert children nodes', () => {
  1133. model.change( writer => {
  1134. writer.setMarker( 'marker', markerRange );
  1135. } );
  1136. expect( viewToString( viewRoot ) ).to.equal(
  1137. '<div>' +
  1138. '<div class="highlight-class">' +
  1139. 'foo' +
  1140. '</div>' +
  1141. '</div>'
  1142. );
  1143. model.change( writer => {
  1144. writer.removeMarker( 'marker' );
  1145. } );
  1146. expect( viewToString( viewRoot ) ).to.equal( '<div><div>foo</div></div>' );
  1147. } );
  1148. it( 'should be possible to override', () => {
  1149. const newDescriptor = { class: 'override-class' };
  1150. dispatcher.on( 'addMarker:marker', highlightText( newDescriptor ), { priority: 'high' } );
  1151. dispatcher.on( 'addMarker:marker', highlightElement( newDescriptor ), { priority: 'high' } );
  1152. dispatcher.on( 'removeMarker:marker', removeHighlight( newDescriptor ), { priority: 'high' } );
  1153. model.change( writer => {
  1154. writer.setMarker( 'marker', markerRange );
  1155. } );
  1156. expect( viewToString( viewRoot ) ).to.equal(
  1157. '<div>' +
  1158. '<div class="override-class">' +
  1159. 'foo' +
  1160. '</div>' +
  1161. '</div>'
  1162. );
  1163. model.change( writer => {
  1164. writer.removeMarker( 'marker' );
  1165. } );
  1166. expect( viewToString( viewRoot ) ).to.equal( '<div><div>foo</div></div>' );
  1167. } );
  1168. it( 'should use default priority and id if not provided', () => {
  1169. const viewDiv = viewRoot.getChild( 0 );
  1170. dispatcher.on( 'addMarker:marker2', highlightText( () => null ) );
  1171. dispatcher.on( 'addMarker:marker2', highlightElement( () => null ) );
  1172. dispatcher.on( 'removeMarker:marker2', removeHighlight( () => null ) );
  1173. viewDiv._setCustomProperty( 'addHighlight', ( element, descriptor ) => {
  1174. expect( descriptor.priority ).to.equal( 10 );
  1175. expect( descriptor.id ).to.equal( 'marker:foo-bar-baz' );
  1176. } );
  1177. viewDiv._setCustomProperty( 'removeHighlight', ( element, id ) => {
  1178. expect( id ).to.equal( 'marker:foo-bar-baz' );
  1179. } );
  1180. model.change( writer => {
  1181. writer.setMarker( 'marker2', markerRange );
  1182. } );
  1183. } );
  1184. it( 'should do nothing if descriptor is not provided', () => {
  1185. dispatcher.on( 'addMarker:marker2', highlightText( () => null ) );
  1186. dispatcher.on( 'addMarker:marker2', highlightElement( () => null ) );
  1187. dispatcher.on( 'removeMarker:marker2', removeHighlight( () => null ) );
  1188. model.change( writer => {
  1189. writer.setMarker( 'marker2', markerRange );
  1190. } );
  1191. expect( viewToString( viewRoot ) ).to.equal( '<div><div>foo</div></div>' );
  1192. model.change( writer => {
  1193. writer.removeMarker( 'marker2' );
  1194. } );
  1195. expect( viewToString( viewRoot ) ).to.equal( '<div><div>foo</div></div>' );
  1196. } );
  1197. } );
  1198. } );
  1199. describe( 'createViewElementFromHighlightDescriptor()', () => {
  1200. it( 'should return attribute element from descriptor object', () => {
  1201. const descriptor = {
  1202. class: 'foo-class',
  1203. attributes: { one: '1', two: '2' },
  1204. priority: 7,
  1205. };
  1206. const element = createViewElementFromHighlightDescriptor( descriptor );
  1207. expect( element.is( 'attributeElement' ) ).to.be.true;
  1208. expect( element.name ).to.equal( 'span' );
  1209. expect( element.priority ).to.equal( 7 );
  1210. expect( element.hasClass( 'foo-class' ) ).to.be.true;
  1211. for ( const key of Object.keys( descriptor.attributes ) ) {
  1212. expect( element.getAttribute( key ) ).to.equal( descriptor.attributes[ key ] );
  1213. }
  1214. } );
  1215. it( 'should return attribute element from descriptor object - array with classes', () => {
  1216. const descriptor = {
  1217. class: [ 'foo-class', 'bar-class' ],
  1218. attributes: { one: '1', two: '2' },
  1219. priority: 7,
  1220. };
  1221. const element = createViewElementFromHighlightDescriptor( descriptor );
  1222. expect( element.is( 'attributeElement' ) ).to.be.true;
  1223. expect( element.name ).to.equal( 'span' );
  1224. expect( element.priority ).to.equal( 7 );
  1225. expect( element.hasClass( 'foo-class' ) ).to.be.true;
  1226. expect( element.hasClass( 'bar-class' ) ).to.be.true;
  1227. for ( const key of Object.keys( descriptor.attributes ) ) {
  1228. expect( element.getAttribute( key ) ).to.equal( descriptor.attributes[ key ] );
  1229. }
  1230. } );
  1231. it( 'should create element without class', () => {
  1232. const descriptor = {
  1233. attributes: { one: '1', two: '2' },
  1234. priority: 7,
  1235. };
  1236. const element = createViewElementFromHighlightDescriptor( descriptor );
  1237. expect( element.is( 'attributeElement' ) ).to.be.true;
  1238. expect( element.name ).to.equal( 'span' );
  1239. expect( element.priority ).to.equal( 7 );
  1240. for ( const key of Object.keys( descriptor.attributes ) ) {
  1241. expect( element.getAttribute( key ) ).to.equal( descriptor.attributes[ key ] );
  1242. }
  1243. } );
  1244. it( 'should create element without priority', () => {
  1245. const descriptor = {
  1246. class: 'foo-class',
  1247. attributes: { one: '1', two: '2' },
  1248. };
  1249. const element = createViewElementFromHighlightDescriptor( descriptor );
  1250. expect( element.is( 'attributeElement' ) ).to.be.true;
  1251. expect( element.name ).to.equal( 'span' );
  1252. expect( element.priority ).to.equal( 10 );
  1253. expect( element.hasClass( 'foo-class' ) ).to.be.true;
  1254. for ( const key of Object.keys( descriptor.attributes ) ) {
  1255. expect( element.getAttribute( key ) ).to.equal( descriptor.attributes[ key ] );
  1256. }
  1257. } );
  1258. it( 'should create element without attributes', () => {
  1259. const descriptor = {
  1260. class: 'foo-class',
  1261. priority: 7
  1262. };
  1263. const element = createViewElementFromHighlightDescriptor( descriptor );
  1264. expect( element.is( 'attributeElement' ) ).to.be.true;
  1265. expect( element.name ).to.equal( 'span' );
  1266. expect( element.priority ).to.equal( 7 );
  1267. expect( element.hasClass( 'foo-class' ) ).to.be.true;
  1268. } );
  1269. } );
  1270. } );