downcast-converters.js 53 KB

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