downcast-converters.js 49 KB

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