downcasthelpers.js 74 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394
  1. /**
  2. * @license Copyright (c) 2003-2020, CKSource - Frederico Knabben. All rights reserved.
  3. * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
  4. */
  5. /* globals console */
  6. import EditingController from '../../src/controller/editingcontroller';
  7. import Model from '../../src/model/model';
  8. import ModelElement from '../../src/model/element';
  9. import ModelText from '../../src/model/text';
  10. import ViewElement from '../../src/view/element';
  11. import ViewAttributeElement from '../../src/view/attributeelement';
  12. import ViewContainerElement from '../../src/view/containerelement';
  13. import ViewUIElement from '../../src/view/uielement';
  14. import ViewText from '../../src/view/text';
  15. import ViewDocument from '../../src/view/document';
  16. import testUtils from '@ckeditor/ckeditor5-core/tests/_utils/utils';
  17. import DowncastHelpers, {
  18. clearAttributes,
  19. convertCollapsedSelection,
  20. convertRangeSelection,
  21. createViewElementFromHighlightDescriptor,
  22. insertText
  23. } from '../../src/conversion/downcasthelpers';
  24. import Mapper from '../../src/conversion/mapper';
  25. import DowncastDispatcher from '../../src/conversion/downcastdispatcher';
  26. import { stringify as stringifyView } from '../../src/dev-utils/view';
  27. import View from '../../src/view/view';
  28. import createViewRoot from '../view/_utils/createroot';
  29. import { setData as setModelData } from '../../src/dev-utils/model';
  30. import { expectToThrowCKEditorError } from '@ckeditor/ckeditor5-utils/tests/_utils/utils';
  31. import { StylesProcessor } from '../../src/view/stylesmap';
  32. import DowncastWriter from '../../src/view/downcastwriter';
  33. describe( 'DowncastHelpers', () => {
  34. let model, modelRoot, viewRoot, downcastHelpers, controller, modelRootStart;
  35. beforeEach( () => {
  36. model = new Model();
  37. const modelDoc = model.document;
  38. modelRoot = modelDoc.createRoot();
  39. controller = new EditingController( model, new StylesProcessor() );
  40. // Set name of view root the same as dom root.
  41. // This is a mock of attaching view root to dom root.
  42. controller.view.document.getRoot()._name = 'div';
  43. viewRoot = controller.view.document.getRoot();
  44. downcastHelpers = new DowncastHelpers( [ controller.downcastDispatcher ] );
  45. modelRootStart = model.createPositionAt( modelRoot, 0 );
  46. } );
  47. describe( 'elementToElement()', () => {
  48. it( 'should be chainable', () => {
  49. expect( downcastHelpers.elementToElement( { model: 'paragraph', view: 'p' } ) ).to.equal( downcastHelpers );
  50. } );
  51. it( 'config.view is a string', () => {
  52. downcastHelpers.elementToElement( { model: 'paragraph', view: 'p' } );
  53. model.change( writer => {
  54. writer.insertElement( 'paragraph', modelRoot, 0 );
  55. } );
  56. expectResult( '<p></p>' );
  57. } );
  58. it( 'can be overwritten using converterPriority', () => {
  59. downcastHelpers.elementToElement( { model: 'paragraph', view: 'p' } );
  60. downcastHelpers.elementToElement( { model: 'paragraph', view: 'foo', converterPriority: 'high' } );
  61. model.change( writer => {
  62. writer.insertElement( 'paragraph', modelRoot, 0 );
  63. } );
  64. expectResult( '<foo></foo>' );
  65. } );
  66. it( 'config.view is a view element definition', () => {
  67. downcastHelpers.elementToElement( {
  68. model: 'fancyParagraph',
  69. view: {
  70. name: 'p',
  71. classes: 'fancy'
  72. }
  73. } );
  74. model.change( writer => {
  75. writer.insertElement( 'fancyParagraph', modelRoot, 0 );
  76. } );
  77. expectResult( '<p class="fancy"></p>' );
  78. } );
  79. it( 'config.view is a function', () => {
  80. downcastHelpers.elementToElement( {
  81. model: 'heading',
  82. view: ( modelElement, viewWriter ) => viewWriter.createContainerElement( 'h' + modelElement.getAttribute( 'level' ) )
  83. } );
  84. model.change( writer => {
  85. writer.insertElement( 'heading', { level: 2 }, modelRoot, 0 );
  86. } );
  87. expectResult( '<h2></h2>' );
  88. } );
  89. } );
  90. describe( 'attributeToElement()', () => {
  91. beforeEach( () => {
  92. downcastHelpers.elementToElement( { model: 'paragraph', view: 'p' } );
  93. } );
  94. it( 'should be chainable', () => {
  95. expect( downcastHelpers.attributeToElement( { model: 'bold', view: 'strong' } ) ).to.equal( downcastHelpers );
  96. } );
  97. it( 'config.view is a string', () => {
  98. downcastHelpers.attributeToElement( { model: 'bold', view: 'strong' } );
  99. model.change( writer => {
  100. writer.insertText( 'foo', { bold: true }, modelRoot, 0 );
  101. } );
  102. expectResult( '<strong>foo</strong>' );
  103. } );
  104. it( 'can be overwritten using converterPriority', () => {
  105. downcastHelpers.attributeToElement( { model: 'bold', view: 'strong' } );
  106. downcastHelpers.attributeToElement( { model: 'bold', view: 'b', converterPriority: 'high' } );
  107. model.change( writer => {
  108. writer.insertText( 'foo', { bold: true }, modelRoot, 0 );
  109. } );
  110. expectResult( '<b>foo</b>' );
  111. } );
  112. it( 'config.view is a view element definition', () => {
  113. downcastHelpers.attributeToElement( {
  114. model: 'invert',
  115. view: {
  116. name: 'span',
  117. classes: [ 'font-light', 'bg-dark' ]
  118. }
  119. } );
  120. model.change( writer => {
  121. writer.insertText( 'foo', { invert: true }, modelRoot, 0 );
  122. } );
  123. expectResult( '<span class="bg-dark font-light">foo</span>' );
  124. expect( viewRoot.getChild( 0 ).priority ).to.equal( ViewAttributeElement.DEFAULT_PRIORITY );
  125. } );
  126. it( 'config.view allows specifying the element\'s priority', () => {
  127. downcastHelpers.attributeToElement( {
  128. model: 'invert',
  129. view: {
  130. name: 'span',
  131. priority: 5
  132. }
  133. } );
  134. model.change( writer => {
  135. writer.insertText( 'foo', { invert: true }, modelRoot, 0 );
  136. } );
  137. expect( viewRoot.getChild( 0 ).priority ).to.equal( 5 );
  138. } );
  139. it( 'model attribute value is enum', () => {
  140. downcastHelpers.attributeToElement( {
  141. model: {
  142. key: 'fontSize',
  143. values: [ 'big', 'small' ]
  144. },
  145. view: {
  146. big: {
  147. name: 'span',
  148. styles: {
  149. 'font-size': '1.2em'
  150. }
  151. },
  152. small: {
  153. name: 'span',
  154. styles: {
  155. 'font-size': '0.8em'
  156. },
  157. priority: 5
  158. }
  159. }
  160. } );
  161. model.change( writer => {
  162. writer.insertText( 'foo', { fontSize: 'big' }, modelRoot, 0 );
  163. } );
  164. expect( viewRoot.getChild( 0 ).priority ).to.equal( ViewAttributeElement.DEFAULT_PRIORITY );
  165. expectResult( '<span style="font-size:1.2em">foo</span>' );
  166. model.change( writer => {
  167. writer.setAttribute( 'fontSize', 'small', modelRoot.getChild( 0 ) );
  168. } );
  169. expectResult( '<span style="font-size:0.8em">foo</span>' );
  170. expect( viewRoot.getChild( 0 ).priority ).to.equal( 5 );
  171. model.change( writer => {
  172. writer.removeAttribute( 'fontSize', modelRoot.getChild( 0 ) );
  173. } );
  174. expectResult( 'foo' );
  175. } );
  176. it( 'config.view is a function', () => {
  177. downcastHelpers.attributeToElement( {
  178. model: 'bold',
  179. view: ( modelAttributeValue, viewWriter ) => {
  180. return viewWriter.createAttributeElement( 'span', { style: 'font-weight:' + modelAttributeValue } );
  181. }
  182. } );
  183. model.change( writer => {
  184. writer.insertText( 'foo', { bold: '500' }, modelRoot, 0 );
  185. } );
  186. expectResult( '<span style="font-weight:500">foo</span>' );
  187. } );
  188. it( 'config.model.name is given', () => {
  189. downcastHelpers.attributeToElement( {
  190. model: {
  191. key: 'color',
  192. name: '$text'
  193. },
  194. view: ( modelAttributeValue, viewWriter ) => {
  195. return viewWriter.createAttributeElement( 'span', { style: 'color:' + modelAttributeValue } );
  196. }
  197. } );
  198. downcastHelpers.elementToElement( {
  199. model: 'smiley',
  200. view: ( modelElement, viewWriter ) => {
  201. return viewWriter.createEmptyElement( 'img', {
  202. src: 'smile.jpg',
  203. class: 'smiley'
  204. } );
  205. }
  206. } );
  207. model.change( writer => {
  208. writer.insertText( 'foo', { color: '#FF0000' }, modelRoot, 0 );
  209. writer.insertElement( 'smiley', { color: '#FF0000' }, modelRoot, 3 );
  210. } );
  211. expectResult( '<span style="color:#FF0000">foo</span><img class="smiley" src="smile.jpg"></img>' );
  212. } );
  213. it( 'should not convert if creator returned null', () => {
  214. downcastHelpers.elementToElement( { model: 'div', view: () => null } );
  215. const modelElement = new ModelElement( 'div' );
  216. model.change( writer => {
  217. writer.insert( modelElement, modelRootStart );
  218. } );
  219. expect( viewToString( viewRoot ) ).to.equal( '<div></div>' );
  220. } );
  221. it( 'should convert insert/change/remove of attribute in model into wrapping element in a view', () => {
  222. const modelElement = new ModelElement( 'paragraph', null, new ModelText( 'foobar', { bold: true } ) );
  223. downcastHelpers.attributeToElement( {
  224. model: 'bold',
  225. view: ( modelAttributeValue, viewWriter ) => viewWriter.createAttributeElement( 'b' )
  226. } );
  227. model.change( writer => {
  228. writer.insert( modelElement, modelRootStart );
  229. } );
  230. expect( viewToString( viewRoot ) ).to.equal( '<div><p><b>foobar</b></p></div>' );
  231. model.change( writer => {
  232. writer.removeAttribute( 'bold', writer.createRangeIn( modelElement ) );
  233. } );
  234. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  235. } );
  236. it( 'should convert insert/remove of attribute in model with wrapping element generating function as a parameter', () => {
  237. const modelElement = new ModelElement( 'paragraph', null, new ModelText( 'foobar', { style: 'bold' } ) );
  238. downcastHelpers.attributeToElement( {
  239. model: 'style',
  240. view: ( modelAttributeValue, viewWriter ) => {
  241. if ( modelAttributeValue == 'bold' ) {
  242. return viewWriter.createAttributeElement( 'b' );
  243. }
  244. }
  245. } );
  246. model.change( writer => {
  247. writer.insert( modelElement, modelRootStart );
  248. } );
  249. expect( viewToString( viewRoot ) ).to.equal( '<div><p><b>foobar</b></p></div>' );
  250. model.change( writer => {
  251. writer.removeAttribute( 'style', writer.createRangeIn( modelElement ) );
  252. } );
  253. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  254. } );
  255. it( 'should update range on re-wrapping attribute (#475)', () => {
  256. const modelElement = new ModelElement( 'paragraph', null, [
  257. new ModelText( 'x' ),
  258. new ModelText( 'foo', { link: 'http://foo.com' } ),
  259. new ModelText( 'x' )
  260. ] );
  261. downcastHelpers.attributeToElement( {
  262. model: 'link',
  263. view: ( modelAttributeValue, viewWriter ) => {
  264. return viewWriter.createAttributeElement( 'a', { href: modelAttributeValue } );
  265. }
  266. } );
  267. model.change( writer => {
  268. writer.insert( modelElement, modelRootStart );
  269. } );
  270. expect( viewToString( viewRoot ) ).to.equal( '<div><p>x<a href="http://foo.com">foo</a>x</p></div>' );
  271. // Set new attribute on old link but also on non-linked characters.
  272. model.change( writer => {
  273. writer.setAttribute( 'link', 'http://foobar.com', writer.createRangeIn( modelElement ) );
  274. } );
  275. expect( viewToString( viewRoot ) ).to.equal( '<div><p><a href="http://foobar.com">xfoox</a></p></div>' );
  276. } );
  277. it( 'should support unicode', () => {
  278. const modelElement = new ModelElement( 'paragraph', null, [ 'நி', new ModelText( 'லைக்', { bold: true } ), 'கு' ] );
  279. downcastHelpers.attributeToElement( {
  280. model: 'bold',
  281. view: ( modelAttributeValue, viewWriter ) => viewWriter.createAttributeElement( 'b' )
  282. } );
  283. model.change( writer => {
  284. writer.insert( modelElement, modelRootStart );
  285. } );
  286. expect( viewToString( viewRoot ) ).to.equal( '<div><p>நி<b>லைக்</b>கு</p></div>' );
  287. model.change( writer => {
  288. writer.removeAttribute( 'bold', writer.createRangeIn( modelElement ) );
  289. } );
  290. expect( viewToString( viewRoot ) ).to.equal( '<div><p>நிலைக்கு</p></div>' );
  291. } );
  292. it( 'should be possible to override ', () => {
  293. const modelElement = new ModelElement( 'paragraph', null, new ModelText( 'foobar', { bold: true } ) );
  294. downcastHelpers.attributeToElement( {
  295. model: 'bold',
  296. view: ( modelAttributeValue, viewWriter ) => viewWriter.createAttributeElement( 'b' )
  297. } );
  298. downcastHelpers.attributeToElement( {
  299. model: 'bold',
  300. view: ( modelAttributeValue, viewWriter ) => viewWriter.createAttributeElement( 'strong' ),
  301. converterPriority: 'high'
  302. } );
  303. model.change( writer => {
  304. writer.insert( modelElement, modelRootStart );
  305. } );
  306. expect( viewToString( viewRoot ) ).to.equal( '<div><p><strong>foobar</strong></p></div>' );
  307. } );
  308. it( 'should not convert and not consume if creator function returned null', () => {
  309. sinon.spy( controller.downcastDispatcher, 'fire' );
  310. const modelElement = new ModelElement( 'paragraph', null, new ModelText( 'foobar', { italic: true } ) );
  311. downcastHelpers.attributeToElement( {
  312. model: 'italic',
  313. view: () => null
  314. } );
  315. const spy = sinon.spy();
  316. controller.downcastDispatcher.on( 'attribute:italic', spy );
  317. model.change( writer => {
  318. writer.insert( modelElement, modelRootStart );
  319. } );
  320. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  321. expect( controller.downcastDispatcher.fire.calledWith( 'attribute:italic:$text' ) ).to.be.true;
  322. expect( spy.called ).to.be.true;
  323. } );
  324. } );
  325. describe( 'attributeToAttribute()', () => {
  326. testUtils.createSinonSandbox();
  327. beforeEach( () => {
  328. downcastHelpers.elementToElement( { model: 'image', view: 'img' } );
  329. downcastHelpers.elementToElement( {
  330. model: 'paragraph',
  331. view: ( modelItem, viewWriter ) => viewWriter.createContainerElement( 'p' )
  332. } );
  333. downcastHelpers.attributeToAttribute( {
  334. model: 'class',
  335. view: 'class'
  336. } );
  337. } );
  338. it( 'should be chainable', () => {
  339. expect( downcastHelpers.attributeToAttribute( { model: 'source', view: 'src' } ) ).to.equal( downcastHelpers );
  340. } );
  341. it( 'config.view is a string', () => {
  342. downcastHelpers.attributeToAttribute( { model: 'source', view: 'src' } );
  343. model.change( writer => {
  344. writer.insertElement( 'image', { source: 'foo.jpg' }, modelRoot, 0 );
  345. } );
  346. expectResult( '<img src="foo.jpg"></img>' );
  347. model.change( writer => {
  348. writer.removeAttribute( 'source', modelRoot.getChild( 0 ) );
  349. } );
  350. expectResult( '<img></img>' );
  351. } );
  352. it( 'can be overwritten using converterPriority', () => {
  353. downcastHelpers.attributeToAttribute( { model: 'source', view: 'href' } );
  354. downcastHelpers.attributeToAttribute( { model: 'source', view: 'src', converterPriority: 'high' } );
  355. model.change( writer => {
  356. writer.insertElement( 'image', { source: 'foo.jpg' }, modelRoot, 0 );
  357. } );
  358. expectResult( '<img src="foo.jpg"></img>' );
  359. } );
  360. it( 'model element name specified', () => {
  361. downcastHelpers.elementToElement( { model: 'paragraph', view: 'p' } );
  362. downcastHelpers.attributeToAttribute( {
  363. model: {
  364. name: 'image',
  365. key: 'source'
  366. },
  367. view: 'src'
  368. } );
  369. model.change( writer => {
  370. writer.insertElement( 'image', { source: 'foo.jpg' }, modelRoot, 0 );
  371. } );
  372. expectResult( '<img src="foo.jpg"></img>' );
  373. model.change( writer => {
  374. writer.rename( modelRoot.getChild( 0 ), 'paragraph' );
  375. } );
  376. expectResult( '<p></p>' );
  377. } );
  378. it( 'config.view is an object, model attribute value is enum', () => {
  379. downcastHelpers.elementToElement( { model: 'paragraph', view: 'p' } );
  380. downcastHelpers.attributeToAttribute( {
  381. model: {
  382. key: 'styled',
  383. values: [ 'dark', 'light' ]
  384. },
  385. view: {
  386. dark: {
  387. key: 'class',
  388. value: [ 'styled', 'styled-dark' ]
  389. },
  390. light: {
  391. key: 'class',
  392. value: [ 'styled', 'styled-light' ]
  393. }
  394. }
  395. } );
  396. model.change( writer => {
  397. writer.insertElement( 'paragraph', { styled: 'dark' }, modelRoot, 0 );
  398. } );
  399. expectResult( '<p class="styled styled-dark"></p>' );
  400. model.change( writer => {
  401. writer.setAttribute( 'styled', 'light', modelRoot.getChild( 0 ) );
  402. } );
  403. expectResult( '<p class="styled styled-light"></p>' );
  404. model.change( writer => {
  405. writer.removeAttribute( 'styled', modelRoot.getChild( 0 ) );
  406. } );
  407. expectResult( '<p></p>' );
  408. } );
  409. it( 'config.view is an object, model attribute value is enum, view has style', () => {
  410. downcastHelpers.elementToElement( { model: 'paragraph', view: 'p' } );
  411. downcastHelpers.attributeToAttribute( {
  412. model: {
  413. key: 'align',
  414. values: [ 'right', 'center' ]
  415. },
  416. view: {
  417. right: {
  418. key: 'style',
  419. value: {
  420. 'text-align': 'right'
  421. }
  422. },
  423. center: {
  424. key: 'style',
  425. value: {
  426. 'text-align': 'center'
  427. }
  428. }
  429. }
  430. } );
  431. model.change( writer => {
  432. writer.insertElement( 'paragraph', { align: 'right' }, modelRoot, 0 );
  433. } );
  434. expectResult( '<p style="text-align:right"></p>' );
  435. model.change( writer => {
  436. writer.setAttribute( 'align', 'center', modelRoot.getChild( 0 ) );
  437. } );
  438. expectResult( '<p style="text-align:center"></p>' );
  439. model.change( writer => {
  440. writer.removeAttribute( 'align', modelRoot.getChild( 0 ) );
  441. } );
  442. expectResult( '<p></p>' );
  443. } );
  444. it( 'config.view is an object, only name and key are provided', () => {
  445. downcastHelpers.elementToElement( { model: 'paragraph', view: 'p' } );
  446. downcastHelpers.attributeToAttribute( {
  447. model: {
  448. name: 'paragraph',
  449. key: 'class'
  450. },
  451. view: {
  452. name: 'paragraph',
  453. key: 'class'
  454. }
  455. } );
  456. model.change( writer => {
  457. writer.insertElement( 'paragraph', { class: 'dark' }, modelRoot, 0 );
  458. } );
  459. expectResult( '<p class="dark"></p>' );
  460. model.change( writer => {
  461. writer.setAttribute( 'class', 'light', modelRoot.getChild( 0 ) );
  462. } );
  463. expectResult( '<p class="light"></p>' );
  464. model.change( writer => {
  465. writer.removeAttribute( 'class', modelRoot.getChild( 0 ) );
  466. } );
  467. expectResult( '<p></p>' );
  468. } );
  469. it( 'config.view is a function', () => {
  470. downcastHelpers.attributeToAttribute( {
  471. model: 'styled',
  472. view: attributeValue => ( { key: 'class', value: 'styled-' + attributeValue } )
  473. } );
  474. model.change( writer => {
  475. writer.insertElement( 'image', { styled: 'pull-out' }, modelRoot, 0 );
  476. } );
  477. expectResult( '<img class="styled-pull-out"></img>' );
  478. } );
  479. // #1587
  480. it( 'config.view and config.model as strings in generic conversion (elements only)', () => {
  481. const consoleWarnStub = testUtils.sinon.stub( console, 'warn' );
  482. downcastHelpers.elementToElement( { model: 'paragraph', view: 'p' } );
  483. downcastHelpers.attributeToAttribute( { model: 'test', view: 'test' } );
  484. model.change( writer => {
  485. writer.insertElement( 'paragraph', { test: '1' }, modelRoot, 0 );
  486. writer.insertElement( 'paragraph', { test: '2' }, modelRoot, 1 );
  487. } );
  488. expectResult( '<p test="1"></p><p test="2"></p>' );
  489. expect( consoleWarnStub.callCount ).to.equal( 0 );
  490. model.change( writer => {
  491. writer.removeAttribute( 'test', modelRoot.getChild( 1 ) );
  492. } );
  493. expectResult( '<p test="1"></p><p></p>' );
  494. } );
  495. // #1587
  496. it( 'config.view and config.model as strings in generic conversion (elements + text)', () => {
  497. downcastHelpers.elementToElement( { model: 'paragraph', view: 'p' } );
  498. downcastHelpers.attributeToAttribute( { model: 'test', view: 'test' } );
  499. expectToThrowCKEditorError( () => {
  500. model.change( writer => {
  501. writer.insertElement( 'paragraph', modelRoot, 0 );
  502. writer.insertElement( 'paragraph', { test: '1' }, modelRoot, 1 );
  503. writer.insertText( 'Foo', { test: '2' }, modelRoot.getChild( 0 ), 0 );
  504. writer.insertText( 'Bar', { test: '3' }, modelRoot.getChild( 1 ), 0 );
  505. } );
  506. }, /^conversion-attribute-to-attribute-on-text/ );
  507. } );
  508. it( 'should convert attribute insert/change/remove on a model node', () => {
  509. const modelElement = new ModelElement( 'paragraph', { class: 'foo' }, new ModelText( 'foobar' ) );
  510. model.change( writer => {
  511. writer.insert( modelElement, modelRootStart );
  512. } );
  513. expect( viewToString( viewRoot ) ).to.equal( '<div><p class="foo">foobar</p></div>' );
  514. model.change( writer => {
  515. writer.setAttribute( 'class', 'bar', modelElement );
  516. } );
  517. expect( viewToString( viewRoot ) ).to.equal( '<div><p class="bar">foobar</p></div>' );
  518. model.change( writer => {
  519. writer.removeAttribute( 'class', modelElement );
  520. } );
  521. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  522. } );
  523. it( 'should convert insert/change/remove with attribute generating function as a parameter', () => {
  524. downcastHelpers.elementToElement( { model: 'div', view: 'div' } );
  525. downcastHelpers.attributeToAttribute( {
  526. model: 'theme',
  527. view: ( value, data ) => {
  528. if ( data.item instanceof ModelElement && data.item.childCount > 0 ) {
  529. value += ' fix-content';
  530. }
  531. return { key: 'class', value };
  532. }
  533. } );
  534. const modelParagraph = new ModelElement( 'paragraph', { theme: 'nice' }, new ModelText( 'foobar' ) );
  535. const modelDiv = new ModelElement( 'div', { theme: 'nice' } );
  536. model.change( writer => {
  537. writer.insert( [ modelParagraph, modelDiv ], modelRootStart );
  538. } );
  539. expect( viewToString( viewRoot ) ).to.equal( '<div><p class="nice fix-content">foobar</p><div class="nice"></div></div>' );
  540. model.change( writer => {
  541. writer.setAttribute( 'theme', 'awesome', modelParagraph );
  542. } );
  543. expect( viewToString( viewRoot ) ).to.equal( '<div><p class="awesome fix-content">foobar</p><div class="nice"></div></div>' );
  544. model.change( writer => {
  545. writer.removeAttribute( 'theme', modelParagraph );
  546. } );
  547. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p><div class="nice"></div></div>' );
  548. } );
  549. it( 'should be possible to override setAttribute', () => {
  550. downcastHelpers.attributeToAttribute( {
  551. model: 'class',
  552. view: ( evt, data, conversionApi ) => {
  553. conversionApi.consumable.consume( data.item, 'attribute:class' );
  554. },
  555. converterPriority: 'high'
  556. } );
  557. model.change( writer => {
  558. const modelElement = new ModelElement( 'paragraph', { classes: 'foo' }, new ModelText( 'foobar' ) );
  559. writer.insert( modelElement, modelRootStart );
  560. } );
  561. // No attribute set.
  562. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  563. } );
  564. it( 'should not convert or consume if element creator returned null', () => {
  565. const callback = sinon.stub().returns( null );
  566. downcastHelpers.attributeToAttribute( {
  567. model: 'class',
  568. view: callback,
  569. converterPriority: 'high'
  570. } );
  571. const modelElement = new ModelElement( 'paragraph', { class: 'foo' }, new ModelText( 'foobar' ) );
  572. model.change( writer => {
  573. writer.insert( modelElement, modelRootStart );
  574. } );
  575. expect( viewToString( viewRoot ) ).to.equal( '<div><p class="foo">foobar</p></div>' );
  576. sinon.assert.called( callback );
  577. } );
  578. } );
  579. describe( 'markerToElement()', () => {
  580. let modelText, modelElement, range;
  581. it( 'should be chainable', () => {
  582. expect( downcastHelpers.markerToElement( { model: 'search', view: 'marker-search' } ) ).to.equal( downcastHelpers );
  583. } );
  584. it( 'config.view is a string', () => {
  585. downcastHelpers.markerToElement( { model: 'search', view: 'marker-search' } );
  586. model.change( writer => {
  587. writer.insertText( 'foo', modelRoot, 0 );
  588. const range = writer.createRange( writer.createPositionAt( modelRoot, 1 ), writer.createPositionAt( modelRoot, 2 ) );
  589. writer.addMarker( 'search', { range, usingOperation: false } );
  590. } );
  591. expectResult( 'f<marker-search></marker-search>o<marker-search></marker-search>o' );
  592. } );
  593. it( 'can be overwritten using converterPriority', () => {
  594. downcastHelpers.markerToElement( { model: 'search', view: 'marker-search' } );
  595. downcastHelpers.markerToElement( { model: 'search', view: 'search', converterPriority: 'high' } );
  596. model.change( writer => {
  597. writer.insertText( 'foo', modelRoot, 0 );
  598. const range = writer.createRange( writer.createPositionAt( modelRoot, 1 ), writer.createPositionAt( modelRoot, 2 ) );
  599. writer.addMarker( 'search', { range, usingOperation: false } );
  600. } );
  601. expectResult( 'f<search></search>o<search></search>o' );
  602. } );
  603. it( 'config.view is a view element definition', () => {
  604. downcastHelpers.markerToElement( {
  605. model: 'search',
  606. view: {
  607. name: 'span',
  608. attributes: {
  609. 'data-marker': 'search'
  610. }
  611. }
  612. } );
  613. model.change( writer => {
  614. writer.insertText( 'foo', modelRoot, 0 );
  615. const range = writer.createRange( writer.createPositionAt( modelRoot, 1 ), writer.createPositionAt( modelRoot, 2 ) );
  616. writer.addMarker( 'search', { range, usingOperation: false } );
  617. } );
  618. expectResult( 'f<span data-marker="search"></span>o<span data-marker="search"></span>o' );
  619. } );
  620. it( 'config.view is a function', () => {
  621. downcastHelpers.markerToElement( {
  622. model: 'search',
  623. view: ( data, viewWriter ) => {
  624. return viewWriter.createUIElement( 'span', { 'data-marker': 'search', 'data-start': data.isOpening } );
  625. }
  626. } );
  627. model.change( writer => {
  628. writer.insertText( 'foo', modelRoot, 0 );
  629. const range = writer.createRange( writer.createPositionAt( modelRoot, 1 ), writer.createPositionAt( modelRoot, 2 ) );
  630. writer.addMarker( 'search', { range, usingOperation: false } );
  631. } );
  632. expectResult( 'f<span data-marker="search" data-start="true"></span>o<span data-marker="search" data-start="false"></span>o' );
  633. } );
  634. describe( 'collapsed range', () => {
  635. beforeEach( () => {
  636. modelText = new ModelText( 'foobar' );
  637. modelElement = new ModelElement( 'paragraph', null, modelText );
  638. downcastHelpers.elementToElement( { model: 'paragraph', view: 'p' } );
  639. model.change( writer => {
  640. writer.insert( modelElement, modelRootStart );
  641. } );
  642. range = model.createRange( model.createPositionAt( modelElement, 3 ), model.createPositionAt( modelElement, 3 ) );
  643. } );
  644. it( 'should insert and remove ui element', () => {
  645. downcastHelpers.markerToElement( {
  646. model: 'marker',
  647. view: ( data, viewWriter ) => viewWriter.createUIElement( 'span', { 'class': 'marker' } )
  648. } );
  649. model.change( writer => {
  650. writer.addMarker( 'marker', { range, usingOperation: false } );
  651. } );
  652. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foo<span class="marker"></span>bar</p></div>' );
  653. model.change( writer => {
  654. writer.removeMarker( 'marker' );
  655. } );
  656. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  657. } );
  658. it( 'should not convert if consumable was consumed', () => {
  659. sinon.spy( controller.downcastDispatcher, 'fire' );
  660. downcastHelpers.markerToElement( {
  661. model: 'marker',
  662. view: ( data, viewWriter ) => viewWriter.createUIElement( 'span', { 'class': 'marker' } )
  663. } );
  664. controller.downcastDispatcher.on( 'addMarker:marker', ( evt, data, conversionApi ) => {
  665. conversionApi.consumable.consume( data.markerRange, 'addMarker:marker' );
  666. }, { priority: 'high' } );
  667. model.change( writer => {
  668. writer.addMarker( 'marker', { range, usingOperation: false } );
  669. } );
  670. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  671. expect( controller.downcastDispatcher.fire.calledWith( 'addMarker:marker' ) );
  672. } );
  673. it( 'should not convert if creator returned null', () => {
  674. downcastHelpers.markerToElement( {
  675. model: 'marker',
  676. view: () => null
  677. } );
  678. model.change( writer => {
  679. writer.addMarker( 'marker', { range, usingOperation: false } );
  680. } );
  681. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  682. model.change( writer => {
  683. writer.removeMarker( 'marker' );
  684. } );
  685. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  686. } );
  687. } );
  688. describe( 'non-collapsed range', () => {
  689. beforeEach( () => {
  690. modelText = new ModelText( 'foobar' );
  691. modelElement = new ModelElement( 'paragraph', null, modelText );
  692. downcastHelpers.elementToElement( { model: 'paragraph', view: 'p' } );
  693. model.change( writer => {
  694. writer.insert( modelElement, modelRootStart );
  695. } );
  696. range = model.createRange( model.createPositionAt( modelElement, 2 ), model.createPositionAt( modelElement, 5 ) );
  697. } );
  698. it( 'should insert and remove ui element - element as a creator', () => {
  699. downcastHelpers.markerToElement( {
  700. model: 'marker',
  701. view: ( data, viewWriter ) => viewWriter.createUIElement( 'span', { 'class': 'marker' } )
  702. } );
  703. model.change( writer => {
  704. writer.addMarker( 'marker', { range, usingOperation: false } );
  705. } );
  706. expect( viewToString( viewRoot ) )
  707. .to.equal( '<div><p>fo<span class="marker"></span>oba<span class="marker"></span>r</p></div>' );
  708. model.change( writer => {
  709. writer.removeMarker( 'marker' );
  710. } );
  711. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  712. } );
  713. it( 'should insert and remove ui element - function as a creator', () => {
  714. downcastHelpers.markerToElement( {
  715. model: 'marker',
  716. view: ( data, viewWriter ) => viewWriter.createUIElement( 'span', { 'class': data.markerName } )
  717. } );
  718. model.change( writer => {
  719. writer.addMarker( 'marker', { range, usingOperation: false } );
  720. } );
  721. expect( viewToString( viewRoot ) )
  722. .to.equal( '<div><p>fo<span class="marker"></span>oba<span class="marker"></span>r</p></div>' );
  723. model.change( writer => {
  724. writer.removeMarker( 'marker' );
  725. } );
  726. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  727. } );
  728. it( 'should insert and remove different opening and ending element', () => {
  729. downcastHelpers.markerToElement( {
  730. model: 'marker',
  731. view: ( data, viewWriter ) => {
  732. if ( data.isOpening ) {
  733. return viewWriter.createUIElement( 'span', { 'class': data.markerName, 'data-start': true } );
  734. }
  735. return viewWriter.createUIElement( 'span', { 'class': data.markerName, 'data-end': true } );
  736. }
  737. } );
  738. model.change( writer => {
  739. writer.addMarker( 'marker', { range, usingOperation: false } );
  740. } );
  741. expect( viewToString( viewRoot ) ).to.equal(
  742. '<div><p>fo<span class="marker" data-start="true"></span>oba<span class="marker" data-end="true"></span>r</p></div>'
  743. );
  744. model.change( writer => {
  745. writer.removeMarker( 'marker' );
  746. } );
  747. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  748. } );
  749. it( 'should not convert if consumable was consumed', () => {
  750. sinon.spy( controller.downcastDispatcher, 'fire' );
  751. downcastHelpers.markerToElement( {
  752. model: 'marker',
  753. view: ( data, viewWriter ) => viewWriter.createUIElement( 'span', { 'class': 'marker' } )
  754. } );
  755. controller.downcastDispatcher.on( 'addMarker:marker', ( evt, data, conversionApi ) => {
  756. conversionApi.consumable.consume( data.item, 'addMarker:marker' );
  757. }, { priority: 'high' } );
  758. model.change( writer => {
  759. writer.addMarker( 'marker', { range, usingOperation: false } );
  760. } );
  761. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  762. expect( controller.downcastDispatcher.fire.calledWith( 'addMarker:marker' ) );
  763. } );
  764. } );
  765. } );
  766. describe( 'markerToHighlight()', () => {
  767. it( 'should be chainable', () => {
  768. expect( downcastHelpers.markerToHighlight( { model: 'comment', view: { classes: 'comment' } } ) ).to.equal( downcastHelpers );
  769. } );
  770. it( 'config.view is a highlight descriptor', () => {
  771. downcastHelpers.markerToHighlight( { model: 'comment', view: { classes: 'comment' } } );
  772. model.change( writer => {
  773. writer.insertText( 'foo', modelRoot, 0 );
  774. const range = writer.createRange( writer.createPositionAt( modelRoot, 0 ), writer.createPositionAt( modelRoot, 3 ) );
  775. writer.addMarker( 'comment', { range, usingOperation: false } );
  776. } );
  777. expectResult( '<span class="comment">foo</span>' );
  778. } );
  779. it( 'can be overwritten using converterPriority', () => {
  780. downcastHelpers.markerToHighlight( { model: 'comment', view: { classes: 'comment' } } );
  781. downcastHelpers.markerToHighlight( { model: 'comment', view: { classes: 'new-comment' }, converterPriority: 'high' } );
  782. model.change( writer => {
  783. writer.insertText( 'foo', modelRoot, 0 );
  784. const range = writer.createRange( writer.createPositionAt( modelRoot, 0 ), writer.createPositionAt( modelRoot, 3 ) );
  785. writer.addMarker( 'comment', { range, usingOperation: false } );
  786. } );
  787. expectResult( '<span class="new-comment">foo</span>' );
  788. } );
  789. it( 'config.view is a function', () => {
  790. downcastHelpers.markerToHighlight( {
  791. model: 'comment',
  792. view: data => {
  793. const commentType = data.markerName.split( ':' )[ 1 ];
  794. return {
  795. classes: [ 'comment', 'comment-' + commentType ]
  796. };
  797. }
  798. } );
  799. model.change( writer => {
  800. writer.insertText( 'foo', modelRoot, 0 );
  801. const range = writer.createRange( writer.createPositionAt( modelRoot, 0 ), writer.createPositionAt( modelRoot, 3 ) );
  802. writer.addMarker( 'comment:abc', { range, usingOperation: false } );
  803. } );
  804. expectResult( '<span class="comment comment-abc">foo</span>' );
  805. } );
  806. describe( 'highlight', () => {
  807. const highlightConfig = {
  808. model: 'marker',
  809. view: {
  810. classes: 'highlight-class',
  811. attributes: { title: 'title' }
  812. },
  813. converterPriority: 7
  814. };
  815. describe( 'on text', () => {
  816. let markerRange;
  817. beforeEach( () => {
  818. downcastHelpers.elementToElement( { model: 'paragraph', view: 'p' } );
  819. const modelElement1 = new ModelElement( 'paragraph', null, new ModelText( 'foo' ) );
  820. const modelElement2 = new ModelElement( 'paragraph', null, new ModelText( 'bar' ) );
  821. model.change( writer => {
  822. writer.insert( [ modelElement1, modelElement2 ], modelRootStart );
  823. } );
  824. markerRange = model.createRangeIn( modelRoot );
  825. } );
  826. it( 'should wrap and unwrap text nodes', () => {
  827. downcastHelpers.markerToHighlight( highlightConfig );
  828. model.change( writer => {
  829. writer.addMarker( 'marker', { range: markerRange, usingOperation: false } );
  830. } );
  831. expect( viewToString( viewRoot ) ).to.equal(
  832. '<div>' +
  833. '<p>' +
  834. '<span class="highlight-class" title="title">foo</span>' +
  835. '</p>' +
  836. '<p>' +
  837. '<span class="highlight-class" title="title">bar</span>' +
  838. '</p>' +
  839. '</div>'
  840. );
  841. model.change( writer => {
  842. writer.removeMarker( 'marker' );
  843. } );
  844. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foo</p><p>bar</p></div>' );
  845. } );
  846. it( 'should be possible to overwrite', () => {
  847. downcastHelpers.markerToHighlight( highlightConfig );
  848. downcastHelpers.markerToHighlight( {
  849. model: 'marker',
  850. view: { classes: 'override-class' },
  851. converterPriority: 'high'
  852. } );
  853. model.change( writer => {
  854. writer.addMarker( 'marker', { range: markerRange, usingOperation: false } );
  855. } );
  856. expect( viewToString( viewRoot ) ).to.equal(
  857. '<div>' +
  858. '<p>' +
  859. '<span class="override-class">foo</span>' +
  860. '</p>' +
  861. '<p>' +
  862. '<span class="override-class">bar</span>' +
  863. '</p>' +
  864. '</div>'
  865. );
  866. model.change( writer => {
  867. writer.removeMarker( 'marker' );
  868. } );
  869. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foo</p><p>bar</p></div>' );
  870. } );
  871. it( 'should do nothing if descriptor is not provided or generating function returns null', () => {
  872. downcastHelpers.markerToHighlight( {
  873. model: 'marker',
  874. view: () => null,
  875. converterPriority: 'high'
  876. } );
  877. model.change( writer => {
  878. writer.addMarker( 'marker', { range: markerRange, usingOperation: false } );
  879. } );
  880. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foo</p><p>bar</p></div>' );
  881. model.change( writer => {
  882. writer.removeMarker( 'marker' );
  883. } );
  884. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foo</p><p>bar</p></div>' );
  885. } );
  886. it( 'should do nothing if collapsed marker is converted', () => {
  887. downcastHelpers.markerToHighlight( {
  888. model: 'marker',
  889. view: { classes: 'foo' },
  890. converterPriority: 'high'
  891. } );
  892. markerRange = model.createRange( model.createPositionAt( modelRoot, 0 ), model.createPositionAt( modelRoot, 0 ) );
  893. model.change( writer => {
  894. writer.addMarker( 'marker', { range: markerRange, usingOperation: false } );
  895. } );
  896. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foo</p><p>bar</p></div>' );
  897. model.change( () => {
  898. model.markers._remove( 'marker' );
  899. } );
  900. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foo</p><p>bar</p></div>' );
  901. } );
  902. it( 'should correctly wrap and unwrap multiple, intersecting markers', () => {
  903. downcastHelpers.markerToHighlight( {
  904. model: 'markerFoo',
  905. view: { classes: 'foo' }
  906. } );
  907. downcastHelpers.markerToHighlight( {
  908. model: 'markerBar',
  909. view: { classes: 'bar' }
  910. } );
  911. downcastHelpers.markerToHighlight( {
  912. model: 'markerXyz',
  913. view: { classes: 'xyz' }
  914. } );
  915. const p1 = modelRoot.getChild( 0 );
  916. const p2 = modelRoot.getChild( 1 );
  917. model.change( writer => {
  918. const range = writer.createRange( writer.createPositionAt( p1, 0 ), writer.createPositionAt( p1, 3 ) );
  919. writer.addMarker( 'markerFoo', { range, usingOperation: false } );
  920. } );
  921. expect( viewToString( viewRoot ) ).to.equal(
  922. '<div>' +
  923. '<p>' +
  924. '<span class="foo">foo</span>' +
  925. '</p>' +
  926. '<p>bar</p>' +
  927. '</div>'
  928. );
  929. model.change( writer => {
  930. const range = writer.createRange( writer.createPositionAt( p1, 1 ), writer.createPositionAt( p2, 2 ) );
  931. writer.addMarker( 'markerBar', { range, usingOperation: false } );
  932. } );
  933. expect( viewToString( viewRoot ) ).to.equal(
  934. '<div>' +
  935. '<p>' +
  936. '<span class="foo">f</span>' +
  937. '<span class="bar">' +
  938. '<span class="foo">oo</span>' +
  939. '</span>' +
  940. '</p>' +
  941. '<p>' +
  942. '<span class="bar">ba</span>' +
  943. 'r' +
  944. '</p>' +
  945. '</div>'
  946. );
  947. model.change( writer => {
  948. const range = writer.createRange( writer.createPositionAt( p1, 2 ), writer.createPositionAt( p2, 3 ) );
  949. writer.addMarker( 'markerXyz', { range, usingOperation: false } );
  950. } );
  951. expect( viewToString( viewRoot ) ).to.equal(
  952. '<div>' +
  953. '<p>' +
  954. '<span class="foo">f</span>' +
  955. '<span class="bar">' +
  956. '<span class="foo">' +
  957. 'o' +
  958. '<span class="xyz">o</span>' +
  959. '</span>' +
  960. '</span>' +
  961. '</p>' +
  962. '<p>' +
  963. '<span class="bar">' +
  964. '<span class="xyz">ba</span>' +
  965. '</span>' +
  966. '<span class="xyz">r</span>' +
  967. '</p>' +
  968. '</div>'
  969. );
  970. model.change( writer => {
  971. writer.removeMarker( 'markerBar' );
  972. } );
  973. expect( viewToString( viewRoot ) ).to.equal(
  974. '<div>' +
  975. '<p>' +
  976. '<span class="foo">' +
  977. 'fo' +
  978. '<span class="xyz">o</span>' +
  979. '</span>' +
  980. '</p>' +
  981. '<p>' +
  982. '<span class="xyz">bar</span>' +
  983. '</p>' +
  984. '</div>'
  985. );
  986. model.change( writer => {
  987. writer.removeMarker( 'markerFoo' );
  988. } );
  989. expect( viewToString( viewRoot ) ).to.equal(
  990. '<div>' +
  991. '<p>' +
  992. 'fo' +
  993. '<span class="xyz">o</span>' +
  994. '</p>' +
  995. '<p>' +
  996. '<span class="xyz">bar</span>' +
  997. '</p>' +
  998. '</div>'
  999. );
  1000. model.change( writer => {
  1001. writer.removeMarker( 'markerXyz' );
  1002. } );
  1003. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foo</p><p>bar</p></div>' );
  1004. } );
  1005. it( 'should do nothing if marker is applied and removed on empty-ish range', () => {
  1006. downcastHelpers.markerToHighlight( highlightConfig );
  1007. const p1 = modelRoot.getChild( 0 );
  1008. const p2 = modelRoot.getChild( 1 );
  1009. const markerRange = model.createRange( model.createPositionAt( p1, 3 ), model.createPositionAt( p2, 0 ) );
  1010. model.change( writer => {
  1011. writer.addMarker( 'marker', { range: markerRange, usingOperation: false } );
  1012. } );
  1013. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foo</p><p>bar</p></div>' );
  1014. model.change( writer => {
  1015. writer.removeMarker( 'marker', { range: markerRange, usingOperation: false } );
  1016. } );
  1017. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foo</p><p>bar</p></div>' );
  1018. } );
  1019. } );
  1020. describe( 'on element', () => {
  1021. const highlightConfig = {
  1022. model: 'marker',
  1023. view: {
  1024. classes: 'highlight-class',
  1025. attributes: { title: 'title' },
  1026. id: 'customId'
  1027. },
  1028. converterPriority: 7
  1029. };
  1030. let markerRange, viewDocument;
  1031. beforeEach( () => {
  1032. viewDocument = new ViewDocument( new StylesProcessor() );
  1033. downcastHelpers.elementToElement( {
  1034. model: 'div',
  1035. view: () => {
  1036. const viewContainer = new ViewContainerElement( viewDocument, 'div' );
  1037. viewContainer._setCustomProperty( 'addHighlight', ( element, descriptor, writer ) => {
  1038. writer.addClass( descriptor.classes, element );
  1039. } );
  1040. viewContainer._setCustomProperty( 'removeHighlight', ( element, id, writer ) => {
  1041. writer.setAttribute( 'class', '', element );
  1042. } );
  1043. return viewContainer;
  1044. }
  1045. } );
  1046. const modelElement = new ModelElement( 'div', null, new ModelText( 'foo' ) );
  1047. model.change( writer => {
  1048. writer.insert( modelElement, modelRootStart );
  1049. } );
  1050. markerRange = model.createRangeOn( modelElement );
  1051. downcastHelpers.markerToHighlight( highlightConfig );
  1052. } );
  1053. it( 'should use addHighlight and removeHighlight on elements and not convert children nodes', () => {
  1054. model.change( writer => {
  1055. writer.addMarker( 'marker', { range: markerRange, usingOperation: false } );
  1056. } );
  1057. expect( viewToString( viewRoot ) ).to.equal(
  1058. '<div>' +
  1059. '<div class="highlight-class">' +
  1060. 'foo' +
  1061. '</div>' +
  1062. '</div>'
  1063. );
  1064. model.change( writer => {
  1065. writer.removeMarker( 'marker' );
  1066. } );
  1067. expect( viewToString( viewRoot ) ).to.equal( '<div><div>foo</div></div>' );
  1068. } );
  1069. it( 'should be possible to override', () => {
  1070. downcastHelpers.markerToHighlight( {
  1071. model: 'marker',
  1072. view: { classes: 'override-class' },
  1073. converterPriority: 'high'
  1074. } );
  1075. model.change( writer => {
  1076. writer.addMarker( 'marker', { range: markerRange, usingOperation: false } );
  1077. } );
  1078. expect( viewToString( viewRoot ) ).to.equal(
  1079. '<div>' +
  1080. '<div class="override-class">' +
  1081. 'foo' +
  1082. '</div>' +
  1083. '</div>'
  1084. );
  1085. model.change( writer => {
  1086. writer.removeMarker( 'marker' );
  1087. } );
  1088. expect( viewToString( viewRoot ) ).to.equal( '<div><div>foo</div></div>' );
  1089. } );
  1090. it( 'should use default priority and id if not provided', () => {
  1091. const viewDiv = viewRoot.getChild( 0 );
  1092. downcastHelpers.markerToHighlight( {
  1093. model: 'marker2',
  1094. view: () => null,
  1095. converterPriority: 'high'
  1096. } );
  1097. viewDiv._setCustomProperty( 'addHighlight', ( element, descriptor ) => {
  1098. expect( descriptor.priority ).to.equal( ViewAttributeElement.DEFAULT_PRIORITY );
  1099. expect( descriptor.id ).to.equal( 'marker:foo-bar-baz' );
  1100. } );
  1101. viewDiv._setCustomProperty( 'removeHighlight', ( element, id ) => {
  1102. expect( id ).to.equal( 'marker:foo-bar-baz' );
  1103. } );
  1104. model.change( writer => {
  1105. writer.addMarker( 'marker2', { range: markerRange, usingOperation: false } );
  1106. } );
  1107. } );
  1108. it( 'should do nothing if descriptor is not provided', () => {
  1109. downcastHelpers.markerToHighlight( {
  1110. model: 'marker2',
  1111. view: () => null
  1112. } );
  1113. model.change( writer => {
  1114. writer.addMarker( 'marker2', { range: markerRange, usingOperation: false } );
  1115. } );
  1116. expect( viewToString( viewRoot ) ).to.equal( '<div><div>foo</div></div>' );
  1117. model.change( writer => {
  1118. writer.removeMarker( 'marker2' );
  1119. } );
  1120. expect( viewToString( viewRoot ) ).to.equal( '<div><div>foo</div></div>' );
  1121. } );
  1122. } );
  1123. } );
  1124. } );
  1125. function expectResult( string ) {
  1126. expect( stringifyView( viewRoot, null, { ignoreRoot: true } ) ).to.equal( string );
  1127. }
  1128. } );
  1129. describe( 'downcast converters', () => {
  1130. let dispatcher, modelDoc, modelRoot, viewRoot, controller, modelRootStart, model;
  1131. beforeEach( () => {
  1132. model = new Model();
  1133. modelDoc = model.document;
  1134. modelRoot = modelDoc.createRoot();
  1135. controller = new EditingController( model, new StylesProcessor() );
  1136. viewRoot = controller.view.document.getRoot();
  1137. // Set name of view root the same as dom root.
  1138. // This is a mock of attaching view root to dom root.
  1139. controller.view.document.getRoot()._name = 'div';
  1140. dispatcher = controller.downcastDispatcher;
  1141. const downcastHelpers = new DowncastHelpers( [ dispatcher ] );
  1142. downcastHelpers.elementToElement( { model: 'paragraph', view: 'p' } );
  1143. modelRootStart = model.createPositionAt( modelRoot, 0 );
  1144. } );
  1145. describe( 'insertText()', () => {
  1146. it( 'should downcast text', () => {
  1147. model.change( writer => {
  1148. writer.insert( new ModelText( 'foobar' ), modelRootStart );
  1149. } );
  1150. expect( viewToString( viewRoot ) ).to.equal( '<div>foobar</div>' );
  1151. } );
  1152. it( 'should support unicode', () => {
  1153. model.change( writer => {
  1154. writer.insert( new ModelText( 'நிலைக்கு' ), modelRootStart );
  1155. } );
  1156. expect( viewToString( viewRoot ) ).to.equal( '<div>நிலைக்கு</div>' );
  1157. } );
  1158. it( 'should be possible to override it', () => {
  1159. dispatcher.on( 'insert:$text', ( evt, data, conversionApi ) => {
  1160. conversionApi.consumable.consume( data.item, 'insert' );
  1161. }, { converterPriority: 'high' } );
  1162. model.change( writer => {
  1163. writer.insert( new ModelText( 'foobar' ), modelRootStart );
  1164. } );
  1165. expect( viewToString( viewRoot ) ).to.equal( '<div></div>' );
  1166. } );
  1167. } );
  1168. // Remove converter is by default already added in `EditingController` instance.
  1169. describe( 'remove()', () => {
  1170. let viewDocument;
  1171. beforeEach( () => {
  1172. viewDocument = new ViewDocument( new StylesProcessor() );
  1173. } );
  1174. it( 'should remove items from view accordingly to changes in model #1', () => {
  1175. const modelElement = new ModelElement( 'paragraph', null, new ModelText( 'foobar' ) );
  1176. model.change( writer => {
  1177. writer.insert( modelElement, modelRootStart );
  1178. } );
  1179. model.change( writer => {
  1180. writer.remove(
  1181. writer.createRange( writer.createPositionAt( modelElement, 2 ), writer.createPositionAt( modelElement, 4 ) )
  1182. );
  1183. } );
  1184. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foar</p></div>' );
  1185. } );
  1186. it( 'should be possible to overwrite', () => {
  1187. dispatcher.on( 'remove', evt => evt.stop(), { priority: 'high' } );
  1188. const modelElement = new ModelElement( 'paragraph', null, new ModelText( 'foobar' ) );
  1189. model.change( writer => {
  1190. writer.insert( modelElement, modelRootStart );
  1191. } );
  1192. model.change( writer => {
  1193. writer.remove(
  1194. writer.createRange( writer.createPositionAt( modelElement, 2 ), writer.createPositionAt( modelElement, 4 ) )
  1195. );
  1196. } );
  1197. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  1198. } );
  1199. it( 'should support unicode', () => {
  1200. const modelElement = new ModelElement( 'paragraph', null, 'நிலைக்கு' );
  1201. model.change( writer => {
  1202. writer.insert( modelElement, modelRootStart );
  1203. } );
  1204. model.change( writer => {
  1205. writer.remove(
  1206. writer.createRange( writer.createPositionAt( modelElement, 0 ), writer.createPositionAt( modelElement, 6 ) )
  1207. );
  1208. } );
  1209. expect( viewToString( viewRoot ) ).to.equal( '<div><p>கு</p></div>' );
  1210. } );
  1211. it( 'should not remove view ui elements that are placed next to removed content', () => {
  1212. modelRoot._appendChild( new ModelText( 'fozbar' ) );
  1213. viewRoot._appendChild( [
  1214. new ViewText( viewDocument, 'foz' ),
  1215. new ViewUIElement( viewDocument, 'span' ),
  1216. new ViewText( viewDocument, 'bar' )
  1217. ] );
  1218. // Remove 'b'.
  1219. model.change( writer => {
  1220. writer.remove(
  1221. writer.createRange( writer.createPositionAt( modelRoot, 3 ), writer.createPositionAt( modelRoot, 4 ) )
  1222. );
  1223. } );
  1224. expect( viewToString( viewRoot ) ).to.equal( '<div>foz<span></span>ar</div>' );
  1225. // Remove 'z'.
  1226. model.change( writer => {
  1227. writer.remove(
  1228. writer.createRange( writer.createPositionAt( modelRoot, 2 ), writer.createPositionAt( modelRoot, 3 ) )
  1229. );
  1230. } );
  1231. expect( viewToString( viewRoot ) ).to.equal( '<div>fo<span></span>ar</div>' );
  1232. } );
  1233. it( 'should remove correct amount of text when it is split by view ui element', () => {
  1234. modelRoot._appendChild( new ModelText( 'fozbar' ) );
  1235. viewRoot._appendChild( [
  1236. new ViewText( viewDocument, 'foz' ),
  1237. new ViewUIElement( viewDocument, 'span' ),
  1238. new ViewText( viewDocument, 'bar' )
  1239. ] );
  1240. // Remove 'z<span></span>b'.
  1241. model.change( writer => {
  1242. writer.remove(
  1243. writer.createRange( writer.createPositionAt( modelRoot, 2 ), writer.createPositionAt( modelRoot, 4 ) )
  1244. );
  1245. } );
  1246. expect( viewToString( viewRoot ) ).to.equal( '<div>foar</div>' );
  1247. } );
  1248. it( 'should unbind elements', () => {
  1249. const modelElement = new ModelElement( 'paragraph' );
  1250. model.change( writer => {
  1251. writer.insert( modelElement, modelRootStart );
  1252. } );
  1253. const viewElement = controller.mapper.toViewElement( modelElement );
  1254. expect( viewElement ).not.to.be.undefined;
  1255. expect( controller.mapper.toModelElement( viewElement ) ).to.equal( modelElement );
  1256. model.change( writer => {
  1257. writer.remove( modelElement );
  1258. } );
  1259. expect( controller.mapper.toViewElement( modelElement ) ).to.be.undefined;
  1260. expect( controller.mapper.toModelElement( viewElement ) ).to.be.undefined;
  1261. } );
  1262. it( 'should not break when remove() is used as part of unwrapping', () => {
  1263. const modelP = new ModelElement( 'paragraph', null, new ModelText( 'foo' ) );
  1264. const modelWidget = new ModelElement( 'widget', null, modelP );
  1265. const downcastHelpers = new DowncastHelpers( [ dispatcher ] );
  1266. downcastHelpers.elementToElement( { model: 'widget', view: 'widget' } );
  1267. model.change( writer => {
  1268. writer.insert( modelWidget, modelRootStart );
  1269. } );
  1270. expect( viewToString( viewRoot ) ).to.equal( '<div><widget><p>foo</p></widget></div>' );
  1271. const viewP = controller.mapper.toViewElement( modelP );
  1272. expect( viewP ).not.to.be.undefined;
  1273. model.change( writer => {
  1274. writer.unwrap( modelWidget );
  1275. } );
  1276. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foo</p></div>' );
  1277. // `modelP` is now bound with newly created view element.
  1278. expect( controller.mapper.toViewElement( modelP ) ).not.to.equal( viewP );
  1279. // `viewP` is no longer bound with model element.
  1280. expect( controller.mapper.toModelElement( viewP ) ).to.be.undefined;
  1281. // View element from view root is bound to `modelP`.
  1282. expect( controller.mapper.toModelElement( viewRoot.getChild( 0 ) ) ).to.equal( modelP );
  1283. } );
  1284. it( 'should work correctly if container element after ui element is removed', () => {
  1285. // Prepare a model and view structure.
  1286. // This is done outside of conversion to put view ui elements inside easily.
  1287. const modelP1 = new ModelElement( 'paragraph' );
  1288. const modelP2 = new ModelElement( 'paragraph' );
  1289. const viewP1 = new ViewContainerElement( viewDocument, 'p' );
  1290. const viewUi1 = new ViewUIElement( viewDocument, 'span' );
  1291. const viewUi2 = new ViewUIElement( viewDocument, 'span' );
  1292. const viewP2 = new ViewContainerElement( viewDocument, 'p' );
  1293. modelRoot._appendChild( [ modelP1, modelP2 ] );
  1294. viewRoot._appendChild( [ viewP1, viewUi1, viewUi2, viewP2 ] );
  1295. controller.mapper.bindElements( modelP1, viewP1 );
  1296. controller.mapper.bindElements( modelP2, viewP2 );
  1297. // Remove second paragraph element.
  1298. model.change( writer => {
  1299. writer.remove( writer.createRange( writer.createPositionAt( modelRoot, 1 ), writer.createPositionAt( modelRoot, 2 ) ) );
  1300. } );
  1301. expect( viewToString( viewRoot ) ).to.equal( '<div><p></p><span></span><span></span></div>' );
  1302. } );
  1303. it( 'should work correctly if container element after text node is removed', () => {
  1304. const modelText = new ModelText( 'foo' );
  1305. const modelP = new ModelElement( 'paragraph' );
  1306. model.change( writer => {
  1307. writer.insert( [ modelText, modelP ], modelRootStart );
  1308. } );
  1309. model.change( writer => {
  1310. writer.remove( modelP );
  1311. } );
  1312. expect( viewToString( viewRoot ) ).to.equal( '<div>foo</div>' );
  1313. } );
  1314. } );
  1315. describe( 'createViewElementFromHighlightDescriptor()', () => {
  1316. let viewWriter;
  1317. beforeEach( () => {
  1318. viewWriter = new DowncastWriter( controller.view.document );
  1319. } );
  1320. it( 'should return attribute element from descriptor object', () => {
  1321. const descriptor = {
  1322. classes: 'foo-class',
  1323. attributes: { one: '1', two: '2' },
  1324. priority: 7
  1325. };
  1326. const element = createViewElementFromHighlightDescriptor( viewWriter, descriptor );
  1327. expect( element.is( 'attributeElement' ) ).to.be.true;
  1328. expect( element.name ).to.equal( 'span' );
  1329. expect( element.priority ).to.equal( 7 );
  1330. expect( element.hasClass( 'foo-class' ) ).to.be.true;
  1331. for ( const key of Object.keys( descriptor.attributes ) ) {
  1332. expect( element.getAttribute( key ) ).to.equal( descriptor.attributes[ key ] );
  1333. }
  1334. } );
  1335. it( 'should return attribute element from descriptor object - array with classes', () => {
  1336. const descriptor = {
  1337. classes: [ 'foo-class', 'bar-class' ],
  1338. attributes: { one: '1', two: '2' },
  1339. priority: 7
  1340. };
  1341. const element = createViewElementFromHighlightDescriptor( viewWriter, descriptor );
  1342. expect( element.is( 'attributeElement' ) ).to.be.true;
  1343. expect( element.name ).to.equal( 'span' );
  1344. expect( element.priority ).to.equal( 7 );
  1345. expect( element.hasClass( 'foo-class' ) ).to.be.true;
  1346. expect( element.hasClass( 'bar-class' ) ).to.be.true;
  1347. for ( const key of Object.keys( descriptor.attributes ) ) {
  1348. expect( element.getAttribute( key ) ).to.equal( descriptor.attributes[ key ] );
  1349. }
  1350. } );
  1351. it( 'should create element without class', () => {
  1352. const descriptor = {
  1353. attributes: { one: '1', two: '2' },
  1354. priority: 7
  1355. };
  1356. const element = createViewElementFromHighlightDescriptor( viewWriter, descriptor );
  1357. expect( element.is( 'attributeElement' ) ).to.be.true;
  1358. expect( element.name ).to.equal( 'span' );
  1359. expect( element.priority ).to.equal( 7 );
  1360. for ( const key of Object.keys( descriptor.attributes ) ) {
  1361. expect( element.getAttribute( key ) ).to.equal( descriptor.attributes[ key ] );
  1362. }
  1363. } );
  1364. it( 'should create element without priority', () => {
  1365. const descriptor = {
  1366. classes: 'foo-class',
  1367. attributes: { one: '1', two: '2' }
  1368. };
  1369. const element = createViewElementFromHighlightDescriptor( viewWriter, descriptor );
  1370. expect( element.is( 'attributeElement' ) ).to.be.true;
  1371. expect( element.name ).to.equal( 'span' );
  1372. expect( element.priority ).to.equal( ViewAttributeElement.DEFAULT_PRIORITY );
  1373. expect( element.hasClass( 'foo-class' ) ).to.be.true;
  1374. for ( const key of Object.keys( descriptor.attributes ) ) {
  1375. expect( element.getAttribute( key ) ).to.equal( descriptor.attributes[ key ] );
  1376. }
  1377. } );
  1378. it( 'should create element without attributes', () => {
  1379. const descriptor = {
  1380. classes: 'foo-class',
  1381. priority: 7
  1382. };
  1383. const element = createViewElementFromHighlightDescriptor( viewWriter, descriptor );
  1384. expect( element.is( 'attributeElement' ) ).to.be.true;
  1385. expect( element.name ).to.equal( 'span' );
  1386. expect( element.priority ).to.equal( 7 );
  1387. expect( element.hasClass( 'foo-class' ) ).to.be.true;
  1388. } );
  1389. } );
  1390. } );
  1391. describe( 'downcast selection converters', () => {
  1392. let dispatcher, mapper, model, view, modelDoc, modelRoot, docSelection, viewDoc, viewRoot, viewSelection, downcastHelpers;
  1393. beforeEach( () => {
  1394. model = new Model();
  1395. modelDoc = model.document;
  1396. modelRoot = modelDoc.createRoot();
  1397. docSelection = modelDoc.selection;
  1398. model.schema.extend( '$text', { allowIn: '$root' } );
  1399. view = new View( new StylesProcessor() );
  1400. viewDoc = view.document;
  1401. viewRoot = createViewRoot( viewDoc );
  1402. viewSelection = viewDoc.selection;
  1403. mapper = new Mapper();
  1404. mapper.bindElements( modelRoot, viewRoot );
  1405. dispatcher = new DowncastDispatcher( { mapper, viewSelection } );
  1406. dispatcher.on( 'insert:$text', insertText() );
  1407. downcastHelpers = new DowncastHelpers( [ dispatcher ] );
  1408. downcastHelpers.attributeToElement( { model: 'bold', view: 'strong' } );
  1409. downcastHelpers.markerToHighlight( { model: 'marker', view: { classes: 'marker' }, converterPriority: 1 } );
  1410. // Default selection converters.
  1411. dispatcher.on( 'selection', clearAttributes(), { priority: 'low' } );
  1412. dispatcher.on( 'selection', convertRangeSelection(), { priority: 'low' } );
  1413. dispatcher.on( 'selection', convertCollapsedSelection(), { priority: 'low' } );
  1414. } );
  1415. afterEach( () => {
  1416. view.destroy();
  1417. } );
  1418. describe( 'default converters', () => {
  1419. describe( 'range selection', () => {
  1420. it( 'in same container', () => {
  1421. testSelection(
  1422. [ 1, 4 ],
  1423. 'foobar',
  1424. 'f{oob}ar'
  1425. );
  1426. } );
  1427. it( 'in same container with unicode characters', () => {
  1428. testSelection(
  1429. [ 2, 6 ],
  1430. 'நிலைக்கு',
  1431. 'நி{லைக்}கு'
  1432. );
  1433. } );
  1434. it( 'in same container, over attribute', () => {
  1435. testSelection(
  1436. [ 1, 5 ],
  1437. 'fo<$text bold="true">ob</$text>ar',
  1438. 'f{o<strong>ob</strong>a}r'
  1439. );
  1440. } );
  1441. it( 'in same container, next to attribute', () => {
  1442. testSelection(
  1443. [ 1, 2 ],
  1444. 'fo<$text bold="true">ob</$text>ar',
  1445. 'f{o}<strong>ob</strong>ar'
  1446. );
  1447. } );
  1448. it( 'in same attribute', () => {
  1449. testSelection(
  1450. [ 2, 4 ],
  1451. 'f<$text bold="true">ooba</$text>r',
  1452. 'f<strong>o{ob}a</strong>r'
  1453. );
  1454. } );
  1455. it( 'in same attribute, selection same as attribute', () => {
  1456. testSelection(
  1457. [ 2, 4 ],
  1458. 'fo<$text bold="true">ob</$text>ar',
  1459. 'fo{<strong>ob</strong>}ar'
  1460. );
  1461. } );
  1462. it( 'starts in text node, ends in attribute #1', () => {
  1463. testSelection(
  1464. [ 1, 3 ],
  1465. 'fo<$text bold="true">ob</$text>ar',
  1466. 'f{o<strong>o}b</strong>ar'
  1467. );
  1468. } );
  1469. it( 'starts in text node, ends in attribute #2', () => {
  1470. testSelection(
  1471. [ 1, 4 ],
  1472. 'fo<$text bold="true">ob</$text>ar',
  1473. 'f{o<strong>ob</strong>}ar'
  1474. );
  1475. } );
  1476. it( 'starts in attribute, ends in text node', () => {
  1477. testSelection(
  1478. [ 3, 5 ],
  1479. 'fo<$text bold="true">ob</$text>ar',
  1480. 'fo<strong>o{b</strong>a}r'
  1481. );
  1482. } );
  1483. it( 'consumes consumable values properly', () => {
  1484. // Add callback that will fire before default ones.
  1485. // This should prevent default callback doing anything.
  1486. dispatcher.on( 'selection', ( evt, data, conversionApi ) => {
  1487. expect( conversionApi.consumable.consume( data.selection, 'selection' ) ).to.be.true;
  1488. }, { priority: 'high' } );
  1489. // Similar test case as the first in this suite.
  1490. testSelection(
  1491. [ 1, 4 ],
  1492. 'foobar',
  1493. 'foobar' // No selection in view.
  1494. );
  1495. } );
  1496. it( 'should convert backward selection', () => {
  1497. testSelection(
  1498. [ 1, 3, 'backward' ],
  1499. 'foobar',
  1500. 'f{oo}bar'
  1501. );
  1502. expect( viewSelection.focus.offset ).to.equal( 1 );
  1503. } );
  1504. } );
  1505. describe( 'collapsed selection', () => {
  1506. let marker, viewDocument;
  1507. beforeEach( () => {
  1508. viewDocument = new ViewDocument( new StylesProcessor() );
  1509. } );
  1510. it( 'in container', () => {
  1511. testSelection(
  1512. [ 1, 1 ],
  1513. 'foobar',
  1514. 'f{}oobar'
  1515. );
  1516. } );
  1517. it( 'in attribute', () => {
  1518. testSelection(
  1519. [ 3, 3 ],
  1520. 'f<$text bold="true">ooba</$text>r',
  1521. 'f<strong>oo{}ba</strong>r'
  1522. );
  1523. } );
  1524. it( 'in attribute and marker', () => {
  1525. setModelData( model, 'fo<$text bold="true">ob</$text>ar' );
  1526. model.change( writer => {
  1527. const range = writer.createRange( writer.createPositionAt( modelRoot, 1 ), writer.createPositionAt( modelRoot, 5 ) );
  1528. marker = writer.addMarker( 'marker', { range, usingOperation: false } );
  1529. writer.setSelection( modelRoot, 3 );
  1530. } );
  1531. // Remove view children manually (without firing additional conversion).
  1532. viewRoot._removeChildren( 0, viewRoot.childCount );
  1533. // Convert model to view.
  1534. view.change( writer => {
  1535. dispatcher.convertInsert( model.createRangeIn( modelRoot ), writer );
  1536. dispatcher.convertMarkerAdd( marker.name, marker.getRange(), writer );
  1537. dispatcher.convertSelection( docSelection, model.markers, writer );
  1538. } );
  1539. // Stringify view and check if it is same as expected.
  1540. expect( stringifyView( viewRoot, viewSelection, { showType: false } ) ).to.equal(
  1541. '<div>f<span class="marker">o<strong>o{}b</strong>a</span>r</div>'
  1542. );
  1543. } );
  1544. it( 'in attribute and marker - no attribute', () => {
  1545. setModelData( model, 'fo<$text bold="true">ob</$text>ar' );
  1546. model.change( writer => {
  1547. const range = writer.createRange( writer.createPositionAt( modelRoot, 1 ), writer.createPositionAt( modelRoot, 5 ) );
  1548. marker = writer.addMarker( 'marker', { range, usingOperation: false } );
  1549. writer.setSelection( modelRoot, 3 );
  1550. writer.removeSelectionAttribute( 'bold' );
  1551. } );
  1552. // Remove view children manually (without firing additional conversion).
  1553. viewRoot._removeChildren( 0, viewRoot.childCount );
  1554. // Convert model to view.
  1555. view.change( writer => {
  1556. dispatcher.convertInsert( model.createRangeIn( modelRoot ), writer );
  1557. dispatcher.convertMarkerAdd( marker.name, marker.getRange(), writer );
  1558. dispatcher.convertSelection( docSelection, model.markers, writer );
  1559. } );
  1560. // Stringify view and check if it is same as expected.
  1561. expect( stringifyView( viewRoot, viewSelection, { showType: false } ) )
  1562. .to.equal( '<div>f<span class="marker">o<strong>o</strong>[]<strong>b</strong>a</span>r</div>' );
  1563. } );
  1564. it( 'in marker - using highlight descriptor creator', () => {
  1565. downcastHelpers.markerToHighlight( {
  1566. model: 'marker2',
  1567. view: data => ( { classes: data.markerName } )
  1568. } );
  1569. setModelData( model, 'foobar' );
  1570. model.change( writer => {
  1571. const range = writer.createRange( writer.createPositionAt( modelRoot, 1 ), writer.createPositionAt( modelRoot, 5 ) );
  1572. marker = writer.addMarker( 'marker2', { range, usingOperation: false } );
  1573. writer.setSelection( modelRoot, 3 );
  1574. } );
  1575. // Remove view children manually (without firing additional conversion).
  1576. viewRoot._removeChildren( 0, viewRoot.childCount );
  1577. // Convert model to view.
  1578. view.change( writer => {
  1579. dispatcher.convertInsert( model.createRangeIn( modelRoot ), writer );
  1580. dispatcher.convertMarkerAdd( marker.name, marker.getRange(), writer );
  1581. dispatcher.convertSelection( docSelection, model.markers, writer );
  1582. } );
  1583. // Stringify view and check if it is same as expected.
  1584. expect( stringifyView( viewRoot, viewSelection, { showType: false } ) )
  1585. .to.equal( '<div>f<span class="marker2">oo{}ba</span>r</div>' );
  1586. } );
  1587. it( 'should do nothing if creator return null', () => {
  1588. downcastHelpers.markerToHighlight( {
  1589. model: 'marker3',
  1590. view: () => null
  1591. } );
  1592. setModelData( model, 'foobar' );
  1593. model.change( writer => {
  1594. const range = writer.createRange( writer.createPositionAt( modelRoot, 1 ), writer.createPositionAt( modelRoot, 5 ) );
  1595. marker = writer.addMarker( 'marker3', { range, usingOperation: false } );
  1596. writer.setSelection( modelRoot, 3 );
  1597. } );
  1598. // Remove view children manually (without firing additional conversion).
  1599. viewRoot._removeChildren( 0, viewRoot.childCount );
  1600. // Convert model to view.
  1601. view.change( writer => {
  1602. dispatcher.convertInsert( model.createRangeIn( modelRoot ), writer );
  1603. dispatcher.convertMarkerAdd( marker.name, marker.getRange(), writer );
  1604. dispatcher.convertSelection( docSelection, model.markers, writer );
  1605. } );
  1606. // Stringify view and check if it is same as expected.
  1607. expect( stringifyView( viewRoot, viewSelection, { showType: false } ) )
  1608. .to.equal( '<div>foo{}bar</div>' );
  1609. } );
  1610. // #1072 - if the container has only ui elements, collapsed selection attribute should be rendered after those ui elements.
  1611. it( 'selection with attribute before ui element - no non-ui children', () => {
  1612. setModelData( model, '' );
  1613. // Add two ui elements to view.
  1614. viewRoot._appendChild( [
  1615. new ViewUIElement( viewDocument, 'span' ),
  1616. new ViewUIElement( viewDocument, 'span' )
  1617. ] );
  1618. model.change( writer => {
  1619. writer.setSelection( writer.createRange( writer.createPositionFromPath( modelRoot, [ 0 ] ) ) );
  1620. writer.setSelectionAttribute( 'bold', true );
  1621. } );
  1622. // Convert model to view.
  1623. view.change( writer => {
  1624. dispatcher.convertSelection( docSelection, model.markers, writer );
  1625. } );
  1626. // Stringify view and check if it is same as expected.
  1627. expect( stringifyView( viewRoot, viewSelection, { showType: false } ) )
  1628. .to.equal( '<div><span></span><span></span><strong>[]</strong></div>' );
  1629. } );
  1630. // #1072.
  1631. it( 'selection with attribute before ui element - has non-ui children #1', () => {
  1632. setModelData( model, 'x' );
  1633. model.change( writer => {
  1634. writer.setSelection( writer.createRange( writer.createPositionFromPath( modelRoot, [ 1 ] ) ) );
  1635. writer.setSelectionAttribute( 'bold', true );
  1636. } );
  1637. // Convert model to view.
  1638. view.change( writer => {
  1639. dispatcher.convertInsert( model.createRangeIn( modelRoot ), writer );
  1640. // Add ui element to view.
  1641. const uiElement = new ViewUIElement( viewDocument, 'span' );
  1642. viewRoot._insertChild( 1, uiElement );
  1643. dispatcher.convertSelection( docSelection, model.markers, writer );
  1644. } );
  1645. // Stringify view and check if it is same as expected.
  1646. expect( stringifyView( viewRoot, viewSelection, { showType: false } ) )
  1647. .to.equal( '<div>x<strong>[]</strong><span></span></div>' );
  1648. } );
  1649. // #1072.
  1650. it( 'selection with attribute before ui element - has non-ui children #2', () => {
  1651. setModelData( model, '<$text bold="true">x</$text>y' );
  1652. model.change( writer => {
  1653. writer.setSelection( writer.createRange( writer.createPositionFromPath( modelRoot, [ 1 ] ) ) );
  1654. writer.setSelectionAttribute( 'bold', true );
  1655. } );
  1656. // Convert model to view.
  1657. view.change( writer => {
  1658. dispatcher.convertInsert( model.createRangeIn( modelRoot ), writer );
  1659. // Add ui element to view.
  1660. const uiElement = new ViewUIElement( viewDocument, 'span' );
  1661. viewRoot._insertChild( 1, uiElement, writer );
  1662. dispatcher.convertSelection( docSelection, model.markers, writer );
  1663. } );
  1664. // Stringify view and check if it is same as expected.
  1665. expect( stringifyView( viewRoot, viewSelection, { showType: false } ) )
  1666. .to.equal( '<div><strong>x{}</strong><span></span>y</div>' );
  1667. } );
  1668. it( 'consumes consumable values properly', () => {
  1669. // Add callbacks that will fire before default ones.
  1670. // This should prevent default callbacks doing anything.
  1671. dispatcher.on( 'selection', ( evt, data, conversionApi ) => {
  1672. expect( conversionApi.consumable.consume( data.selection, 'selection' ) ).to.be.true;
  1673. }, { priority: 'high' } );
  1674. dispatcher.on( 'attribute:bold', ( evt, data, conversionApi ) => {
  1675. expect( conversionApi.consumable.consume( data.item, 'attribute:bold' ) ).to.be.true;
  1676. }, { priority: 'high' } );
  1677. // Similar test case as above.
  1678. testSelection(
  1679. [ 3, 3 ],
  1680. 'f<$text bold="true">ooba</$text>r',
  1681. 'foobar' // No selection in view and no attribute.
  1682. );
  1683. } );
  1684. } );
  1685. } );
  1686. describe( 'clean-up', () => {
  1687. describe( 'convertRangeSelection', () => {
  1688. it( 'should remove all ranges before adding new range', () => {
  1689. testSelection(
  1690. [ 0, 2 ],
  1691. 'foobar',
  1692. '{fo}obar'
  1693. );
  1694. testSelection(
  1695. [ 3, 5 ],
  1696. 'foobar',
  1697. 'foo{ba}r'
  1698. );
  1699. expect( viewSelection.rangeCount ).to.equal( 1 );
  1700. } );
  1701. } );
  1702. describe( 'convertCollapsedSelection', () => {
  1703. it( 'should remove all ranges before adding new range', () => {
  1704. testSelection(
  1705. [ 2, 2 ],
  1706. 'foobar',
  1707. 'fo{}obar'
  1708. );
  1709. testSelection(
  1710. [ 3, 3 ],
  1711. 'foobar',
  1712. 'foo{}bar'
  1713. );
  1714. expect( viewSelection.rangeCount ).to.equal( 1 );
  1715. } );
  1716. } );
  1717. describe( 'clearAttributes', () => {
  1718. it( 'should remove all ranges before adding new range', () => {
  1719. testSelection(
  1720. [ 3, 3 ],
  1721. 'foobar',
  1722. 'foo<strong>[]</strong>bar',
  1723. { bold: 'true' }
  1724. );
  1725. view.change( writer => {
  1726. const modelRange = model.createRange( model.createPositionAt( modelRoot, 1 ), model.createPositionAt( modelRoot, 1 ) );
  1727. model.change( writer => {
  1728. writer.setSelection( modelRange );
  1729. } );
  1730. dispatcher.convertSelection( modelDoc.selection, model.markers, writer );
  1731. } );
  1732. expect( viewSelection.rangeCount ).to.equal( 1 );
  1733. const viewString = stringifyView( viewRoot, viewSelection, { showType: false } );
  1734. expect( viewString ).to.equal( '<div>f{}oobar</div>' );
  1735. } );
  1736. it( 'should do nothing if the attribute element had been already removed', () => {
  1737. testSelection(
  1738. [ 3, 3 ],
  1739. 'foobar',
  1740. 'foo<strong>[]</strong>bar',
  1741. { bold: 'true' }
  1742. );
  1743. view.change( writer => {
  1744. // Remove <strong></strong> manually.
  1745. writer.mergeAttributes( viewSelection.getFirstPosition() );
  1746. const modelRange = model.createRange( model.createPositionAt( modelRoot, 1 ), model.createPositionAt( modelRoot, 1 ) );
  1747. model.change( writer => {
  1748. writer.setSelection( modelRange );
  1749. } );
  1750. dispatcher.convertSelection( modelDoc.selection, model.markers, writer );
  1751. } );
  1752. expect( viewSelection.rangeCount ).to.equal( 1 );
  1753. const viewString = stringifyView( viewRoot, viewSelection, { showType: false } );
  1754. expect( viewString ).to.equal( '<div>f{}oobar</div>' );
  1755. } );
  1756. it( 'should clear fake selection', () => {
  1757. const modelRange = model.createRange( model.createPositionAt( modelRoot, 1 ), model.createPositionAt( modelRoot, 1 ) );
  1758. view.change( writer => {
  1759. writer.setSelection( modelRange, { fake: true } );
  1760. dispatcher.convertSelection( docSelection, model.markers, writer );
  1761. } );
  1762. expect( viewSelection.isFake ).to.be.false;
  1763. } );
  1764. } );
  1765. } );
  1766. describe( 'table cell selection converter', () => {
  1767. beforeEach( () => {
  1768. model.schema.register( 'table', { isLimit: true } );
  1769. model.schema.register( 'tr', { isLimit: true } );
  1770. model.schema.register( 'td', { isLimit: true } );
  1771. model.schema.extend( 'table', { allowIn: '$root' } );
  1772. model.schema.extend( 'tr', { allowIn: 'table' } );
  1773. model.schema.extend( 'td', { allowIn: 'tr' } );
  1774. model.schema.extend( '$text', { allowIn: 'td' } );
  1775. const downcastHelpers = new DowncastHelpers( [ dispatcher ] );
  1776. // "Universal" converter to convert table structure.
  1777. downcastHelpers.elementToElement( { model: 'table', view: 'table' } );
  1778. downcastHelpers.elementToElement( { model: 'tr', view: 'tr' } );
  1779. downcastHelpers.elementToElement( { model: 'td', view: 'td' } );
  1780. // Special converter for table cells.
  1781. dispatcher.on( 'selection', ( evt, data, conversionApi ) => {
  1782. const selection = data.selection;
  1783. if ( !conversionApi.consumable.test( selection, 'selection' ) || selection.isCollapsed ) {
  1784. return;
  1785. }
  1786. for ( const range of selection.getRanges() ) {
  1787. const node = range.start.parent;
  1788. if ( !!node && node.is( 'td' ) ) {
  1789. conversionApi.consumable.consume( selection, 'selection' );
  1790. const viewNode = conversionApi.mapper.toViewElement( node );
  1791. conversionApi.writer.addClass( 'selected', viewNode );
  1792. }
  1793. }
  1794. }, { priority: 'high' } );
  1795. } );
  1796. it( 'should not be used to convert selection that is not on table cell', () => {
  1797. testSelection(
  1798. [ 1, 5 ],
  1799. 'f{o<$text bold="true">ob</$text>a}r',
  1800. 'f{o<strong>ob</strong>a}r'
  1801. );
  1802. } );
  1803. it( 'should add a class to the selected table cell', () => {
  1804. testSelection(
  1805. // table tr#0 td#0 [foo, table tr#0 td#0 bar]
  1806. [ [ 0, 0, 0, 0 ], [ 0, 0, 0, 3 ] ],
  1807. '<table><tr><td>foo</td></tr><tr><td>bar</td></tr></table>',
  1808. '<table><tr><td class="selected">foo</td></tr><tr><td>bar</td></tr></table>'
  1809. );
  1810. } );
  1811. it( 'should not be used if selection contains more than just a table cell', () => {
  1812. testSelection(
  1813. // table tr td#1 f{oo bar, table tr#2 bar]
  1814. [ [ 0, 0, 0, 1 ], [ 0, 0, 1, 3 ] ],
  1815. '<table><tr><td>foo</td><td>bar</td></tr></table>',
  1816. '[<table><tr><td>foo</td><td>bar</td></tr></table>]'
  1817. );
  1818. } );
  1819. } );
  1820. // Tests if the selection got correctly converted.
  1821. // Because `setData` might use selection converters itself to set the selection, we can't use it
  1822. // to set the selection (because then we would test converters using converters).
  1823. // Instead, the `test` function expects to be passed `selectionPaths` which is an array containing two numbers or two arrays,
  1824. // that are offsets or paths of selection positions in root element.
  1825. function testSelection( selectionPaths, modelInput, expectedView, selectionAttributes = {} ) {
  1826. // Parse passed `modelInput` string and set it as current model.
  1827. setModelData( model, modelInput );
  1828. // Manually set selection ranges using passed `selectionPaths`.
  1829. const startPath = typeof selectionPaths[ 0 ] == 'number' ? [ selectionPaths[ 0 ] ] : selectionPaths[ 0 ];
  1830. const endPath = typeof selectionPaths[ 1 ] == 'number' ? [ selectionPaths[ 1 ] ] : selectionPaths[ 1 ];
  1831. const startPos = model.createPositionFromPath( modelRoot, startPath );
  1832. const endPos = model.createPositionFromPath( modelRoot, endPath );
  1833. const isBackward = selectionPaths[ 2 ] === 'backward';
  1834. model.change( writer => {
  1835. writer.setSelection( writer.createRange( startPos, endPos ), { backward: isBackward } );
  1836. // And add or remove passed attributes.
  1837. for ( const key in selectionAttributes ) {
  1838. const value = selectionAttributes[ key ];
  1839. if ( value ) {
  1840. writer.setSelectionAttribute( key, value );
  1841. } else {
  1842. writer.removeSelectionAttribute( key );
  1843. }
  1844. }
  1845. } );
  1846. // Remove view children manually (without firing additional conversion).
  1847. viewRoot._removeChildren( 0, viewRoot.childCount );
  1848. // Convert model to view.
  1849. view.change( writer => {
  1850. dispatcher.convertInsert( model.createRangeIn( modelRoot ), writer );
  1851. dispatcher.convertSelection( docSelection, model.markers, writer );
  1852. } );
  1853. // Stringify view and check if it is same as expected.
  1854. expect( stringifyView( viewRoot, viewSelection, { showType: false } ) ).to.equal( '<div>' + expectedView + '</div>' );
  1855. }
  1856. } );
  1857. function viewToString( item ) {
  1858. let result = '';
  1859. if ( item instanceof ViewText ) {
  1860. result = item.data;
  1861. } else {
  1862. // ViewElement or ViewDocumentFragment.
  1863. for ( const child of item.getChildren() ) {
  1864. result += viewToString( child );
  1865. }
  1866. if ( item instanceof ViewElement ) {
  1867. result = '<' + item.name + viewAttributesToString( item ) + '>' + result + '</' + item.name + '>';
  1868. }
  1869. }
  1870. return result;
  1871. }
  1872. function viewAttributesToString( item ) {
  1873. let result = '';
  1874. for ( const key of item.getAttributeKeys() ) {
  1875. const value = item.getAttribute( key );
  1876. if ( value ) {
  1877. result += ' ' + key + '="' + value + '"';
  1878. }
  1879. }
  1880. return result;
  1881. }