downcasthelpers.js 123 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992
  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, { writer } ) => writer.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. describe( 'config.triggerBy', () => {
  90. describe( 'with simple block view structure (without children)', () => {
  91. beforeEach( () => {
  92. model.schema.register( 'simpleBlock', {
  93. allowIn: '$root',
  94. allowAttributes: [ 'toStyle', 'toClass' ]
  95. } );
  96. downcastHelpers.elementToElement( {
  97. model: 'simpleBlock',
  98. view: ( modelElement, { writer } ) => {
  99. return writer.createContainerElement( 'div', getViewAttributes( modelElement ) );
  100. },
  101. triggerBy: {
  102. attributes: [ 'toStyle', 'toClass' ]
  103. }
  104. } );
  105. } );
  106. it( 'should convert on insert', () => {
  107. model.change( writer => {
  108. writer.insertElement( 'simpleBlock', modelRoot, 0 );
  109. } );
  110. expectResult( '<div></div>' );
  111. } );
  112. it( 'should convert on attribute set', () => {
  113. setModelData( model, '<simpleBlock></simpleBlock>' );
  114. const [ viewBefore ] = getNodes();
  115. model.change( writer => {
  116. writer.setAttribute( 'toStyle', 'display:block', modelRoot.getChild( 0 ) );
  117. } );
  118. const [ viewAfter ] = getNodes();
  119. expectResult( '<div style="display:block"></div>' );
  120. expect( viewAfter ).to.not.equal( viewBefore );
  121. } );
  122. it( 'should convert on attribute change', () => {
  123. setModelData( model, '<simpleBlock toStyle="display:block"></simpleBlock>' );
  124. const [ viewBefore ] = getNodes();
  125. model.change( writer => {
  126. writer.setAttribute( 'toStyle', 'display:inline', modelRoot.getChild( 0 ) );
  127. } );
  128. const [ viewAfter ] = getNodes();
  129. expectResult( '<div style="display:inline"></div>' );
  130. expect( viewAfter ).to.not.equal( viewBefore );
  131. } );
  132. it( 'should convert on attribute remove', () => {
  133. setModelData( model, '<simpleBlock toStyle="display:block"></simpleBlock>' );
  134. model.change( writer => {
  135. writer.removeAttribute( 'toStyle', modelRoot.getChild( 0 ) );
  136. } );
  137. expectResult( '<div></div>' );
  138. } );
  139. it( 'should convert on one attribute add and other remove', () => {
  140. setModelData( model, '<simpleBlock toStyle="display:block"></simpleBlock>' );
  141. model.change( writer => {
  142. writer.removeAttribute( 'toStyle', modelRoot.getChild( 0 ) );
  143. writer.setAttribute( 'toClass', true, modelRoot.getChild( 0 ) );
  144. } );
  145. expectResult( '<div class="is-classy"></div>' );
  146. } );
  147. it( 'should do nothing if non-triggerBy attribute has changed', () => {
  148. setModelData( model, '<simpleBlock></simpleBlock>' );
  149. const [ viewBefore ] = getNodes();
  150. model.change( writer => {
  151. writer.setAttribute( 'notTriggered', true, modelRoot.getChild( 0 ) );
  152. } );
  153. const [ viewAfter ] = getNodes();
  154. expectResult( '<div></div>' );
  155. expect( viewAfter ).to.equal( viewBefore );
  156. } );
  157. } );
  158. describe( 'with simple block view structure (with children)', () => {
  159. beforeEach( () => {
  160. model.schema.register( 'simpleBlock', {
  161. allowIn: '$root',
  162. allowAttributes: [ 'toStyle', 'toClass' ]
  163. } );
  164. downcastHelpers.elementToElement( {
  165. model: 'simpleBlock',
  166. view: ( modelElement, { writer } ) => {
  167. return writer.createContainerElement( 'div', getViewAttributes( modelElement ) );
  168. },
  169. triggerBy: {
  170. attributes: [ 'toStyle', 'toClass' ]
  171. }
  172. } );
  173. model.schema.register( 'paragraph', {
  174. inheritAllFrom: '$block',
  175. allowIn: 'simpleBlock'
  176. } );
  177. downcastHelpers.elementToElement( { model: 'paragraph', view: 'p' } );
  178. } );
  179. it( 'should convert on insert', () => {
  180. model.change( writer => {
  181. const simpleBlock = writer.createElement( 'simpleBlock' );
  182. const paragraph = writer.createElement( 'paragraph' );
  183. writer.insert( simpleBlock, modelRoot, 0 );
  184. writer.insert( paragraph, simpleBlock, 0 );
  185. writer.insertText( 'foo', paragraph, 0 );
  186. } );
  187. expectResult( '<div><p>foo</p></div>' );
  188. } );
  189. it( 'should convert on attribute set', () => {
  190. setModelData( model, '<simpleBlock><paragraph>foo</paragraph></simpleBlock>' );
  191. const [ viewBefore, paraBefore, textBefore ] = getNodes();
  192. model.change( writer => {
  193. writer.setAttribute( 'toStyle', 'display:block', modelRoot.getChild( 0 ) );
  194. } );
  195. const [ viewAfter, paraAfter, textAfter ] = getNodes();
  196. expectResult( '<div style="display:block"><p>foo</p></div>' );
  197. expect( viewAfter, 'simpleBlock' ).to.not.equal( viewBefore );
  198. expect( paraAfter, 'para' ).to.equal( paraBefore );
  199. expect( textAfter, 'text' ).to.equal( textBefore );
  200. } );
  201. it( 'should convert on attribute change', () => {
  202. setModelData( model, '<simpleBlock toStyle="display:block"><paragraph>foo</paragraph></simpleBlock>' );
  203. const [ viewBefore, paraBefore, textBefore ] = getNodes();
  204. model.change( writer => {
  205. writer.setAttribute( 'toStyle', 'display:inline', modelRoot.getChild( 0 ) );
  206. } );
  207. const [ viewAfter, paraAfter, textAfter ] = getNodes();
  208. expectResult( '<div style="display:inline"><p>foo</p></div>' );
  209. expect( viewAfter, 'simpleBlock' ).to.not.equal( viewBefore );
  210. expect( paraAfter, 'para' ).to.equal( paraBefore );
  211. expect( textAfter, 'text' ).to.equal( textBefore );
  212. } );
  213. it( 'should convert on attribute remove', () => {
  214. setModelData( model, '<simpleBlock toStyle="display:block"><paragraph>foo</paragraph></simpleBlock>' );
  215. model.change( writer => {
  216. writer.removeAttribute( 'toStyle', modelRoot.getChild( 0 ) );
  217. } );
  218. expectResult( '<div><p>foo</p></div>' );
  219. } );
  220. it( 'should convert on one attribute add and other remove', () => {
  221. setModelData( model, '<simpleBlock toStyle="display:block"><paragraph>foo</paragraph></simpleBlock>' );
  222. model.change( writer => {
  223. writer.removeAttribute( 'toStyle', modelRoot.getChild( 0 ) );
  224. writer.setAttribute( 'toClass', true, modelRoot.getChild( 0 ) );
  225. } );
  226. expectResult( '<div class="is-classy"><p>foo</p></div>' );
  227. } );
  228. it( 'should do nothing if non-triggerBy attribute has changed', () => {
  229. setModelData( model, '<simpleBlock><paragraph>foo</paragraph></simpleBlock>' );
  230. const [ viewBefore, paraBefore, textBefore ] = getNodes();
  231. model.change( writer => {
  232. writer.setAttribute( 'notTriggered', true, modelRoot.getChild( 0 ) );
  233. } );
  234. const [ viewAfter, paraAfter, textAfter ] = getNodes();
  235. expectResult( '<div><p>foo</p></div>' );
  236. expect( viewAfter, 'simpleBlock' ).to.equal( viewBefore );
  237. expect( paraAfter, 'para' ).to.equal( paraBefore );
  238. // TODO - is text always re-converted?
  239. expect( textAfter, 'text' ).to.equal( textBefore );
  240. } );
  241. } );
  242. describe( 'with simple block view structure (with children - reconvert on child add)', () => {
  243. beforeEach( () => {
  244. model.schema.register( 'simpleBlock', {
  245. allowIn: '$root'
  246. } );
  247. downcastHelpers.elementToElement( {
  248. model: 'simpleBlock',
  249. view: 'div',
  250. triggerBy: {
  251. children: [ 'paragraph' ]
  252. }
  253. } );
  254. model.schema.register( 'paragraph', {
  255. inheritAllFrom: '$block',
  256. allowIn: 'simpleBlock'
  257. } );
  258. downcastHelpers.elementToElement( { model: 'paragraph', view: 'p' } );
  259. } );
  260. it( 'should convert on insert', () => {
  261. model.change( writer => {
  262. const simpleBlock = writer.createElement( 'simpleBlock' );
  263. const paragraph = writer.createElement( 'paragraph' );
  264. writer.insert( simpleBlock, modelRoot, 0 );
  265. writer.insert( paragraph, simpleBlock, 0 );
  266. writer.insertText( 'foo', paragraph, 0 );
  267. } );
  268. expectResult( '<div><p>foo</p></div>' );
  269. } );
  270. it( 'should convert on adding a child (at the beginning)', () => {
  271. setModelData( model, '<simpleBlock toStyle="display:block"><paragraph>foo</paragraph></simpleBlock>' );
  272. const [ viewBefore, paraBefore, textBefore ] = getNodes();
  273. model.change( writer => {
  274. const paragraph = writer.createElement( 'paragraph' );
  275. const text = writer.createText( 'bar' );
  276. writer.insert( paragraph, modelRoot.getChild( 0 ), 0 );
  277. writer.insert( text, paragraph, 0 );
  278. } );
  279. const [ viewAfter, /* insertedPara */, /* insertedText */, paraAfter, textAfter ] = getNodes();
  280. expectResult( '<div><p>bar</p><p>foo</p></div>' );
  281. expect( viewAfter, 'simpleBlock' ).to.not.equal( viewBefore );
  282. expect( paraAfter, 'para' ).to.equal( paraBefore );
  283. expect( textAfter, 'text' ).to.equal( textBefore );
  284. } );
  285. it( 'should convert on adding a child (in the middle)', () => {
  286. setModelData( model,
  287. '<simpleBlock toStyle="display:block">' +
  288. '<paragraph>foo</paragraph><paragraph>bar</paragraph>' +
  289. '</simpleBlock>' );
  290. const [ viewBefore, paraFooBefore, textFooBefore, paraBarBefore, textBarBefore ] = getNodes();
  291. model.change( writer => {
  292. const paragraph = writer.createElement( 'paragraph' );
  293. const text = writer.createText( 'baz' );
  294. writer.insert( paragraph, modelRoot.getChild( 0 ), 1 );
  295. writer.insert( text, paragraph, 0 );
  296. } );
  297. const [ viewAfter,
  298. paraFooAfter, textFooAfter, /* insertedPara */, /* insertedText */, paraBarAfter, textBarAfter
  299. ] = getNodes();
  300. expectResult( '<div><p>foo</p><p>baz</p><p>bar</p></div>' );
  301. expect( viewAfter, 'simpleBlock' ).to.not.equal( viewBefore );
  302. expect( paraFooAfter, 'para foo' ).to.equal( paraFooBefore );
  303. expect( textFooAfter, 'text foo' ).to.equal( textFooBefore );
  304. expect( paraBarAfter, 'para bar' ).to.equal( paraBarBefore );
  305. expect( textBarAfter, 'text bar' ).to.equal( textBarBefore );
  306. } );
  307. it( 'should convert on adding a child (at the end)', () => {
  308. setModelData( model, '<simpleBlock toStyle="display:block"><paragraph>foo</paragraph></simpleBlock>' );
  309. const [ viewBefore, paraBefore, textBefore ] = getNodes();
  310. model.change( writer => {
  311. const paragraph = writer.createElement( 'paragraph' );
  312. const text = writer.createText( 'bar' );
  313. writer.insert( paragraph, modelRoot.getChild( 0 ), 1 );
  314. writer.insert( text, paragraph, 0 );
  315. } );
  316. const [ viewAfter, paraAfter, textAfter ] = getNodes();
  317. expectResult( '<div><p>foo</p><p>bar</p></div>' );
  318. expect( viewAfter, 'simpleBlock' ).to.not.equal( viewBefore );
  319. expect( paraAfter, 'para' ).to.equal( paraBefore );
  320. expect( textAfter, 'text' ).to.equal( textBefore );
  321. } );
  322. it( 'should convert on removing a child', () => {
  323. setModelData( model,
  324. '<simpleBlock><paragraph>foo</paragraph><paragraph>bar</paragraph></simpleBlock>' );
  325. const [ viewBefore, paraBefore, textBefore ] = getNodes();
  326. model.change( writer => {
  327. writer.remove( modelRoot.getNodeByPath( [ 0, 1 ] ) );
  328. } );
  329. const [ viewAfter, paraAfter, textAfter ] = getNodes();
  330. expectResult( '<div><p>foo</p></div>' );
  331. expect( viewAfter, 'simpleBlock' ).to.not.equal( viewBefore );
  332. expect( paraAfter, 'para' ).to.equal( paraBefore );
  333. expect( textAfter, 'text' ).to.equal( textBefore );
  334. } );
  335. } );
  336. describe( 'with complex view structure - no children allowed', () => {
  337. beforeEach( () => {
  338. model.schema.register( 'complex', {
  339. allowIn: '$root',
  340. allowAttributes: [ 'toStyle', 'toClass' ]
  341. } );
  342. downcastHelpers.elementToElement( {
  343. model: 'complex',
  344. view: ( modelElement, { writer } ) => {
  345. const outer = writer.createContainerElement( 'div', { class: 'complex-outer' } );
  346. const inner = writer.createContainerElement( 'div', getViewAttributes( modelElement ) );
  347. writer.insert( writer.createPositionAt( outer, 0 ), inner );
  348. return outer;
  349. },
  350. triggerBy: {
  351. attributes: [ 'toStyle', 'toClass' ]
  352. }
  353. } );
  354. } );
  355. it( 'should convert on insert', () => {
  356. model.change( writer => {
  357. writer.insertElement( 'complex', modelRoot, 0 );
  358. } );
  359. expectResult( '<div class="complex-outer"><div></div></div>' );
  360. } );
  361. it( 'should convert on attribute set', () => {
  362. setModelData( model, '<complex></complex>' );
  363. const [ outerDivBefore, innerDivBefore ] = getNodes();
  364. model.change( writer => {
  365. writer.setAttribute( 'toStyle', 'display:block', modelRoot.getChild( 0 ) );
  366. } );
  367. const [ outerDivAfter, innerDivAfter ] = getNodes();
  368. expectResult( '<div class="complex-outer"><div style="display:block"></div></div>' );
  369. expect( outerDivAfter, 'outer div' ).to.not.equal( outerDivBefore );
  370. expect( innerDivAfter, 'inner div' ).to.not.equal( innerDivBefore );
  371. } );
  372. it( 'should convert on attribute change', () => {
  373. setModelData( model, '<complex toStyle="display:block"></complex>' );
  374. model.change( writer => {
  375. writer.setAttribute( 'toStyle', 'display:inline', modelRoot.getChild( 0 ) );
  376. } );
  377. expectResult( '<div class="complex-outer"><div style="display:inline"></div></div>' );
  378. } );
  379. it( 'should convert on attribute remove', () => {
  380. setModelData( model, '<complex toStyle="display:block"></complex>' );
  381. model.change( writer => {
  382. writer.removeAttribute( 'toStyle', modelRoot.getChild( 0 ) );
  383. } );
  384. expectResult( '<div class="complex-outer"><div></div></div>' );
  385. } );
  386. it( 'should convert on one attribute add and other remove', () => {
  387. setModelData( model, '<complex toStyle="display:block"></complex>' );
  388. model.change( writer => {
  389. writer.removeAttribute( 'toStyle', modelRoot.getChild( 0 ) );
  390. writer.setAttribute( 'toClass', true, modelRoot.getChild( 0 ) );
  391. } );
  392. expectResult( '<div class="complex-outer"><div class="is-classy"></div></div>' );
  393. } );
  394. it( 'should do nothing if non-triggerBy attribute has changed', () => {
  395. setModelData( model, '<complex></complex>' );
  396. const [ outerDivBefore, innerDivBefore ] = getNodes();
  397. model.change( writer => {
  398. writer.setAttribute( 'notTriggered', true, modelRoot.getChild( 0 ) );
  399. } );
  400. const [ outerDivAfter, innerDivAfter ] = getNodes();
  401. expectResult( '<div class="complex-outer"><div></div></div>' );
  402. expect( outerDivAfter, 'outer div' ).to.equal( outerDivBefore );
  403. expect( innerDivAfter, 'inner div' ).to.equal( innerDivBefore );
  404. } );
  405. } );
  406. describe( 'with complex view structure (without slots)', () => {
  407. beforeEach( () => {
  408. model.schema.register( 'complex', {
  409. allowIn: '$root',
  410. allowAttributes: [ 'toStyle', 'toClass' ]
  411. } );
  412. downcastHelpers.elementToElement( {
  413. model: 'complex',
  414. view: ( modelElement, { writer, mapper } ) => {
  415. const outer = writer.createContainerElement( 'c-outer' );
  416. const inner = writer.createContainerElement( 'c-inner', getViewAttributes( modelElement ) );
  417. writer.insert( writer.createPositionAt( outer, 0 ), inner );
  418. mapper.bindElements( modelElement, outer ); // Need for nested mapping
  419. mapper.bindElements( modelElement, inner );
  420. return outer;
  421. },
  422. triggerBy: {
  423. attributes: [ 'toStyle', 'toClass' ]
  424. }
  425. } );
  426. model.schema.register( 'paragraph', {
  427. inheritAllFrom: '$block',
  428. allowIn: 'complex'
  429. } );
  430. downcastHelpers.elementToElement( { model: 'paragraph', view: 'p' } );
  431. } );
  432. it( 'should convert on insert', () => {
  433. model.change( writer => {
  434. writer.insertElement( 'complex', modelRoot, 0 );
  435. } );
  436. expectResult( '<c-outer><c-inner></c-inner></c-outer>' );
  437. } );
  438. it( 'should convert on attribute set', () => {
  439. setModelData( model, '<complex></complex>' );
  440. model.change( writer => {
  441. writer.setAttribute( 'toStyle', 'display:block', modelRoot.getChild( 0 ) );
  442. } );
  443. expectResult( '<c-outer><c-inner style="display:block"></c-inner></c-outer>' );
  444. } );
  445. it( 'should convert on attribute remove', () => {
  446. setModelData( model, '<complex toStyle="display:block"></complex>' );
  447. model.change( writer => {
  448. writer.removeAttribute( 'toStyle', modelRoot.getChild( 0 ) );
  449. } );
  450. expectResult( '<c-outer><c-inner></c-inner></c-outer>' );
  451. } );
  452. it( 'should convert on one attribute add and other remove', () => {
  453. setModelData( model, '<complex toStyle="display:block"></complex>' );
  454. model.change( writer => {
  455. writer.removeAttribute( 'toStyle', modelRoot.getChild( 0 ) );
  456. writer.setAttribute( 'toClass', true, modelRoot.getChild( 0 ) );
  457. } );
  458. expectResult( '<c-outer><c-inner class="is-classy"></c-inner></c-outer>' );
  459. } );
  460. it( 'should do nothing if non-triggerBy attribute has changed', () => {
  461. setModelData( model, '<complex></complex>' );
  462. model.change( writer => {
  463. writer.setAttribute( 'notTriggered', true, modelRoot.getChild( 0 ) );
  464. } );
  465. expectResult( '<c-outer><c-inner></c-inner></c-outer>' );
  466. } );
  467. describe( 'memoization', () => {
  468. it( 'should create new element on re-converting element', () => {
  469. setModelData( model, '<complex></complex>' );
  470. const [ outerBefore, innerBefore ] = getNodes();
  471. model.change( writer => {
  472. writer.setAttribute( 'toStyle', 'display:block', modelRoot.getChild( 0 ) );
  473. } );
  474. const [ outerAfter, innerAfter ] = getNodes();
  475. expect( outerAfter, 'outer' ).to.not.equal( outerBefore );
  476. expect( innerAfter, 'inner' ).to.not.equal( innerBefore );
  477. } );
  478. // Skipped, as it would require two-level mapping. See https://github.com/ckeditor/ckeditor5/issues/1589.
  479. // Doable as a similar case works in table scenario for table cells (table is refreshed).
  480. it.skip( 'should not re-create child elements on re-converting element', () => {
  481. setModelData( model, '<complex><paragraph>Foo bar baz</paragraph></complex>' );
  482. expectResult( '<c-outer><c-inner><p>Foo bar baz</p></c-inner></c-outer>' );
  483. const renderedViewView = viewRoot.getChild( 0 ).getChild( 0 );
  484. model.change( writer => {
  485. writer.setAttribute( 'toStyle', 'display:block', modelRoot.getChild( 0 ) );
  486. } );
  487. const viewAfterReRender = viewRoot.getChild( 0 ).getChild( 0 );
  488. expect( viewAfterReRender ).to.equal( renderedViewView );
  489. } );
  490. } );
  491. } );
  492. describe( 'with complex view structure (slot conversion)', () => {
  493. beforeEach( () => {
  494. model.schema.register( 'complex', {
  495. allowIn: '$root',
  496. allowAttributes: [ 'classForMain', 'classForWrap', 'attributeToElement' ]
  497. } );
  498. downcastHelpers.elementToElement( {
  499. model: 'complex',
  500. view: ( modelElement, { writer, mapper } ) => {
  501. const classForMain = !!modelElement.getAttribute( 'classForMain' );
  502. const classForWrap = !!modelElement.getAttribute( 'classForWrap' );
  503. const attributeToElement = !!modelElement.getAttribute( 'attributeToElement' );
  504. const outer = writer.createContainerElement( 'div', {
  505. class: `complex-slots${ classForMain ? ' with-class' : '' }`
  506. } );
  507. const inner = writer.createContainerElement( 'div', {
  508. class: `slots${ classForWrap ? ' with-class' : '' }`
  509. } );
  510. if ( attributeToElement ) {
  511. const optional = writer.createEmptyElement( 'div', { class: 'optional' } );
  512. writer.insert( writer.createPositionAt( outer, 0 ), optional );
  513. }
  514. writer.insert( writer.createPositionAt( outer, 'end' ), inner );
  515. mapper.bindElements( modelElement, inner );
  516. for ( const slot of modelElement.getChildren() ) {
  517. const viewSlot = writer.createContainerElement( 'div', { class: 'slot' } );
  518. writer.insert( writer.createPositionAt( inner, slot.index ), viewSlot );
  519. mapper.bindElements( slot, viewSlot );
  520. }
  521. return outer;
  522. },
  523. triggerBy: {
  524. attributes: [ 'classForMain', 'classForWrap', 'attributeToElement' ],
  525. children: [ 'slot' ]
  526. }
  527. } );
  528. model.schema.register( 'slot', {
  529. allowIn: 'complex'
  530. } );
  531. model.schema.register( 'paragraph', {
  532. inheritAllFrom: '$block',
  533. allowIn: 'slot'
  534. } );
  535. downcastHelpers.elementToElement( { model: 'paragraph', view: 'p' } );
  536. } );
  537. it( 'should convert on insert', () => {
  538. model.change( writer => {
  539. writer.insertElement( 'complex', modelRoot, 0 );
  540. } );
  541. expectResult( '<div class="complex-slots"><div class="slots"></div></div>' );
  542. } );
  543. it( 'should convert on attribute set (main element)', () => {
  544. setModelData( model, '<complex></complex>' );
  545. model.change( writer => {
  546. writer.setAttribute( 'classForMain', true, modelRoot.getChild( 0 ) );
  547. } );
  548. expectResult( '<div class="complex-slots with-class"><div class="slots"></div></div>' );
  549. } );
  550. it( 'should convert on attribute set (other element)', () => {
  551. setModelData( model, '<complex></complex>' );
  552. model.change( writer => {
  553. writer.setAttribute( 'classForWrap', true, modelRoot.getChild( 0 ) );
  554. } );
  555. expectResult( '<div class="complex-slots"><div class="slots with-class"></div></div>' );
  556. } );
  557. it( 'should convert on attribute set (insert new view element)', () => {
  558. setModelData( model, '<complex></complex>' );
  559. model.change( writer => {
  560. writer.setAttribute( 'attributeToElement', true, modelRoot.getChild( 0 ) );
  561. } );
  562. expectResult( '<div class="complex-slots"><div class="optional"></div><div class="slots"></div></div>' );
  563. } );
  564. it( 'should convert element with slots', () => {
  565. setModelData( model,
  566. '<complex>' +
  567. '<slot><paragraph>foo</paragraph></slot>' +
  568. '<slot><paragraph>bar</paragraph></slot>' +
  569. '</complex>' );
  570. expectResult(
  571. '<div class="complex-slots">' +
  572. '<div class="slots">' +
  573. '<div class="slot"><p>foo</p></div>' +
  574. '<div class="slot"><p>bar</p></div>' +
  575. '</div>' +
  576. '</div>'
  577. );
  578. } );
  579. it( 'should convert element on adding slot', () => {
  580. setModelData( model,
  581. '<complex>' +
  582. '<slot><paragraph>foo</paragraph></slot>' +
  583. '<slot><paragraph>bar</paragraph></slot>' +
  584. '</complex>' );
  585. model.change( writer => {
  586. insertBazSlot( writer, modelRoot );
  587. } );
  588. expectResult(
  589. '<div class="complex-slots">' +
  590. '<div class="slots">' +
  591. '<div class="slot"><p>foo</p></div>' +
  592. '<div class="slot"><p>bar</p></div>' +
  593. '<div class="slot"><p>baz</p></div>' +
  594. '</div>' +
  595. '</div>'
  596. );
  597. } );
  598. it( 'should convert element on removing slot', () => {
  599. setModelData( model,
  600. '<complex>' +
  601. '<slot><paragraph>foo</paragraph></slot>' +
  602. '<slot><paragraph>bar</paragraph></slot>' +
  603. '</complex>' );
  604. model.change( writer => {
  605. writer.remove( modelRoot.getChild( 0 ).getChild( 0 ) );
  606. } );
  607. expectResult(
  608. '<div class="complex-slots">' +
  609. '<div class="slots">' +
  610. '<div class="slot"><p>bar</p></div>' +
  611. '</div>' +
  612. '</div>'
  613. );
  614. } );
  615. it( 'should convert element on multiple triggers (remove + insert)', () => {
  616. setModelData( model,
  617. '<complex>' +
  618. '<slot><paragraph>foo</paragraph></slot>' +
  619. '<slot><paragraph>bar</paragraph></slot>' +
  620. '</complex>' );
  621. model.change( writer => {
  622. writer.remove( modelRoot.getChild( 0 ).getChild( 0 ) );
  623. insertBazSlot( writer, modelRoot );
  624. } );
  625. expectResult(
  626. '<div class="complex-slots">' +
  627. '<div class="slots">' +
  628. '<div class="slot"><p>bar</p></div>' +
  629. '<div class="slot"><p>baz</p></div>' +
  630. '</div>' +
  631. '</div>'
  632. );
  633. } );
  634. it( 'should convert element on multiple triggers (remove + attribute)', () => {
  635. setModelData( model,
  636. '<complex>' +
  637. '<slot><paragraph>foo</paragraph></slot>' +
  638. '<slot><paragraph>bar</paragraph></slot>' +
  639. '</complex>' );
  640. model.change( writer => {
  641. writer.remove( modelRoot.getChild( 0 ).getChild( 0 ) );
  642. writer.setAttribute( 'classForMain', true, modelRoot.getChild( 0 ) );
  643. } );
  644. expectResult(
  645. '<div class="complex-slots with-class">' +
  646. '<div class="slots">' +
  647. '<div class="slot"><p>bar</p></div>' +
  648. '</div>' +
  649. '</div>'
  650. );
  651. } );
  652. it( 'should convert element on multiple triggers (insert + attribute)', () => {
  653. setModelData( model,
  654. '<complex>' +
  655. '<slot><paragraph>foo</paragraph></slot>' +
  656. '<slot><paragraph>bar</paragraph></slot>' +
  657. '</complex>' );
  658. model.change( writer => {
  659. insertBazSlot( writer, modelRoot );
  660. writer.setAttribute( 'classForMain', true, modelRoot.getChild( 0 ) );
  661. } );
  662. expectResult(
  663. '<div class="complex-slots with-class">' +
  664. '<div class="slots">' +
  665. '<div class="slot"><p>foo</p></div>' +
  666. '<div class="slot"><p>bar</p></div>' +
  667. '<div class="slot"><p>baz</p></div>' +
  668. '</div>' +
  669. '</div>'
  670. );
  671. } );
  672. it( 'should not trigger refresh on adding a slot to an element without triggerBy conversion', () => {
  673. model.schema.register( 'other', {
  674. allowIn: '$root'
  675. } );
  676. model.schema.extend( 'slot', {
  677. allowIn: 'other'
  678. } );
  679. downcastHelpers.elementToElement( {
  680. model: 'other',
  681. view: {
  682. name: 'div',
  683. classes: 'other'
  684. }
  685. } );
  686. downcastHelpers.elementToElement( {
  687. model: 'slot',
  688. view: {
  689. name: 'div',
  690. classes: 'slot'
  691. }
  692. } );
  693. setModelData( model,
  694. '<other>' +
  695. '<slot><paragraph>foo</paragraph></slot>' +
  696. '<slot><paragraph>bar</paragraph></slot>' +
  697. '</other>'
  698. );
  699. const otherView = viewRoot.getChild( 0 );
  700. model.change( writer => {
  701. insertBazSlot( writer, modelRoot );
  702. } );
  703. expectResult(
  704. '<div class="other">' +
  705. '<div class="slot"><p>foo</p></div>' +
  706. '<div class="slot"><p>bar</p></div>' +
  707. '<div class="slot"><p>baz</p></div>' +
  708. '</div>'
  709. );
  710. const otherViewAfter = viewRoot.getChild( 0 );
  711. expect( otherView, 'the view should not be refreshed' ).to.equal( otherViewAfter );
  712. } );
  713. describe( 'memoization', () => {
  714. it( 'should create new element on re-converting element', () => {
  715. setModelData( model, '<complex>' +
  716. '<slot><paragraph>foo</paragraph></slot>' +
  717. '<slot><paragraph>bar</paragraph></slot>' +
  718. '</complex>'
  719. );
  720. const [ complexView ] = getNodes();
  721. model.change( writer => {
  722. writer.setAttribute( 'classForMain', true, modelRoot.getChild( 0 ) );
  723. } );
  724. const [ viewAfterReRender ] = getNodes();
  725. expect( viewAfterReRender, 'the view should be refreshed' ).to.not.equal( complexView );
  726. } );
  727. it( 'should not re-create slot\'s child elements on re-converting main element (attribute changed)', () => {
  728. setModelData( model, '<complex>' +
  729. '<slot><paragraph>foo</paragraph></slot>' +
  730. '<slot><paragraph>bar</paragraph></slot>' +
  731. '</complex>'
  732. );
  733. const [ main, /* unused */,
  734. slotOne, paraOne, textNodeOne,
  735. slotTwo, paraTwo, textNodeTwo ] = getNodes();
  736. model.change( writer => {
  737. writer.setAttribute( 'classForMain', true, modelRoot.getChild( 0 ) );
  738. } );
  739. const [ mainAfter, /* unused */,
  740. slotOneAfter, paraOneAfter, textNodeOneAfter,
  741. slotTwoAfter, paraTwoAfter, textNodeTwoAfter ] = getNodes();
  742. expect( mainAfter, 'main view' ).to.not.equal( main );
  743. expect( slotOneAfter, 'first slot view' ).to.not.equal( slotOne );
  744. expect( slotTwoAfter, 'second slot view' ).to.not.equal( slotTwo );
  745. expect( paraOneAfter, 'first slot paragraph view' ).to.equal( paraOne );
  746. expect( textNodeOneAfter, 'first slot text node view' ).to.equal( textNodeOne );
  747. expect( paraTwoAfter, 'second slot paragraph view' ).to.equal( paraTwo );
  748. expect( textNodeTwoAfter, 'second slot text node view' ).to.equal( textNodeTwo );
  749. } );
  750. it( 'should not re-create slot\'s child elements on re-converting main element (slot added)', () => {
  751. setModelData( model, '<complex>' +
  752. '<slot><paragraph>foo</paragraph></slot>' +
  753. '<slot><paragraph>bar</paragraph></slot>' +
  754. '</complex>'
  755. );
  756. const [ main, /* unused */,
  757. slotOne, paraOne, textNodeOne,
  758. slotTwo, paraTwo, textNodeTwo ] = getNodes();
  759. model.change( writer => {
  760. const slot = writer.createElement( 'slot' );
  761. const paragraph = writer.createElement( 'paragraph' );
  762. writer.insertText( 'baz', paragraph, 0 );
  763. writer.insert( paragraph, slot, 0 );
  764. writer.insert( slot, modelRoot.getChild( 0 ), 'end' );
  765. } );
  766. const [ mainAfter, /* unused */,
  767. slotOneAfter, paraOneAfter, textNodeOneAfter,
  768. slotTwoAfter, paraTwoAfter, textNodeTwoAfter,
  769. slotThreeAfter, paraThreeAfter, textNodeThreeAfter
  770. ] = getNodes();
  771. expect( mainAfter, 'main view' ).to.not.equal( main );
  772. expect( slotOneAfter, 'first slot view' ).to.not.equal( slotOne );
  773. expect( slotTwoAfter, 'second slot view' ).to.not.equal( slotTwo );
  774. expect( paraOneAfter, 'first slot paragraph view' ).to.equal( paraOne );
  775. expect( textNodeOneAfter, 'first slot text node view' ).to.equal( textNodeOne );
  776. expect( paraTwoAfter, 'second slot paragraph view' ).to.equal( paraTwo );
  777. expect( textNodeTwoAfter, 'second slot text node view' ).to.equal( textNodeTwo );
  778. expect( slotThreeAfter, 'third slot view' ).to.not.be.undefined;
  779. expect( paraThreeAfter, 'third slot paragraph view' ).to.not.be.undefined;
  780. expect( textNodeThreeAfter, 'third slot text node view' ).to.not.be.undefined;
  781. } );
  782. } );
  783. } );
  784. // Skipped, as it would require two-level mapping. See https://github.com/ckeditor/ckeditor5/issues/1589.
  785. describe.skip( 'with complex view structure (slot conversion atomic converters for some changes)', () => {
  786. beforeEach( () => {
  787. model.schema.register( 'complex', {
  788. allowIn: '$root',
  789. allowAttributes: [ 'classForMain', 'classForWrap', 'attributeToElement' ]
  790. } );
  791. function createViewSlot( slot, { writer, mapper } ) {
  792. const viewSlot = writer.createContainerElement( 'div', { class: 'slot' } );
  793. mapper.bindElements( slot, viewSlot );
  794. return viewSlot;
  795. }
  796. downcastHelpers.elementToElement( {
  797. model: 'complex',
  798. view: ( modelElement, { writer, mapper, consumable } ) => {
  799. const classForMain = !!modelElement.getAttribute( 'classForMain' );
  800. const classForWrap = !!modelElement.getAttribute( 'classForWrap' );
  801. const attributeToElement = !!modelElement.getAttribute( 'attributeToElement' );
  802. const outer = writer.createContainerElement( 'div', {
  803. class: `complex-slots${ classForMain ? ' with-class' : '' }`
  804. } );
  805. const inner = writer.createContainerElement( 'div', {
  806. class: `slots${ classForWrap ? ' with-class' : '' }`
  807. } );
  808. if ( attributeToElement ) {
  809. const optional = writer.createEmptyElement( 'div', { class: 'optional' } );
  810. writer.insert( writer.createPositionAt( outer, 0 ), optional );
  811. }
  812. writer.insert( writer.createPositionAt( outer, 'end' ), inner );
  813. mapper.bindElements( modelElement, outer );
  814. mapper.bindElements( modelElement, inner );
  815. for ( const slot of modelElement.getChildren() ) {
  816. const viewSlot = createViewSlot( slot, { writer, mapper } );
  817. writer.insert( writer.createPositionAt( inner, slot.index ), viewSlot );
  818. consumable.consume( slot, 'insert' );
  819. }
  820. return outer;
  821. },
  822. triggerBy: {
  823. attributes: [ 'classForMain', 'classForWrap', 'attributeToElement' ]
  824. // Contrary to the previous test - do not act on child changes.
  825. // children: [ 'slot' ]
  826. }
  827. } );
  828. downcastHelpers.elementToElement( {
  829. model: 'slot',
  830. view: createViewSlot
  831. } );
  832. model.schema.register( 'slot', {
  833. allowIn: 'complex'
  834. } );
  835. model.schema.register( 'paragraph', {
  836. inheritAllFrom: '$block',
  837. allowIn: 'slot'
  838. } );
  839. downcastHelpers.elementToElement( { model: 'paragraph', view: 'p' } );
  840. } );
  841. it( 'should convert on insert', () => {
  842. model.change( writer => {
  843. writer.insertElement( 'complex', modelRoot, 0 );
  844. } );
  845. expectResult( '<div class="complex-slots"><div class="slots"></div></div>' );
  846. } );
  847. it( 'should convert on attribute set (main element)', () => {
  848. setModelData( model, '<complex></complex>' );
  849. model.change( writer => {
  850. writer.setAttribute( 'classForMain', true, modelRoot.getChild( 0 ) );
  851. } );
  852. expectResult( '<div class="complex-slots with-class"><div class="slots"></div></div>' );
  853. } );
  854. it( 'should convert on attribute set (other element)', () => {
  855. setModelData( model, '<complex></complex>' );
  856. model.change( writer => {
  857. writer.setAttribute( 'classForWrap', true, modelRoot.getChild( 0 ) );
  858. } );
  859. expectResult( '<div class="complex-slots"><div class="slots with-class"></div></div>' );
  860. } );
  861. it( 'should convert on attribute set (insert new view element)', () => {
  862. setModelData( model, '<complex></complex>' );
  863. model.change( writer => {
  864. writer.setAttribute( 'attributeToElement', true, modelRoot.getChild( 0 ) );
  865. } );
  866. expectResult( '<div class="complex-slots"><div class="optional"></div><div class="slots"></div></div>' );
  867. } );
  868. it( 'should convert element with slots', () => {
  869. setModelData( model,
  870. '<complex>' +
  871. '<slot><paragraph>foo</paragraph></slot>' +
  872. '<slot><paragraph>bar</paragraph></slot>' +
  873. '</complex>' );
  874. expectResult(
  875. '<div class="complex-slots">' +
  876. '<div class="slots">' +
  877. '<div class="slot"><p>foo</p></div>' +
  878. '<div class="slot"><p>bar</p></div>' +
  879. '</div>' +
  880. '</div>'
  881. );
  882. } );
  883. it( 'should not convert element on adding slot', () => {
  884. setModelData( model,
  885. '<complex>' +
  886. '<slot><paragraph>foo</paragraph></slot>' +
  887. '<slot><paragraph>bar</paragraph></slot>' +
  888. '</complex>' );
  889. model.change( writer => {
  890. const slot = writer.createElement( 'slot' );
  891. const paragraph = writer.createElement( 'paragraph' );
  892. writer.insertText( 'baz', paragraph, 0 );
  893. writer.insert( paragraph, slot, 0 );
  894. writer.insert( slot, modelRoot.getChild( 0 ), 'end' );
  895. } );
  896. expectResult(
  897. '<div class="complex-slots">' +
  898. '<div class="slots">' +
  899. '<div class="slot"><p>foo</p></div>' +
  900. '<div class="slot"><p>bar</p></div>' +
  901. '<div class="slot"><p>baz</p></div>' +
  902. '</div>' +
  903. '</div>'
  904. );
  905. } );
  906. it( 'should not convert element on removing slot', () => {
  907. setModelData( model,
  908. '<complex>' +
  909. '<slot><paragraph>foo</paragraph></slot>' +
  910. '<slot><paragraph>bar</paragraph></slot>' +
  911. '</complex>' );
  912. model.change( writer => {
  913. writer.remove( modelRoot.getChild( 0 ).getChild( 0 ) );
  914. } );
  915. expectResult(
  916. '<div class="complex-slots">' +
  917. '<div class="slots">' +
  918. '<div class="slot"><p>bar</p></div>' +
  919. '</div>' +
  920. '</div>'
  921. );
  922. } );
  923. it( 'should convert element on a trigger and block atomic converters (remove + attribute)', () => {
  924. setModelData( model,
  925. '<complex>' +
  926. '<slot><paragraph>foo</paragraph></slot>' +
  927. '<slot><paragraph>bar</paragraph></slot>' +
  928. '</complex>' );
  929. model.change( writer => {
  930. writer.remove( modelRoot.getChild( 0 ).getChild( 0 ) );
  931. writer.setAttribute( 'classForMain', true, modelRoot.getChild( 0 ) );
  932. } );
  933. expectResult(
  934. '<div class="complex-slots with-class">' +
  935. '<div class="slots">' +
  936. '<div class="slot"><p>bar</p></div>' +
  937. '</div>' +
  938. '</div>'
  939. );
  940. } );
  941. it( 'should convert element on a trigger and block atomic converters (insert + attribute)', () => {
  942. setModelData( model,
  943. '<complex>' +
  944. '<slot><paragraph>foo</paragraph></slot>' +
  945. '<slot><paragraph>bar</paragraph></slot>' +
  946. '</complex>' );
  947. model.change( writer => {
  948. writer.insert( modelRoot.getChild( 0 ).getChild( 0 ) );
  949. writer.setAttribute( 'classForMain', true, modelRoot.getChild( 0 ) );
  950. } );
  951. expectResult(
  952. '<div class="complex-slots with-class">' +
  953. '<div class="slots">' +
  954. '<div class="slot"><p>foo</p></div>' +
  955. '<div class="slot"><p>bar</p></div>' +
  956. '<div class="slot"><p>baz</p></div>' +
  957. '</div>' +
  958. '</div>'
  959. );
  960. } );
  961. } );
  962. function getViewAttributes( modelElement ) {
  963. const toStyle = modelElement.hasAttribute( 'toStyle' ) && { style: modelElement.getAttribute( 'toStyle' ) };
  964. const toClass = modelElement.hasAttribute( 'toClass' ) && { class: 'is-classy' };
  965. return {
  966. ...toStyle,
  967. ...toClass
  968. };
  969. }
  970. function insertBazSlot( writer, modelRoot ) {
  971. const slot = writer.createElement( 'slot' );
  972. const paragraph = writer.createElement( 'paragraph' );
  973. writer.insertText( 'baz', paragraph, 0 );
  974. writer.insert( paragraph, slot, 0 );
  975. writer.insert( slot, modelRoot.getChild( 0 ), 'end' );
  976. }
  977. function* getNodes() {
  978. const main = viewRoot.getChild( 0 );
  979. yield main;
  980. for ( const { item } of controller.view.createRangeIn( main ) ) {
  981. if ( item.is( 'textProxy' ) ) {
  982. // TreeWalker always create a new instance of a TextProxy so use referenced textNode.
  983. yield item.textNode;
  984. } else {
  985. yield item;
  986. }
  987. }
  988. }
  989. } );
  990. } );
  991. describe( 'attributeToElement()', () => {
  992. beforeEach( () => {
  993. downcastHelpers.elementToElement( { model: 'paragraph', view: 'p' } );
  994. } );
  995. it( 'should be chainable', () => {
  996. expect( downcastHelpers.attributeToElement( { model: 'bold', view: 'strong' } ) ).to.equal( downcastHelpers );
  997. } );
  998. it( 'config.view is a string', () => {
  999. downcastHelpers.attributeToElement( { model: 'bold', view: 'strong' } );
  1000. model.change( writer => {
  1001. writer.insertText( 'foo', { bold: true }, modelRoot, 0 );
  1002. } );
  1003. expectResult( '<strong>foo</strong>' );
  1004. } );
  1005. it( 'can be overwritten using converterPriority', () => {
  1006. downcastHelpers.attributeToElement( { model: 'bold', view: 'strong' } );
  1007. downcastHelpers.attributeToElement( { model: 'bold', view: 'b', converterPriority: 'high' } );
  1008. model.change( writer => {
  1009. writer.insertText( 'foo', { bold: true }, modelRoot, 0 );
  1010. } );
  1011. expectResult( '<b>foo</b>' );
  1012. } );
  1013. it( 'config.view is a view element definition', () => {
  1014. downcastHelpers.attributeToElement( {
  1015. model: 'invert',
  1016. view: {
  1017. name: 'span',
  1018. classes: [ 'font-light', 'bg-dark' ]
  1019. }
  1020. } );
  1021. model.change( writer => {
  1022. writer.insertText( 'foo', { invert: true }, modelRoot, 0 );
  1023. } );
  1024. expectResult( '<span class="bg-dark font-light">foo</span>' );
  1025. expect( viewRoot.getChild( 0 ).priority ).to.equal( ViewAttributeElement.DEFAULT_PRIORITY );
  1026. } );
  1027. it( 'config.view allows specifying the element\'s priority', () => {
  1028. downcastHelpers.attributeToElement( {
  1029. model: 'invert',
  1030. view: {
  1031. name: 'span',
  1032. priority: 5
  1033. }
  1034. } );
  1035. model.change( writer => {
  1036. writer.insertText( 'foo', { invert: true }, modelRoot, 0 );
  1037. } );
  1038. expect( viewRoot.getChild( 0 ).priority ).to.equal( 5 );
  1039. } );
  1040. it( 'model attribute value is enum', () => {
  1041. downcastHelpers.attributeToElement( {
  1042. model: {
  1043. key: 'fontSize',
  1044. values: [ 'big', 'small' ]
  1045. },
  1046. view: {
  1047. big: {
  1048. name: 'span',
  1049. styles: {
  1050. 'font-size': '1.2em'
  1051. }
  1052. },
  1053. small: {
  1054. name: 'span',
  1055. styles: {
  1056. 'font-size': '0.8em'
  1057. },
  1058. priority: 5
  1059. }
  1060. }
  1061. } );
  1062. model.change( writer => {
  1063. writer.insertText( 'foo', { fontSize: 'big' }, modelRoot, 0 );
  1064. } );
  1065. expect( viewRoot.getChild( 0 ).priority ).to.equal( ViewAttributeElement.DEFAULT_PRIORITY );
  1066. expectResult( '<span style="font-size:1.2em">foo</span>' );
  1067. model.change( writer => {
  1068. writer.setAttribute( 'fontSize', 'small', modelRoot.getChild( 0 ) );
  1069. } );
  1070. expectResult( '<span style="font-size:0.8em">foo</span>' );
  1071. expect( viewRoot.getChild( 0 ).priority ).to.equal( 5 );
  1072. model.change( writer => {
  1073. writer.removeAttribute( 'fontSize', modelRoot.getChild( 0 ) );
  1074. } );
  1075. expectResult( 'foo' );
  1076. } );
  1077. it( 'config.view is a function', () => {
  1078. downcastHelpers.attributeToElement( {
  1079. model: 'bold',
  1080. view: ( modelAttributeValue, { writer } ) => {
  1081. return writer.createAttributeElement( 'span', { style: 'font-weight:' + modelAttributeValue } );
  1082. }
  1083. } );
  1084. model.change( writer => {
  1085. writer.insertText( 'foo', { bold: '500' }, modelRoot, 0 );
  1086. } );
  1087. expectResult( '<span style="font-weight:500">foo</span>' );
  1088. } );
  1089. it( 'config.model.name is given', () => {
  1090. downcastHelpers.attributeToElement( {
  1091. model: {
  1092. key: 'color',
  1093. name: '$text'
  1094. },
  1095. view: ( modelAttributeValue, { writer } ) => {
  1096. return writer.createAttributeElement( 'span', { style: 'color:' + modelAttributeValue } );
  1097. }
  1098. } );
  1099. downcastHelpers.elementToElement( {
  1100. model: 'smiley',
  1101. view: ( modelElement, { writer } ) => {
  1102. return writer.createEmptyElement( 'img', {
  1103. src: 'smile.jpg',
  1104. class: 'smiley'
  1105. } );
  1106. }
  1107. } );
  1108. model.change( writer => {
  1109. writer.insertText( 'foo', { color: '#FF0000' }, modelRoot, 0 );
  1110. writer.insertElement( 'smiley', { color: '#FF0000' }, modelRoot, 3 );
  1111. } );
  1112. expectResult( '<span style="color:#FF0000">foo</span><img class="smiley" src="smile.jpg"></img>' );
  1113. } );
  1114. it( 'should not convert if creator returned null', () => {
  1115. downcastHelpers.elementToElement( { model: 'div', view: () => null } );
  1116. const modelElement = new ModelElement( 'div' );
  1117. model.change( writer => {
  1118. writer.insert( modelElement, modelRootStart );
  1119. } );
  1120. expect( viewToString( viewRoot ) ).to.equal( '<div></div>' );
  1121. } );
  1122. it( 'should convert insert/change/remove of attribute in model into wrapping element in a view', () => {
  1123. const modelElement = new ModelElement( 'paragraph', null, new ModelText( 'foobar', { bold: true } ) );
  1124. downcastHelpers.attributeToElement( {
  1125. model: 'bold',
  1126. view: ( modelAttributeValue, { writer } ) => writer.createAttributeElement( 'b' )
  1127. } );
  1128. model.change( writer => {
  1129. writer.insert( modelElement, modelRootStart );
  1130. } );
  1131. expect( viewToString( viewRoot ) ).to.equal( '<div><p><b>foobar</b></p></div>' );
  1132. model.change( writer => {
  1133. writer.removeAttribute( 'bold', writer.createRangeIn( modelElement ) );
  1134. } );
  1135. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  1136. } );
  1137. it( 'should convert insert/remove of attribute in model with wrapping element generating function as a parameter', () => {
  1138. const modelElement = new ModelElement( 'paragraph', null, new ModelText( 'foobar', { style: 'bold' } ) );
  1139. downcastHelpers.attributeToElement( {
  1140. model: 'style',
  1141. view: ( modelAttributeValue, { writer } ) => {
  1142. if ( modelAttributeValue == 'bold' ) {
  1143. return writer.createAttributeElement( 'b' );
  1144. }
  1145. }
  1146. } );
  1147. model.change( writer => {
  1148. writer.insert( modelElement, modelRootStart );
  1149. } );
  1150. expect( viewToString( viewRoot ) ).to.equal( '<div><p><b>foobar</b></p></div>' );
  1151. model.change( writer => {
  1152. writer.removeAttribute( 'style', writer.createRangeIn( modelElement ) );
  1153. } );
  1154. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  1155. } );
  1156. it( 'should update range on re-wrapping attribute (#475)', () => {
  1157. const modelElement = new ModelElement( 'paragraph', null, [
  1158. new ModelText( 'x' ),
  1159. new ModelText( 'foo', { link: 'http://foo.com' } ),
  1160. new ModelText( 'x' )
  1161. ] );
  1162. downcastHelpers.attributeToElement( {
  1163. model: 'link',
  1164. view: ( modelAttributeValue, { writer } ) => {
  1165. return writer.createAttributeElement( 'a', { href: modelAttributeValue } );
  1166. }
  1167. } );
  1168. model.change( writer => {
  1169. writer.insert( modelElement, modelRootStart );
  1170. } );
  1171. expect( viewToString( viewRoot ) ).to.equal( '<div><p>x<a href="http://foo.com">foo</a>x</p></div>' );
  1172. // Set new attribute on old link but also on non-linked characters.
  1173. model.change( writer => {
  1174. writer.setAttribute( 'link', 'http://foobar.com', writer.createRangeIn( modelElement ) );
  1175. } );
  1176. expect( viewToString( viewRoot ) ).to.equal( '<div><p><a href="http://foobar.com">xfoox</a></p></div>' );
  1177. } );
  1178. it( 'should support unicode', () => {
  1179. const modelElement = new ModelElement( 'paragraph', null, [ 'நி', new ModelText( 'லைக்', { bold: true } ), 'கு' ] );
  1180. downcastHelpers.attributeToElement( {
  1181. model: 'bold',
  1182. view: ( modelAttributeValue, { writer } ) => writer.createAttributeElement( 'b' )
  1183. } );
  1184. model.change( writer => {
  1185. writer.insert( modelElement, modelRootStart );
  1186. } );
  1187. expect( viewToString( viewRoot ) ).to.equal( '<div><p>நி<b>லைக்</b>கு</p></div>' );
  1188. model.change( writer => {
  1189. writer.removeAttribute( 'bold', writer.createRangeIn( modelElement ) );
  1190. } );
  1191. expect( viewToString( viewRoot ) ).to.equal( '<div><p>நிலைக்கு</p></div>' );
  1192. } );
  1193. it( 'should be possible to override ', () => {
  1194. const modelElement = new ModelElement( 'paragraph', null, new ModelText( 'foobar', { bold: true } ) );
  1195. downcastHelpers.attributeToElement( {
  1196. model: 'bold',
  1197. view: ( modelAttributeValue, { writer } ) => writer.createAttributeElement( 'b' )
  1198. } );
  1199. downcastHelpers.attributeToElement( {
  1200. model: 'bold',
  1201. view: ( modelAttributeValue, { writer } ) => writer.createAttributeElement( 'strong' ),
  1202. converterPriority: 'high'
  1203. } );
  1204. model.change( writer => {
  1205. writer.insert( modelElement, modelRootStart );
  1206. } );
  1207. expect( viewToString( viewRoot ) ).to.equal( '<div><p><strong>foobar</strong></p></div>' );
  1208. } );
  1209. it( 'should not convert and not consume if creator function returned null', () => {
  1210. sinon.spy( controller.downcastDispatcher, 'fire' );
  1211. const modelElement = new ModelElement( 'paragraph', null, new ModelText( 'foobar', { italic: true } ) );
  1212. downcastHelpers.attributeToElement( {
  1213. model: 'italic',
  1214. view: () => null
  1215. } );
  1216. const spy = sinon.spy();
  1217. controller.downcastDispatcher.on( 'attribute:italic', spy );
  1218. model.change( writer => {
  1219. writer.insert( modelElement, modelRootStart );
  1220. } );
  1221. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  1222. expect( controller.downcastDispatcher.fire.calledWith( 'attribute:italic:$text' ) ).to.be.true;
  1223. expect( spy.called ).to.be.true;
  1224. } );
  1225. } );
  1226. describe( 'attributeToAttribute()', () => {
  1227. testUtils.createSinonSandbox();
  1228. beforeEach( () => {
  1229. downcastHelpers.elementToElement( { model: 'image', view: 'img' } );
  1230. downcastHelpers.elementToElement( {
  1231. model: 'paragraph',
  1232. view: ( modelItem, { writer } ) => writer.createContainerElement( 'p' )
  1233. } );
  1234. downcastHelpers.attributeToAttribute( {
  1235. model: 'class',
  1236. view: 'class'
  1237. } );
  1238. } );
  1239. it( 'should be chainable', () => {
  1240. expect( downcastHelpers.attributeToAttribute( { model: 'source', view: 'src' } ) ).to.equal( downcastHelpers );
  1241. } );
  1242. it( 'config.view is a string', () => {
  1243. downcastHelpers.attributeToAttribute( { model: 'source', view: 'src' } );
  1244. model.change( writer => {
  1245. writer.insertElement( 'image', { source: 'foo.jpg' }, modelRoot, 0 );
  1246. } );
  1247. expectResult( '<img src="foo.jpg"></img>' );
  1248. model.change( writer => {
  1249. writer.removeAttribute( 'source', modelRoot.getChild( 0 ) );
  1250. } );
  1251. expectResult( '<img></img>' );
  1252. } );
  1253. it( 'can be overwritten using converterPriority', () => {
  1254. downcastHelpers.attributeToAttribute( { model: 'source', view: 'href' } );
  1255. downcastHelpers.attributeToAttribute( { model: 'source', view: 'src', converterPriority: 'high' } );
  1256. model.change( writer => {
  1257. writer.insertElement( 'image', { source: 'foo.jpg' }, modelRoot, 0 );
  1258. } );
  1259. expectResult( '<img src="foo.jpg"></img>' );
  1260. } );
  1261. it( 'model element name specified', () => {
  1262. downcastHelpers.elementToElement( { model: 'paragraph', view: 'p' } );
  1263. downcastHelpers.attributeToAttribute( {
  1264. model: {
  1265. name: 'image',
  1266. key: 'source'
  1267. },
  1268. view: 'src'
  1269. } );
  1270. model.change( writer => {
  1271. writer.insertElement( 'image', { source: 'foo.jpg' }, modelRoot, 0 );
  1272. } );
  1273. expectResult( '<img src="foo.jpg"></img>' );
  1274. model.change( writer => {
  1275. writer.rename( modelRoot.getChild( 0 ), 'paragraph' );
  1276. } );
  1277. expectResult( '<p></p>' );
  1278. } );
  1279. it( 'config.view is an object, model attribute value is enum', () => {
  1280. downcastHelpers.elementToElement( { model: 'paragraph', view: 'p' } );
  1281. downcastHelpers.attributeToAttribute( {
  1282. model: {
  1283. key: 'styled',
  1284. values: [ 'dark', 'light' ]
  1285. },
  1286. view: {
  1287. dark: {
  1288. key: 'class',
  1289. value: [ 'styled', 'styled-dark' ]
  1290. },
  1291. light: {
  1292. key: 'class',
  1293. value: [ 'styled', 'styled-light' ]
  1294. }
  1295. }
  1296. } );
  1297. model.change( writer => {
  1298. writer.insertElement( 'paragraph', { styled: 'dark' }, modelRoot, 0 );
  1299. } );
  1300. expectResult( '<p class="styled styled-dark"></p>' );
  1301. model.change( writer => {
  1302. writer.setAttribute( 'styled', 'light', modelRoot.getChild( 0 ) );
  1303. } );
  1304. expectResult( '<p class="styled styled-light"></p>' );
  1305. model.change( writer => {
  1306. writer.removeAttribute( 'styled', modelRoot.getChild( 0 ) );
  1307. } );
  1308. expectResult( '<p></p>' );
  1309. } );
  1310. it( 'config.view is an object, model attribute value is enum, view has style', () => {
  1311. downcastHelpers.elementToElement( { model: 'paragraph', view: 'p' } );
  1312. downcastHelpers.attributeToAttribute( {
  1313. model: {
  1314. key: 'align',
  1315. values: [ 'right', 'center' ]
  1316. },
  1317. view: {
  1318. right: {
  1319. key: 'style',
  1320. value: {
  1321. 'text-align': 'right'
  1322. }
  1323. },
  1324. center: {
  1325. key: 'style',
  1326. value: {
  1327. 'text-align': 'center'
  1328. }
  1329. }
  1330. }
  1331. } );
  1332. model.change( writer => {
  1333. writer.insertElement( 'paragraph', { align: 'right' }, modelRoot, 0 );
  1334. } );
  1335. expectResult( '<p style="text-align:right"></p>' );
  1336. model.change( writer => {
  1337. writer.setAttribute( 'align', 'center', modelRoot.getChild( 0 ) );
  1338. } );
  1339. expectResult( '<p style="text-align:center"></p>' );
  1340. model.change( writer => {
  1341. writer.removeAttribute( 'align', modelRoot.getChild( 0 ) );
  1342. } );
  1343. expectResult( '<p></p>' );
  1344. } );
  1345. it( 'config.view is an object, only name and key are provided', () => {
  1346. downcastHelpers.elementToElement( { model: 'paragraph', view: 'p' } );
  1347. downcastHelpers.attributeToAttribute( {
  1348. model: {
  1349. name: 'paragraph',
  1350. key: 'class'
  1351. },
  1352. view: {
  1353. name: 'paragraph',
  1354. key: 'class'
  1355. }
  1356. } );
  1357. model.change( writer => {
  1358. writer.insertElement( 'paragraph', { class: 'dark' }, modelRoot, 0 );
  1359. } );
  1360. expectResult( '<p class="dark"></p>' );
  1361. model.change( writer => {
  1362. writer.setAttribute( 'class', 'light', modelRoot.getChild( 0 ) );
  1363. } );
  1364. expectResult( '<p class="light"></p>' );
  1365. model.change( writer => {
  1366. writer.removeAttribute( 'class', modelRoot.getChild( 0 ) );
  1367. } );
  1368. expectResult( '<p></p>' );
  1369. } );
  1370. it( 'config.view is a function', () => {
  1371. downcastHelpers.attributeToAttribute( {
  1372. model: 'styled',
  1373. view: ( attributeValue, conversionApi ) => {
  1374. // To ensure conversion API is provided.
  1375. expect( conversionApi.writer ).to.instanceof( DowncastWriter );
  1376. return { key: 'class', value: 'styled-' + attributeValue };
  1377. }
  1378. } );
  1379. model.change( writer => {
  1380. writer.insertElement( 'image', { styled: 'pull-out' }, modelRoot, 0 );
  1381. } );
  1382. expectResult( '<img class="styled-pull-out"></img>' );
  1383. } );
  1384. // #1587
  1385. it( 'config.view and config.model as strings in generic conversion (elements only)', () => {
  1386. const consoleWarnStub = testUtils.sinon.stub( console, 'warn' );
  1387. downcastHelpers.elementToElement( { model: 'paragraph', view: 'p' } );
  1388. downcastHelpers.attributeToAttribute( { model: 'test', view: 'test' } );
  1389. model.change( writer => {
  1390. writer.insertElement( 'paragraph', { test: '1' }, modelRoot, 0 );
  1391. writer.insertElement( 'paragraph', { test: '2' }, modelRoot, 1 );
  1392. } );
  1393. expectResult( '<p test="1"></p><p test="2"></p>' );
  1394. expect( consoleWarnStub.callCount ).to.equal( 0 );
  1395. model.change( writer => {
  1396. writer.removeAttribute( 'test', modelRoot.getChild( 1 ) );
  1397. } );
  1398. expectResult( '<p test="1"></p><p></p>' );
  1399. } );
  1400. // #1587
  1401. it( 'config.view and config.model as strings in generic conversion (elements + text)', () => {
  1402. downcastHelpers.elementToElement( { model: 'paragraph', view: 'p' } );
  1403. downcastHelpers.attributeToAttribute( { model: 'test', view: 'test' } );
  1404. expectToThrowCKEditorError( () => {
  1405. model.change( writer => {
  1406. writer.insertElement( 'paragraph', modelRoot, 0 );
  1407. writer.insertElement( 'paragraph', { test: '1' }, modelRoot, 1 );
  1408. writer.insertText( 'Foo', { test: '2' }, modelRoot.getChild( 0 ), 0 );
  1409. writer.insertText( 'Bar', { test: '3' }, modelRoot.getChild( 1 ), 0 );
  1410. } );
  1411. }, /^conversion-attribute-to-attribute-on-text/ );
  1412. } );
  1413. it( 'should convert attribute insert/change/remove on a model node', () => {
  1414. const modelElement = new ModelElement( 'paragraph', { class: 'foo' }, new ModelText( 'foobar' ) );
  1415. model.change( writer => {
  1416. writer.insert( modelElement, modelRootStart );
  1417. } );
  1418. expect( viewToString( viewRoot ) ).to.equal( '<div><p class="foo">foobar</p></div>' );
  1419. model.change( writer => {
  1420. writer.setAttribute( 'class', 'bar', modelElement );
  1421. } );
  1422. expect( viewToString( viewRoot ) ).to.equal( '<div><p class="bar">foobar</p></div>' );
  1423. model.change( writer => {
  1424. writer.removeAttribute( 'class', modelElement );
  1425. } );
  1426. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  1427. } );
  1428. it( 'should be possible to override setAttribute', () => {
  1429. downcastHelpers.attributeToAttribute( {
  1430. model: 'class',
  1431. view: ( evt, data, conversionApi ) => {
  1432. conversionApi.consumable.consume( data.item, 'attribute:class' );
  1433. },
  1434. converterPriority: 'high'
  1435. } );
  1436. model.change( writer => {
  1437. const modelElement = new ModelElement( 'paragraph', { classes: 'foo' }, new ModelText( 'foobar' ) );
  1438. writer.insert( modelElement, modelRootStart );
  1439. } );
  1440. // No attribute set.
  1441. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  1442. } );
  1443. it( 'should not convert or consume if element creator returned null', () => {
  1444. const callback = sinon.stub().returns( null );
  1445. downcastHelpers.attributeToAttribute( {
  1446. model: 'class',
  1447. view: callback,
  1448. converterPriority: 'high'
  1449. } );
  1450. const modelElement = new ModelElement( 'paragraph', { class: 'foo' }, new ModelText( 'foobar' ) );
  1451. model.change( writer => {
  1452. writer.insert( modelElement, modelRootStart );
  1453. } );
  1454. expect( viewToString( viewRoot ) ).to.equal( '<div><p class="foo">foobar</p></div>' );
  1455. sinon.assert.called( callback );
  1456. } );
  1457. } );
  1458. describe( 'markerToElement()', () => {
  1459. let modelText, modelElement, range;
  1460. it( 'should be chainable', () => {
  1461. expect( downcastHelpers.markerToElement( { model: 'search', view: 'marker-search' } ) ).to.equal( downcastHelpers );
  1462. } );
  1463. it( 'config.view is a string', () => {
  1464. downcastHelpers.markerToElement( { model: 'search', view: 'marker-search' } );
  1465. model.change( writer => {
  1466. writer.insertText( 'foo', modelRoot, 0 );
  1467. const range = writer.createRange( writer.createPositionAt( modelRoot, 1 ), writer.createPositionAt( modelRoot, 2 ) );
  1468. writer.addMarker( 'search', { range, usingOperation: false } );
  1469. } );
  1470. expectResult( 'f<marker-search></marker-search>o<marker-search></marker-search>o' );
  1471. } );
  1472. it( 'can be overwritten using converterPriority', () => {
  1473. downcastHelpers.markerToElement( { model: 'search', view: 'marker-search' } );
  1474. downcastHelpers.markerToElement( { model: 'search', view: 'search', converterPriority: 'high' } );
  1475. model.change( writer => {
  1476. writer.insertText( 'foo', modelRoot, 0 );
  1477. const range = writer.createRange( writer.createPositionAt( modelRoot, 1 ), writer.createPositionAt( modelRoot, 2 ) );
  1478. writer.addMarker( 'search', { range, usingOperation: false } );
  1479. } );
  1480. expectResult( 'f<search></search>o<search></search>o' );
  1481. } );
  1482. it( 'config.view is a view element definition', () => {
  1483. downcastHelpers.markerToElement( {
  1484. model: 'search',
  1485. view: {
  1486. name: 'span',
  1487. attributes: {
  1488. 'data-marker': 'search'
  1489. }
  1490. }
  1491. } );
  1492. model.change( writer => {
  1493. writer.insertText( 'foo', modelRoot, 0 );
  1494. const range = writer.createRange( writer.createPositionAt( modelRoot, 1 ), writer.createPositionAt( modelRoot, 2 ) );
  1495. writer.addMarker( 'search', { range, usingOperation: false } );
  1496. } );
  1497. expectResult( 'f<span data-marker="search"></span>o<span data-marker="search"></span>o' );
  1498. } );
  1499. it( 'config.view is a function', () => {
  1500. downcastHelpers.markerToElement( {
  1501. model: 'search',
  1502. view: ( data, { writer } ) => {
  1503. return writer.createUIElement( 'span', { 'data-marker': 'search', 'data-start': data.isOpening } );
  1504. }
  1505. } );
  1506. model.change( writer => {
  1507. writer.insertText( 'foo', modelRoot, 0 );
  1508. const range = writer.createRange( writer.createPositionAt( modelRoot, 1 ), writer.createPositionAt( modelRoot, 2 ) );
  1509. writer.addMarker( 'search', { range, usingOperation: false } );
  1510. } );
  1511. expectResult( 'f<span data-marker="search" data-start="true"></span>o<span data-marker="search" data-start="false"></span>o' );
  1512. } );
  1513. describe( 'collapsed range', () => {
  1514. beforeEach( () => {
  1515. modelText = new ModelText( 'foobar' );
  1516. modelElement = new ModelElement( 'paragraph', null, modelText );
  1517. downcastHelpers.elementToElement( { model: 'paragraph', view: 'p' } );
  1518. model.change( writer => {
  1519. writer.insert( modelElement, modelRootStart );
  1520. } );
  1521. range = model.createRange( model.createPositionAt( modelElement, 3 ), model.createPositionAt( modelElement, 3 ) );
  1522. } );
  1523. it( 'should insert and remove ui element', () => {
  1524. downcastHelpers.markerToElement( {
  1525. model: 'marker',
  1526. view: ( data, { writer } ) => writer.createUIElement( 'span', { 'class': 'marker' } )
  1527. } );
  1528. model.change( writer => {
  1529. writer.addMarker( 'marker', { range, usingOperation: false } );
  1530. } );
  1531. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foo<span class="marker"></span>bar</p></div>' );
  1532. model.change( writer => {
  1533. writer.removeMarker( 'marker' );
  1534. } );
  1535. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  1536. } );
  1537. it( 'should not convert if consumable was consumed', () => {
  1538. sinon.spy( controller.downcastDispatcher, 'fire' );
  1539. downcastHelpers.markerToElement( {
  1540. model: 'marker',
  1541. view: ( data, { writer } ) => writer.createUIElement( 'span', { 'class': 'marker' } )
  1542. } );
  1543. controller.downcastDispatcher.on( 'addMarker:marker', ( evt, data, conversionApi ) => {
  1544. conversionApi.consumable.consume( data.markerRange, 'addMarker:marker' );
  1545. }, { priority: 'high' } );
  1546. model.change( writer => {
  1547. writer.addMarker( 'marker', { range, usingOperation: false } );
  1548. } );
  1549. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  1550. expect( controller.downcastDispatcher.fire.calledWith( 'addMarker:marker' ) );
  1551. } );
  1552. it( 'should not convert if creator returned null', () => {
  1553. downcastHelpers.markerToElement( {
  1554. model: 'marker',
  1555. view: () => null
  1556. } );
  1557. model.change( writer => {
  1558. writer.addMarker( 'marker', { range, usingOperation: false } );
  1559. } );
  1560. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  1561. model.change( writer => {
  1562. writer.removeMarker( 'marker' );
  1563. } );
  1564. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  1565. } );
  1566. } );
  1567. describe( 'non-collapsed range', () => {
  1568. beforeEach( () => {
  1569. modelText = new ModelText( 'foobar' );
  1570. modelElement = new ModelElement( 'paragraph', null, modelText );
  1571. downcastHelpers.elementToElement( { model: 'paragraph', view: 'p' } );
  1572. model.change( writer => {
  1573. writer.insert( modelElement, modelRootStart );
  1574. } );
  1575. range = model.createRange( model.createPositionAt( modelElement, 2 ), model.createPositionAt( modelElement, 5 ) );
  1576. } );
  1577. it( 'should insert and remove ui element - element as a creator', () => {
  1578. downcastHelpers.markerToElement( {
  1579. model: 'marker',
  1580. view: ( data, { writer } ) => writer.createUIElement( 'span', { 'class': 'marker' } )
  1581. } );
  1582. model.change( writer => {
  1583. writer.addMarker( 'marker', { range, usingOperation: false } );
  1584. } );
  1585. expect( viewToString( viewRoot ) )
  1586. .to.equal( '<div><p>fo<span class="marker"></span>oba<span class="marker"></span>r</p></div>' );
  1587. model.change( writer => {
  1588. writer.removeMarker( 'marker' );
  1589. } );
  1590. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  1591. } );
  1592. it( 'should insert and remove ui element - function as a creator', () => {
  1593. downcastHelpers.markerToElement( {
  1594. model: 'marker',
  1595. view: ( data, { writer } ) => writer.createUIElement( 'span', { 'class': data.markerName } )
  1596. } );
  1597. model.change( writer => {
  1598. writer.addMarker( 'marker', { range, usingOperation: false } );
  1599. } );
  1600. expect( viewToString( viewRoot ) )
  1601. .to.equal( '<div><p>fo<span class="marker"></span>oba<span class="marker"></span>r</p></div>' );
  1602. model.change( writer => {
  1603. writer.removeMarker( 'marker' );
  1604. } );
  1605. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  1606. } );
  1607. it( 'should insert and remove different opening and ending element', () => {
  1608. downcastHelpers.markerToElement( {
  1609. model: 'marker',
  1610. view: ( data, { writer } ) => {
  1611. if ( data.isOpening ) {
  1612. return writer.createUIElement( 'span', { 'class': data.markerName, 'data-start': true } );
  1613. }
  1614. return writer.createUIElement( 'span', { 'class': data.markerName, 'data-end': true } );
  1615. }
  1616. } );
  1617. model.change( writer => {
  1618. writer.addMarker( 'marker', { range, usingOperation: false } );
  1619. } );
  1620. expect( viewToString( viewRoot ) ).to.equal(
  1621. '<div><p>fo<span class="marker" data-start="true"></span>oba<span class="marker" data-end="true"></span>r</p></div>'
  1622. );
  1623. model.change( writer => {
  1624. writer.removeMarker( 'marker' );
  1625. } );
  1626. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  1627. } );
  1628. it( 'should not convert if consumable was consumed', () => {
  1629. sinon.spy( controller.downcastDispatcher, 'fire' );
  1630. downcastHelpers.markerToElement( {
  1631. model: 'marker',
  1632. view: ( data, { writer } ) => writer.createUIElement( 'span', { 'class': 'marker' } )
  1633. } );
  1634. controller.downcastDispatcher.on( 'addMarker:marker', ( evt, data, conversionApi ) => {
  1635. conversionApi.consumable.consume( data.item, 'addMarker:marker' );
  1636. }, { priority: 'high' } );
  1637. model.change( writer => {
  1638. writer.addMarker( 'marker', { range, usingOperation: false } );
  1639. } );
  1640. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  1641. expect( controller.downcastDispatcher.fire.calledWith( 'addMarker:marker' ) );
  1642. } );
  1643. } );
  1644. } );
  1645. describe( 'markerToData()', () => {
  1646. let root;
  1647. beforeEach( () => {
  1648. root = model.document.getRoot();
  1649. model.schema.register( 'paragraph', { inheritAllFrom: '$block' } );
  1650. downcastHelpers.elementToElement( { model: 'paragraph', view: 'p' } );
  1651. } );
  1652. it( 'should be chainable', () => {
  1653. expect( downcastHelpers.markerToData( { model: 'search' } ) ).to.equal( downcastHelpers );
  1654. } );
  1655. it( 'default conversion, inside text, non-collapsed, no name', () => {
  1656. downcastHelpers.markerToData( { model: 'search' } );
  1657. setModelData( model, '<paragraph>Fo[ob]ar</paragraph>' );
  1658. model.change( writer => {
  1659. writer.addMarker( 'search', { range: model.document.selection.getFirstRange(), usingOperation: false } );
  1660. } );
  1661. expectResult( '<p>Fo<search-start></search-start>ob<search-end></search-end>ar</p>' );
  1662. model.change( writer => {
  1663. writer.removeMarker( 'search' );
  1664. } );
  1665. expectResult( '<p>Foobar</p>' );
  1666. } );
  1667. it( 'default conversion, inside text, non-collapsed, name', () => {
  1668. downcastHelpers.markerToData( { model: 'group' } );
  1669. setModelData( model, '<paragraph>Fo[ob]ar</paragraph>' );
  1670. model.change( writer => {
  1671. writer.addMarker( 'group:foo:bar:baz', { range: model.document.selection.getFirstRange(), usingOperation: false } );
  1672. } );
  1673. expectResult( '<p>Fo<group-start name="foo:bar:baz"></group-start>ob<group-end name="foo:bar:baz"></group-end>ar</p>' );
  1674. model.change( writer => {
  1675. writer.removeMarker( 'group:foo:bar:baz' );
  1676. } );
  1677. expectResult( '<p>Foobar</p>' );
  1678. } );
  1679. it( 'default conversion, inside text, collapsed, no name', () => {
  1680. downcastHelpers.markerToData( { model: 'search' } );
  1681. setModelData( model, '<paragraph>Foo[]bar</paragraph>' );
  1682. model.change( writer => {
  1683. writer.addMarker( 'search', { range: model.document.selection.getFirstRange(), usingOperation: false } );
  1684. } );
  1685. expectResult( '<p>Foo<search-start></search-start><search-end></search-end>bar</p>' );
  1686. model.change( writer => {
  1687. writer.removeMarker( 'search' );
  1688. } );
  1689. expectResult( '<p>Foobar</p>' );
  1690. } );
  1691. it( 'default conversion, inside text, collapsed, multiple markers, no name', () => {
  1692. downcastHelpers.markerToData( { model: 'group' } );
  1693. setModelData( model, '<paragraph>Foo[]bar</paragraph>' );
  1694. model.change( writer => {
  1695. writer.addMarker( 'group:foo', { range: model.document.selection.getFirstRange(), usingOperation: false } );
  1696. writer.addMarker( 'group:abc', { range: model.document.selection.getFirstRange(), usingOperation: false } );
  1697. } );
  1698. expectResult(
  1699. '<p>' +
  1700. 'Foo' +
  1701. '<group-start name="abc"></group-start><group-end name="abc"></group-end>' +
  1702. '<group-start name="foo"></group-start><group-end name="foo"></group-end>' +
  1703. 'bar' +
  1704. '</p>'
  1705. );
  1706. model.change( writer => {
  1707. writer.removeMarker( 'group:foo' );
  1708. writer.removeMarker( 'group:abc' );
  1709. } );
  1710. expectResult( '<p>Foobar</p>' );
  1711. } );
  1712. it( 'default conversion, on two elements, no name', () => {
  1713. downcastHelpers.markerToData( { model: 'search' } );
  1714. setModelData( model, '<paragraph>Foo</paragraph><paragraph>Bar</paragraph>' );
  1715. model.change( writer => {
  1716. const range = writer.createRangeIn( root );
  1717. writer.addMarker( 'search', { range, usingOperation: false } );
  1718. } );
  1719. expectResult( '<p data-search-start-before="">Foo</p><p data-search-end-after="">Bar</p>' );
  1720. model.change( writer => {
  1721. writer.removeMarker( 'search' );
  1722. } );
  1723. expectResult( '<p>Foo</p><p>Bar</p>' );
  1724. } );
  1725. it( 'default conversion, on two elements, name', () => {
  1726. downcastHelpers.markerToData( { model: 'group' } );
  1727. setModelData( model, '<paragraph>Foo</paragraph><paragraph>Bar</paragraph>' );
  1728. model.change( writer => {
  1729. const range = writer.createRangeIn( root );
  1730. writer.addMarker( 'group:foo:bar:baz', { range, usingOperation: false } );
  1731. } );
  1732. expectResult( '<p data-group-start-before="foo:bar:baz">Foo</p><p data-group-end-after="foo:bar:baz">Bar</p>' );
  1733. model.change( writer => {
  1734. writer.removeMarker( 'group:foo:bar:baz' );
  1735. } );
  1736. expectResult( '<p>Foo</p><p>Bar</p>' );
  1737. } );
  1738. it( 'default conversion, on one element, name', () => {
  1739. downcastHelpers.markerToData( { model: 'group' } );
  1740. setModelData( model, '<paragraph>Foobar</paragraph>' );
  1741. model.change( writer => {
  1742. const range = writer.createRangeIn( root );
  1743. writer.addMarker( 'group:foo:bar:baz', { range, usingOperation: false } );
  1744. } );
  1745. expectResult( '<p data-group-end-after="foo:bar:baz" data-group-start-before="foo:bar:baz">Foobar</p>' );
  1746. model.change( writer => {
  1747. writer.removeMarker( 'group:foo:bar:baz' );
  1748. } );
  1749. expectResult( '<p>Foobar</p>' );
  1750. } );
  1751. it( 'default conversion, collapsed before element, name', () => {
  1752. downcastHelpers.markerToData( { model: 'group' } );
  1753. setModelData( model, '<paragraph>Foobar</paragraph>' );
  1754. model.change( writer => {
  1755. // Collapsed before <paragraph>.
  1756. const range = writer.createRange(
  1757. writer.createPositionFromPath( root, [ 0 ] )
  1758. );
  1759. writer.addMarker( 'group:foo:bar:baz', { range, usingOperation: false } );
  1760. } );
  1761. expectResult( '<p data-group-end-before="foo:bar:baz" data-group-start-before="foo:bar:baz">Foobar</p>' );
  1762. model.change( writer => {
  1763. writer.removeMarker( 'group:foo:bar:baz' );
  1764. } );
  1765. expectResult( '<p>Foobar</p>' );
  1766. } );
  1767. it( 'default conversion, collapsed after element, name', () => {
  1768. downcastHelpers.markerToData( { model: 'group' } );
  1769. setModelData( model, '<paragraph>Foobar</paragraph>' );
  1770. model.change( writer => {
  1771. // Collapsed before <paragraph>.
  1772. const range = writer.createRange(
  1773. writer.createPositionFromPath( root, [ 1 ] )
  1774. );
  1775. writer.addMarker( 'group:foo:bar:baz', { range, usingOperation: false } );
  1776. } );
  1777. expectResult( '<p data-group-end-after="foo:bar:baz" data-group-start-after="foo:bar:baz">Foobar</p>' );
  1778. model.change( writer => {
  1779. writer.removeMarker( 'group:foo:bar:baz' );
  1780. } );
  1781. expectResult( '<p>Foobar</p>' );
  1782. } );
  1783. it( 'default conversion, mixed, multiple markers, name', () => {
  1784. downcastHelpers.markerToData( { model: 'group' } );
  1785. setModelData( model, '<paragraph>Foo</paragraph><paragraph>Bar</paragraph>' );
  1786. model.change( writer => {
  1787. const range = writer.createRange(
  1788. writer.createPositionFromPath( root, [ 0 ] ),
  1789. writer.createPositionFromPath( root, [ 1, 2 ] )
  1790. );
  1791. writer.addMarker( 'group:foo:bar', { range, usingOperation: false } );
  1792. writer.addMarker( 'group:abc:xyz', { range, usingOperation: false } );
  1793. } );
  1794. expectResult(
  1795. '<p data-group-start-before="abc:xyz,foo:bar">Foo</p>' +
  1796. '<p>Ba<group-end name="abc:xyz"></group-end><group-end name="foo:bar"></group-end>r</p>'
  1797. );
  1798. model.change( writer => {
  1799. writer.removeMarker( 'group:foo:bar' );
  1800. writer.removeMarker( 'group:abc:xyz' );
  1801. } );
  1802. expectResult( '<p>Foo</p><p>Bar</p>' );
  1803. } );
  1804. it( 'default conversion, mixed #2, multiple markers, name', () => {
  1805. downcastHelpers.markerToData( { model: 'group' } );
  1806. setModelData( model, '<paragraph>Foo</paragraph><paragraph>Bar</paragraph>' );
  1807. model.change( writer => {
  1808. const range = writer.createRange(
  1809. writer.createPositionFromPath( root, [ 0, 1 ] ),
  1810. writer.createPositionFromPath( root, [ 2 ] )
  1811. );
  1812. writer.addMarker( 'group:foo:bar', { range, usingOperation: false } );
  1813. writer.addMarker( 'group:abc:xyz', { range, usingOperation: false } );
  1814. } );
  1815. expectResult(
  1816. '<p>F<group-start name="abc:xyz"></group-start><group-start name="foo:bar"></group-start>oo</p>' +
  1817. '<p data-group-end-after="abc:xyz,foo:bar">Bar</p>'
  1818. );
  1819. model.change( writer => {
  1820. writer.removeMarker( 'group:foo:bar' );
  1821. writer.removeMarker( 'group:abc:xyz' );
  1822. } );
  1823. expectResult( '<p>Foo</p><p>Bar</p>' );
  1824. } );
  1825. it( 'default conversion, mixed #3, multiple markers, name', () => {
  1826. downcastHelpers.markerToData( { model: 'group' } );
  1827. setModelData( model, '<paragraph>Foo</paragraph>' );
  1828. model.change( writer => {
  1829. const range = writer.createRange(
  1830. writer.createPositionFromPath( root, [ 0 ] ),
  1831. writer.createPositionFromPath( root, [ 0, 2 ] )
  1832. );
  1833. writer.addMarker( 'group:foo:bar', { range, usingOperation: false } );
  1834. writer.addMarker( 'group:abc:xyz', { range, usingOperation: false } );
  1835. } );
  1836. expectResult(
  1837. '<p data-group-start-before="abc:xyz,foo:bar">' +
  1838. 'Fo<group-end name="abc:xyz"></group-end><group-end name="foo:bar"></group-end>o' +
  1839. '</p>'
  1840. );
  1841. model.change( writer => {
  1842. writer.removeMarker( 'group:foo:bar' );
  1843. writer.removeMarker( 'group:abc:xyz' );
  1844. } );
  1845. expectResult( '<p>Foo</p>' );
  1846. } );
  1847. it( 'default conversion, mixed #4, multiple markers, name', () => {
  1848. downcastHelpers.markerToData( { model: 'group' } );
  1849. setModelData( model, '<paragraph>Foo</paragraph>' );
  1850. model.change( writer => {
  1851. const range = writer.createRange(
  1852. writer.createPositionFromPath( root, [ 0, 2 ] ),
  1853. writer.createPositionFromPath( root, [ 1 ] )
  1854. );
  1855. writer.addMarker( 'group:foo:bar', { range, usingOperation: false } );
  1856. writer.addMarker( 'group:abc:xyz', { range, usingOperation: false } );
  1857. } );
  1858. expectResult(
  1859. '<p data-group-end-after="abc:xyz,foo:bar">' +
  1860. 'Fo<group-start name="abc:xyz"></group-start><group-start name="foo:bar"></group-start>o' +
  1861. '</p>'
  1862. );
  1863. model.change( writer => {
  1864. writer.removeMarker( 'group:foo:bar' );
  1865. writer.removeMarker( 'group:abc:xyz' );
  1866. } );
  1867. expectResult( '<p>Foo</p>' );
  1868. } );
  1869. it( 'conversion callback, mixed, multiple markers, name', () => {
  1870. const customData = {
  1871. foo: 'bar',
  1872. abc: 'xyz'
  1873. };
  1874. downcastHelpers.markerToData( {
  1875. model: 'group',
  1876. view: ( markerName, conversionApi ) => {
  1877. const namePart = markerName.split( ':' )[ 1 ];
  1878. // To ensure conversion API is provided.
  1879. expect( conversionApi.writer ).to.instanceof( DowncastWriter );
  1880. return {
  1881. group: 'g',
  1882. name: namePart + '_' + customData[ namePart ]
  1883. };
  1884. }
  1885. } );
  1886. setModelData( model, '<paragraph>Foo</paragraph><paragraph>Bar</paragraph>' );
  1887. model.change( writer => {
  1888. const range = writer.createRange(
  1889. writer.createPositionFromPath( root, [ 0 ] ),
  1890. writer.createPositionFromPath( root, [ 1, 2 ] )
  1891. );
  1892. writer.addMarker( 'group:foo', { range, usingOperation: false } );
  1893. writer.addMarker( 'group:abc', { range, usingOperation: false } );
  1894. } );
  1895. expectResult(
  1896. '<p data-g-start-before="abc_xyz,foo_bar">Foo</p>' +
  1897. '<p>Ba<g-end name="abc_xyz"></g-end><g-end name="foo_bar"></g-end>r</p>'
  1898. );
  1899. model.change( writer => {
  1900. writer.removeMarker( 'group:foo' );
  1901. writer.removeMarker( 'group:abc' );
  1902. } );
  1903. expectResult( '<p>Foo</p><p>Bar</p>' );
  1904. } );
  1905. it( 'conversion callback, mixed #2, multiple markers, name', () => {
  1906. const customData = {
  1907. foo: 'bar',
  1908. abc: 'xyz'
  1909. };
  1910. downcastHelpers.markerToData( {
  1911. model: 'group',
  1912. view: markerName => {
  1913. const namePart = markerName.split( ':' )[ 1 ];
  1914. return {
  1915. group: 'g',
  1916. name: namePart + '_' + customData[ namePart ]
  1917. };
  1918. }
  1919. } );
  1920. setModelData( model, '<paragraph>Foo</paragraph><paragraph>Bar</paragraph>' );
  1921. model.change( writer => {
  1922. const range = writer.createRange(
  1923. writer.createPositionFromPath( root, [ 0, 1 ] ),
  1924. writer.createPositionFromPath( root, [ 2 ] )
  1925. );
  1926. writer.addMarker( 'group:foo', { range, usingOperation: false } );
  1927. writer.addMarker( 'group:abc', { range, usingOperation: false } );
  1928. } );
  1929. expectResult(
  1930. '<p>F<g-start name="abc_xyz"></g-start><g-start name="foo_bar"></g-start>oo</p>' +
  1931. '<p data-g-end-after="abc_xyz,foo_bar">Bar</p>'
  1932. );
  1933. model.change( writer => {
  1934. writer.removeMarker( 'group:foo' );
  1935. writer.removeMarker( 'group:abc' );
  1936. } );
  1937. expectResult( '<p>Foo</p><p>Bar</p>' );
  1938. } );
  1939. it( 'can be overwritten using converterPriority', () => {
  1940. downcastHelpers.markerToData( {
  1941. model: 'group'
  1942. } );
  1943. downcastHelpers.markerToData( {
  1944. model: 'group',
  1945. view: markerName => {
  1946. const name = markerName.split( ':' )[ 1 ];
  1947. return {
  1948. group: 'g',
  1949. name
  1950. };
  1951. },
  1952. converterPriority: 'high'
  1953. } );
  1954. setModelData( model, '<paragraph>F[ooba]r</paragraph>' );
  1955. model.change( writer => {
  1956. writer.addMarker( 'group:foo', { range: model.document.selection.getFirstRange(), usingOperation: false } );
  1957. } );
  1958. expectResult(
  1959. '<p>F<g-start name="foo"></g-start>ooba<g-end name="foo"></g-end>r</p>'
  1960. );
  1961. model.change( writer => {
  1962. writer.removeMarker( 'group:foo' );
  1963. } );
  1964. expectResult( '<p>Foobar</p>' );
  1965. } );
  1966. it( 'can be overwritten by custom callback', () => {
  1967. downcastHelpers.markerToData( {
  1968. model: 'group'
  1969. } );
  1970. downcastHelpers.add( dispatcher => {
  1971. dispatcher.on( 'addMarker:group', ( evt, data, conversionApi ) => {
  1972. conversionApi.consumable.consume( data.markerRange, evt.name );
  1973. }, { priority: 'high' } );
  1974. } );
  1975. setModelData( model, '<paragraph>Foo[]bar</paragraph>' );
  1976. model.change( writer => {
  1977. writer.addMarker( 'group:foo', { range: model.document.selection.getFirstRange(), usingOperation: false } );
  1978. } );
  1979. expectResult( '<p>Foobar</p>' );
  1980. model.change( writer => {
  1981. writer.removeMarker( 'group:foo' );
  1982. } );
  1983. expectResult( '<p>Foobar</p>' );
  1984. } );
  1985. it( 'should not perform conversion if the callback returned falsy value', () => {
  1986. downcastHelpers.markerToData( {
  1987. model: 'group',
  1988. view: () => false
  1989. } );
  1990. setModelData( model, '<paragraph>F[ooba]r</paragraph>' );
  1991. model.change( writer => {
  1992. writer.addMarker( 'group:foo', { range: model.document.selection.getFirstRange(), usingOperation: false } );
  1993. } );
  1994. expectResult( '<p>Foobar</p>' );
  1995. model.change( writer => {
  1996. writer.removeMarker( 'group:foo' );
  1997. } );
  1998. expectResult( '<p>Foobar</p>' );
  1999. } );
  2000. } );
  2001. describe( 'markerToHighlight()', () => {
  2002. it( 'should be chainable', () => {
  2003. expect( downcastHelpers.markerToHighlight( { model: 'comment', view: { classes: 'comment' } } ) ).to.equal( downcastHelpers );
  2004. } );
  2005. it( 'config.view is a highlight descriptor', () => {
  2006. downcastHelpers.markerToHighlight( { model: 'comment', view: { classes: 'comment' } } );
  2007. model.change( writer => {
  2008. writer.insertText( 'foo', modelRoot, 0 );
  2009. const range = writer.createRange( writer.createPositionAt( modelRoot, 0 ), writer.createPositionAt( modelRoot, 3 ) );
  2010. writer.addMarker( 'comment', { range, usingOperation: false } );
  2011. } );
  2012. expectResult( '<span class="comment">foo</span>' );
  2013. } );
  2014. it( 'can be overwritten using converterPriority', () => {
  2015. downcastHelpers.markerToHighlight( { model: 'comment', view: { classes: 'comment' } } );
  2016. downcastHelpers.markerToHighlight( { model: 'comment', view: { classes: 'new-comment' }, converterPriority: 'high' } );
  2017. model.change( writer => {
  2018. writer.insertText( 'foo', modelRoot, 0 );
  2019. const range = writer.createRange( writer.createPositionAt( modelRoot, 0 ), writer.createPositionAt( modelRoot, 3 ) );
  2020. writer.addMarker( 'comment', { range, usingOperation: false } );
  2021. } );
  2022. expectResult( '<span class="new-comment">foo</span>' );
  2023. } );
  2024. it( 'config.view is a function', () => {
  2025. downcastHelpers.markerToHighlight( {
  2026. model: 'comment',
  2027. view: ( data, conversionApi ) => {
  2028. const commentType = data.markerName.split( ':' )[ 1 ];
  2029. // To ensure conversion API is provided.
  2030. expect( conversionApi.writer ).to.instanceof( DowncastWriter );
  2031. return {
  2032. classes: [ 'comment', 'comment-' + commentType ]
  2033. };
  2034. }
  2035. } );
  2036. model.change( writer => {
  2037. writer.insertText( 'foo', modelRoot, 0 );
  2038. const range = writer.createRange( writer.createPositionAt( modelRoot, 0 ), writer.createPositionAt( modelRoot, 3 ) );
  2039. writer.addMarker( 'comment:abc', { range, usingOperation: false } );
  2040. } );
  2041. expectResult( '<span class="comment comment-abc">foo</span>' );
  2042. } );
  2043. describe( 'highlight', () => {
  2044. const highlightConfig = {
  2045. model: 'marker',
  2046. view: {
  2047. classes: 'highlight-class',
  2048. attributes: { title: 'title' }
  2049. },
  2050. converterPriority: 7
  2051. };
  2052. describe( 'on text', () => {
  2053. let markerRange;
  2054. beforeEach( () => {
  2055. downcastHelpers.elementToElement( { model: 'paragraph', view: 'p' } );
  2056. const modelElement1 = new ModelElement( 'paragraph', null, new ModelText( 'foo' ) );
  2057. const modelElement2 = new ModelElement( 'paragraph', null, new ModelText( 'bar' ) );
  2058. model.change( writer => {
  2059. writer.insert( [ modelElement1, modelElement2 ], modelRootStart );
  2060. } );
  2061. markerRange = model.createRangeIn( modelRoot );
  2062. } );
  2063. it( 'should wrap and unwrap text nodes', () => {
  2064. downcastHelpers.markerToHighlight( highlightConfig );
  2065. model.change( writer => {
  2066. writer.addMarker( 'marker', { range: markerRange, usingOperation: false } );
  2067. } );
  2068. expect( viewToString( viewRoot ) ).to.equal(
  2069. '<div>' +
  2070. '<p>' +
  2071. '<span class="highlight-class" title="title">foo</span>' +
  2072. '</p>' +
  2073. '<p>' +
  2074. '<span class="highlight-class" title="title">bar</span>' +
  2075. '</p>' +
  2076. '</div>'
  2077. );
  2078. model.change( writer => {
  2079. writer.removeMarker( 'marker' );
  2080. } );
  2081. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foo</p><p>bar</p></div>' );
  2082. } );
  2083. it( 'should be possible to overwrite', () => {
  2084. downcastHelpers.markerToHighlight( highlightConfig );
  2085. downcastHelpers.markerToHighlight( {
  2086. model: 'marker',
  2087. view: { classes: 'override-class' },
  2088. converterPriority: 'high'
  2089. } );
  2090. model.change( writer => {
  2091. writer.addMarker( 'marker', { range: markerRange, usingOperation: false } );
  2092. } );
  2093. expect( viewToString( viewRoot ) ).to.equal(
  2094. '<div>' +
  2095. '<p>' +
  2096. '<span class="override-class">foo</span>' +
  2097. '</p>' +
  2098. '<p>' +
  2099. '<span class="override-class">bar</span>' +
  2100. '</p>' +
  2101. '</div>'
  2102. );
  2103. model.change( writer => {
  2104. writer.removeMarker( 'marker' );
  2105. } );
  2106. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foo</p><p>bar</p></div>' );
  2107. } );
  2108. it( 'should do nothing if descriptor is not provided or generating function returns null', () => {
  2109. downcastHelpers.markerToHighlight( {
  2110. model: 'marker',
  2111. view: () => null,
  2112. converterPriority: 'high'
  2113. } );
  2114. model.change( writer => {
  2115. writer.addMarker( 'marker', { range: markerRange, usingOperation: false } );
  2116. } );
  2117. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foo</p><p>bar</p></div>' );
  2118. model.change( writer => {
  2119. writer.removeMarker( 'marker' );
  2120. } );
  2121. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foo</p><p>bar</p></div>' );
  2122. } );
  2123. it( 'should do nothing if collapsed marker is converted', () => {
  2124. downcastHelpers.markerToHighlight( {
  2125. model: 'marker',
  2126. view: { classes: 'foo' },
  2127. converterPriority: 'high'
  2128. } );
  2129. markerRange = model.createRange( model.createPositionAt( modelRoot, 0 ), model.createPositionAt( modelRoot, 0 ) );
  2130. model.change( writer => {
  2131. writer.addMarker( 'marker', { range: markerRange, usingOperation: false } );
  2132. } );
  2133. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foo</p><p>bar</p></div>' );
  2134. model.change( () => {
  2135. model.markers._remove( 'marker' );
  2136. } );
  2137. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foo</p><p>bar</p></div>' );
  2138. } );
  2139. it( 'should correctly wrap and unwrap multiple, intersecting markers', () => {
  2140. downcastHelpers.markerToHighlight( {
  2141. model: 'markerFoo',
  2142. view: { classes: 'foo' }
  2143. } );
  2144. downcastHelpers.markerToHighlight( {
  2145. model: 'markerBar',
  2146. view: { classes: 'bar' }
  2147. } );
  2148. downcastHelpers.markerToHighlight( {
  2149. model: 'markerXyz',
  2150. view: { classes: 'xyz' }
  2151. } );
  2152. const p1 = modelRoot.getChild( 0 );
  2153. const p2 = modelRoot.getChild( 1 );
  2154. model.change( writer => {
  2155. const range = writer.createRange( writer.createPositionAt( p1, 0 ), writer.createPositionAt( p1, 3 ) );
  2156. writer.addMarker( 'markerFoo', { range, usingOperation: false } );
  2157. } );
  2158. expect( viewToString( viewRoot ) ).to.equal(
  2159. '<div>' +
  2160. '<p>' +
  2161. '<span class="foo">foo</span>' +
  2162. '</p>' +
  2163. '<p>bar</p>' +
  2164. '</div>'
  2165. );
  2166. model.change( writer => {
  2167. const range = writer.createRange( writer.createPositionAt( p1, 1 ), writer.createPositionAt( p2, 2 ) );
  2168. writer.addMarker( 'markerBar', { range, usingOperation: false } );
  2169. } );
  2170. expect( viewToString( viewRoot ) ).to.equal(
  2171. '<div>' +
  2172. '<p>' +
  2173. '<span class="foo">f</span>' +
  2174. '<span class="bar">' +
  2175. '<span class="foo">oo</span>' +
  2176. '</span>' +
  2177. '</p>' +
  2178. '<p>' +
  2179. '<span class="bar">ba</span>' +
  2180. 'r' +
  2181. '</p>' +
  2182. '</div>'
  2183. );
  2184. model.change( writer => {
  2185. const range = writer.createRange( writer.createPositionAt( p1, 2 ), writer.createPositionAt( p2, 3 ) );
  2186. writer.addMarker( 'markerXyz', { range, usingOperation: false } );
  2187. } );
  2188. expect( viewToString( viewRoot ) ).to.equal(
  2189. '<div>' +
  2190. '<p>' +
  2191. '<span class="foo">f</span>' +
  2192. '<span class="bar">' +
  2193. '<span class="foo">' +
  2194. 'o' +
  2195. '<span class="xyz">o</span>' +
  2196. '</span>' +
  2197. '</span>' +
  2198. '</p>' +
  2199. '<p>' +
  2200. '<span class="bar">' +
  2201. '<span class="xyz">ba</span>' +
  2202. '</span>' +
  2203. '<span class="xyz">r</span>' +
  2204. '</p>' +
  2205. '</div>'
  2206. );
  2207. model.change( writer => {
  2208. writer.removeMarker( 'markerBar' );
  2209. } );
  2210. expect( viewToString( viewRoot ) ).to.equal(
  2211. '<div>' +
  2212. '<p>' +
  2213. '<span class="foo">' +
  2214. 'fo' +
  2215. '<span class="xyz">o</span>' +
  2216. '</span>' +
  2217. '</p>' +
  2218. '<p>' +
  2219. '<span class="xyz">bar</span>' +
  2220. '</p>' +
  2221. '</div>'
  2222. );
  2223. model.change( writer => {
  2224. writer.removeMarker( 'markerFoo' );
  2225. } );
  2226. expect( viewToString( viewRoot ) ).to.equal(
  2227. '<div>' +
  2228. '<p>' +
  2229. 'fo' +
  2230. '<span class="xyz">o</span>' +
  2231. '</p>' +
  2232. '<p>' +
  2233. '<span class="xyz">bar</span>' +
  2234. '</p>' +
  2235. '</div>'
  2236. );
  2237. model.change( writer => {
  2238. writer.removeMarker( 'markerXyz' );
  2239. } );
  2240. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foo</p><p>bar</p></div>' );
  2241. } );
  2242. it( 'should do nothing if marker is applied and removed on empty-ish range', () => {
  2243. downcastHelpers.markerToHighlight( highlightConfig );
  2244. const p1 = modelRoot.getChild( 0 );
  2245. const p2 = modelRoot.getChild( 1 );
  2246. const markerRange = model.createRange( model.createPositionAt( p1, 3 ), model.createPositionAt( p2, 0 ) );
  2247. model.change( writer => {
  2248. writer.addMarker( 'marker', { range: markerRange, usingOperation: false } );
  2249. } );
  2250. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foo</p><p>bar</p></div>' );
  2251. model.change( writer => {
  2252. writer.removeMarker( 'marker', { range: markerRange, usingOperation: false } );
  2253. } );
  2254. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foo</p><p>bar</p></div>' );
  2255. } );
  2256. } );
  2257. describe( 'on element', () => {
  2258. const highlightConfig = {
  2259. model: 'marker',
  2260. view: {
  2261. classes: 'highlight-class',
  2262. attributes: { title: 'title' },
  2263. id: 'customId'
  2264. },
  2265. converterPriority: 7
  2266. };
  2267. let markerRange, viewDocument;
  2268. beforeEach( () => {
  2269. viewDocument = new ViewDocument( new StylesProcessor() );
  2270. downcastHelpers.elementToElement( {
  2271. model: 'div',
  2272. view: () => {
  2273. const viewContainer = new ViewContainerElement( viewDocument, 'div' );
  2274. viewContainer._setCustomProperty( 'addHighlight', ( element, descriptor, writer ) => {
  2275. writer.addClass( descriptor.classes, element );
  2276. } );
  2277. viewContainer._setCustomProperty( 'removeHighlight', ( element, id, writer ) => {
  2278. writer.setAttribute( 'class', '', element );
  2279. } );
  2280. return viewContainer;
  2281. }
  2282. } );
  2283. const modelElement = new ModelElement( 'div', null, new ModelText( 'foo' ) );
  2284. model.change( writer => {
  2285. writer.insert( modelElement, modelRootStart );
  2286. } );
  2287. markerRange = model.createRangeOn( modelElement );
  2288. downcastHelpers.markerToHighlight( highlightConfig );
  2289. } );
  2290. it( 'should use addHighlight and removeHighlight on elements and not convert children nodes', () => {
  2291. model.change( writer => {
  2292. writer.addMarker( 'marker', { range: markerRange, usingOperation: false } );
  2293. } );
  2294. expect( viewToString( viewRoot ) ).to.equal(
  2295. '<div>' +
  2296. '<div class="highlight-class">' +
  2297. 'foo' +
  2298. '</div>' +
  2299. '</div>'
  2300. );
  2301. model.change( writer => {
  2302. writer.removeMarker( 'marker' );
  2303. } );
  2304. expect( viewToString( viewRoot ) ).to.equal( '<div><div>foo</div></div>' );
  2305. } );
  2306. it( 'should be possible to override', () => {
  2307. downcastHelpers.markerToHighlight( {
  2308. model: 'marker',
  2309. view: { classes: 'override-class' },
  2310. converterPriority: 'high'
  2311. } );
  2312. model.change( writer => {
  2313. writer.addMarker( 'marker', { range: markerRange, usingOperation: false } );
  2314. } );
  2315. expect( viewToString( viewRoot ) ).to.equal(
  2316. '<div>' +
  2317. '<div class="override-class">' +
  2318. 'foo' +
  2319. '</div>' +
  2320. '</div>'
  2321. );
  2322. model.change( writer => {
  2323. writer.removeMarker( 'marker' );
  2324. } );
  2325. expect( viewToString( viewRoot ) ).to.equal( '<div><div>foo</div></div>' );
  2326. } );
  2327. it( 'should use default priority and id if not provided', () => {
  2328. const viewDiv = viewRoot.getChild( 0 );
  2329. downcastHelpers.markerToHighlight( {
  2330. model: 'marker2',
  2331. view: () => null,
  2332. converterPriority: 'high'
  2333. } );
  2334. viewDiv._setCustomProperty( 'addHighlight', ( element, descriptor ) => {
  2335. expect( descriptor.priority ).to.equal( ViewAttributeElement.DEFAULT_PRIORITY );
  2336. expect( descriptor.id ).to.equal( 'marker:foo-bar-baz' );
  2337. } );
  2338. viewDiv._setCustomProperty( 'removeHighlight', ( element, id ) => {
  2339. expect( id ).to.equal( 'marker:foo-bar-baz' );
  2340. } );
  2341. model.change( writer => {
  2342. writer.addMarker( 'marker2', { range: markerRange, usingOperation: false } );
  2343. } );
  2344. } );
  2345. it( 'should do nothing if descriptor is not provided', () => {
  2346. downcastHelpers.markerToHighlight( {
  2347. model: 'marker2',
  2348. view: () => null
  2349. } );
  2350. model.change( writer => {
  2351. writer.addMarker( 'marker2', { range: markerRange, usingOperation: false } );
  2352. } );
  2353. expect( viewToString( viewRoot ) ).to.equal( '<div><div>foo</div></div>' );
  2354. model.change( writer => {
  2355. writer.removeMarker( 'marker2' );
  2356. } );
  2357. expect( viewToString( viewRoot ) ).to.equal( '<div><div>foo</div></div>' );
  2358. } );
  2359. } );
  2360. } );
  2361. } );
  2362. function expectResult( string ) {
  2363. expect( stringifyView( viewRoot, null, { ignoreRoot: true } ) ).to.equal( string );
  2364. }
  2365. } );
  2366. describe( 'downcast converters', () => {
  2367. let dispatcher, modelDoc, modelRoot, viewRoot, controller, modelRootStart, model;
  2368. beforeEach( () => {
  2369. model = new Model();
  2370. modelDoc = model.document;
  2371. modelRoot = modelDoc.createRoot();
  2372. controller = new EditingController( model, new StylesProcessor() );
  2373. viewRoot = controller.view.document.getRoot();
  2374. // Set name of view root the same as dom root.
  2375. // This is a mock of attaching view root to dom root.
  2376. controller.view.document.getRoot()._name = 'div';
  2377. dispatcher = controller.downcastDispatcher;
  2378. const downcastHelpers = new DowncastHelpers( [ dispatcher ] );
  2379. downcastHelpers.elementToElement( { model: 'paragraph', view: 'p' } );
  2380. modelRootStart = model.createPositionAt( modelRoot, 0 );
  2381. } );
  2382. describe( 'insertText()', () => {
  2383. it( 'should downcast text', () => {
  2384. model.change( writer => {
  2385. writer.insert( new ModelText( 'foobar' ), modelRootStart );
  2386. } );
  2387. expect( viewToString( viewRoot ) ).to.equal( '<div>foobar</div>' );
  2388. } );
  2389. it( 'should support unicode', () => {
  2390. model.change( writer => {
  2391. writer.insert( new ModelText( 'நிலைக்கு' ), modelRootStart );
  2392. } );
  2393. expect( viewToString( viewRoot ) ).to.equal( '<div>நிலைக்கு</div>' );
  2394. } );
  2395. it( 'should be possible to override it', () => {
  2396. dispatcher.on( 'insert:$text', ( evt, data, conversionApi ) => {
  2397. conversionApi.consumable.consume( data.item, 'insert' );
  2398. }, { converterPriority: 'high' } );
  2399. model.change( writer => {
  2400. writer.insert( new ModelText( 'foobar' ), modelRootStart );
  2401. } );
  2402. expect( viewToString( viewRoot ) ).to.equal( '<div></div>' );
  2403. } );
  2404. } );
  2405. // Remove converter is by default already added in `EditingController` instance.
  2406. describe( 'remove()', () => {
  2407. let viewDocument;
  2408. beforeEach( () => {
  2409. viewDocument = new ViewDocument( new StylesProcessor() );
  2410. } );
  2411. it( 'should remove items from view accordingly to changes in model #1', () => {
  2412. const modelElement = new ModelElement( 'paragraph', null, new ModelText( 'foobar' ) );
  2413. model.change( writer => {
  2414. writer.insert( modelElement, modelRootStart );
  2415. } );
  2416. model.change( writer => {
  2417. writer.remove(
  2418. writer.createRange( writer.createPositionAt( modelElement, 2 ), writer.createPositionAt( modelElement, 4 ) )
  2419. );
  2420. } );
  2421. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foar</p></div>' );
  2422. } );
  2423. it( 'should be possible to overwrite', () => {
  2424. dispatcher.on( 'remove', evt => evt.stop(), { priority: 'high' } );
  2425. const modelElement = new ModelElement( 'paragraph', null, new ModelText( 'foobar' ) );
  2426. model.change( writer => {
  2427. writer.insert( modelElement, modelRootStart );
  2428. } );
  2429. model.change( writer => {
  2430. writer.remove(
  2431. writer.createRange( writer.createPositionAt( modelElement, 2 ), writer.createPositionAt( modelElement, 4 ) )
  2432. );
  2433. } );
  2434. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  2435. } );
  2436. it( 'should support unicode', () => {
  2437. const modelElement = new ModelElement( 'paragraph', null, 'நிலைக்கு' );
  2438. model.change( writer => {
  2439. writer.insert( modelElement, modelRootStart );
  2440. } );
  2441. model.change( writer => {
  2442. writer.remove(
  2443. writer.createRange( writer.createPositionAt( modelElement, 0 ), writer.createPositionAt( modelElement, 6 ) )
  2444. );
  2445. } );
  2446. expect( viewToString( viewRoot ) ).to.equal( '<div><p>கு</p></div>' );
  2447. } );
  2448. it( 'should not remove view ui elements that are placed next to removed content', () => {
  2449. modelRoot._appendChild( new ModelText( 'fozbar' ) );
  2450. viewRoot._appendChild( [
  2451. new ViewText( viewDocument, 'foz' ),
  2452. new ViewUIElement( viewDocument, 'span' ),
  2453. new ViewText( viewDocument, 'bar' )
  2454. ] );
  2455. // Remove 'b'.
  2456. model.change( writer => {
  2457. writer.remove(
  2458. writer.createRange( writer.createPositionAt( modelRoot, 3 ), writer.createPositionAt( modelRoot, 4 ) )
  2459. );
  2460. } );
  2461. expect( viewToString( viewRoot ) ).to.equal( '<div>foz<span></span>ar</div>' );
  2462. // Remove 'z'.
  2463. model.change( writer => {
  2464. writer.remove(
  2465. writer.createRange( writer.createPositionAt( modelRoot, 2 ), writer.createPositionAt( modelRoot, 3 ) )
  2466. );
  2467. } );
  2468. expect( viewToString( viewRoot ) ).to.equal( '<div>fo<span></span>ar</div>' );
  2469. } );
  2470. it( 'should remove correct amount of text when it is split by view ui element', () => {
  2471. modelRoot._appendChild( new ModelText( 'fozbar' ) );
  2472. viewRoot._appendChild( [
  2473. new ViewText( viewDocument, 'foz' ),
  2474. new ViewUIElement( viewDocument, 'span' ),
  2475. new ViewText( viewDocument, 'bar' )
  2476. ] );
  2477. // Remove 'z<span></span>b'.
  2478. model.change( writer => {
  2479. writer.remove(
  2480. writer.createRange( writer.createPositionAt( modelRoot, 2 ), writer.createPositionAt( modelRoot, 4 ) )
  2481. );
  2482. } );
  2483. expect( viewToString( viewRoot ) ).to.equal( '<div>foar</div>' );
  2484. } );
  2485. it( 'should unbind elements', () => {
  2486. const modelElement = new ModelElement( 'paragraph' );
  2487. model.change( writer => {
  2488. writer.insert( modelElement, modelRootStart );
  2489. } );
  2490. const viewElement = controller.mapper.toViewElement( modelElement );
  2491. expect( viewElement ).not.to.be.undefined;
  2492. expect( controller.mapper.toModelElement( viewElement ) ).to.equal( modelElement );
  2493. model.change( writer => {
  2494. writer.remove( modelElement );
  2495. } );
  2496. expect( controller.mapper.toViewElement( modelElement ) ).to.be.undefined;
  2497. expect( controller.mapper.toModelElement( viewElement ) ).to.be.undefined;
  2498. } );
  2499. it( 'should not break when remove() is used as part of unwrapping', () => {
  2500. const modelP = new ModelElement( 'paragraph', null, new ModelText( 'foo' ) );
  2501. const modelWidget = new ModelElement( 'widget', null, modelP );
  2502. const downcastHelpers = new DowncastHelpers( [ dispatcher ] );
  2503. downcastHelpers.elementToElement( { model: 'widget', view: 'widget' } );
  2504. model.change( writer => {
  2505. writer.insert( modelWidget, modelRootStart );
  2506. } );
  2507. expect( viewToString( viewRoot ) ).to.equal( '<div><widget><p>foo</p></widget></div>' );
  2508. const viewP = controller.mapper.toViewElement( modelP );
  2509. expect( viewP ).not.to.be.undefined;
  2510. model.change( writer => {
  2511. writer.unwrap( modelWidget );
  2512. } );
  2513. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foo</p></div>' );
  2514. // `modelP` is now bound with newly created view element.
  2515. expect( controller.mapper.toViewElement( modelP ) ).not.to.equal( viewP );
  2516. // `viewP` is no longer bound with model element.
  2517. expect( controller.mapper.toModelElement( viewP ) ).to.be.undefined;
  2518. // View element from view root is bound to `modelP`.
  2519. expect( controller.mapper.toModelElement( viewRoot.getChild( 0 ) ) ).to.equal( modelP );
  2520. } );
  2521. it( 'should work correctly if container element after ui element is removed', () => {
  2522. // Prepare a model and view structure.
  2523. // This is done outside of conversion to put view ui elements inside easily.
  2524. const modelP1 = new ModelElement( 'paragraph' );
  2525. const modelP2 = new ModelElement( 'paragraph' );
  2526. const viewP1 = new ViewContainerElement( viewDocument, 'p' );
  2527. const viewUi1 = new ViewUIElement( viewDocument, 'span' );
  2528. const viewUi2 = new ViewUIElement( viewDocument, 'span' );
  2529. const viewP2 = new ViewContainerElement( viewDocument, 'p' );
  2530. modelRoot._appendChild( [ modelP1, modelP2 ] );
  2531. viewRoot._appendChild( [ viewP1, viewUi1, viewUi2, viewP2 ] );
  2532. controller.mapper.bindElements( modelP1, viewP1 );
  2533. controller.mapper.bindElements( modelP2, viewP2 );
  2534. // Remove second paragraph element.
  2535. model.change( writer => {
  2536. writer.remove( writer.createRange( writer.createPositionAt( modelRoot, 1 ), writer.createPositionAt( modelRoot, 2 ) ) );
  2537. } );
  2538. expect( viewToString( viewRoot ) ).to.equal( '<div><p></p><span></span><span></span></div>' );
  2539. } );
  2540. it( 'should work correctly if container element after text node is removed', () => {
  2541. const modelText = new ModelText( 'foo' );
  2542. const modelP = new ModelElement( 'paragraph' );
  2543. model.change( writer => {
  2544. writer.insert( [ modelText, modelP ], modelRootStart );
  2545. } );
  2546. model.change( writer => {
  2547. writer.remove( modelP );
  2548. } );
  2549. expect( viewToString( viewRoot ) ).to.equal( '<div>foo</div>' );
  2550. } );
  2551. } );
  2552. describe( 'createViewElementFromHighlightDescriptor()', () => {
  2553. let viewWriter;
  2554. beforeEach( () => {
  2555. viewWriter = new DowncastWriter( controller.view.document );
  2556. } );
  2557. it( 'should return attribute element from descriptor object', () => {
  2558. const descriptor = {
  2559. classes: 'foo-class',
  2560. attributes: { one: '1', two: '2' },
  2561. priority: 7
  2562. };
  2563. const element = createViewElementFromHighlightDescriptor( viewWriter, descriptor );
  2564. expect( element.is( 'attributeElement' ) ).to.be.true;
  2565. expect( element.name ).to.equal( 'span' );
  2566. expect( element.priority ).to.equal( 7 );
  2567. expect( element.hasClass( 'foo-class' ) ).to.be.true;
  2568. for ( const key of Object.keys( descriptor.attributes ) ) {
  2569. expect( element.getAttribute( key ) ).to.equal( descriptor.attributes[ key ] );
  2570. }
  2571. } );
  2572. it( 'should return attribute element from descriptor object - array with classes', () => {
  2573. const descriptor = {
  2574. classes: [ 'foo-class', 'bar-class' ],
  2575. attributes: { one: '1', two: '2' },
  2576. priority: 7
  2577. };
  2578. const element = createViewElementFromHighlightDescriptor( viewWriter, descriptor );
  2579. expect( element.is( 'attributeElement' ) ).to.be.true;
  2580. expect( element.name ).to.equal( 'span' );
  2581. expect( element.priority ).to.equal( 7 );
  2582. expect( element.hasClass( 'foo-class' ) ).to.be.true;
  2583. expect( element.hasClass( 'bar-class' ) ).to.be.true;
  2584. for ( const key of Object.keys( descriptor.attributes ) ) {
  2585. expect( element.getAttribute( key ) ).to.equal( descriptor.attributes[ key ] );
  2586. }
  2587. } );
  2588. it( 'should create element without class', () => {
  2589. const descriptor = {
  2590. attributes: { one: '1', two: '2' },
  2591. priority: 7
  2592. };
  2593. const element = createViewElementFromHighlightDescriptor( viewWriter, descriptor );
  2594. expect( element.is( 'attributeElement' ) ).to.be.true;
  2595. expect( element.name ).to.equal( 'span' );
  2596. expect( element.priority ).to.equal( 7 );
  2597. for ( const key of Object.keys( descriptor.attributes ) ) {
  2598. expect( element.getAttribute( key ) ).to.equal( descriptor.attributes[ key ] );
  2599. }
  2600. } );
  2601. it( 'should create element without priority', () => {
  2602. const descriptor = {
  2603. classes: 'foo-class',
  2604. attributes: { one: '1', two: '2' }
  2605. };
  2606. const element = createViewElementFromHighlightDescriptor( viewWriter, descriptor );
  2607. expect( element.is( 'attributeElement' ) ).to.be.true;
  2608. expect( element.name ).to.equal( 'span' );
  2609. expect( element.priority ).to.equal( ViewAttributeElement.DEFAULT_PRIORITY );
  2610. expect( element.hasClass( 'foo-class' ) ).to.be.true;
  2611. for ( const key of Object.keys( descriptor.attributes ) ) {
  2612. expect( element.getAttribute( key ) ).to.equal( descriptor.attributes[ key ] );
  2613. }
  2614. } );
  2615. it( 'should create element without attributes', () => {
  2616. const descriptor = {
  2617. classes: 'foo-class',
  2618. priority: 7
  2619. };
  2620. const element = createViewElementFromHighlightDescriptor( viewWriter, descriptor );
  2621. expect( element.is( 'attributeElement' ) ).to.be.true;
  2622. expect( element.name ).to.equal( 'span' );
  2623. expect( element.priority ).to.equal( 7 );
  2624. expect( element.hasClass( 'foo-class' ) ).to.be.true;
  2625. } );
  2626. } );
  2627. } );
  2628. describe( 'downcast selection converters', () => {
  2629. let dispatcher, mapper, model, view, modelDoc, modelRoot, docSelection, viewDoc, viewRoot, viewSelection, downcastHelpers;
  2630. beforeEach( () => {
  2631. model = new Model();
  2632. modelDoc = model.document;
  2633. modelRoot = modelDoc.createRoot();
  2634. docSelection = modelDoc.selection;
  2635. model.schema.extend( '$text', { allowIn: '$root' } );
  2636. view = new View( new StylesProcessor() );
  2637. viewDoc = view.document;
  2638. viewRoot = createViewRoot( viewDoc );
  2639. viewSelection = viewDoc.selection;
  2640. mapper = new Mapper();
  2641. mapper.bindElements( modelRoot, viewRoot );
  2642. dispatcher = new DowncastDispatcher( { mapper, viewSelection } );
  2643. dispatcher.on( 'insert:$text', insertText() );
  2644. downcastHelpers = new DowncastHelpers( [ dispatcher ] );
  2645. downcastHelpers.attributeToElement( { model: 'bold', view: 'strong' } );
  2646. downcastHelpers.markerToHighlight( { model: 'marker', view: { classes: 'marker' }, converterPriority: 1 } );
  2647. // Default selection converters.
  2648. dispatcher.on( 'selection', clearAttributes(), { priority: 'low' } );
  2649. dispatcher.on( 'selection', convertRangeSelection(), { priority: 'low' } );
  2650. dispatcher.on( 'selection', convertCollapsedSelection(), { priority: 'low' } );
  2651. } );
  2652. afterEach( () => {
  2653. view.destroy();
  2654. } );
  2655. describe( 'default converters', () => {
  2656. describe( 'range selection', () => {
  2657. it( 'in same container', () => {
  2658. testSelection(
  2659. [ 1, 4 ],
  2660. 'foobar',
  2661. 'f{oob}ar'
  2662. );
  2663. } );
  2664. it( 'in same container with unicode characters', () => {
  2665. testSelection(
  2666. [ 2, 6 ],
  2667. 'நிலைக்கு',
  2668. 'நி{லைக்}கு'
  2669. );
  2670. } );
  2671. it( 'in same container, over attribute', () => {
  2672. testSelection(
  2673. [ 1, 5 ],
  2674. 'fo<$text bold="true">ob</$text>ar',
  2675. 'f{o<strong>ob</strong>a}r'
  2676. );
  2677. } );
  2678. it( 'in same container, next to attribute', () => {
  2679. testSelection(
  2680. [ 1, 2 ],
  2681. 'fo<$text bold="true">ob</$text>ar',
  2682. 'f{o}<strong>ob</strong>ar'
  2683. );
  2684. } );
  2685. it( 'in same attribute', () => {
  2686. testSelection(
  2687. [ 2, 4 ],
  2688. 'f<$text bold="true">ooba</$text>r',
  2689. 'f<strong>o{ob}a</strong>r'
  2690. );
  2691. } );
  2692. it( 'in same attribute, selection same as attribute', () => {
  2693. testSelection(
  2694. [ 2, 4 ],
  2695. 'fo<$text bold="true">ob</$text>ar',
  2696. 'fo{<strong>ob</strong>}ar'
  2697. );
  2698. } );
  2699. it( 'starts in text node, ends in attribute #1', () => {
  2700. testSelection(
  2701. [ 1, 3 ],
  2702. 'fo<$text bold="true">ob</$text>ar',
  2703. 'f{o<strong>o}b</strong>ar'
  2704. );
  2705. } );
  2706. it( 'starts in text node, ends in attribute #2', () => {
  2707. testSelection(
  2708. [ 1, 4 ],
  2709. 'fo<$text bold="true">ob</$text>ar',
  2710. 'f{o<strong>ob</strong>}ar'
  2711. );
  2712. } );
  2713. it( 'starts in attribute, ends in text node', () => {
  2714. testSelection(
  2715. [ 3, 5 ],
  2716. 'fo<$text bold="true">ob</$text>ar',
  2717. 'fo<strong>o{b</strong>a}r'
  2718. );
  2719. } );
  2720. it( 'consumes consumable values properly', () => {
  2721. // Add callback that will fire before default ones.
  2722. // This should prevent default callback doing anything.
  2723. dispatcher.on( 'selection', ( evt, data, conversionApi ) => {
  2724. expect( conversionApi.consumable.consume( data.selection, 'selection' ) ).to.be.true;
  2725. }, { priority: 'high' } );
  2726. // Similar test case as the first in this suite.
  2727. testSelection(
  2728. [ 1, 4 ],
  2729. 'foobar',
  2730. 'foobar' // No selection in view.
  2731. );
  2732. } );
  2733. it( 'should convert backward selection', () => {
  2734. testSelection(
  2735. [ 1, 3, 'backward' ],
  2736. 'foobar',
  2737. 'f{oo}bar'
  2738. );
  2739. expect( viewSelection.focus.offset ).to.equal( 1 );
  2740. } );
  2741. } );
  2742. describe( 'collapsed selection', () => {
  2743. let marker, viewDocument;
  2744. beforeEach( () => {
  2745. viewDocument = new ViewDocument( new StylesProcessor() );
  2746. } );
  2747. it( 'in container', () => {
  2748. testSelection(
  2749. [ 1, 1 ],
  2750. 'foobar',
  2751. 'f{}oobar'
  2752. );
  2753. } );
  2754. it( 'in attribute', () => {
  2755. testSelection(
  2756. [ 3, 3 ],
  2757. 'f<$text bold="true">ooba</$text>r',
  2758. 'f<strong>oo{}ba</strong>r'
  2759. );
  2760. } );
  2761. it( 'in attribute and marker', () => {
  2762. setModelData( model, 'fo<$text bold="true">ob</$text>ar' );
  2763. model.change( writer => {
  2764. const range = writer.createRange( writer.createPositionAt( modelRoot, 1 ), writer.createPositionAt( modelRoot, 5 ) );
  2765. marker = writer.addMarker( 'marker', { range, usingOperation: false } );
  2766. writer.setSelection( modelRoot, 3 );
  2767. } );
  2768. // Remove view children manually (without firing additional conversion).
  2769. viewRoot._removeChildren( 0, viewRoot.childCount );
  2770. // Convert model to view.
  2771. view.change( writer => {
  2772. dispatcher.convertInsert( model.createRangeIn( modelRoot ), writer );
  2773. dispatcher.convertMarkerAdd( marker.name, marker.getRange(), writer );
  2774. dispatcher.convertSelection( docSelection, model.markers, writer );
  2775. } );
  2776. // Stringify view and check if it is same as expected.
  2777. expect( stringifyView( viewRoot, viewSelection, { showType: false } ) ).to.equal(
  2778. '<div>f<span class="marker">o<strong>o{}b</strong>a</span>r</div>'
  2779. );
  2780. } );
  2781. it( 'in attribute and marker - no attribute', () => {
  2782. setModelData( model, 'fo<$text bold="true">ob</$text>ar' );
  2783. model.change( writer => {
  2784. const range = writer.createRange( writer.createPositionAt( modelRoot, 1 ), writer.createPositionAt( modelRoot, 5 ) );
  2785. marker = writer.addMarker( 'marker', { range, usingOperation: false } );
  2786. writer.setSelection( modelRoot, 3 );
  2787. writer.removeSelectionAttribute( 'bold' );
  2788. } );
  2789. // Remove view children manually (without firing additional conversion).
  2790. viewRoot._removeChildren( 0, viewRoot.childCount );
  2791. // Convert model to view.
  2792. view.change( writer => {
  2793. dispatcher.convertInsert( model.createRangeIn( modelRoot ), writer );
  2794. dispatcher.convertMarkerAdd( marker.name, marker.getRange(), writer );
  2795. dispatcher.convertSelection( docSelection, model.markers, writer );
  2796. } );
  2797. // Stringify view and check if it is same as expected.
  2798. expect( stringifyView( viewRoot, viewSelection, { showType: false } ) )
  2799. .to.equal( '<div>f<span class="marker">o<strong>o</strong>[]<strong>b</strong>a</span>r</div>' );
  2800. } );
  2801. it( 'in marker - using highlight descriptor creator', () => {
  2802. downcastHelpers.markerToHighlight( {
  2803. model: 'marker2',
  2804. view: data => ( { classes: data.markerName } )
  2805. } );
  2806. setModelData( model, 'foobar' );
  2807. model.change( writer => {
  2808. const range = writer.createRange( writer.createPositionAt( modelRoot, 1 ), writer.createPositionAt( modelRoot, 5 ) );
  2809. marker = writer.addMarker( 'marker2', { range, usingOperation: false } );
  2810. writer.setSelection( modelRoot, 3 );
  2811. } );
  2812. // Remove view children manually (without firing additional conversion).
  2813. viewRoot._removeChildren( 0, viewRoot.childCount );
  2814. // Convert model to view.
  2815. view.change( writer => {
  2816. dispatcher.convertInsert( model.createRangeIn( modelRoot ), writer );
  2817. dispatcher.convertMarkerAdd( marker.name, marker.getRange(), writer );
  2818. dispatcher.convertSelection( docSelection, model.markers, writer );
  2819. } );
  2820. // Stringify view and check if it is same as expected.
  2821. expect( stringifyView( viewRoot, viewSelection, { showType: false } ) )
  2822. .to.equal( '<div>f<span class="marker2">oo{}ba</span>r</div>' );
  2823. } );
  2824. it( 'should do nothing if creator return null', () => {
  2825. downcastHelpers.markerToHighlight( {
  2826. model: 'marker3',
  2827. view: () => null
  2828. } );
  2829. setModelData( model, 'foobar' );
  2830. model.change( writer => {
  2831. const range = writer.createRange( writer.createPositionAt( modelRoot, 1 ), writer.createPositionAt( modelRoot, 5 ) );
  2832. marker = writer.addMarker( 'marker3', { range, usingOperation: false } );
  2833. writer.setSelection( modelRoot, 3 );
  2834. } );
  2835. // Remove view children manually (without firing additional conversion).
  2836. viewRoot._removeChildren( 0, viewRoot.childCount );
  2837. // Convert model to view.
  2838. view.change( writer => {
  2839. dispatcher.convertInsert( model.createRangeIn( modelRoot ), writer );
  2840. dispatcher.convertMarkerAdd( marker.name, marker.getRange(), writer );
  2841. dispatcher.convertSelection( docSelection, model.markers, writer );
  2842. } );
  2843. // Stringify view and check if it is same as expected.
  2844. expect( stringifyView( viewRoot, viewSelection, { showType: false } ) )
  2845. .to.equal( '<div>foo{}bar</div>' );
  2846. } );
  2847. // #1072 - if the container has only ui elements, collapsed selection attribute should be rendered after those ui elements.
  2848. it( 'selection with attribute before ui element - no non-ui children', () => {
  2849. setModelData( model, '' );
  2850. // Add two ui elements to view.
  2851. viewRoot._appendChild( [
  2852. new ViewUIElement( viewDocument, 'span' ),
  2853. new ViewUIElement( viewDocument, 'span' )
  2854. ] );
  2855. model.change( writer => {
  2856. writer.setSelection( writer.createRange( writer.createPositionFromPath( modelRoot, [ 0 ] ) ) );
  2857. writer.setSelectionAttribute( 'bold', true );
  2858. } );
  2859. // Convert model to view.
  2860. view.change( writer => {
  2861. dispatcher.convertSelection( docSelection, model.markers, writer );
  2862. } );
  2863. // Stringify view and check if it is same as expected.
  2864. expect( stringifyView( viewRoot, viewSelection, { showType: false } ) )
  2865. .to.equal( '<div><span></span><span></span><strong>[]</strong></div>' );
  2866. } );
  2867. // #1072.
  2868. it( 'selection with attribute before ui element - has non-ui children #1', () => {
  2869. setModelData( model, 'x' );
  2870. model.change( writer => {
  2871. writer.setSelection( writer.createRange( writer.createPositionFromPath( modelRoot, [ 1 ] ) ) );
  2872. writer.setSelectionAttribute( 'bold', true );
  2873. } );
  2874. // Convert model to view.
  2875. view.change( writer => {
  2876. dispatcher.convertInsert( model.createRangeIn( modelRoot ), writer );
  2877. // Add ui element to view.
  2878. const uiElement = new ViewUIElement( viewDocument, 'span' );
  2879. viewRoot._insertChild( 1, uiElement );
  2880. dispatcher.convertSelection( docSelection, model.markers, writer );
  2881. } );
  2882. // Stringify view and check if it is same as expected.
  2883. expect( stringifyView( viewRoot, viewSelection, { showType: false } ) )
  2884. .to.equal( '<div>x<strong>[]</strong><span></span></div>' );
  2885. } );
  2886. // #1072.
  2887. it( 'selection with attribute before ui element - has non-ui children #2', () => {
  2888. setModelData( model, '<$text bold="true">x</$text>y' );
  2889. model.change( writer => {
  2890. writer.setSelection( writer.createRange( writer.createPositionFromPath( modelRoot, [ 1 ] ) ) );
  2891. writer.setSelectionAttribute( 'bold', true );
  2892. } );
  2893. // Convert model to view.
  2894. view.change( writer => {
  2895. dispatcher.convertInsert( model.createRangeIn( modelRoot ), writer );
  2896. // Add ui element to view.
  2897. const uiElement = new ViewUIElement( viewDocument, 'span' );
  2898. viewRoot._insertChild( 1, uiElement, writer );
  2899. dispatcher.convertSelection( docSelection, model.markers, writer );
  2900. } );
  2901. // Stringify view and check if it is same as expected.
  2902. expect( stringifyView( viewRoot, viewSelection, { showType: false } ) )
  2903. .to.equal( '<div><strong>x{}</strong><span></span>y</div>' );
  2904. } );
  2905. it( 'consumes consumable values properly', () => {
  2906. // Add callbacks that will fire before default ones.
  2907. // This should prevent default callbacks doing anything.
  2908. dispatcher.on( 'selection', ( evt, data, conversionApi ) => {
  2909. expect( conversionApi.consumable.consume( data.selection, 'selection' ) ).to.be.true;
  2910. }, { priority: 'high' } );
  2911. dispatcher.on( 'attribute:bold', ( evt, data, conversionApi ) => {
  2912. expect( conversionApi.consumable.consume( data.item, 'attribute:bold' ) ).to.be.true;
  2913. }, { priority: 'high' } );
  2914. // Similar test case as above.
  2915. testSelection(
  2916. [ 3, 3 ],
  2917. 'f<$text bold="true">ooba</$text>r',
  2918. 'foobar' // No selection in view and no attribute.
  2919. );
  2920. } );
  2921. } );
  2922. } );
  2923. describe( 'clean-up', () => {
  2924. describe( 'convertRangeSelection', () => {
  2925. it( 'should remove all ranges before adding new range', () => {
  2926. testSelection(
  2927. [ 0, 2 ],
  2928. 'foobar',
  2929. '{fo}obar'
  2930. );
  2931. testSelection(
  2932. [ 3, 5 ],
  2933. 'foobar',
  2934. 'foo{ba}r'
  2935. );
  2936. expect( viewSelection.rangeCount ).to.equal( 1 );
  2937. } );
  2938. } );
  2939. describe( 'convertCollapsedSelection', () => {
  2940. it( 'should remove all ranges before adding new range', () => {
  2941. testSelection(
  2942. [ 2, 2 ],
  2943. 'foobar',
  2944. 'fo{}obar'
  2945. );
  2946. testSelection(
  2947. [ 3, 3 ],
  2948. 'foobar',
  2949. 'foo{}bar'
  2950. );
  2951. expect( viewSelection.rangeCount ).to.equal( 1 );
  2952. } );
  2953. } );
  2954. describe( 'clearAttributes', () => {
  2955. it( 'should remove all ranges before adding new range', () => {
  2956. testSelection(
  2957. [ 3, 3 ],
  2958. 'foobar',
  2959. 'foo<strong>[]</strong>bar',
  2960. { bold: 'true' }
  2961. );
  2962. view.change( writer => {
  2963. const modelRange = model.createRange( model.createPositionAt( modelRoot, 1 ), model.createPositionAt( modelRoot, 1 ) );
  2964. model.change( writer => {
  2965. writer.setSelection( modelRange );
  2966. } );
  2967. dispatcher.convertSelection( modelDoc.selection, model.markers, writer );
  2968. } );
  2969. expect( viewSelection.rangeCount ).to.equal( 1 );
  2970. const viewString = stringifyView( viewRoot, viewSelection, { showType: false } );
  2971. expect( viewString ).to.equal( '<div>f{}oobar</div>' );
  2972. } );
  2973. it( 'should do nothing if the attribute element had been already removed', () => {
  2974. testSelection(
  2975. [ 3, 3 ],
  2976. 'foobar',
  2977. 'foo<strong>[]</strong>bar',
  2978. { bold: 'true' }
  2979. );
  2980. view.change( writer => {
  2981. // Remove <strong></strong> manually.
  2982. writer.mergeAttributes( viewSelection.getFirstPosition() );
  2983. const modelRange = model.createRange( model.createPositionAt( modelRoot, 1 ), model.createPositionAt( modelRoot, 1 ) );
  2984. model.change( writer => {
  2985. writer.setSelection( modelRange );
  2986. } );
  2987. dispatcher.convertSelection( modelDoc.selection, model.markers, writer );
  2988. } );
  2989. expect( viewSelection.rangeCount ).to.equal( 1 );
  2990. const viewString = stringifyView( viewRoot, viewSelection, { showType: false } );
  2991. expect( viewString ).to.equal( '<div>f{}oobar</div>' );
  2992. } );
  2993. it( 'should clear fake selection', () => {
  2994. const modelRange = model.createRange( model.createPositionAt( modelRoot, 1 ), model.createPositionAt( modelRoot, 1 ) );
  2995. view.change( writer => {
  2996. writer.setSelection( modelRange, { fake: true } );
  2997. dispatcher.convertSelection( docSelection, model.markers, writer );
  2998. } );
  2999. expect( viewSelection.isFake ).to.be.false;
  3000. } );
  3001. } );
  3002. } );
  3003. describe( 'table cell selection converter', () => {
  3004. beforeEach( () => {
  3005. model.schema.register( 'table', { isLimit: true } );
  3006. model.schema.register( 'tr', { isLimit: true } );
  3007. model.schema.register( 'td', { isLimit: true } );
  3008. model.schema.extend( 'table', { allowIn: '$root' } );
  3009. model.schema.extend( 'tr', { allowIn: 'table' } );
  3010. model.schema.extend( 'td', { allowIn: 'tr' } );
  3011. model.schema.extend( '$text', { allowIn: 'td' } );
  3012. const downcastHelpers = new DowncastHelpers( [ dispatcher ] );
  3013. // "Universal" converter to convert table structure.
  3014. downcastHelpers.elementToElement( { model: 'table', view: 'table' } );
  3015. downcastHelpers.elementToElement( { model: 'tr', view: 'tr' } );
  3016. downcastHelpers.elementToElement( { model: 'td', view: 'td' } );
  3017. // Special converter for table cells.
  3018. dispatcher.on( 'selection', ( evt, data, conversionApi ) => {
  3019. const selection = data.selection;
  3020. if ( !conversionApi.consumable.test( selection, 'selection' ) || selection.isCollapsed ) {
  3021. return;
  3022. }
  3023. for ( const range of selection.getRanges() ) {
  3024. const node = range.start.parent;
  3025. if ( !!node && node.is( 'element', 'td' ) ) {
  3026. conversionApi.consumable.consume( selection, 'selection' );
  3027. const viewNode = conversionApi.mapper.toViewElement( node );
  3028. conversionApi.writer.addClass( 'selected', viewNode );
  3029. }
  3030. }
  3031. }, { priority: 'high' } );
  3032. } );
  3033. it( 'should not be used to convert selection that is not on table cell', () => {
  3034. testSelection(
  3035. [ 1, 5 ],
  3036. 'f{o<$text bold="true">ob</$text>a}r',
  3037. 'f{o<strong>ob</strong>a}r'
  3038. );
  3039. } );
  3040. it( 'should add a class to the selected table cell', () => {
  3041. testSelection(
  3042. // table tr#0 td#0 [foo, table tr#0 td#0 bar]
  3043. [ [ 0, 0, 0, 0 ], [ 0, 0, 0, 3 ] ],
  3044. '<table><tr><td>foo</td></tr><tr><td>bar</td></tr></table>',
  3045. '<table><tr><td class="selected">foo</td></tr><tr><td>bar</td></tr></table>'
  3046. );
  3047. } );
  3048. it( 'should not be used if selection contains more than just a table cell', () => {
  3049. testSelection(
  3050. // table tr td#1 f{oo bar, table tr#2 bar]
  3051. [ [ 0, 0, 0, 1 ], [ 0, 0, 1, 3 ] ],
  3052. '<table><tr><td>foo</td><td>bar</td></tr></table>',
  3053. '[<table><tr><td>foo</td><td>bar</td></tr></table>]'
  3054. );
  3055. } );
  3056. } );
  3057. // Tests if the selection got correctly converted.
  3058. // Because `setData` might use selection converters itself to set the selection, we can't use it
  3059. // to set the selection (because then we would test converters using converters).
  3060. // Instead, the `test` function expects to be passed `selectionPaths` which is an array containing two numbers or two arrays,
  3061. // that are offsets or paths of selection positions in root element.
  3062. function testSelection( selectionPaths, modelInput, expectedView, selectionAttributes = {} ) {
  3063. // Parse passed `modelInput` string and set it as current model.
  3064. setModelData( model, modelInput );
  3065. // Manually set selection ranges using passed `selectionPaths`.
  3066. const startPath = typeof selectionPaths[ 0 ] == 'number' ? [ selectionPaths[ 0 ] ] : selectionPaths[ 0 ];
  3067. const endPath = typeof selectionPaths[ 1 ] == 'number' ? [ selectionPaths[ 1 ] ] : selectionPaths[ 1 ];
  3068. const startPos = model.createPositionFromPath( modelRoot, startPath );
  3069. const endPos = model.createPositionFromPath( modelRoot, endPath );
  3070. const isBackward = selectionPaths[ 2 ] === 'backward';
  3071. model.change( writer => {
  3072. writer.setSelection( writer.createRange( startPos, endPos ), { backward: isBackward } );
  3073. // And add or remove passed attributes.
  3074. for ( const key in selectionAttributes ) {
  3075. const value = selectionAttributes[ key ];
  3076. if ( value ) {
  3077. writer.setSelectionAttribute( key, value );
  3078. } else {
  3079. writer.removeSelectionAttribute( key );
  3080. }
  3081. }
  3082. } );
  3083. // Remove view children manually (without firing additional conversion).
  3084. viewRoot._removeChildren( 0, viewRoot.childCount );
  3085. // Convert model to view.
  3086. view.change( writer => {
  3087. dispatcher.convertInsert( model.createRangeIn( modelRoot ), writer );
  3088. dispatcher.convertSelection( docSelection, model.markers, writer );
  3089. } );
  3090. // Stringify view and check if it is same as expected.
  3091. expect( stringifyView( viewRoot, viewSelection, { showType: false } ) ).to.equal( '<div>' + expectedView + '</div>' );
  3092. }
  3093. } );
  3094. function viewToString( item ) {
  3095. let result = '';
  3096. if ( item instanceof ViewText ) {
  3097. result = item.data;
  3098. } else {
  3099. // ViewElement or ViewDocumentFragment.
  3100. for ( const child of item.getChildren() ) {
  3101. result += viewToString( child );
  3102. }
  3103. if ( item instanceof ViewElement ) {
  3104. result = '<' + item.name + viewAttributesToString( item ) + '>' + result + '</' + item.name + '>';
  3105. }
  3106. }
  3107. return result;
  3108. }
  3109. function viewAttributesToString( item ) {
  3110. let result = '';
  3111. for ( const key of item.getAttributeKeys() ) {
  3112. const value = item.getAttribute( key );
  3113. if ( value ) {
  3114. result += ' ' + key + '="' + value + '"';
  3115. }
  3116. }
  3117. return result;
  3118. }