downcast-converters.js 48 KB

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