renderer.js 155 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371
  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 document, window, NodeFilter, MutationObserver, HTMLImageElement */
  6. import View from '../../src/view/view';
  7. import ViewElement from '../../src/view/element';
  8. import ViewEditableElement from '../../src/view/editableelement';
  9. import ViewContainerElement from '../../src/view/containerelement';
  10. import ViewAttributeElement from '../../src/view/attributeelement';
  11. import ViewText from '../../src/view/text';
  12. import ViewRange from '../../src/view/range';
  13. import ViewPosition from '../../src/view/position';
  14. import UIElement from '../../src/view/uielement';
  15. import DocumentSelection from '../../src/view/documentselection';
  16. import DomConverter from '../../src/view/domconverter';
  17. import Renderer from '../../src/view/renderer';
  18. import DocumentFragment from '../../src/view/documentfragment';
  19. import ViewDocument from '../../src/view/document';
  20. import DowncastWriter from '../../src/view/downcastwriter';
  21. import { parse, stringify, setData as setViewData, getData as getViewData } from '../../src/dev-utils/view';
  22. import { BR_FILLER, INLINE_FILLER, INLINE_FILLER_LENGTH } from '../../src/view/filler';
  23. import testUtils from '@ckeditor/ckeditor5-core/tests/_utils/utils';
  24. import createViewRoot from './_utils/createroot';
  25. import createElement from '@ckeditor/ckeditor5-utils/src/dom/createelement';
  26. import normalizeHtml from '@ckeditor/ckeditor5-utils/tests/_utils/normalizehtml';
  27. import env from '@ckeditor/ckeditor5-utils/src/env';
  28. import { expectToThrowCKEditorError } from '@ckeditor/ckeditor5-utils/tests/_utils/utils';
  29. import { StylesProcessor } from '../../src/view/stylesmap';
  30. describe( 'Renderer', () => {
  31. let selection, domConverter, renderer, viewDocument;
  32. testUtils.createSinonSandbox();
  33. beforeEach( () => {
  34. viewDocument = new ViewDocument( new StylesProcessor() );
  35. selection = new DocumentSelection();
  36. domConverter = new DomConverter( viewDocument );
  37. renderer = new Renderer( domConverter, selection );
  38. renderer.domDocuments.add( document );
  39. } );
  40. describe( 'markToSync', () => {
  41. let viewRoot;
  42. beforeEach( () => {
  43. viewRoot = new ViewElement( viewDocument, 'p' );
  44. const domRoot = document.createElement( 'p' );
  45. domConverter.bindElements( domRoot, viewRoot );
  46. viewRoot._appendChild( new ViewText( viewDocument, 'foo' ) );
  47. renderer.markedTexts.clear();
  48. renderer.markedAttributes.clear();
  49. renderer.markedChildren.clear();
  50. } );
  51. it( 'should mark attributes which need update', () => {
  52. viewRoot._setAttribute( 'class', 'foo' );
  53. renderer.markToSync( 'attributes', viewRoot );
  54. expect( renderer.markedAttributes.has( viewRoot ) ).to.be.true;
  55. } );
  56. it( 'should mark children which need update', () => {
  57. viewRoot._appendChild( new ViewText( viewDocument, 'foo' ) );
  58. renderer.markToSync( 'children', viewRoot );
  59. expect( renderer.markedChildren.has( viewRoot ) ).to.be.true;
  60. } );
  61. it( 'should not mark children if element has no corresponding node', () => {
  62. // Overwrite viewRoot with node without coresponding DOM node.
  63. viewRoot = new ViewElement( viewDocument, 'p' );
  64. viewRoot._appendChild( new ViewText( viewDocument, 'foo' ) );
  65. renderer.markToSync( 'children', viewRoot );
  66. expect( renderer.markedTexts.has( viewRoot ) ).to.be.false;
  67. } );
  68. it( 'should mark text which need update', () => {
  69. const viewText = new ViewText( viewDocument, 'foo' );
  70. viewRoot._appendChild( viewText );
  71. viewText._data = 'bar';
  72. renderer.markToSync( 'text', viewText );
  73. expect( renderer.markedTexts.has( viewText ) ).to.be.true;
  74. } );
  75. it( 'should not mark text if parent has no corresponding node', () => {
  76. const viewText = new ViewText( viewDocument, 'foo' );
  77. // Overwrite viewRoot with node without coresponding DOM node.
  78. viewRoot = new ViewElement( viewDocument, 'p' );
  79. viewRoot._appendChild( viewText );
  80. viewText._data = 'bar';
  81. renderer.markToSync( 'text', viewText );
  82. expect( renderer.markedTexts.has( viewText ) ).to.be.false;
  83. } );
  84. it( 'should throw if the type is unknown', () => {
  85. expectToThrowCKEditorError( () => {
  86. renderer.markToSync( 'UNKNOWN', viewRoot );
  87. }, /^view-renderer-unknown-type/, selection );
  88. } );
  89. } );
  90. describe( 'render', () => {
  91. let viewRoot, domRoot;
  92. beforeEach( () => {
  93. viewRoot = new ViewEditableElement( viewDocument, 'div' );
  94. viewRoot.getFillerOffset = () => null;
  95. domRoot = document.createElement( 'div' );
  96. document.body.appendChild( domRoot );
  97. domConverter.bindElements( domRoot, viewRoot );
  98. renderer.markedTexts.clear();
  99. renderer.markedAttributes.clear();
  100. renderer.markedChildren.clear();
  101. selection._setTo( null );
  102. renderer.isFocused = true;
  103. } );
  104. afterEach( () => {
  105. domRoot.remove();
  106. } );
  107. it( 'should update attributes', () => {
  108. viewRoot._setAttribute( 'class', 'foo' );
  109. renderer.markToSync( 'attributes', viewRoot );
  110. renderer.render();
  111. expect( domRoot.getAttribute( 'class' ) ).to.equal( 'foo' );
  112. expect( renderer.markedAttributes.size ).to.equal( 0 );
  113. } );
  114. it( 'should remove attributes', () => {
  115. viewRoot._setAttribute( 'class', 'foo' );
  116. domRoot.setAttribute( 'id', 'bar' );
  117. domRoot.setAttribute( 'class', 'bar' );
  118. renderer.markToSync( 'attributes', viewRoot );
  119. renderer.render();
  120. expect( domRoot.getAttribute( 'class' ) ).to.equal( 'foo' );
  121. expect( domRoot.getAttribute( 'id' ) ).to.be.not.ok;
  122. expect( renderer.markedAttributes.size ).to.equal( 0 );
  123. } );
  124. it( 'should add children', () => {
  125. viewRoot._appendChild( new ViewText( viewDocument, 'foo' ) );
  126. renderer.markToSync( 'children', viewRoot );
  127. renderer.render();
  128. expect( domRoot.childNodes.length ).to.equal( 1 );
  129. expect( domRoot.childNodes[ 0 ].data ).to.equal( 'foo' );
  130. expect( renderer.markedChildren.size ).to.equal( 0 );
  131. } );
  132. it( 'should remove children', () => {
  133. viewRoot._appendChild( new ViewText( viewDocument, 'foo' ) );
  134. renderer.markToSync( 'children', viewRoot );
  135. renderer.render();
  136. expect( domRoot.childNodes.length ).to.equal( 1 );
  137. expect( domRoot.childNodes[ 0 ].data ).to.equal( 'foo' );
  138. viewRoot._removeChildren( 0, 1 );
  139. renderer.markToSync( 'children', viewRoot );
  140. renderer.render();
  141. expect( domRoot.childNodes.length ).to.equal( 0 );
  142. expect( renderer.markedChildren.size ).to.equal( 0 );
  143. } );
  144. it( 'should update text', () => {
  145. const viewText = new ViewText( viewDocument, 'foo' );
  146. viewRoot._appendChild( viewText );
  147. renderer.markToSync( 'children', viewRoot );
  148. renderer.render();
  149. expect( domRoot.childNodes.length ).to.equal( 1 );
  150. expect( domRoot.childNodes[ 0 ].data ).to.equal( 'foo' );
  151. viewText._data = 'bar';
  152. renderer.markToSync( 'text', viewText );
  153. renderer.render();
  154. expect( domRoot.childNodes.length ).to.equal( 1 );
  155. expect( domRoot.childNodes[ 0 ].data ).to.equal( 'bar' );
  156. expect( renderer.markedTexts.size ).to.equal( 0 );
  157. } );
  158. it( 'should not update same text', () => {
  159. const viewText = new ViewText( viewDocument, 'foo' );
  160. viewRoot._appendChild( viewText );
  161. renderer.markToSync( 'children', viewRoot );
  162. renderer.render();
  163. expect( domRoot.childNodes.length ).to.equal( 1 );
  164. expect( domRoot.childNodes[ 0 ].data ).to.equal( 'foo' );
  165. viewText._data = 'foo';
  166. renderer.markToSync( 'text', viewText );
  167. renderAndExpectNoChanges( renderer, domRoot );
  168. expect( domRoot.childNodes.length ).to.equal( 1 );
  169. expect( domRoot.childNodes[ 0 ].data ).to.equal( 'foo' );
  170. expect( renderer.markedTexts.size ).to.equal( 0 );
  171. } );
  172. it( 'should not update text parent child list changed', () => {
  173. const viewImg = new ViewElement( viewDocument, 'img' );
  174. const viewText = new ViewText( viewDocument, 'foo' );
  175. viewRoot._appendChild( [ viewImg, viewText ] );
  176. renderer.markToSync( 'children', viewRoot );
  177. renderer.markToSync( 'text', viewText );
  178. renderer.render();
  179. expect( domRoot.childNodes.length ).to.equal( 2 );
  180. expect( domRoot.childNodes[ 0 ].tagName ).to.equal( 'IMG' );
  181. expect( domRoot.childNodes[ 1 ].data ).to.equal( 'foo' );
  182. } );
  183. it( 'should not change text if it is the same during text rendering', () => {
  184. const viewText = new ViewText( viewDocument, 'foo' );
  185. viewRoot._appendChild( viewText );
  186. renderer.markToSync( 'children', viewRoot );
  187. renderer.render();
  188. // This should not be changed during the render.
  189. const domText = domRoot.childNodes[ 0 ];
  190. renderer.markToSync( 'text', viewText );
  191. renderer.render();
  192. expect( domRoot.childNodes.length ).to.equal( 1 );
  193. expect( domRoot.childNodes[ 0 ] ).to.equal( domText );
  194. } );
  195. it( 'should not change text if it is the same during children rendering', () => {
  196. const viewText = new ViewText( viewDocument, 'foo' );
  197. viewRoot._appendChild( viewText );
  198. renderer.markToSync( 'children', viewRoot );
  199. renderer.render();
  200. // This should not be changed during the render.
  201. const domText = domRoot.childNodes[ 0 ];
  202. renderer.markToSync( 'children', viewRoot );
  203. renderer.render();
  204. expect( domRoot.childNodes.length ).to.equal( 1 );
  205. expect( domRoot.childNodes[ 0 ] ).to.equal( domText );
  206. } );
  207. it( 'should not change element if it is the same', () => {
  208. const viewImg = new ViewElement( viewDocument, 'img' );
  209. viewRoot._appendChild( viewImg );
  210. // This should not be changed during the render.
  211. const domImg = document.createElement( 'img' );
  212. domRoot.appendChild( domImg );
  213. domConverter.bindElements( domImg, viewImg );
  214. renderer.markToSync( 'children', viewRoot );
  215. renderer.render();
  216. expect( domRoot.childNodes.length ).to.equal( 1 );
  217. expect( domRoot.childNodes[ 0 ] ).to.equal( domImg );
  218. } );
  219. it( 'should remove any comment from the DOM element', () => {
  220. // This comment should be cleared during render.
  221. const domComment = document.createComment( 'some comment from the user-land' );
  222. domRoot.appendChild( domComment );
  223. renderer.markToSync( 'children', viewRoot );
  224. renderer.render();
  225. expect( domRoot.childNodes.length ).to.equal( 0 );
  226. } );
  227. // https://github.com/ckeditor/ckeditor5/issues/5734
  228. it( 'should remove the comment and add a child element', () => {
  229. const viewImg = new ViewElement( viewDocument, 'img' );
  230. viewRoot._appendChild( viewImg );
  231. // This comment should be cleared during render.
  232. const domComment = document.createComment( 'some comment from the user-land' );
  233. domRoot.appendChild( domComment );
  234. renderer.markToSync( 'children', viewRoot );
  235. renderer.render();
  236. expect( domRoot.childNodes.length ).to.equal( 1 );
  237. expect( domRoot.childNodes[ 0 ] ).to.be.an.instanceof( HTMLImageElement );
  238. } );
  239. it( 'should change element if it is different', () => {
  240. const viewImg = new ViewElement( viewDocument, 'img' );
  241. viewRoot._appendChild( viewImg );
  242. renderer.markToSync( 'children', viewRoot );
  243. renderer.render();
  244. const viewP = new ViewElement( viewDocument, 'p' );
  245. viewRoot._removeChildren( 0, 1 );
  246. viewRoot._appendChild( viewP );
  247. renderer.markToSync( 'children', viewRoot );
  248. renderer.render();
  249. expect( domRoot.childNodes.length ).to.equal( 1 );
  250. expect( domRoot.childNodes[ 0 ].tagName ).to.equal( 'P' );
  251. } );
  252. it( 'should update removed item when it is reinserted', () => {
  253. const viewFoo = new ViewText( viewDocument, 'foo' );
  254. const viewP = new ViewElement( viewDocument, 'p', null, viewFoo );
  255. const viewDiv = new ViewElement( viewDocument, 'div', null, viewP );
  256. viewRoot._appendChild( viewDiv );
  257. renderer.markToSync( 'children', viewRoot );
  258. renderer.render();
  259. viewDiv._removeChildren( 0, 1 );
  260. renderer.markToSync( 'children', viewDiv );
  261. renderer.render();
  262. viewP._removeChildren( 0, 1 );
  263. viewDiv._appendChild( viewP );
  264. renderer.markToSync( 'children', viewDiv );
  265. renderer.render();
  266. expect( domRoot.childNodes.length ).to.equal( 1 );
  267. const domDiv = domRoot.childNodes[ 0 ];
  268. expect( domDiv.tagName ).to.equal( 'DIV' );
  269. expect( domDiv.childNodes.length ).to.equal( 1 );
  270. const domP = domDiv.childNodes[ 0 ];
  271. expect( domP.tagName ).to.equal( 'P' );
  272. expect( domP.childNodes.length ).to.equal( 0 );
  273. } );
  274. it( 'should update removed item when it is reinserted #2', () => {
  275. // Prepare view: root -> div "outer" -> div "inner" -> p.
  276. const viewP = new ViewElement( viewDocument, 'p' );
  277. const viewDivInner = new ViewElement( viewDocument, 'div', null, viewP );
  278. const viewDivOuter = new ViewElement( viewDocument, 'div', null, viewDivInner );
  279. viewRoot._appendChild( viewDivOuter );
  280. // Render view tree to DOM.
  281. renderer.markToSync( 'children', viewRoot );
  282. renderer.render();
  283. // Remove div "outer" from root and render it.
  284. viewDivOuter._remove();
  285. renderer.markToSync( 'children', viewRoot );
  286. renderer.render();
  287. // Remove p from div "child" -- div "inner" won't be marked because it is in document fragment not view root.
  288. viewP._remove();
  289. // Add div "outer" back to root.
  290. viewRoot._appendChild( viewDivOuter );
  291. renderer.markToSync( 'children', viewRoot );
  292. // Render changes, view is: root -> div "outer" -> div "inner".
  293. renderer.render();
  294. // Same is expected in DOM.
  295. expect( domRoot.childNodes.length ).to.equal( 1 );
  296. const domDivOuter = domRoot.childNodes[ 0 ];
  297. expect( renderer.domConverter.viewToDom( viewDivOuter, domRoot.document ) ).to.equal( domDivOuter );
  298. expect( domDivOuter.tagName ).to.equal( 'DIV' );
  299. expect( domDivOuter.childNodes.length ).to.equal( 1 );
  300. const domDivInner = domDivOuter.childNodes[ 0 ];
  301. expect( renderer.domConverter.viewToDom( viewDivInner, domRoot.document ) ).to.equal( domDivInner );
  302. expect( domDivInner.tagName ).to.equal( 'DIV' );
  303. expect( domDivInner.childNodes.length ).to.equal( 0 );
  304. } );
  305. it( 'should not throw when trying to update children of view element that got removed and lost its binding', () => {
  306. const viewFoo = new ViewText( viewDocument, 'foo' );
  307. const viewP = new ViewElement( viewDocument, 'p', null, viewFoo );
  308. const viewDiv = new ViewElement( viewDocument, 'div', null, viewP );
  309. viewRoot._appendChild( viewDiv );
  310. renderer.markToSync( 'children', viewRoot );
  311. renderer.render();
  312. viewRoot._removeChildren( 0, 1 );
  313. renderer.markToSync( 'children', viewRoot );
  314. viewDiv._removeChildren( 0, 1 );
  315. renderer.markToSync( 'children', viewDiv );
  316. viewP._removeChildren( 0, 1 );
  317. renderer.markToSync( 'children', viewP );
  318. renderer.render();
  319. expect( domRoot.childNodes.length ).to.equal( 0 );
  320. } );
  321. it( 'should not care about filler if there is no DOM', () => {
  322. const { view: viewP, selection: newSelection } = parse(
  323. '<container:p>foo<attribute:b>[]</attribute:b>bar</container:p>' );
  324. const viewRoot = new ViewElement( viewDocument, 'p' );
  325. viewRoot._appendChild( viewP );
  326. selection._setTo( newSelection );
  327. renderer.markToSync( 'children', viewRoot );
  328. renderer.render();
  329. // Expect no error on render.
  330. expect( viewRoot ).to.be.ok;
  331. } );
  332. it( 'should not add filler when inside contenteditable=false parent', () => {
  333. const { view: viewP, selection: newSelection } = parse(
  334. '<container:p>foo<attribute:b contenteditable="false">[]</attribute:b>bar</container:p>' );
  335. viewRoot._appendChild( viewP );
  336. selection._setTo( newSelection );
  337. renderer.markToSync( 'children', viewRoot );
  338. renderer.render();
  339. expect( domRoot.childNodes.length ).to.equal( 1 );
  340. expect( domRoot.childNodes[ 0 ].tagName.toLowerCase() ).to.equal( 'p' );
  341. const domP = domRoot.childNodes[ 0 ];
  342. expect( domP.childNodes.length ).to.equal( 3 );
  343. expect( domP.childNodes[ 0 ].data ).to.equal( 'foo' );
  344. expect( domP.childNodes[ 2 ].data ).to.equal( 'bar' );
  345. expect( domP.childNodes[ 1 ].tagName.toLowerCase() ).to.equal( 'b' );
  346. expect( domP.childNodes[ 1 ].childNodes.length ).to.equal( 0 );
  347. } );
  348. it( 'should not add filler when inside contenteditable=false ancestor', () => {
  349. const { view: viewP, selection: newSelection } = parse(
  350. '<container:p contenteditable="false">foo<attribute:b>[]</attribute:b>bar</container:p>' );
  351. viewRoot._appendChild( viewP );
  352. selection._setTo( newSelection );
  353. renderer.markToSync( 'children', viewRoot );
  354. renderer.render();
  355. expect( domRoot.childNodes.length ).to.equal( 1 );
  356. expect( domRoot.childNodes[ 0 ].tagName.toLowerCase() ).to.equal( 'p' );
  357. const domP = domRoot.childNodes[ 0 ];
  358. expect( domP.childNodes.length ).to.equal( 3 );
  359. expect( domP.childNodes[ 0 ].data ).to.equal( 'foo' );
  360. expect( domP.childNodes[ 2 ].data ).to.equal( 'bar' );
  361. expect( domP.childNodes[ 1 ].tagName.toLowerCase() ).to.equal( 'b' );
  362. expect( domP.childNodes[ 1 ].childNodes.length ).to.equal( 0 );
  363. } );
  364. it( 'should add and remove inline filler in case <p>foo<b>[]</b>bar</p>', () => {
  365. const domSelection = document.getSelection();
  366. // Step 1: <p>foo<b>"FILLER{}"</b></p>
  367. const { view: viewP, selection: newSelection } = parse(
  368. '<container:p>foo<attribute:b>[]</attribute:b>bar</container:p>' );
  369. viewRoot._appendChild( viewP );
  370. selection._setTo( newSelection );
  371. renderer.markToSync( 'children', viewRoot );
  372. renderer.render();
  373. expect( domRoot.childNodes.length ).to.equal( 1 );
  374. expect( domRoot.childNodes[ 0 ].tagName.toLowerCase() ).to.equal( 'p' );
  375. const domP = domRoot.childNodes[ 0 ];
  376. expect( domP.childNodes.length ).to.equal( 3 );
  377. expect( domP.childNodes[ 0 ].data ).to.equal( 'foo' );
  378. expect( domP.childNodes[ 2 ].data ).to.equal( 'bar' );
  379. expect( domP.childNodes[ 1 ].tagName.toLowerCase() ).to.equal( 'b' );
  380. expect( domP.childNodes[ 1 ].childNodes.length ).to.equal( 1 );
  381. expect( domP.childNodes[ 1 ].childNodes[ 0 ].data ).to.equal( INLINE_FILLER );
  382. expect( domSelection.rangeCount ).to.equal( 1 );
  383. expect( domSelection.getRangeAt( 0 ).startContainer ).to.equal( domP.childNodes[ 1 ].childNodes[ 0 ] );
  384. expect( domSelection.getRangeAt( 0 ).startOffset ).to.equal( INLINE_FILLER_LENGTH );
  385. expect( domSelection.getRangeAt( 0 ).collapsed ).to.be.true;
  386. // Step 2: No mutation on second render
  387. renderer.markToSync( 'children', viewRoot );
  388. renderer.markToSync( 'children', viewP );
  389. renderAndExpectNoChanges( renderer, domRoot );
  390. // Step 3: <p>foo{}<b></b></p>
  391. selection._setTo( ViewRange._createFromParentsAndOffsets( viewP.getChild( 0 ), 3, viewP.getChild( 0 ), 3 ) );
  392. renderer.render();
  393. expect( domP.childNodes.length ).to.equal( 3 );
  394. expect( domP.childNodes[ 0 ].data ).to.equal( 'foo' );
  395. expect( domP.childNodes[ 2 ].data ).to.equal( 'bar' );
  396. expect( domP.childNodes[ 1 ].tagName.toLowerCase() ).to.equal( 'b' );
  397. expect( domP.childNodes[ 1 ].childNodes.length ).to.equal( 0 );
  398. expect( domSelection.rangeCount ).to.equal( 1 );
  399. expect( domSelection.getRangeAt( 0 ).startContainer ).to.equal( domP.childNodes[ 0 ] );
  400. expect( domSelection.getRangeAt( 0 ).startOffset ).to.equal( 3 );
  401. expect( domSelection.getRangeAt( 0 ).collapsed ).to.be.true;
  402. // Step 4: No mutation on second render
  403. renderer.markToSync( 'children', viewRoot );
  404. renderer.markToSync( 'children', viewP );
  405. renderAndExpectNoChanges( renderer, domRoot );
  406. } );
  407. it( 'should add and remove inline filler in case <p>[]<b>foo</b></p>', () => {
  408. const domSelection = document.getSelection();
  409. // Step 1: <p>"FILLER{}"<b>foo</b></p>
  410. const { view: viewP, selection: newSelection } = parse(
  411. '<container:p>[]<attribute:b>foo</attribute:b></container:p>' );
  412. viewRoot._appendChild( viewP );
  413. selection._setTo( newSelection );
  414. renderer.markToSync( 'children', viewRoot );
  415. renderer.render();
  416. const domP = domRoot.childNodes[ 0 ];
  417. expect( domP.childNodes.length ).to.equal( 2 );
  418. expect( domP.childNodes[ 0 ].data ).to.equal( INLINE_FILLER );
  419. expect( domP.childNodes[ 1 ].tagName.toLowerCase() ).to.equal( 'b' );
  420. expect( domP.childNodes[ 1 ].childNodes.length ).to.equal( 1 );
  421. expect( domP.childNodes[ 1 ].childNodes[ 0 ].data ).to.equal( 'foo' );
  422. expect( domSelection.rangeCount ).to.equal( 1 );
  423. expect( domSelection.getRangeAt( 0 ).startContainer ).to.equal( domP.childNodes[ 0 ] );
  424. expect( domSelection.getRangeAt( 0 ).startOffset ).to.equal( INLINE_FILLER_LENGTH );
  425. expect( domSelection.getRangeAt( 0 ).collapsed ).to.be.true;
  426. // Step 2: No mutation on second render
  427. renderer.markToSync( 'children', viewP );
  428. renderAndExpectNoChanges( renderer, domRoot );
  429. // Step 3: <p><b>{}foo</b></p>
  430. selection._setTo( ViewRange._createFromParentsAndOffsets(
  431. viewP.getChild( 0 ).getChild( 0 ), 0, viewP.getChild( 0 ).getChild( 0 ), 0 ) );
  432. renderer.render();
  433. expect( domP.childNodes.length ).to.equal( 1 );
  434. expect( domP.childNodes[ 0 ].tagName.toLowerCase() ).to.equal( 'b' );
  435. expect( domP.childNodes[ 0 ].childNodes.length ).to.equal( 1 );
  436. expect( domP.childNodes[ 0 ].childNodes[ 0 ].data ).to.equal( 'foo' );
  437. expect( domSelection.rangeCount ).to.equal( 1 );
  438. expect( domSelection.getRangeAt( 0 ).startContainer ).to.equal( domP.childNodes[ 0 ].childNodes[ 0 ] );
  439. expect( domSelection.getRangeAt( 0 ).startOffset ).to.equal( 0 );
  440. expect( domSelection.getRangeAt( 0 ).collapsed ).to.be.true;
  441. // Step 4: No mutation on second render
  442. renderer.markToSync( 'children', viewP );
  443. renderAndExpectNoChanges( renderer, domRoot );
  444. } );
  445. it( 'should add and remove inline filler in case <p><b>foo</b>[]</p>', () => {
  446. const domSelection = document.getSelection();
  447. // Step 1: <p>"FILLER{}"<b>foo</b></p>
  448. const { view: viewP, selection: newSelection } = parse(
  449. '<container:p><attribute:b>foo</attribute:b>[]</container:p>' );
  450. viewRoot._appendChild( viewP );
  451. selection._setTo( newSelection );
  452. renderer.markToSync( 'children', viewRoot );
  453. renderer.render();
  454. const domP = domRoot.childNodes[ 0 ];
  455. expect( domP.childNodes.length ).to.equal( 2 );
  456. expect( domP.childNodes[ 0 ].tagName.toLowerCase() ).to.equal( 'b' );
  457. expect( domP.childNodes[ 0 ].childNodes.length ).to.equal( 1 );
  458. expect( domP.childNodes[ 0 ].childNodes[ 0 ].data ).to.equal( 'foo' );
  459. expect( domP.childNodes[ 1 ].data ).to.equal( INLINE_FILLER );
  460. expect( domSelection.rangeCount ).to.equal( 1 );
  461. expect( domSelection.getRangeAt( 0 ).startContainer ).to.equal( domP.childNodes[ 1 ] );
  462. expect( domSelection.getRangeAt( 0 ).startOffset ).to.equal( INLINE_FILLER_LENGTH );
  463. expect( domSelection.getRangeAt( 0 ).collapsed ).to.be.true;
  464. // Step 2: No mutation on second render
  465. renderer.markToSync( 'children', viewP );
  466. renderAndExpectNoChanges( renderer, domRoot );
  467. // Step 3: <p><b>foo{}</b></p>
  468. selection._setTo( ViewRange._createFromParentsAndOffsets(
  469. viewP.getChild( 0 ).getChild( 0 ), 3, viewP.getChild( 0 ).getChild( 0 ), 3 ) );
  470. renderer.render();
  471. expect( domP.childNodes.length ).to.equal( 1 );
  472. expect( domP.childNodes[ 0 ].tagName.toLowerCase() ).to.equal( 'b' );
  473. expect( domP.childNodes[ 0 ].childNodes.length ).to.equal( 1 );
  474. expect( domP.childNodes[ 0 ].childNodes[ 0 ].data ).to.equal( 'foo' );
  475. expect( domSelection.rangeCount ).to.equal( 1 );
  476. expect( domSelection.getRangeAt( 0 ).startContainer ).to.equal( domP.childNodes[ 0 ].childNodes[ 0 ] );
  477. expect( domSelection.getRangeAt( 0 ).startOffset ).to.equal( 3 );
  478. expect( domSelection.getRangeAt( 0 ).collapsed ).to.be.true;
  479. // Step 4: No mutation on second render
  480. renderer.markToSync( 'children', viewP );
  481. renderAndExpectNoChanges( renderer, domRoot );
  482. } );
  483. it( 'should add and remove inline filler in case <p><b>foo</b>[]<b>bar</b></p>', () => {
  484. const domSelection = document.getSelection();
  485. const { view: viewP, selection: newSelection } = parse(
  486. '<container:p><attribute:b>foo</attribute:b>[]<attribute:b>bar</attribute:b></container:p>' );
  487. viewRoot._appendChild( viewP );
  488. selection._setTo( newSelection );
  489. renderer.markToSync( 'children', viewRoot );
  490. renderer.render();
  491. const domP = domRoot.childNodes[ 0 ];
  492. expect( domP.childNodes.length ).to.equal( 3 );
  493. expect( domP.childNodes[ 0 ].tagName.toLowerCase() ).to.equal( 'b' );
  494. expect( domP.childNodes[ 0 ].childNodes.length ).to.equal( 1 );
  495. expect( domP.childNodes[ 0 ].childNodes[ 0 ].data ).to.equal( 'foo' );
  496. expect( domP.childNodes[ 1 ].data ).to.equal( INLINE_FILLER );
  497. expect( domP.childNodes[ 2 ].tagName.toLowerCase() ).to.equal( 'b' );
  498. expect( domP.childNodes[ 2 ].childNodes.length ).to.equal( 1 );
  499. expect( domP.childNodes[ 2 ].childNodes[ 0 ].data ).to.equal( 'bar' );
  500. expect( domSelection.rangeCount ).to.equal( 1 );
  501. expect( domSelection.getRangeAt( 0 ).startContainer ).to.equal( domP.childNodes[ 1 ] );
  502. expect( domSelection.getRangeAt( 0 ).startOffset ).to.equal( INLINE_FILLER_LENGTH );
  503. expect( domSelection.getRangeAt( 0 ).collapsed ).to.be.true;
  504. } );
  505. it( 'should move filler when selection is moved', () => {
  506. // Step 1: <p>foo<b>"FILLER{}"</b></p>
  507. const { view: viewP, selection: newSelection } = parse(
  508. '<container:p>foo<attribute:b>[]</attribute:b><attribute:i></attribute:i></container:p>' );
  509. viewRoot._appendChild( viewP );
  510. selection._setTo( newSelection );
  511. renderer.markToSync( 'children', viewRoot );
  512. renderer.render();
  513. const domP = domRoot.childNodes[ 0 ];
  514. expect( domP.childNodes.length ).to.equal( 3 );
  515. expect( domP.childNodes[ 0 ].data ).to.equal( 'foo' );
  516. expect( domP.childNodes[ 1 ].tagName.toLowerCase() ).to.equal( 'b' );
  517. expect( domP.childNodes[ 1 ].childNodes.length ).to.equal( 1 );
  518. expect( domP.childNodes[ 1 ].childNodes[ 0 ].data ).to.equal( INLINE_FILLER );
  519. expect( domP.childNodes[ 2 ].tagName.toLowerCase() ).to.equal( 'i' );
  520. expect( domP.childNodes[ 2 ].childNodes.length ).to.equal( 0 );
  521. // Step 2: <p>foo<b></b><i>"FILLER{}"</i></p>
  522. const viewI = viewP.getChild( 2 );
  523. selection._setTo( ViewRange._createFromParentsAndOffsets( viewI, 0, viewI, 0 ) );
  524. renderer.render();
  525. expect( domP.childNodes.length ).to.equal( 3 );
  526. expect( domP.childNodes[ 0 ].data ).to.equal( 'foo' );
  527. expect( domP.childNodes[ 1 ].tagName.toLowerCase() ).to.equal( 'b' );
  528. expect( domP.childNodes[ 1 ].childNodes.length ).to.equal( 0 );
  529. expect( domP.childNodes[ 2 ].tagName.toLowerCase() ).to.equal( 'i' );
  530. expect( domP.childNodes[ 2 ].childNodes.length ).to.equal( 1 );
  531. expect( domP.childNodes[ 2 ].childNodes[ 0 ].data ).to.equal( INLINE_FILLER );
  532. } );
  533. it( 'should remove filler when text is added and selection removed', () => {
  534. // Step 1: <p>foo<b>"FILLER{}"</b></p>
  535. const { view: viewP, selection: newSelection } = parse( '<container:p>foo<attribute:b>[]</attribute:b></container:p>' );
  536. const viewB = viewP.getChild( 1 );
  537. viewRoot._appendChild( viewP );
  538. selection._setTo( newSelection );
  539. renderer.markToSync( 'children', viewRoot );
  540. renderer.render();
  541. const domP = domRoot.childNodes[ 0 ];
  542. expect( domP.childNodes.length ).to.equal( 2 );
  543. expect( domP.childNodes[ 0 ].data ).to.equal( 'foo' );
  544. expect( domP.childNodes[ 1 ].tagName.toLowerCase() ).to.equal( 'b' );
  545. expect( domP.childNodes[ 1 ].childNodes.length ).to.equal( 1 );
  546. expect( domP.childNodes[ 1 ].childNodes[ 0 ].data ).to.equal( INLINE_FILLER );
  547. // Step 2: Add text node.
  548. const viewText = new ViewText( viewDocument, 'x' );
  549. viewB._appendChild( viewText );
  550. selection._setTo( ViewRange._createFromParentsAndOffsets( viewText, 1, viewText, 1 ) );
  551. renderer.markToSync( 'children', viewB );
  552. renderer.render();
  553. // Step 3: Remove selection from the view.
  554. selection._setTo( null );
  555. renderer.render();
  556. expect( domP.childNodes.length ).to.equal( 2 );
  557. expect( domP.childNodes[ 0 ].data ).to.equal( 'foo' );
  558. expect( domP.childNodes[ 1 ].tagName.toLowerCase() ).to.equal( 'b' );
  559. expect( domP.childNodes[ 1 ].childNodes.length ).to.equal( 1 );
  560. expect( domP.childNodes[ 1 ].childNodes[ 0 ].data ).to.equal( 'x' );
  561. } );
  562. // #659
  563. // The element before the filler is removed so the position of the filler
  564. // cannot be remembered as parent+offset.
  565. it( 'should remove filler from a modified DOM in case <p>bar<b>foo</b>[]</p>', () => {
  566. // Step 1: <p>bar<b>foo</b>"FILLER{}"</p>
  567. const { view: viewP, selection: newSelection } = parse( '<container:p>bar<attribute:b>foo</attribute:b>[]</container:p>' );
  568. viewRoot._appendChild( viewP );
  569. selection._setTo( newSelection );
  570. renderer.markToSync( 'children', viewRoot );
  571. renderer.render();
  572. const domP = domRoot.childNodes[ 0 ];
  573. expect( domP.childNodes.length ).to.equal( 3 );
  574. expect( domP.childNodes[ 2 ].data ).to.equal( INLINE_FILLER );
  575. // Step 2: Remove the <b> and update the selection (<p>bar[]</p>).
  576. viewP._removeChildren( 1 );
  577. selection._setTo( ViewRange._createFromParentsAndOffsets( viewP, 1, viewP, 1 ) );
  578. renderer.markToSync( 'children', viewP );
  579. renderer.render();
  580. // Step 3: Check whether there's no filler in the DOM.
  581. expect( domP.childNodes.length ).to.equal( 1 );
  582. expect( domP.childNodes[ 0 ].data ).to.equal( 'bar' );
  583. } );
  584. // #659
  585. it( 'should remove filler from a modified DOM when children moved', () => {
  586. // Step 1: <p><b>foo</b>"FILLER{}"<b>bar</b></p><p></p>
  587. const { view: viewFragment, selection: newSelection } = parse(
  588. '<container:p><attribute:b>foo</attribute:b>[]<attribute:b>bar</attribute:b></container:p><container:p></container:p>'
  589. );
  590. viewRoot._appendChild( viewFragment );
  591. selection._setTo( newSelection );
  592. renderer.markToSync( 'children', viewRoot );
  593. renderer.render();
  594. expect( domRoot.childNodes.length ).to.equal( 2 );
  595. const domP = domRoot.childNodes[ 0 ];
  596. const domP2 = domRoot.childNodes[ 1 ];
  597. expect( domP.childNodes.length ).to.equal( 3 );
  598. expect( domP.childNodes[ 1 ].data ).to.equal( INLINE_FILLER );
  599. // Step 2: Move <b>foo</b><b>bar</b> to the second paragraph and leave collapsed selection in the first one.
  600. // <p>[]</p><p><b>foo</b><b>bar</b></p>
  601. const viewP = viewRoot.getChild( 0 );
  602. const viewP2 = viewRoot.getChild( 1 );
  603. const removedChildren = viewP._removeChildren( 0, 2 );
  604. viewP2._appendChild( removedChildren );
  605. selection._setTo( ViewRange._createFromParentsAndOffsets( viewP, 0, viewP, 0 ) );
  606. renderer.markToSync( 'children', viewP );
  607. renderer.markToSync( 'children', viewP2 );
  608. renderer.render();
  609. // Step 3: Check whether in the first paragraph there's a <br> filler and that
  610. // in the second one there are two <b> tags.
  611. expect( domP.childNodes.length ).to.equal( 1 );
  612. expect( domConverter.isBlockFiller( domP.childNodes[ 0 ] ) ).to.be.true;
  613. expect( domP2.childNodes.length ).to.equal( 2 );
  614. expect( domP2.childNodes[ 0 ].tagName.toLowerCase() ).to.equal( 'b' );
  615. expect( domP2.childNodes[ 1 ].tagName.toLowerCase() ).to.equal( 'b' );
  616. } );
  617. // Test for an edge case in the _isSelectionInInlineFiller which can be triggered like
  618. // in one of ckeditor/ckeditor5-typing#59 automated tests.
  619. it( 'should not break when selection is moved to a new element, when filler exists', () => {
  620. // Step 1: <p>bar<b>"FILLER{}"</b></p>
  621. const { view: viewP, selection: newSelection } = parse( '<container:p>bar<attribute:b>[]</attribute:b></container:p>' );
  622. viewRoot._appendChild( viewP );
  623. selection._setTo( newSelection );
  624. renderer.markToSync( 'children', viewRoot );
  625. renderer.render();
  626. const domP = domRoot.childNodes[ 0 ];
  627. expect( domP.childNodes.length ).to.equal( 2 );
  628. expect( domP.childNodes[ 1 ].childNodes[ 0 ].data ).to.equal( INLINE_FILLER );
  629. // Step 2: Move selection to a new attribute element and remove the previous one
  630. viewP._removeChildren( 1 ); // Remove <b>.
  631. const viewI = parse( '<attribute:i></attribute:i>' );
  632. viewP._appendChild( viewI );
  633. selection._setTo( ViewRange._createFromParentsAndOffsets( viewI, 0, viewI, 0 ) );
  634. renderer.markToSync( 'children', viewP );
  635. renderer.render();
  636. // Step 3: Check whether new filler was created in the <i> element.
  637. expect( domP.childNodes.length ).to.equal( 2 );
  638. expect( domP.childNodes[ 1 ].tagName.toLowerCase() ).to.equal( 'i' );
  639. expect( domP.childNodes[ 1 ].childNodes[ 0 ].data ).to.equal( INLINE_FILLER );
  640. } );
  641. // Test for an edge case in the _isSelectionInInlineFiller, when selection is before a view element
  642. // that has not been yet rendered/bound to DOM.
  643. it( 'should remove inline filler if selection is before a view element not bound to dom', () => {
  644. // Step 1: <p>bar<b>abc</b>"FILLER"{}</p>
  645. const { view: viewP, selection: newSelection } = parse( '<container:p>bar<attribute:b>abc</attribute:b>[]</container:p>' );
  646. viewRoot._appendChild( viewP );
  647. selection._setTo( newSelection );
  648. renderer.markToSync( 'children', viewRoot );
  649. renderer.render();
  650. const domP = domRoot.childNodes[ 0 ];
  651. expect( domP.childNodes.length ).to.equal( 3 );
  652. expect( domP.childNodes[ 2 ].data ).to.equal( INLINE_FILLER );
  653. // Step 2: Move selection to a new attribute element.
  654. const viewAbc = parse( 'abc' );
  655. viewP._appendChild( viewAbc );
  656. selection._setTo( ViewRange._createFromParentsAndOffsets( viewP, 3, viewP, 3 ) );
  657. renderer.markToSync( 'children', viewP );
  658. renderer.render();
  659. // Step 3: Check whether old filler was removed.
  660. expect( domP.childNodes.length ).to.equal( 3 );
  661. expect( domP.textContent.indexOf( INLINE_FILLER ) ).to.equal( -1 );
  662. } );
  663. it( 'should handle typing in empty block, do nothing if changes are already applied', () => {
  664. const domSelection = document.getSelection();
  665. const { view: viewP, selection: newSelection } = parse( '<container:p>[]</container:p>' );
  666. viewRoot._appendChild( viewP );
  667. selection._setTo( newSelection );
  668. renderer.markToSync( 'children', viewRoot );
  669. renderer.render();
  670. const domP = domRoot.childNodes[ 0 ];
  671. expect( domP.childNodes.length ).to.equal( 1 );
  672. expect( domConverter.isBlockFiller( domP.childNodes[ 0 ] ) ).to.be.true;
  673. expect( domSelection.rangeCount ).to.equal( 1 );
  674. expect( domSelection.getRangeAt( 0 ).startContainer ).to.equal( domP );
  675. expect( domSelection.getRangeAt( 0 ).startOffset ).to.equal( 0 );
  676. expect( domSelection.getRangeAt( 0 ).collapsed ).to.be.true;
  677. // Remove filler and add text node to both DOM and View <p>x{}</p>
  678. domP.removeChild( domP.childNodes[ 0 ] );
  679. domP.appendChild( document.createTextNode( 'x' ) );
  680. domSelection.removeAllRanges();
  681. const domRange = document.createRange();
  682. domRange.setStart( domP.childNodes[ 0 ], 1 );
  683. domRange.collapse( true );
  684. domSelection.addRange( domRange );
  685. const viewText = new ViewText( viewDocument, 'x' );
  686. viewP._appendChild( viewText );
  687. selection._setTo( ViewRange._createFromParentsAndOffsets( viewText, 1, viewText, 1 ) );
  688. renderer.markToSync( 'children', viewP );
  689. renderAndExpectNoChanges( renderer, domRoot );
  690. } );
  691. it( 'should handle typing in empty block, render if needed', () => {
  692. const domSelection = document.getSelection();
  693. const { view: viewP, selection: newSelection } = parse( '<container:p>[]</container:p>' );
  694. viewRoot._appendChild( viewP );
  695. selection._setTo( newSelection );
  696. renderer.markToSync( 'children', viewRoot );
  697. renderer.render();
  698. const domP = domRoot.childNodes[ 0 ];
  699. expect( domP.childNodes.length ).to.equal( 1 );
  700. expect( domConverter.isBlockFiller( domP.childNodes[ 0 ] ) ).to.be.true;
  701. expect( domSelection.rangeCount ).to.equal( 1 );
  702. expect( domSelection.getRangeAt( 0 ).startContainer ).to.equal( domP );
  703. expect( domSelection.getRangeAt( 0 ).startOffset ).to.equal( 0 );
  704. expect( domSelection.getRangeAt( 0 ).collapsed ).to.be.true;
  705. // Add text node only in View <p>x{}</p>
  706. const viewText = new ViewText( viewDocument, 'x' );
  707. viewP._appendChild( viewText );
  708. selection._setTo( ViewRange._createFromParentsAndOffsets( viewText, 1, viewText, 1 ) );
  709. renderer.markToSync( 'children', viewP );
  710. renderer.render();
  711. expect( domP.childNodes.length ).to.equal( 1 );
  712. expect( domP.childNodes[ 0 ].data ).to.equal( 'x' );
  713. expect( domSelection.rangeCount ).to.equal( 1 );
  714. expect( domSelection.getRangeAt( 0 ).startContainer ).to.equal( domP.childNodes[ 0 ] );
  715. expect( domSelection.getRangeAt( 0 ).startOffset ).to.equal( 1 );
  716. expect( domSelection.getRangeAt( 0 ).collapsed ).to.be.true;
  717. } );
  718. it( 'should handle removing last character', () => {
  719. const domSelection = document.getSelection();
  720. const { view: viewP, selection: newSelection } = parse( '<container:p>x{}</container:p>' );
  721. viewRoot._appendChild( viewP );
  722. selection._setTo( newSelection );
  723. renderer.markToSync( 'children', viewRoot );
  724. renderer.render();
  725. const domP = domRoot.childNodes[ 0 ];
  726. expect( domP.childNodes.length ).to.equal( 1 );
  727. expect( domP.childNodes[ 0 ].data ).to.equal( 'x' );
  728. expect( domSelection.rangeCount ).to.equal( 1 );
  729. expect( domSelection.getRangeAt( 0 ).startContainer ).to.equal( domP.childNodes[ 0 ] );
  730. expect( domSelection.getRangeAt( 0 ).startOffset ).to.equal( 1 );
  731. expect( domSelection.getRangeAt( 0 ).collapsed ).to.be.true;
  732. // Remove text and add filler to both DOM and View <p>{}</p>
  733. domP.removeChild( domP.childNodes[ 0 ] );
  734. domP.appendChild( BR_FILLER( document ) ); // eslint-disable-line new-cap
  735. domSelection.removeAllRanges();
  736. const domRange = document.createRange();
  737. domRange.setStart( domP.childNodes[ 0 ], 0 );
  738. domRange.collapse( true );
  739. domSelection.addRange( domRange );
  740. viewP._removeChildren( 0 );
  741. selection._setTo( ViewRange._createFromParentsAndOffsets( viewP, 0, viewP, 0 ) );
  742. renderer.markToSync( 'children', viewP );
  743. renderAndExpectNoChanges( renderer, domRoot );
  744. } );
  745. it( 'should handle typing in empty attribute, do nothing if changes are already applied', () => {
  746. const domSelection = document.getSelection();
  747. // 1. Render <p><b>FILLER{}</b>foo</p>.
  748. const { view: viewP, selection: newSelection } = parse(
  749. '<container:p><attribute:b>[]</attribute:b>foo</container:p>' );
  750. viewRoot._appendChild( viewP );
  751. selection._setTo( newSelection );
  752. renderer.markToSync( 'children', viewRoot );
  753. renderer.render();
  754. // 2. Check the DOM.
  755. const domP = domRoot.childNodes[ 0 ];
  756. expect( domP.childNodes.length ).to.equal( 2 );
  757. expect( domP.childNodes[ 0 ].tagName.toLowerCase() ).to.equal( 'b' );
  758. expect( domP.childNodes[ 1 ].data ).to.equal( 'foo' );
  759. const domB = domP.childNodes[ 0 ];
  760. const viewB = viewP.getChild( 0 );
  761. expect( domB.childNodes.length ).to.equal( 1 );
  762. expect( domB.childNodes[ 0 ].data ).to.equal( INLINE_FILLER );
  763. expect( domSelection.rangeCount ).to.equal( 1 );
  764. expect( domSelection.getRangeAt( 0 ).startContainer ).to.equal( domB.childNodes[ 0 ] );
  765. expect( domSelection.getRangeAt( 0 ).startOffset ).to.equal( INLINE_FILLER_LENGTH );
  766. expect( domSelection.getRangeAt( 0 ).collapsed ).to.be.true;
  767. // 3. Add text node to both the DOM and the view: <p><b>FILLERx</b>foo</p>.
  768. domB.childNodes[ 0 ].data += 'x';
  769. domSelection.removeAllRanges();
  770. const domRange = document.createRange();
  771. domRange.setStart( domB.childNodes[ 0 ], INLINE_FILLER_LENGTH + 1 );
  772. domRange.collapse( true );
  773. domSelection.addRange( domRange );
  774. const viewText = new ViewText( viewDocument, 'x' );
  775. viewB._appendChild( viewText );
  776. selection._setTo( ViewRange._createFromParentsAndOffsets( viewText, 1, viewText, 1 ) );
  777. renderer.markToSync( 'children', viewP );
  778. renderAndExpectNoChanges( renderer, domRoot );
  779. } );
  780. it( 'should handle typing in empty attribute as a children change, render if needed', () => {
  781. const domSelection = document.getSelection();
  782. // 1. Render <p><b>FILLER{}</b>foo</p>.
  783. const { view: viewP, selection: newSelection } = parse(
  784. '<container:p><attribute:b>[]</attribute:b>foo</container:p>' );
  785. viewRoot._appendChild( viewP );
  786. selection._setTo( newSelection );
  787. renderer.markToSync( 'children', viewRoot );
  788. renderer.render();
  789. // 2. Check the DOM.
  790. const domP = domRoot.childNodes[ 0 ];
  791. expect( domP.childNodes.length ).to.equal( 2 );
  792. expect( domP.childNodes[ 0 ].tagName.toLowerCase() ).to.equal( 'b' );
  793. expect( domP.childNodes[ 1 ].data ).to.equal( 'foo' );
  794. const domB = domP.childNodes[ 0 ];
  795. const viewB = viewP.getChild( 0 );
  796. expect( domB.childNodes.length ).to.equal( 1 );
  797. expect( domB.childNodes[ 0 ].data ).to.equal( INLINE_FILLER );
  798. expect( domSelection.rangeCount ).to.equal( 1 );
  799. expect( domSelection.getRangeAt( 0 ).startContainer ).to.equal( domB.childNodes[ 0 ] );
  800. expect( domSelection.getRangeAt( 0 ).startOffset ).to.equal( INLINE_FILLER_LENGTH );
  801. expect( domSelection.getRangeAt( 0 ).collapsed ).to.be.true;
  802. domSelection.removeAllRanges();
  803. // 3. Add text node only to the view: <p><b>x{}</b>foo</p>.
  804. const viewText = new ViewText( viewDocument, 'x' );
  805. viewB._appendChild( viewText );
  806. selection._setTo( ViewRange._createFromParentsAndOffsets( viewText, 1, viewText, 1 ) );
  807. renderer.markToSync( 'children', viewB );
  808. renderer.render();
  809. expect( domB.childNodes.length ).to.equal( 1 );
  810. expect( domB.childNodes[ 0 ].data ).to.equal( INLINE_FILLER + 'x' );
  811. expect( domSelection.rangeCount ).to.equal( 1 );
  812. // Depending on the browser selection may end up at the end of the text node or after the text node.
  813. const firstRange = domSelection.getRangeAt( 0 );
  814. const assertSelectionAtEndOfTextNode = () => {
  815. expect( firstRange.startOffset ).to.equal( INLINE_FILLER_LENGTH + 1 );
  816. };
  817. const assertSelectionInsideTextNode = () => {
  818. expect( firstRange.startContainer ).to.equal( domB );
  819. expect( firstRange.startOffset ).to.equal( 1 );
  820. };
  821. testUtils.checkAssertions( assertSelectionAtEndOfTextNode, assertSelectionInsideTextNode );
  822. expect( firstRange.collapsed ).to.be.true;
  823. } );
  824. it( 'should handle typing in empty attribute as a text change, render if needed', () => {
  825. const domSelection = document.getSelection();
  826. // 1. Render <p><b>FILLER{}</b>foo</p>.
  827. const { view: viewP, selection: newSelection } = parse(
  828. '<container:p><attribute:b>[]</attribute:b>foo</container:p>' );
  829. viewRoot._appendChild( viewP );
  830. selection._setTo( newSelection );
  831. renderer.markToSync( 'children', viewRoot );
  832. renderer.render();
  833. // 2. Check the DOM.
  834. const domP = domRoot.childNodes[ 0 ];
  835. expect( domP.childNodes.length ).to.equal( 2 );
  836. expect( domP.childNodes[ 0 ].tagName.toLowerCase() ).to.equal( 'b' );
  837. expect( domP.childNodes[ 1 ].data ).to.equal( 'foo' );
  838. const domB = domP.childNodes[ 0 ];
  839. const viewB = viewP.getChild( 0 );
  840. expect( domB.childNodes.length ).to.equal( 1 );
  841. expect( domB.childNodes[ 0 ].data ).to.equal( INLINE_FILLER );
  842. expect( domSelection.rangeCount ).to.equal( 1 );
  843. expect( domSelection.getRangeAt( 0 ).startContainer ).to.equal( domB.childNodes[ 0 ] );
  844. expect( domSelection.getRangeAt( 0 ).startOffset ).to.equal( INLINE_FILLER_LENGTH );
  845. expect( domSelection.getRangeAt( 0 ).collapsed ).to.be.true;
  846. // 3. Add text node only to the view: <p><b>x{}</b>foo</p>.
  847. const viewText = new ViewText( viewDocument, 'x' );
  848. viewB._appendChild( viewText );
  849. selection._setTo( ViewRange._createFromParentsAndOffsets( viewText, 1, viewText, 1 ) );
  850. renderer.markToSync( 'text', viewText );
  851. renderer.render();
  852. // 4. Check the DOM.
  853. expect( domB.childNodes.length ).to.equal( 1 );
  854. expect( domB.childNodes[ 0 ].data ).to.equal( INLINE_FILLER + 'x' );
  855. expect( domSelection.rangeCount ).to.equal( 1 );
  856. expect( domSelection.getRangeAt( 0 ).startContainer ).to.equal( domB.childNodes[ 0 ] );
  857. expect( domSelection.getRangeAt( 0 ).startOffset ).to.equal( INLINE_FILLER_LENGTH + 1 );
  858. expect( domSelection.getRangeAt( 0 ).collapsed ).to.be.true;
  859. } );
  860. it( 'should handle not collapsed range', () => {
  861. const domSelection = document.getSelection();
  862. const { view: viewP, selection: newSelection } = parse(
  863. '<container:p>fo{o<attribute:b>b}ar</attribute:b></container:p>' );
  864. viewRoot._appendChild( viewP );
  865. selection._setTo( newSelection );
  866. renderer.markToSync( 'children', viewRoot );
  867. renderer.render();
  868. const domP = domRoot.childNodes[ 0 ];
  869. expect( domP.childNodes.length ).to.equal( 2 );
  870. expect( domP.childNodes[ 0 ].data ).to.equal( 'foo' );
  871. expect( domP.childNodes[ 1 ].tagName.toLowerCase() ).to.equal( 'b' );
  872. expect( domP.childNodes[ 1 ].childNodes.length ).to.equal( 1 );
  873. expect( domP.childNodes[ 1 ].childNodes[ 0 ].data ).to.equal( 'bar' );
  874. expect( domSelection.rangeCount ).to.equal( 1 );
  875. expect( domSelection.getRangeAt( 0 ).startContainer ).to.equal( domP.childNodes[ 0 ] );
  876. expect( domSelection.getRangeAt( 0 ).startOffset ).to.equal( 2 );
  877. expect( domSelection.getRangeAt( 0 ).endContainer ).to.equal( domP.childNodes[ 1 ].childNodes[ 0 ] );
  878. expect( domSelection.getRangeAt( 0 ).endOffset ).to.equal( 1 );
  879. renderer.markToSync( 'children', viewP );
  880. renderAndExpectNoChanges( renderer, domRoot );
  881. } );
  882. it( 'should not change selection if there is no editable with selection', () => {
  883. const domDiv = createElement( document, 'div', { contenteditable: true }, 'not editable' );
  884. document.body.appendChild( domDiv );
  885. domDiv.focus();
  886. const domSelection = document.getSelection();
  887. domSelection.removeAllRanges();
  888. domSelection.collapse( domDiv, 0 );
  889. const viewDiv = new ViewElement( viewDocument, 'div' );
  890. const { view: viewP, selection: newSelection } = parse( '<container:p>fo{o}</container:p>' );
  891. viewDiv._appendChild( viewP );
  892. selection._setTo( newSelection );
  893. renderer.render();
  894. expect( domSelection.rangeCount ).to.equal( 1 );
  895. // Depending on the browser selection may end up before the text node or at the beginning of it.
  896. const domRange = domSelection.getRangeAt( 0 );
  897. const assertSelectionAtEndOfTextNode = () => {
  898. expect( domRange.startContainer ).to.equal( domDiv );
  899. };
  900. const assertSelectionInsideTextNode = () => {
  901. expect( domRange.startContainer ).to.equal( domDiv.childNodes[ 0 ] );
  902. };
  903. testUtils.checkAssertions( assertSelectionAtEndOfTextNode, assertSelectionInsideTextNode );
  904. expect( domRange.startOffset ).to.equal( 0 );
  905. expect( domRange.collapsed ).to.be.true;
  906. domDiv.remove();
  907. } );
  908. it( 'should not change selection if there is no focus', () => {
  909. const domDiv = createElement( document, 'div', null, 'not editable' );
  910. document.body.appendChild( domDiv );
  911. const domSelection = document.getSelection();
  912. domSelection.removeAllRanges();
  913. const domRange = document.createRange();
  914. domRange.setStart( domDiv, 0 );
  915. domRange.collapse( true );
  916. domSelection.addRange( domRange );
  917. renderer.isFocused = false;
  918. const { view: viewP, selection: newSelection } = parse( '<container:p>fo{o}</container:p>' );
  919. viewRoot._appendChild( viewP );
  920. selection._setTo( newSelection );
  921. renderer.render();
  922. expect( domSelection.rangeCount ).to.equal( 1 );
  923. // Depending on the browser selection may end up before the text node or at the beginning of it.
  924. const domSelectionRange = domSelection.getRangeAt( 0 );
  925. const assertSelectionAtEndOfTextNode = () => {
  926. expect( domSelectionRange.startContainer ).to.equal( domDiv );
  927. };
  928. const assertSelectionInsideTextNode = () => {
  929. expect( domSelectionRange.startContainer ).to.equal( domDiv.childNodes[ 0 ] );
  930. };
  931. testUtils.checkAssertions( assertSelectionAtEndOfTextNode, assertSelectionInsideTextNode );
  932. expect( domSelectionRange.startOffset ).to.equal( 0 );
  933. expect( domSelectionRange.collapsed ).to.be.true;
  934. domDiv.remove();
  935. } );
  936. it( 'should not add inline filler after text node', () => {
  937. const { view: viewP, selection: newSelection } = parse( '<container:p>foo[]</container:p>' );
  938. viewRoot._appendChild( viewP );
  939. selection._setTo( newSelection );
  940. renderer.markToSync( 'children', viewRoot );
  941. renderer.render();
  942. const domP = domRoot.childNodes[ 0 ];
  943. expect( domP.innerHTML.indexOf( INLINE_FILLER ) ).to.equal( -1 );
  944. } );
  945. it( 'should throw if there is no filler in expected position', () => {
  946. const { view: viewP, selection: newSelection } = parse(
  947. '<container:p>foo<attribute:b>[]</attribute:b>bar</container:p>' );
  948. viewRoot._appendChild( viewP );
  949. selection._setTo( newSelection );
  950. renderer.markToSync( 'children', viewRoot );
  951. renderer.render();
  952. const domB = domRoot.childNodes[ 0 ].childNodes[ 1 ];
  953. const viewB = viewP.getChild( 1 );
  954. expect( domB.childNodes[ 0 ].data ).to.equal( INLINE_FILLER );
  955. // Remove filler.
  956. domB.childNodes[ 0 ].data = '';
  957. selection._setTo( null );
  958. renderer.markToSync( 'children', viewB );
  959. expectToThrowCKEditorError( () => {
  960. renderer.render();
  961. }, /^view-renderer-filler-was-lost/, selection );
  962. } );
  963. // #1014.
  964. it( 'should create inline filler in newly created dom nodes', () => {
  965. // 1. Create the view structure which needs inline filler.
  966. const inputView =
  967. '<container:ul>' +
  968. '<container:li>Foobar.</container:li>' +
  969. '<container:li>[]<container:div></container:div></container:li>' +
  970. '</container:ul>';
  971. const { view: view, selection: newSelection } = parse( inputView );
  972. viewRoot._appendChild( view );
  973. selection._setTo( newSelection );
  974. renderer.markToSync( 'children', viewRoot );
  975. renderer.render();
  976. // 2. Check if filler element has been (correctly) created.
  977. expect( domRoot.innerHTML.indexOf( INLINE_FILLER ) ).not.to.equal( -1 );
  978. // 3. Move the inline filler parent to a newly created element.
  979. const viewLi = view.getChild( 0 );
  980. const viewLiIndented = view._removeChildren( 1, 1 ); // Array with one element.
  981. const viewUl = new ViewContainerElement( viewDocument, 'ul', null, viewLiIndented );
  982. viewLi._appendChild( viewUl );
  983. // 4. Mark changed items and render the view.
  984. renderer.markToSync( 'children', view );
  985. renderer.markToSync( 'children', viewLi );
  986. renderer.render();
  987. expect( domRoot.innerHTML.indexOf( INLINE_FILLER ) ).not.to.equal( -1 );
  988. const domSelection = document.getSelection();
  989. expect( domSelection.getRangeAt( 0 ).startOffset ).to.equal( 7 ); // After inline filler.
  990. } );
  991. it( 'should handle focusing element', () => {
  992. selection._setTo( viewRoot, 0 );
  993. const domFocusSpy = testUtils.sinon.spy( domRoot, 'focus' );
  994. renderer.render();
  995. expect( domFocusSpy.called ).to.be.true;
  996. } );
  997. it( 'should not focus editable if isFocues is set to false', () => {
  998. const domFocusSpy = testUtils.sinon.spy( domRoot, 'focus' );
  999. renderer.isFocused = false;
  1000. renderer.render();
  1001. expect( domFocusSpy.calledOnce ).to.be.false;
  1002. } );
  1003. it( 'should not focus already focused DOM element', () => {
  1004. domRoot.setAttribute( 'contentEditable', true );
  1005. domRoot.focus();
  1006. const domFocusSpy = testUtils.sinon.spy( domRoot, 'focus' );
  1007. renderer.render();
  1008. expect( domFocusSpy.called ).to.be.false;
  1009. } );
  1010. it( 'should render NBSP as last space in the previous inline element', () => {
  1011. const viewP = parse( '<container:p>x <attribute:b>y</attribute:b></container:p>' );
  1012. viewRoot._appendChild( viewP );
  1013. renderer.markToSync( 'children', viewRoot );
  1014. renderer.render();
  1015. const domP = domRoot.childNodes[ 0 ];
  1016. const domB = domP.childNodes[ 1 ];
  1017. expect( domP.childNodes[ 0 ].data ).to.equal( 'x ' );
  1018. expect( domB.childNodes[ 0 ].data ).to.equal( 'y' );
  1019. expect( domP.innerHTML ).to.equal( 'x <b>y</b>' );
  1020. // Insert space resulting in '<p>x <b> y</b></p>'.
  1021. const viewB = viewP.getChild( 1 );
  1022. viewB._removeChildren( 0 );
  1023. viewB._appendChild( new ViewText( viewDocument, ' y' ) );
  1024. renderer.markToSync( 'children', viewP );
  1025. renderer.render();
  1026. expect( domP.childNodes[ 0 ].data ).to.equal( 'x\u00A0' );
  1027. expect( domB.childNodes[ 0 ].data ).to.equal( ' y' );
  1028. expect( domP.innerHTML ).to.equal( 'x&nbsp;<b> y</b>' );
  1029. } );
  1030. it( 'should update sibling after, when node before is removed', () => {
  1031. const viewP = parse( '<container:p>x<attribute:b> y</attribute:b></container:p>' );
  1032. viewRoot._appendChild( viewP );
  1033. renderer.markToSync( 'children', viewRoot );
  1034. renderer.render();
  1035. const domP = domRoot.childNodes[ 0 ];
  1036. const domB = domP.childNodes[ 1 ];
  1037. expect( domP.childNodes[ 0 ].data ).to.equal( 'x' );
  1038. expect( domB.childNodes[ 0 ].data ).to.equal( ' y' );
  1039. expect( domP.innerHTML ).to.equal( 'x<b> y</b>' );
  1040. // Remove 'x' resulting in '<p><b> y</b></p>'.
  1041. viewP._removeChildren( 0 );
  1042. renderer.markToSync( 'children', viewP );
  1043. renderer.render();
  1044. expect( domB.childNodes[ 0 ].data ).to.equal( '\u00A0y' );
  1045. expect( domP.innerHTML ).to.equal( '<b>&nbsp;y</b>' );
  1046. } );
  1047. it( 'should update sibling before, when node after is removed', () => {
  1048. const viewP = parse( '<container:p>x <attribute:b>y</attribute:b></container:p>' );
  1049. viewRoot._appendChild( viewP );
  1050. renderer.markToSync( 'children', viewRoot );
  1051. renderer.render();
  1052. const domP = domRoot.childNodes[ 0 ];
  1053. const domB = domP.childNodes[ 1 ];
  1054. expect( domP.childNodes[ 0 ].data ).to.equal( 'x ' );
  1055. expect( domB.childNodes[ 0 ].data ).to.equal( 'y' );
  1056. expect( domP.innerHTML ).to.equal( 'x <b>y</b>' );
  1057. // Remove '<b>y</b>' resulting in '<p>x </p>'.
  1058. viewP._removeChildren( 1 );
  1059. renderer.markToSync( 'children', viewP );
  1060. renderer.render();
  1061. expect( domP.childNodes[ 0 ].data ).to.equal( 'x\u00A0' );
  1062. expect( domP.innerHTML ).to.equal( 'x&nbsp;' );
  1063. } );
  1064. // #1093
  1065. it( 'should update siblings after space is inserted in element before - text-element', () => {
  1066. const viewP = parse( '<container:p>x<attribute:b> y</attribute:b></container:p>' );
  1067. viewRoot._appendChild( viewP );
  1068. renderer.markToSync( 'children', viewRoot );
  1069. renderer.render();
  1070. const domP = domRoot.childNodes[ 0 ];
  1071. const domB = domP.childNodes[ 1 ];
  1072. expect( domP.childNodes[ 0 ].data ).to.equal( 'x' );
  1073. expect( domB.childNodes[ 0 ].data ).to.equal( ' y' );
  1074. expect( domP.innerHTML ).to.equal( 'x<b> y</b>' );
  1075. // Insert space resulting in '<p>x <b> y</b></p>'.
  1076. viewP._removeChildren( 0 );
  1077. viewP._insertChild( 0, new ViewText( viewDocument, 'x ' ) );
  1078. renderer.markToSync( 'children', viewP );
  1079. renderer.render();
  1080. expect( domP.childNodes[ 0 ].data ).to.equal( 'x\u00A0' );
  1081. expect( domB.childNodes[ 0 ].data ).to.equal( ' y' );
  1082. expect( domP.innerHTML ).to.equal( 'x&nbsp;<b> y</b>' );
  1083. } );
  1084. // #1093
  1085. it( 'should update siblings after space is inserted in element before - element-text', () => {
  1086. const viewP = parse( '<container:p><attribute:b>x</attribute:b> y</container:p>' );
  1087. viewRoot._appendChild( viewP );
  1088. renderer.markToSync( 'children', viewRoot );
  1089. renderer.render();
  1090. const domP = domRoot.childNodes[ 0 ];
  1091. const domB = domP.childNodes[ 0 ];
  1092. expect( domB.childNodes[ 0 ].data ).to.equal( 'x' );
  1093. expect( domP.childNodes[ 1 ].data ).to.equal( ' y' );
  1094. expect( domP.innerHTML ).to.equal( '<b>x</b> y' );
  1095. // Insert space resulting in '<p><b>x </b> y</p>'.
  1096. const viewB = viewP.getChild( 0 );
  1097. viewB._removeChildren( 0 );
  1098. viewB._insertChild( 0, new ViewText( viewDocument, 'x ' ) );
  1099. renderer.markToSync( 'children', viewP );
  1100. renderer.render();
  1101. expect( domB.childNodes[ 0 ].data ).to.equal( 'x\u00A0' );
  1102. expect( domP.childNodes[ 1 ].data ).to.equal( ' y' );
  1103. expect( domP.innerHTML ).to.equal( '<b>x&nbsp;</b> y' );
  1104. } );
  1105. // #1093
  1106. it( 'should update siblings after space is inserted in element before - element-element', () => {
  1107. const viewP = parse( '<container:p><attribute:b>x</attribute:b><attribute:i> y</attribute:i></container:p>' );
  1108. viewRoot._appendChild( viewP );
  1109. renderer.markToSync( 'children', viewRoot );
  1110. renderer.render();
  1111. const domP = domRoot.childNodes[ 0 ];
  1112. const domB = domP.childNodes[ 0 ];
  1113. const domI = domP.childNodes[ 1 ];
  1114. expect( domB.childNodes[ 0 ].data ).to.equal( 'x' );
  1115. expect( domI.childNodes[ 0 ].data ).to.equal( ' y' );
  1116. expect( domP.innerHTML ).to.equal( '<b>x</b><i> y</i>' );
  1117. // Insert space resulting in '<p><b>x </b><i> y</i></p>'.
  1118. const viewB = viewP.getChild( 0 );
  1119. viewB._removeChildren( 0 );
  1120. viewB._insertChild( 0, new ViewText( viewDocument, 'x ' ) );
  1121. renderer.markToSync( 'children', viewP );
  1122. renderer.render();
  1123. expect( domB.childNodes[ 0 ].data ).to.equal( 'x\u00A0' );
  1124. expect( domI.childNodes[ 0 ].data ).to.equal( ' y' );
  1125. expect( domP.innerHTML ).to.equal( '<b>x&nbsp;</b><i> y</i>' );
  1126. } );
  1127. // #1125
  1128. it( 'should properly rerender many changes done in one batch', () => {
  1129. // This test transforms:
  1130. //
  1131. // <h2>He<strong>ding 1</strong></h2>
  1132. // <p>Ph <strong>Bold</strong> <i>It<strong>alic</strong></i> <a><strong>Lin</strong>k</a></p>
  1133. // <blockquote><ul><li>Quoted <strong>item 1</strong></li></ul></blockquote>
  1134. //
  1135. // into:
  1136. //
  1137. // <h2>Heading 2</h2>
  1138. // <p>Ph <i><strong>Italic</strong></i> <a><strong>L</strong>ink 1</a></p>
  1139. // <blockquote><p>Qu<strong>ote</strong></p><ul><li><strong>Quoted item 1</strong></li></ul></blockquote>
  1140. //
  1141. // during one rerender to check if complex structure changes are rerendered correctly.
  1142. const viewContent = parse( '' +
  1143. '<container:h2>He' +
  1144. '<attribute:i>ading 1</attribute:i>' +
  1145. '</container:h2>' +
  1146. '<container:p>Ph ' +
  1147. '<attribute:strong>Bold</attribute:strong> ' +
  1148. '<attribute:i>It' +
  1149. '<attribute:strong>alic</attribute:strong>' +
  1150. '</attribute:i> ' +
  1151. '<attribute:a href="https://ckeditor.com">' +
  1152. '<attribute:strong>Lin</attribute:strong>' +
  1153. 'k</attribute:a>' +
  1154. '</container:p>' +
  1155. '<container:blockquote>' +
  1156. '<container:ul>' +
  1157. '<container:li>Quoted <attribute:strong>item 1</attribute:strong></container:li>' +
  1158. '</container:ul>' +
  1159. '</container:blockquote>' );
  1160. viewRoot._appendChild( viewContent );
  1161. renderer.markToSync( 'children', viewRoot );
  1162. renderer.render();
  1163. // '<h2>He<i>ading 1</i></h2>' -> '<h2>Heading 2</h2>'
  1164. const viewHeading = viewRoot.getChild( 0 );
  1165. viewHeading._removeChildren( 0, viewHeading.childCount );
  1166. viewHeading._insertChild( 0, new ViewText( viewDocument, 'Heading 2' ) );
  1167. // Usually whole subtree is marked to sync so we mark root, changed element and all its direct children.
  1168. renderer.markToSync( 'children', viewRoot );
  1169. renderer.markToSync( 'children', viewHeading );
  1170. renderer.markToSync( 'text', viewHeading.getChild( 0 ) );
  1171. // '<p>Ph <strong>Bold</strong> <i>It<strong>alic</strong></i> <a><strong>Lin</strong>k</a></p>'
  1172. // ->
  1173. // '<p>Ph <i><strong>Italic</strong></i> <a><strong>L</strong>ink 1</a></p>'
  1174. const viewP = viewRoot.getChild( 1 );
  1175. viewP._removeChildren( 0, viewP.childCount );
  1176. viewP._insertChild(
  1177. 0,
  1178. parse(
  1179. 'Ph <attribute:i><attribute:strong>Italic</attribute:strong></attribute:i> ' +
  1180. '<attribute:a href="https://ckeditor.com"><attribute:strong>L</attribute:strong>ink 1</attribute:a>'
  1181. )
  1182. );
  1183. renderer.markToSync( 'children', viewRoot );
  1184. renderer.markToSync( 'children', viewP );
  1185. renderer.markToSync( 'children', viewP.getChild( 1 ) );
  1186. renderer.markToSync( 'children', viewP.getChild( 3 ) );
  1187. renderer.markToSync( 'text', viewP.getChild( 0 ) );
  1188. renderer.markToSync( 'text', viewP.getChild( 2 ) );
  1189. // '<blockquote><ul><li>Quoted <strong>item 1</strong></li></ul></blockquote>'
  1190. // -> '<blockquote><p>Qu<strong>ote</strong></p><ul><li><strong>Quoted item 1</strong></li></ul></blockquote>'
  1191. const viewBq = viewRoot.getChild( 2 );
  1192. viewBq._removeChildren( 0, viewBq.childCount );
  1193. viewBq._insertChild(
  1194. 0,
  1195. parse(
  1196. '<container:p>Qu<attribute:strong>ote</attribute:strong></container:p>' +
  1197. '<container:ul><container:li><attribute:strong>Quoted item 1</attribute:strong></container:li></container:ul>'
  1198. )
  1199. );
  1200. renderer.markToSync( 'children', viewRoot );
  1201. renderer.markToSync( 'children', viewBq );
  1202. renderer.markToSync( 'children', viewBq.getChild( 0 ) );
  1203. renderer.markToSync( 'children', viewBq.getChild( 1 ) );
  1204. renderer.render();
  1205. expect( normalizeHtml( domRoot.innerHTML ) ).to.equal(
  1206. '<h2>Heading 2</h2>' +
  1207. '<p>Ph <i><strong>Italic</strong></i> <a href="https://ckeditor.com"><strong>L</strong>ink 1</a></p>' +
  1208. '<blockquote><p>Qu<strong>ote</strong></p><ul><li><strong>Quoted item 1</strong></li></ul></blockquote>'
  1209. );
  1210. } );
  1211. // #1125
  1212. it( 'should properly rerender changes when whole content replaced at once', () => {
  1213. // This test replaces:
  1214. //
  1215. // <h1>Header</h1>
  1216. // <blockquote><ul><li>Quoted <strong>item 1</strong></li><li>Item 2</li></ul></blockquote>
  1217. //
  1218. // with:
  1219. //
  1220. // <h2>Header</h2>
  1221. // <p>Not Quoted <strong>item 1</strong> and item 2</p>
  1222. //
  1223. // during one rerender to check if complex structure changes are rerendered correctly.
  1224. const viewContent = parse(
  1225. '<container:h1>Header</container:h1>' +
  1226. '<container:blockquote>' +
  1227. '<container:ul>' +
  1228. '<container:li>Quoted <attribute:strong>item 1</attribute:strong></container:li>' +
  1229. '<container:li>Item 2</container:li>' +
  1230. '</container:ul>' +
  1231. '</container:blockquote>'
  1232. );
  1233. viewRoot._appendChild( viewContent );
  1234. renderer.markToSync( 'children', viewRoot );
  1235. renderer.render();
  1236. const newViewContent = parse(
  1237. '<container:h2>Header</container:h2>' +
  1238. '<container:p>Not Quoted <attribute:strong>item 1</attribute:strong> and item 2</container:p>'
  1239. );
  1240. viewRoot._removeChildren( 0, viewRoot.childCount );
  1241. viewRoot._appendChild( newViewContent );
  1242. renderer.markToSync( 'children', viewRoot );
  1243. renderer.render();
  1244. expect( normalizeHtml( domRoot.innerHTML ) ).to.equal(
  1245. '<h2>Header</h2><p>Not Quoted <strong>item 1</strong> and item 2</p>'
  1246. );
  1247. } );
  1248. // #1451
  1249. it( 'should correctly render changed children even if direct parent is not marked to sync', () => {
  1250. const inputView =
  1251. '<container:ul>' +
  1252. '<container:li>Foo</container:li>' +
  1253. '<container:li><attribute:b>Bar</attribute:b></container:li>' +
  1254. '</container:ul>';
  1255. const view = parse( inputView );
  1256. viewRoot._appendChild( view );
  1257. renderer.markToSync( 'children', viewRoot );
  1258. renderer.render();
  1259. expect( domRoot.innerHTML ).to.equal( '<ul><li>Foo</li><li><b>Bar</b></li></ul>' );
  1260. const viewLi = view.getChild( 0 );
  1261. const viewLiIndented = view._removeChildren( 1, 1 ); // Array with one element.
  1262. viewLiIndented[ 0 ]._appendChild( parse( '<attribute:i>Baz</attribute:i>' ) );
  1263. const viewUl = new ViewContainerElement( viewDocument, 'ul', null, viewLiIndented );
  1264. viewLi._appendChild( viewUl );
  1265. renderer.markToSync( 'children', view );
  1266. renderer.markToSync( 'children', viewLi );
  1267. renderer.render();
  1268. expect( domRoot.innerHTML ).to.equal( '<ul><li>Foo<ul><li><b>Bar</b><i>Baz</i></li></ul></li></ul>' );
  1269. } );
  1270. // #1439
  1271. it( 'should not force–refresh the selection in non–Gecko browsers after a soft break', () => {
  1272. const domSelection = domRoot.ownerDocument.defaultView.getSelection();
  1273. testUtils.sinon.stub( env, 'isGecko' ).get( () => false );
  1274. const spy = testUtils.sinon.stub( domSelection, 'addRange' );
  1275. // <p>foo<br/>[]</p>
  1276. const { view: viewP, selection: newSelection } = parse(
  1277. '<container:p>' +
  1278. 'foo[]' +
  1279. '<empty:br></empty:br>[]' +
  1280. '</container:p>' );
  1281. viewRoot._appendChild( viewP );
  1282. selection._setTo( newSelection );
  1283. renderer.markToSync( 'children', viewRoot );
  1284. renderer.render();
  1285. sinon.assert.notCalled( spy );
  1286. } );
  1287. // #1439
  1288. it( 'should force–refresh the selection in Gecko browsers after a soft break to nudge the caret', () => {
  1289. const domSelection = domRoot.ownerDocument.defaultView.getSelection();
  1290. testUtils.sinon.stub( env, 'isGecko' ).get( () => true );
  1291. const spy = testUtils.sinon.stub( domSelection, 'addRange' );
  1292. // <p>foo[]<b>bar</b></p>
  1293. let { view: viewP, selection: newSelection } = parse(
  1294. '<container:p>' +
  1295. 'foo[]' +
  1296. '<attribute:b>bar</attribute:b>' +
  1297. '</container:p>' );
  1298. viewRoot._appendChild( viewP );
  1299. selection._setTo( newSelection );
  1300. renderer.markToSync( 'children', viewRoot );
  1301. renderer.render();
  1302. sinon.assert.notCalled( spy );
  1303. // <p>foo<b>bar</b></p><p>foo[]<br/></p>
  1304. ( { view: viewP, selection: newSelection } = parse(
  1305. '<container:p>' +
  1306. 'foo[]' +
  1307. '<empty:br></empty:br>' +
  1308. '</container:p>' ) );
  1309. viewRoot._appendChild( viewP );
  1310. selection._setTo( newSelection );
  1311. renderer.markToSync( 'children', viewRoot );
  1312. renderer.render();
  1313. sinon.assert.notCalled( spy );
  1314. // <p>foo<b>bar</b></p><p>foo<br/>[]</p>
  1315. selection._setTo( [
  1316. new ViewRange( new ViewPosition( viewP, 2 ), new ViewPosition( viewP, 2 ) )
  1317. ] );
  1318. renderer.markToSync( 'children', viewRoot );
  1319. renderer.render();
  1320. sinon.assert.calledOnce( spy );
  1321. } );
  1322. describe( 'fake selection', () => {
  1323. beforeEach( () => {
  1324. const { view: viewP, selection: newSelection } = parse(
  1325. '<container:p>[foo bar]</container:p>'
  1326. );
  1327. viewRoot._appendChild( viewP );
  1328. selection._setTo( newSelection );
  1329. renderer.markToSync( 'children', viewRoot );
  1330. renderer.render();
  1331. } );
  1332. it( 'should render fake selection', () => {
  1333. const label = 'fake selection label';
  1334. selection._setTo( selection.getRanges(), { fake: true, label } );
  1335. renderer.render();
  1336. expect( domRoot.childNodes.length ).to.equal( 2 );
  1337. const container = domRoot.childNodes[ 1 ];
  1338. expect( domConverter.mapDomToView( container ) ).to.be.undefined;
  1339. expect( container.childNodes.length ).to.equal( 1 );
  1340. const textNode = container.childNodes[ 0 ];
  1341. expect( textNode.textContent ).to.equal( label );
  1342. const domSelection = domRoot.ownerDocument.getSelection();
  1343. assertDomSelectionContents( domSelection, container, /^fake selection label$/ );
  1344. } );
  1345. describe( 'subsequent call optimization', () => {
  1346. // https://github.com/ckeditor/ckeditor5-engine/issues/1791
  1347. it( 'doesn\'t render the same selection multiple times', () => {
  1348. const createRangeSpy = sinon.spy( document, 'createRange' );
  1349. const label = 'subsequent fake selection calls';
  1350. selection._setTo( selection.getRanges(), { fake: true, label } );
  1351. renderer.render();
  1352. selection._setTo( selection.getRanges(), { fake: true, label } );
  1353. renderer.render();
  1354. expect( createRangeSpy.callCount ).to.equal( 1 );
  1355. } );
  1356. it( 'different subsequent fake selections sets do change native selection', () => {
  1357. const createRangeSpy = sinon.spy( document, 'createRange' );
  1358. selection._setTo( selection.getRanges(), { fake: true, label: 'selection 1' } );
  1359. renderer.render();
  1360. selection._setTo( selection.getRanges(), { fake: true, label: 'selection 2' } );
  1361. renderer.render();
  1362. expect( createRangeSpy.callCount ).to.equal( 2 );
  1363. } );
  1364. it( 'rerenders selection if disturbed externally', () => {
  1365. const interruptingRange = document.createRange();
  1366. interruptingRange.setStartBefore( domRoot.children[ 0 ] );
  1367. interruptingRange.setEndAfter( domRoot.children[ 0 ] );
  1368. const createRangeSpy = sinon.spy( document, 'createRange' );
  1369. const label = 'selection 1';
  1370. selection._setTo( selection.getRanges(), { fake: true, label } );
  1371. renderer.render();
  1372. document.getSelection().removeAllRanges();
  1373. document.getSelection().addRange( interruptingRange );
  1374. selection._setTo( selection.getRanges(), { fake: true, label } );
  1375. renderer.render();
  1376. expect( createRangeSpy.callCount ).to.equal( 2 );
  1377. } );
  1378. it( 'correctly maps fake selection ', () => {
  1379. // See https://github.com/ckeditor/ckeditor5-engine/pull/1792#issuecomment-529814641
  1380. const label = 'subsequent fake selection calls';
  1381. const { view: newParagraph, selection: newSelection } = parse( '<container:p>[baz]</container:p>' );
  1382. viewRoot._appendChild( newParagraph );
  1383. selection._setTo( selection.getRanges(), { fake: true, label } );
  1384. renderer.render();
  1385. selection._setTo( newSelection.getRanges(), { fake: true, label } );
  1386. renderer.render();
  1387. const fakeSelectionContainer = domRoot.childNodes[ 1 ];
  1388. const mappedSelection = renderer.domConverter.fakeSelectionToView( fakeSelectionContainer );
  1389. expect( stringify( viewRoot, mappedSelection ) ).to.equal( '<div><p>foo bar</p><p>[baz]</p></div>' );
  1390. } );
  1391. } );
  1392. it( 'should render &nbsp; if no selection label is provided', () => {
  1393. selection._setTo( selection.getRanges(), { fake: true } );
  1394. renderer.render();
  1395. expect( domRoot.childNodes.length ).to.equal( 2 );
  1396. const container = domRoot.childNodes[ 1 ];
  1397. expect( container.childNodes.length ).to.equal( 1 );
  1398. const textNode = container.childNodes[ 0 ];
  1399. expect( textNode.textContent ).to.equal( '\u00A0' );
  1400. const domSelection = domRoot.ownerDocument.getSelection();
  1401. assertDomSelectionContents( domSelection, container, /^[ \u00A0]$/ );
  1402. } );
  1403. it( 'should remove fake selection container when selection is no longer fake', () => {
  1404. selection._setTo( selection.getRanges(), { fake: true } );
  1405. renderer.render();
  1406. selection._setTo( selection.getRanges(), { fake: false } );
  1407. renderer.render();
  1408. expect( domRoot.childNodes.length ).to.equal( 1 );
  1409. const domParagraph = domRoot.childNodes[ 0 ];
  1410. expect( domParagraph.childNodes.length ).to.equal( 1 );
  1411. expect( domParagraph.tagName.toLowerCase() ).to.equal( 'p' );
  1412. const domSelection = domRoot.ownerDocument.getSelection();
  1413. assertDomSelectionContents( domSelection, domParagraph, /^foo bar$/ );
  1414. } );
  1415. it( 'should reuse fake selection container #1', () => {
  1416. const label = 'fake selection label';
  1417. selection._setTo( selection.getRanges(), { fake: true, label } );
  1418. renderer.render();
  1419. expect( domRoot.childNodes.length ).to.equal( 2 );
  1420. const container = domRoot.childNodes[ 1 ];
  1421. selection._setTo( selection.getRanges(), { fake: true, label } );
  1422. renderer.render();
  1423. expect( domRoot.childNodes.length ).to.equal( 2 );
  1424. const newContainer = domRoot.childNodes[ 1 ];
  1425. expect( newContainer ).equals( container );
  1426. expect( newContainer.childNodes.length ).to.equal( 1 );
  1427. const textNode = newContainer.childNodes[ 0 ];
  1428. expect( textNode.textContent ).to.equal( label );
  1429. } );
  1430. it( 'should reuse fake selection container #2', () => {
  1431. selection._setTo( selection.getRanges(), { fake: true, label: 'label 1' } );
  1432. renderer.render();
  1433. expect( domRoot.childNodes.length ).to.equal( 2 );
  1434. const container = domRoot.childNodes[ 1 ];
  1435. selection._setTo( selection.getRanges(), { fake: false } );
  1436. renderer.render();
  1437. expect( domRoot.childNodes.length ).to.equal( 1 );
  1438. selection._setTo( selection.getRanges(), { fake: true, label: 'label 2' } );
  1439. renderer.render();
  1440. expect( domRoot.childNodes.length ).to.equal( 2 );
  1441. const newContainer = domRoot.childNodes[ 1 ];
  1442. expect( newContainer ).equals( container );
  1443. expect( newContainer.childNodes.length ).to.equal( 1 );
  1444. const textNode = newContainer.childNodes[ 0 ];
  1445. expect( textNode.textContent ).to.equal( 'label 2' );
  1446. } );
  1447. it( 'should reuse fake selection container #3', () => {
  1448. selection._setTo( selection.getRanges(), { fake: true, label: 'label 1' } );
  1449. renderer.render();
  1450. expect( domRoot.childNodes.length ).to.equal( 2 );
  1451. const container = domRoot.childNodes[ 1 ];
  1452. selection._setTo( selection.getRanges(), { fake: true, label: 'label 2' } );
  1453. renderer.render();
  1454. expect( domRoot.childNodes.length ).to.equal( 2 );
  1455. const newContainer = domRoot.childNodes[ 1 ];
  1456. expect( newContainer ).equals( container );
  1457. expect( newContainer.childNodes.length ).to.equal( 1 );
  1458. const textNode = newContainer.childNodes[ 0 ];
  1459. expect( textNode.textContent ).to.equal( 'label 2' );
  1460. } );
  1461. it( 'should style fake selection container properly', () => {
  1462. selection._setTo( selection.getRanges(), { fake: true, label: 'fake selection' } );
  1463. renderer.render();
  1464. expect( domRoot.childNodes.length ).to.equal( 2 );
  1465. const container = domRoot.childNodes[ 1 ];
  1466. expect( container.style.position ).to.equal( 'fixed' );
  1467. expect( container.style.top ).to.equal( '0px' );
  1468. expect( container.style.left ).to.equal( '-9999px' );
  1469. } );
  1470. it( 'should move fake selection container between editables', () => {
  1471. const viewEditable = new ViewEditableElement( viewDocument, 'div' );
  1472. viewEditable._appendChild( parse( '<container:p>abc xyz</container:p>' ) );
  1473. const domEditable = document.createElement( 'div' );
  1474. document.body.appendChild( domEditable );
  1475. domConverter.bindElements( domEditable, viewEditable );
  1476. renderer.markToSync( 'children', viewEditable );
  1477. selection._setTo( selection.getRanges(), { fake: true, label: 'fake selection' } );
  1478. renderer.render();
  1479. let container = document.getSelection().anchorNode;
  1480. expect( domRoot.contains( container ) ).to.be.true;
  1481. selection._setTo( viewEditable, 'in', { fake: true, label: 'fake selection' } );
  1482. renderer.render();
  1483. container = document.getSelection().anchorNode;
  1484. expect( domEditable.contains( container ) ).to.be.true;
  1485. domEditable.remove();
  1486. } );
  1487. it( 'should bind fake selection container to view selection', () => {
  1488. selection._setTo( selection.getRanges(), { fake: true, label: 'fake selection' } );
  1489. renderer.render();
  1490. expect( domRoot.childNodes.length ).to.equal( 2 );
  1491. const container = domRoot.childNodes[ 1 ];
  1492. const bindSelection = renderer.domConverter.fakeSelectionToView( container );
  1493. expect( bindSelection ).to.not.be.undefined;
  1494. expect( bindSelection.isEqual( selection ) ).to.be.true;
  1495. } );
  1496. // https://github.com/ckeditor/ckeditor5-engine/issues/1714.
  1497. it( 'should handle situation when label got removed from the fake selection container', () => {
  1498. const label = 'fake selection label';
  1499. selection._setTo( selection.getRanges(), { fake: true, label } );
  1500. renderer.render();
  1501. expect( domRoot.childNodes.length ).to.equal( 2 );
  1502. const container = domRoot.childNodes[ 1 ];
  1503. expect( domConverter.mapDomToView( container ) ).to.be.undefined;
  1504. expect( container.childNodes.length ).to.equal( 1 );
  1505. const textNode = container.childNodes[ 0 ];
  1506. expect( textNode.textContent ).to.equal( label );
  1507. // Remove a text node (label) from the fake selection container.
  1508. // It can be done by pressing backspace while the delete command is disabled and selection is on the widget.
  1509. textNode.remove();
  1510. renderer.render();
  1511. const domSelection = domRoot.ownerDocument.getSelection();
  1512. assertDomSelectionContents( domSelection, container, /^fake selection label$/ );
  1513. } );
  1514. // Use a forgiving way of checking what the selection contains
  1515. // because Safari normalizes the selection ranges so precise checking is troublesome.
  1516. // Also, Firefox returns a normal space instead of nbsp so we need to use even more alternatives.
  1517. function assertDomSelectionContents( domSelection, expectedContainer, expectedText ) {
  1518. const domSelectionContainer = domSelection.getRangeAt( 0 ).commonAncestorContainer;
  1519. expect( domSelection.toString() ).to.match( expectedText );
  1520. expect(
  1521. domSelectionContainer == expectedContainer.firstChild || domSelectionContainer == expectedContainer
  1522. ).to.be.true;
  1523. }
  1524. } );
  1525. // #887
  1526. describe( 'similar selection', () => {
  1527. // Use spies to check selection updates. Some selection positions are not achievable in some
  1528. // browsers (e.g. <p>Foo<b>{}Bar</b></p> in Chrome) so asserting dom selection after rendering would fail.
  1529. let selectionCollapseSpy, selectionExtendSpy;
  1530. afterEach( () => {
  1531. if ( selectionCollapseSpy ) {
  1532. selectionCollapseSpy.restore();
  1533. selectionCollapseSpy = null;
  1534. }
  1535. if ( selectionExtendSpy ) {
  1536. selectionExtendSpy.restore();
  1537. selectionExtendSpy = null;
  1538. }
  1539. } );
  1540. it( 'should always render collapsed selection even if it is similar', () => {
  1541. const domSelection = document.getSelection();
  1542. const { view: viewP, selection: newSelection } = parse(
  1543. '<container:p>foo{}<attribute:b>bar</attribute:b></container:p>' );
  1544. viewRoot._appendChild( viewP );
  1545. selection._setTo( newSelection );
  1546. renderer.markToSync( 'children', viewRoot );
  1547. renderer.render();
  1548. const domP = domRoot.childNodes[ 0 ];
  1549. const domB = domP.childNodes[ 1 ];
  1550. const viewB = viewRoot.getChild( 0 ).getChild( 1 );
  1551. expect( domSelection.isCollapsed ).to.true;
  1552. expect( domSelection.rangeCount ).to.equal( 1 );
  1553. expect( domSelection.getRangeAt( 0 ).startContainer ).to.equal( domP.childNodes[ 0 ] );
  1554. expect( domSelection.getRangeAt( 0 ).startOffset ).to.equal( 3 );
  1555. expect( domSelection.getRangeAt( 0 ).endContainer ).to.equal( domP.childNodes[ 0 ] );
  1556. expect( domSelection.getRangeAt( 0 ).endOffset ).to.equal( 3 );
  1557. selectionCollapseSpy = sinon.spy( window.Selection.prototype, 'collapse' );
  1558. selectionExtendSpy = sinon.spy( window.Selection.prototype, 'extend' );
  1559. // <container:p>foo<attribute:b>{}bar</attribute:b></container:p>
  1560. selection._setTo( [
  1561. new ViewRange( new ViewPosition( viewB.getChild( 0 ), 0 ), new ViewPosition( viewB.getChild( 0 ), 0 ) )
  1562. ] );
  1563. renderer.markToSync( 'children', viewP );
  1564. renderer.render();
  1565. expect( selectionCollapseSpy.calledOnce ).to.true;
  1566. expect( selectionCollapseSpy.calledWith( domB.childNodes[ 0 ], 0 ) ).to.true;
  1567. expect( selectionExtendSpy.calledOnce ).to.true;
  1568. expect( selectionExtendSpy.calledWith( domB.childNodes[ 0 ], 0 ) ).to.true;
  1569. } );
  1570. it( 'should always render collapsed selection even if it is similar (with empty element)', () => {
  1571. const domSelection = document.getSelection();
  1572. const { view: viewP, selection: newSelection } = parse(
  1573. '<container:p>foo<attribute:b>[]</attribute:b></container:p>' );
  1574. viewRoot._appendChild( viewP );
  1575. selection._setTo( newSelection );
  1576. renderer.markToSync( 'children', viewRoot );
  1577. renderer.render();
  1578. const domP = domRoot.childNodes[ 0 ];
  1579. const domB = domP.childNodes[ 1 ];
  1580. expect( domSelection.isCollapsed ).to.true;
  1581. expect( domSelection.rangeCount ).to.equal( 1 );
  1582. expect( domSelection.getRangeAt( 0 ).startContainer ).to.equal( domB.childNodes[ 0 ] );
  1583. expect( domSelection.getRangeAt( 0 ).startOffset ).to.equal( INLINE_FILLER_LENGTH );
  1584. expect( domSelection.getRangeAt( 0 ).endContainer ).to.equal( domB.childNodes[ 0 ] );
  1585. expect( domSelection.getRangeAt( 0 ).endOffset ).to.equal( INLINE_FILLER_LENGTH );
  1586. selectionCollapseSpy = sinon.spy( window.Selection.prototype, 'collapse' );
  1587. selectionExtendSpy = sinon.spy( window.Selection.prototype, 'extend' );
  1588. // <container:p>foo{}<attribute:b></attribute:b></container:p>
  1589. selection._setTo( [
  1590. new ViewRange( new ViewPosition( viewP.getChild( 0 ), 3 ), new ViewPosition( viewP.getChild( 0 ), 3 ) )
  1591. ] );
  1592. renderer.markToSync( 'children', viewP );
  1593. renderer.render();
  1594. expect( selectionCollapseSpy.calledOnce ).to.true;
  1595. expect( selectionCollapseSpy.calledWith( domP.childNodes[ 0 ], 3 ) ).to.true;
  1596. expect( selectionExtendSpy.calledOnce ).to.true;
  1597. expect( selectionExtendSpy.calledWith( domP.childNodes[ 0 ], 3 ) ).to.true;
  1598. } );
  1599. it( 'should always render non-collapsed selection if it not is similar', () => {
  1600. const domSelection = document.getSelection();
  1601. const { view: viewP, selection: newSelection } = parse(
  1602. '<container:p>fo{o}<attribute:b>bar</attribute:b></container:p>' );
  1603. viewRoot._appendChild( viewP );
  1604. selection._setTo( newSelection );
  1605. renderer.markToSync( 'children', viewRoot );
  1606. renderer.render();
  1607. const domP = domRoot.childNodes[ 0 ];
  1608. const domB = domP.childNodes[ 1 ];
  1609. const viewB = viewRoot.getChild( 0 ).getChild( 1 );
  1610. expect( domSelection.isCollapsed ).to.false;
  1611. expect( domSelection.rangeCount ).to.equal( 1 );
  1612. expect( domSelection.getRangeAt( 0 ).startContainer ).to.equal( domP.childNodes[ 0 ] );
  1613. expect( domSelection.getRangeAt( 0 ).startOffset ).to.equal( 2 );
  1614. expect( domSelection.getRangeAt( 0 ).endContainer ).to.equal( domP.childNodes[ 0 ] );
  1615. expect( domSelection.getRangeAt( 0 ).endOffset ).to.equal( 3 );
  1616. selectionCollapseSpy = sinon.spy( window.Selection.prototype, 'collapse' );
  1617. selectionExtendSpy = sinon.spy( window.Selection.prototype, 'extend' );
  1618. // <container:p>fo{o<attribute:b>b}ar</attribute:b></container:p>
  1619. selection._setTo( [
  1620. new ViewRange( new ViewPosition( viewP.getChild( 0 ), 2 ), new ViewPosition( viewB.getChild( 0 ), 1 ) )
  1621. ] );
  1622. renderer.markToSync( 'children', viewP );
  1623. renderer.render();
  1624. expect( selectionCollapseSpy.calledOnce ).to.true;
  1625. expect( selectionCollapseSpy.calledWith( domP.childNodes[ 0 ], 2 ) ).to.true;
  1626. expect( selectionExtendSpy.calledOnce ).to.true;
  1627. expect( selectionExtendSpy.calledWith( domB.childNodes[ 0 ], 1 ) ).to.true;
  1628. } );
  1629. it( 'should always render selection (even if it is same in view) if current dom selection is in incorrect place', () => {
  1630. const domSelection = document.getSelection();
  1631. const { view: viewP, selection: newSelection } = parse( '<container:p>foo[]<ui:span></ui:span></container:p>' );
  1632. viewRoot._appendChild( viewP );
  1633. selection._setTo( newSelection );
  1634. renderer.markToSync( 'children', viewRoot );
  1635. renderer.render();
  1636. // In DOM, set position to: <p>foo<span>[]</span></p>. This is incorrect DOM selection (it is in view ui element).
  1637. // Do not change view selection.
  1638. // When renderer will check if the DOM selection changed, it will convert DOM selection to a view selection.
  1639. // Selections (current view selection and view-from-dom selection) will be equal but we will still expect re-render
  1640. // because DOM selection is in incorrect place.
  1641. const domP = domRoot.childNodes[ 0 ];
  1642. const domSpan = domP.childNodes[ 1 ];
  1643. domSelection.collapse( domSpan, 0 );
  1644. renderer.render();
  1645. // Expect that after calling `renderer.render()` the DOM selection was re-rendered (and set at correct position).
  1646. // Depending on the browser selection may end up at the end of the text node or after the text node.
  1647. const assertSelectionAtEndOfTextNode = () => {
  1648. expect( domSelection.anchorNode ).to.equal( domP );
  1649. expect( domSelection.anchorOffset ).to.equal( 1 );
  1650. };
  1651. const assertSelectionInsideTextNode = () => {
  1652. const textNode = domP.childNodes[ 0 ];
  1653. expect( domSelection.anchorNode ).to.equal( textNode );
  1654. expect( domSelection.anchorOffset ).to.equal( 3 );
  1655. };
  1656. testUtils.checkAssertions( assertSelectionAtEndOfTextNode, assertSelectionInsideTextNode );
  1657. expect( domSelection.getRangeAt( 0 ).collapsed ).to.be.true;
  1658. } );
  1659. it( 'should not render non-collapsed selection it is similar (element start)', () => {
  1660. const domSelection = document.getSelection();
  1661. const { view: viewP, selection: newSelection } = parse(
  1662. '<container:p>foo<attribute:b>{ba}r</attribute:b></container:p>' );
  1663. viewRoot._appendChild( viewP );
  1664. selection._setTo( newSelection );
  1665. renderer.markToSync( 'children', viewRoot );
  1666. renderer.render();
  1667. const domP = domRoot.childNodes[ 0 ];
  1668. const domB = domP.childNodes[ 1 ];
  1669. const viewB = viewRoot.getChild( 0 ).getChild( 1 );
  1670. expect( domSelection.isCollapsed ).to.false;
  1671. expect( domSelection.rangeCount ).to.equal( 1 );
  1672. expect( domSelection.getRangeAt( 0 ).startContainer ).to.equal( domB.childNodes[ 0 ] );
  1673. expect( domSelection.getRangeAt( 0 ).startOffset ).to.equal( 0 );
  1674. expect( domSelection.getRangeAt( 0 ).endContainer ).to.equal( domB.childNodes[ 0 ] );
  1675. expect( domSelection.getRangeAt( 0 ).endOffset ).to.equal( 2 );
  1676. selectionCollapseSpy = sinon.spy( window.Selection.prototype, 'collapse' );
  1677. selectionExtendSpy = sinon.spy( window.Selection.prototype, 'extend' );
  1678. // <container:p>foo{<attribute:b>ba}r</attribute:b></container:p>
  1679. selection._setTo( [
  1680. new ViewRange( new ViewPosition( viewP.getChild( 0 ), 3 ), new ViewPosition( viewB.getChild( 0 ), 2 ) )
  1681. ] );
  1682. renderer.markToSync( 'children', viewP );
  1683. renderer.render();
  1684. expect( selectionCollapseSpy.notCalled ).to.true;
  1685. expect( selectionExtendSpy.notCalled ).to.true;
  1686. } );
  1687. it( 'should not render non-collapsed selection it is similar (element end)', () => {
  1688. const domSelection = document.getSelection();
  1689. const { view: viewP, selection: newSelection } = parse(
  1690. '<container:p>foo<attribute:b>b{ar}</attribute:b>baz</container:p>' );
  1691. viewRoot._appendChild( viewP );
  1692. selection._setTo( newSelection );
  1693. renderer.markToSync( 'children', viewRoot );
  1694. renderer.render();
  1695. const domP = domRoot.childNodes[ 0 ];
  1696. const domB = domP.childNodes[ 1 ];
  1697. const viewB = viewRoot.getChild( 0 ).getChild( 1 );
  1698. expect( domSelection.isCollapsed ).to.false;
  1699. expect( domSelection.rangeCount ).to.equal( 1 );
  1700. expect( domSelection.getRangeAt( 0 ).startContainer ).to.equal( domB.childNodes[ 0 ] );
  1701. expect( domSelection.getRangeAt( 0 ).startOffset ).to.equal( 1 );
  1702. expect( domSelection.getRangeAt( 0 ).endContainer ).to.equal( domB.childNodes[ 0 ] );
  1703. expect( domSelection.getRangeAt( 0 ).endOffset ).to.equal( 3 );
  1704. selectionCollapseSpy = sinon.spy( window.Selection.prototype, 'collapse' );
  1705. selectionExtendSpy = sinon.spy( window.Selection.prototype, 'extend' );
  1706. // <container:p>foo<attribute:b>b{ar</attribute:b>}baz</container:p>
  1707. selection._setTo( [
  1708. new ViewRange( new ViewPosition( viewB.getChild( 0 ), 1 ), new ViewPosition( viewP.getChild( 2 ), 0 ) )
  1709. ] );
  1710. renderer.markToSync( 'children', viewP );
  1711. renderer.render();
  1712. expect( selectionCollapseSpy.notCalled ).to.true;
  1713. expect( selectionExtendSpy.notCalled ).to.true;
  1714. } );
  1715. it( 'should not render non-collapsed selection it is similar (element start - nested)', () => {
  1716. const domSelection = document.getSelection();
  1717. const { view: viewP, selection: newSelection } = parse(
  1718. '<container:p>foo<attribute:b><attribute:i>{ba}r</attribute:i></attribute:b></container:p>' );
  1719. viewRoot._appendChild( viewP );
  1720. selection._setTo( newSelection );
  1721. renderer.markToSync( 'children', viewRoot );
  1722. renderer.render();
  1723. const domP = domRoot.childNodes[ 0 ];
  1724. const domB = domP.childNodes[ 1 ];
  1725. const viewI = viewRoot.getChild( 0 ).getChild( 1 ).getChild( 0 );
  1726. expect( domSelection.isCollapsed ).to.false;
  1727. expect( domSelection.rangeCount ).to.equal( 1 );
  1728. expect( domSelection.getRangeAt( 0 ).startContainer ).to.equal( domB.childNodes[ 0 ].childNodes[ 0 ] );
  1729. expect( domSelection.getRangeAt( 0 ).startOffset ).to.equal( 0 );
  1730. expect( domSelection.getRangeAt( 0 ).endContainer ).to.equal( domB.childNodes[ 0 ].childNodes[ 0 ] );
  1731. expect( domSelection.getRangeAt( 0 ).endOffset ).to.equal( 2 );
  1732. selectionCollapseSpy = sinon.spy( window.Selection.prototype, 'collapse' );
  1733. selectionExtendSpy = sinon.spy( window.Selection.prototype, 'extend' );
  1734. // <container:p>foo{<attribute:b><attribute:i>ba}r</attribute:i></attribute:b></container:p>
  1735. selection._setTo( [
  1736. new ViewRange( new ViewPosition( viewP.getChild( 0 ), 3 ), new ViewPosition( viewI.getChild( 0 ), 2 ) )
  1737. ] );
  1738. renderer.markToSync( 'children', viewP );
  1739. renderer.render();
  1740. expect( selectionCollapseSpy.notCalled ).to.true;
  1741. expect( selectionExtendSpy.notCalled ).to.true;
  1742. } );
  1743. it( 'should not render non-collapsed selection it is similar (element end - nested)', () => {
  1744. const domSelection = document.getSelection();
  1745. const { view: viewP, selection: newSelection } = parse(
  1746. '<container:p>f{oo<attribute:b><attribute:i>bar}</attribute:i></attribute:b>baz</container:p>' );
  1747. viewRoot._appendChild( viewP );
  1748. selection._setTo( newSelection );
  1749. renderer.markToSync( 'children', viewRoot );
  1750. renderer.render();
  1751. const domP = domRoot.childNodes[ 0 ];
  1752. const domB = domP.childNodes[ 1 ];
  1753. expect( domSelection.isCollapsed ).to.false;
  1754. expect( domSelection.rangeCount ).to.equal( 1 );
  1755. expect( domSelection.getRangeAt( 0 ).startContainer ).to.equal( domP.childNodes[ 0 ] );
  1756. expect( domSelection.getRangeAt( 0 ).startOffset ).to.equal( 1 );
  1757. expect( domSelection.getRangeAt( 0 ).endContainer ).to.equal( domB.childNodes[ 0 ].childNodes[ 0 ] );
  1758. expect( domSelection.getRangeAt( 0 ).endOffset ).to.equal( 3 );
  1759. selectionCollapseSpy = sinon.spy( window.Selection.prototype, 'collapse' );
  1760. selectionExtendSpy = sinon.spy( window.Selection.prototype, 'extend' );
  1761. // <container:p>f{oo<attribute:b><attribute:i>bar</attribute:i></attribute:b>}baz</container:p>
  1762. selection._setTo( [
  1763. new ViewRange( new ViewPosition( viewP.getChild( 0 ), 1 ), new ViewPosition( viewP.getChild( 2 ), 0 ) )
  1764. ] );
  1765. renderer.markToSync( 'children', viewP );
  1766. renderer.render();
  1767. expect( selectionCollapseSpy.notCalled ).to.true;
  1768. expect( selectionExtendSpy.notCalled ).to.true;
  1769. } );
  1770. } );
  1771. // #1417
  1772. describe( 'optimal rendering – reusing existing nodes', () => {
  1773. it( 'should render inline element replacement (before text)', () => {
  1774. viewRoot._appendChild( parse( '<container:p><attribute:i>A</attribute:i>1</container:p>' ) );
  1775. renderer.markToSync( 'children', viewRoot );
  1776. renderer.render();
  1777. expect( domRoot.innerHTML ).to.equal( '<p><i>A</i>1</p>' );
  1778. const viewP = viewRoot.getChild( 0 );
  1779. viewP._removeChildren( 0, 2 );
  1780. viewP._insertChild( 0, parse( '<attribute:i>B</attribute:i>2' ) );
  1781. const domI = domRoot.childNodes[ 0 ].childNodes[ 0 ];
  1782. renderer.markToSync( 'children', viewRoot );
  1783. renderer.markToSync( 'children', viewP );
  1784. renderer.render();
  1785. expect( domRoot.innerHTML ).to.equal( '<p><i>B</i>2</p>' );
  1786. expect( domI ).to.equal( domRoot.childNodes[ 0 ].childNodes[ 0 ] );
  1787. } );
  1788. it( 'should render inline element replacement (after text)', () => {
  1789. viewRoot._appendChild( parse( '<container:p>1<attribute:i>A</attribute:i></container:p>' ) );
  1790. renderer.markToSync( 'children', viewRoot );
  1791. renderer.render();
  1792. expect( domRoot.innerHTML ).to.equal( '<p>1<i>A</i></p>' );
  1793. const viewP = viewRoot.getChild( 0 );
  1794. viewP._removeChildren( 0, 2 );
  1795. viewP._insertChild( 0, parse( '2<attribute:i>B</attribute:i>' ) );
  1796. const domI = domRoot.childNodes[ 0 ].childNodes[ 1 ];
  1797. renderer.markToSync( 'children', viewRoot );
  1798. renderer.markToSync( 'children', viewP );
  1799. renderer.render();
  1800. expect( domRoot.innerHTML ).to.equal( '<p>2<i>B</i></p>' );
  1801. expect( domI ).to.equal( domRoot.childNodes[ 0 ].childNodes[ 1 ] );
  1802. } );
  1803. it( 'should render inline element replacement (before text swapped order)', () => {
  1804. viewRoot._appendChild( parse( '<container:p><attribute:i>A</attribute:i>1</container:p>' ) );
  1805. renderer.markToSync( 'children', viewRoot );
  1806. renderer.render();
  1807. expect( domRoot.innerHTML ).to.equal( '<p><i>A</i>1</p>' );
  1808. const viewP = viewRoot.getChild( 0 );
  1809. viewP._removeChildren( 0, 2 );
  1810. viewP._insertChild( 0, parse( '2<attribute:i>B</attribute:i>' ) );
  1811. const domI = domRoot.childNodes[ 0 ].childNodes[ 0 ];
  1812. renderer.markToSync( 'children', viewRoot );
  1813. renderer.markToSync( 'children', viewP );
  1814. renderer.render();
  1815. expect( domRoot.innerHTML ).to.equal( '<p>2<i>B</i></p>' );
  1816. expect( domI ).to.equal( domRoot.childNodes[ 0 ].childNodes[ 1 ] );
  1817. } );
  1818. it( 'should render inline element replacement (after text swapped order)', () => {
  1819. viewRoot._appendChild( parse( '<container:p>1<attribute:i>A</attribute:i></container:p>' ) );
  1820. renderer.markToSync( 'children', viewRoot );
  1821. renderer.render();
  1822. expect( domRoot.innerHTML ).to.equal( '<p>1<i>A</i></p>' );
  1823. const viewP = viewRoot.getChild( 0 );
  1824. viewP._removeChildren( 0, 2 );
  1825. viewP._insertChild( 0, parse( '<attribute:i>B</attribute:i>2' ) );
  1826. const domI = domRoot.childNodes[ 0 ].childNodes[ 1 ];
  1827. renderer.markToSync( 'children', viewRoot );
  1828. renderer.markToSync( 'children', viewP );
  1829. renderer.render();
  1830. expect( domRoot.innerHTML ).to.equal( '<p><i>B</i>2</p>' );
  1831. expect( domI ).to.equal( domRoot.childNodes[ 0 ].childNodes[ 0 ] );
  1832. } );
  1833. it( 'should render single replacement in p group', () => {
  1834. const content = '' +
  1835. '<container:p>1</container:p>' +
  1836. '<container:p>2</container:p>' +
  1837. '<container:p>3</container:p>';
  1838. viewRoot._appendChild( parse( content ) );
  1839. renderer.markToSync( 'children', viewRoot );
  1840. renderer.render();
  1841. expect( domRoot.innerHTML ).to.equal( '<p>1</p><p>2</p><p>3</p>' );
  1842. viewRoot._removeChildren( 1 );
  1843. viewRoot._insertChild( 1, parse( '<container:p>4</container:p>' ) );
  1844. const domP = domRoot.childNodes[ 1 ];
  1845. renderer.markToSync( 'children', viewRoot );
  1846. renderer.render();
  1847. expect( domRoot.innerHTML ).to.equal( '<p>1</p><p>4</p><p>3</p>' );
  1848. expect( domP ).to.equal( domRoot.childNodes[ 1 ] );
  1849. } );
  1850. it( 'should render replacement and insertion in p group', () => {
  1851. const content = '' +
  1852. '<container:p>1<attribute:i>A</attribute:i></container:p>' +
  1853. '<container:p>2<attribute:i>B</attribute:i></container:p>' +
  1854. '<container:p>3<attribute:i>C</attribute:i></container:p>';
  1855. const replacement = '' +
  1856. '<container:p><attribute:i>D</attribute:i></container:p>' +
  1857. '<container:p>5<attribute:i>E</attribute:i></container:p>';
  1858. viewRoot._appendChild( parse( content ) );
  1859. renderer.markToSync( 'children', viewRoot );
  1860. renderer.render();
  1861. expect( domRoot.innerHTML ).to.equal( '<p>1<i>A</i></p><p>2<i>B</i></p><p>3<i>C</i></p>' );
  1862. viewRoot._removeChildren( 1 );
  1863. viewRoot._insertChild( 1, parse( replacement ) );
  1864. const domP2 = domRoot.childNodes[ 1 ];
  1865. const domP3 = domRoot.childNodes[ 2 ];
  1866. renderer.markToSync( 'children', viewRoot );
  1867. renderer.render();
  1868. expect( domRoot.innerHTML ).to.equal( '<p>1<i>A</i></p><p><i>D</i></p><p>5<i>E</i></p><p>3<i>C</i></p>' );
  1869. expect( domP2 ).to.equal( domRoot.childNodes[ 1 ] );
  1870. expect( domP3 ).to.equal( domRoot.childNodes[ 3 ] );
  1871. } );
  1872. it( 'should render replacement and deletion in p group', () => {
  1873. const content = '' +
  1874. '<container:p><attribute:i>A</attribute:i>1</container:p>' +
  1875. '<container:p><attribute:i>B</attribute:i>2</container:p>' +
  1876. '<container:p><attribute:i>C</attribute:i>3</container:p>';
  1877. viewRoot._appendChild( parse( content ) );
  1878. renderer.markToSync( 'children', viewRoot );
  1879. renderer.render();
  1880. expect( domRoot.innerHTML ).to.equal( '<p><i>A</i>1</p><p><i>B</i>2</p><p><i>C</i>3</p>' );
  1881. viewRoot._removeChildren( 0, 2 );
  1882. viewRoot._insertChild( 0, parse( '<container:p>4</container:p>' ) );
  1883. const domP0 = domRoot.childNodes[ 0 ];
  1884. const domP2 = domRoot.childNodes[ 2 ];
  1885. renderer.markToSync( 'children', viewRoot );
  1886. renderer.render();
  1887. expect( domRoot.innerHTML ).to.equal( '<p>4</p><p><i>C</i>3</p>' );
  1888. expect( domP0 ).to.equal( domRoot.childNodes[ 0 ] );
  1889. expect( domP2 ).to.equal( domRoot.childNodes[ 1 ] );
  1890. } );
  1891. it( 'should render multiple continuous replacement in p group', () => {
  1892. const content = '' +
  1893. '<container:p>1</container:p>' +
  1894. '<container:p>2</container:p>' +
  1895. '<container:p>3</container:p>' +
  1896. '<container:p>4</container:p>' +
  1897. '<container:p>5</container:p>';
  1898. viewRoot._appendChild( parse( content ) );
  1899. renderer.markToSync( 'children', viewRoot );
  1900. renderer.render();
  1901. expect( domRoot.innerHTML ).to.equal( '<p>1</p><p>2</p><p>3</p><p>4</p><p>5</p>' );
  1902. viewRoot._removeChildren( 0, 3 );
  1903. viewRoot._insertChild( 0, parse( '<container:p>6<attribute:i>A</attribute:i></container:p><container:p>7</container:p>' ) );
  1904. const domP1 = domRoot.childNodes[ 0 ];
  1905. const domP2 = domRoot.childNodes[ 1 ];
  1906. const domP4 = domRoot.childNodes[ 3 ];
  1907. const domP5 = domRoot.childNodes[ 4 ];
  1908. renderer.markToSync( 'children', viewRoot );
  1909. renderer.render();
  1910. expect( domRoot.innerHTML ).to.equal( '<p>6<i>A</i></p><p>7</p><p>4</p><p>5</p>' );
  1911. expect( domP1 ).to.equal( domRoot.childNodes[ 0 ] );
  1912. expect( domP2 ).to.equal( domRoot.childNodes[ 1 ] );
  1913. expect( domP4 ).to.equal( domRoot.childNodes[ 2 ] );
  1914. expect( domP5 ).to.equal( domRoot.childNodes[ 3 ] );
  1915. } );
  1916. it( 'should render multiple replacement in p group', () => {
  1917. const content = '' +
  1918. '<container:p>1</container:p>' +
  1919. '<container:p>2</container:p>' +
  1920. '<container:p>3</container:p>' +
  1921. '<container:p>4</container:p>' +
  1922. '<container:p>5</container:p>';
  1923. viewRoot._appendChild( parse( content ) );
  1924. renderer.markToSync( 'children', viewRoot );
  1925. renderer.render();
  1926. expect( domRoot.innerHTML ).to.equal( '<p>1</p><p>2</p><p>3</p><p>4</p><p>5</p>' );
  1927. viewRoot._removeChildren( 4 );
  1928. viewRoot._removeChildren( 1, 2 );
  1929. viewRoot._insertChild( 2, parse( '<container:p>6</container:p>' ) );
  1930. viewRoot._insertChild( 1, parse( '<container:p><attribute:i>A</attribute:i>7</container:p>' ) );
  1931. const domP1 = domRoot.childNodes[ 0 ];
  1932. const domP2 = domRoot.childNodes[ 1 ];
  1933. const domP4 = domRoot.childNodes[ 3 ];
  1934. const domP5 = domRoot.childNodes[ 4 ];
  1935. renderer.markToSync( 'children', viewRoot );
  1936. renderer.render();
  1937. expect( domRoot.innerHTML ).to.equal( '<p>1</p><p><i>A</i>7</p><p>4</p><p>6</p>' );
  1938. expect( domP1 ).to.equal( domRoot.childNodes[ 0 ] );
  1939. expect( domP2 ).to.equal( domRoot.childNodes[ 1 ] );
  1940. expect( domP4 ).to.equal( domRoot.childNodes[ 2 ] );
  1941. expect( domP5 ).to.equal( domRoot.childNodes[ 3 ] );
  1942. } );
  1943. it( 'should not rerender DOM when view replaced with the same structure', () => {
  1944. const content = '' +
  1945. '<container:h2>He' +
  1946. '<attribute:i>ading 1</attribute:i>' +
  1947. '</container:h2>' +
  1948. '<container:p>Ph ' +
  1949. '<attribute:strong>Bold</attribute:strong>' +
  1950. '<attribute:a href="https://ckeditor.com">' +
  1951. '<attribute:strong>Lin<attribute:i>k</attribute:i></attribute:strong>' +
  1952. '</attribute:a>' +
  1953. '</container:p>' +
  1954. '<container:blockquote>' +
  1955. '<container:ul>' +
  1956. '<container:li>Quoted <attribute:strong>item 1</attribute:strong></container:li>' +
  1957. '</container:ul>' +
  1958. '</container:blockquote>';
  1959. viewRoot._appendChild( parse( content ) );
  1960. renderer.markToSync( 'children', viewRoot );
  1961. renderer.render();
  1962. expect( domRoot.innerHTML ).to.equal( '<h2>He<i>ading 1</i></h2><p>Ph <strong>Bold</strong>' +
  1963. '<a href="https://ckeditor.com"><strong>Lin<i>k</i></strong></a></p><blockquote><ul><li>' +
  1964. 'Quoted <strong>item 1</strong></li></ul></blockquote>' );
  1965. viewRoot._removeChildren( 0, viewRoot.childCount );
  1966. viewRoot._appendChild( parse( content ) );
  1967. const viewH = viewRoot.getChild( 0 );
  1968. const viewP = viewRoot.getChild( 1 );
  1969. const viewQ = viewRoot.getChild( 2 );
  1970. const domH = domRoot.childNodes[ 0 ];
  1971. const domHI = domH.childNodes[ 1 ];
  1972. const domP = domRoot.childNodes[ 1 ];
  1973. const domPT = domP.childNodes[ 0 ];
  1974. const domPABI = domP.childNodes[ 2 ].childNodes[ 0 ].childNodes[ 1 ];
  1975. const domQ = domRoot.childNodes[ 2 ];
  1976. const domQULB = domQ.childNodes[ 0 ].childNodes[ 0 ].childNodes[ 1 ];
  1977. renderer.markToSync( 'children', viewRoot );
  1978. renderer.render();
  1979. // Assert content.
  1980. expect( domRoot.innerHTML ).to.equal( '<h2>He<i>ading 1</i></h2><p>Ph <strong>Bold</strong>' +
  1981. '<a href="https://ckeditor.com"><strong>Lin<i>k</i></strong></a></p><blockquote><ul><li>' +
  1982. 'Quoted <strong>item 1</strong></li></ul></blockquote>' );
  1983. // Assert if DOM elements did not change.
  1984. expect( domRoot.childNodes[ 0 ] ).to.equal( domH );
  1985. expect( domH.childNodes[ 1 ] ).to.equal( domHI );
  1986. expect( domRoot.childNodes[ 1 ] ).to.equal( domP );
  1987. expect( domP.childNodes[ 0 ] ).to.equal( domPT );
  1988. expect( domP.childNodes[ 2 ].childNodes[ 0 ].childNodes[ 1 ] ).to.equal( domPABI );
  1989. expect( domRoot.childNodes[ 2 ] ).to.equal( domQ );
  1990. expect( domQ.childNodes[ 0 ].childNodes[ 0 ].childNodes[ 1 ] ).to.equal( domQULB );
  1991. // Assert mappings.
  1992. const mappings = renderer.domConverter._domToViewMapping;
  1993. expect( mappings.get( domH ) ).to.equal( viewH );
  1994. expect( mappings.get( domHI ) ).to.equal( viewH.getChild( 1 ) );
  1995. expect( mappings.get( domP ) ).to.equal( viewP );
  1996. expect( mappings.get( domPABI ) ).to.equal( viewP.getChild( 2 ).getChild( 0 ).getChild( 1 ) );
  1997. expect( mappings.get( domQ ) ).to.equal( viewQ );
  1998. expect( mappings.get( domQULB ) ).to.equal( viewQ.getChild( 0 ).getChild( 0 ).getChild( 1 ) );
  1999. } );
  2000. // https://github.com/ckeditor/ckeditor5/issues/5734
  2001. it( 'should not rerender DOM when view replaced with the same structure without a comment', () => {
  2002. const domContent = '' +
  2003. '<h2>He<i>ading 1</i></h2>' +
  2004. '<p>Ph <strong>Bold</strong>' +
  2005. '<a href="https://ckeditor.com"><strong>Lin<i>k</i></strong></a>' +
  2006. '</p>' +
  2007. '<!-- A comment to be ignored -->' +
  2008. '<blockquote><ul><li>Quoted <strong>item 1</strong></li></ul></blockquote>';
  2009. const content = '' +
  2010. '<container:h2>He' +
  2011. '<attribute:i>ading 1</attribute:i>' +
  2012. '</container:h2>' +
  2013. '<container:p>Ph ' +
  2014. '<attribute:strong>Bold</attribute:strong>' +
  2015. '<attribute:a href="https://ckeditor.com">' +
  2016. '<attribute:strong>Lin<attribute:i>k</attribute:i></attribute:strong>' +
  2017. '</attribute:a>' +
  2018. '</container:p>' +
  2019. '<container:blockquote>' +
  2020. '<container:ul>' +
  2021. '<container:li>Quoted <attribute:strong>item 1</attribute:strong></container:li>' +
  2022. '</container:ul>' +
  2023. '</container:blockquote>';
  2024. domRoot.innerHTML = domContent;
  2025. viewRoot._appendChild( parse( content ) );
  2026. const viewH = viewRoot.getChild( 0 );
  2027. const viewP = viewRoot.getChild( 1 );
  2028. const viewQ = viewRoot.getChild( 2 );
  2029. const domH = domRoot.childNodes[ 0 ];
  2030. const domHI = domH.childNodes[ 1 ];
  2031. const domP = domRoot.childNodes[ 1 ];
  2032. const domPT = domP.childNodes[ 0 ];
  2033. const domPABI = domP.childNodes[ 2 ].childNodes[ 0 ].childNodes[ 1 ];
  2034. const domC = domRoot.childNodes[ 2 ];
  2035. const domQ = domRoot.childNodes[ 3 ];
  2036. const domQULB = domQ.childNodes[ 0 ].childNodes[ 0 ].childNodes[ 1 ];
  2037. renderer.markToSync( 'children', viewRoot );
  2038. renderer.render();
  2039. // Assert the comment is no longer in the content.
  2040. expect( domRoot.contains( domC ), 'domRoot should not contain the comment' ).to.be.false;
  2041. // Assert content, without the comment.
  2042. expect( domRoot.innerHTML ).to.equal( '<h2>He<i>ading 1</i></h2><p>Ph <strong>Bold</strong>' +
  2043. '<a href="https://ckeditor.com"><strong>Lin<i>k</i></strong></a></p><blockquote><ul><li>' +
  2044. 'Quoted <strong>item 1</strong></li></ul></blockquote>' );
  2045. // Assert if other DOM elements did not change.
  2046. expect( domRoot.childNodes[ 0 ] ).to.equal( domH );
  2047. expect( domH.childNodes[ 1 ] ).to.equal( domHI );
  2048. expect( domRoot.childNodes[ 1 ] ).to.equal( domP );
  2049. expect( domP.childNodes[ 0 ] ).to.equal( domPT );
  2050. expect( domP.childNodes[ 2 ].childNodes[ 0 ].childNodes[ 1 ] ).to.equal( domPABI );
  2051. // Note the shifted index of domQ, from 3 to 2.
  2052. expect( domRoot.childNodes[ 2 ] ).to.equal( domQ );
  2053. expect( domQ.childNodes[ 0 ].childNodes[ 0 ].childNodes[ 1 ] ).to.equal( domQULB );
  2054. // Assert mappings.
  2055. const mappings = renderer.domConverter._domToViewMapping;
  2056. expect( mappings.get( domH ) ).to.equal( viewH );
  2057. expect( mappings.get( domHI ) ).to.equal( viewH.getChild( 1 ) );
  2058. expect( mappings.get( domP ) ).to.equal( viewP );
  2059. expect( mappings.get( domPABI ) ).to.equal( viewP.getChild( 2 ).getChild( 0 ).getChild( 1 ) );
  2060. expect( mappings.get( domQ ) ).to.equal( viewQ );
  2061. expect( mappings.get( domQULB ) ).to.equal( viewQ.getChild( 0 ).getChild( 0 ).getChild( 1 ) );
  2062. } );
  2063. it( 'should not rerender DOM when view replaced with the same structure without first node', () => {
  2064. const content = '' +
  2065. '<container:h2>He' +
  2066. '<attribute:i>ading 1</attribute:i>' +
  2067. '</container:h2>' +
  2068. '<container:p>Ph ' +
  2069. '<attribute:strong>Bold</attribute:strong>' +
  2070. '<attribute:a href="https://ckeditor.com">' +
  2071. '<attribute:strong>Lin<attribute:i>k</attribute:i></attribute:strong>' +
  2072. '</attribute:a>' +
  2073. '</container:p>' +
  2074. '<container:blockquote>' +
  2075. '<container:ul>' +
  2076. '<container:li>Quoted <attribute:strong>item 1</attribute:strong></container:li>' +
  2077. '</container:ul>' +
  2078. '</container:blockquote>';
  2079. const content2 = '' +
  2080. '<container:p>Ph ' +
  2081. '<attribute:strong>Bold</attribute:strong>' +
  2082. '<attribute:a href="https://ckeditor.com">' +
  2083. '<attribute:strong>Lin<attribute:i>k</attribute:i></attribute:strong>' +
  2084. '</attribute:a>' +
  2085. '</container:p>' +
  2086. '<container:blockquote>' +
  2087. '<container:ul>' +
  2088. '<container:li>Quoted <attribute:strong>item 1</attribute:strong></container:li>' +
  2089. '</container:ul>' +
  2090. '</container:blockquote>';
  2091. viewRoot._appendChild( parse( content ) );
  2092. renderer.markToSync( 'children', viewRoot );
  2093. renderer.render();
  2094. expect( domRoot.innerHTML ).to.equal( '<h2>He<i>ading 1</i></h2><p>Ph <strong>Bold</strong>' +
  2095. '<a href="https://ckeditor.com"><strong>Lin<i>k</i></strong></a></p><blockquote><ul><li>' +
  2096. 'Quoted <strong>item 1</strong></li></ul></blockquote>' );
  2097. viewRoot._removeChildren( 0, viewRoot.childCount );
  2098. viewRoot._appendChild( parse( content2 ) );
  2099. const viewP = viewRoot.getChild( 0 );
  2100. const viewQ = viewRoot.getChild( 1 );
  2101. const domP = domRoot.childNodes[ 1 ];
  2102. const domPT = domP.childNodes[ 0 ];
  2103. const domPABI = domP.childNodes[ 2 ].childNodes[ 0 ].childNodes[ 1 ];
  2104. const domQ = domRoot.childNodes[ 2 ];
  2105. const domQULB = domQ.childNodes[ 0 ].childNodes[ 0 ].childNodes[ 1 ];
  2106. renderer.markToSync( 'children', viewRoot );
  2107. renderer.render();
  2108. // Assert content.
  2109. expect( domRoot.innerHTML ).to.equal( '<p>Ph <strong>Bold</strong>' +
  2110. '<a href="https://ckeditor.com"><strong>Lin<i>k</i></strong></a></p><blockquote><ul><li>' +
  2111. 'Quoted <strong>item 1</strong></li></ul></blockquote>' );
  2112. // Assert if DOM elements did not change.
  2113. expect( domRoot.childNodes[ 0 ] ).to.equal( domP );
  2114. expect( domP.childNodes[ 0 ] ).to.equal( domPT );
  2115. expect( domP.childNodes[ 2 ].childNodes[ 0 ].childNodes[ 1 ] ).to.equal( domPABI );
  2116. expect( domRoot.childNodes[ 1 ] ).to.equal( domQ );
  2117. expect( domQ.childNodes[ 0 ].childNodes[ 0 ].childNodes[ 1 ] ).to.equal( domQULB );
  2118. // Assert mappings.
  2119. const mappings = renderer.domConverter._domToViewMapping;
  2120. expect( mappings.get( domP ) ).to.equal( viewP );
  2121. expect( mappings.get( domPABI ) ).to.equal( viewP.getChild( 2 ).getChild( 0 ).getChild( 1 ) );
  2122. expect( mappings.get( domQ ) ).to.equal( viewQ );
  2123. expect( mappings.get( domQULB ) ).to.equal( viewQ.getChild( 0 ).getChild( 0 ).getChild( 1 ) );
  2124. } );
  2125. it( 'should not rerender DOM when typing inside empty inline element', () => {
  2126. const view = parse( '<container:p>Foo Bar<attribute:strong></attribute:strong></container:p>' );
  2127. viewRoot._appendChild( view );
  2128. renderer.markToSync( 'children', viewRoot );
  2129. renderer.render();
  2130. expect( domRoot.innerHTML ).to.equal( '<p>Foo Bar<strong></strong></p>' );
  2131. const viewP = viewRoot.getChild( 0 );
  2132. viewP._removeChildren( 1 );
  2133. viewP._insertChild( 1, parse( '<attribute:strong>a</attribute:strong>' ) );
  2134. const domP = domRoot.childNodes[ 0 ];
  2135. const domText = domP.childNodes[ 0 ];
  2136. const domB = domP.childNodes[ 1 ];
  2137. domB.innerHTML = 'a';
  2138. renderer.markToSync( 'children', viewRoot );
  2139. renderer.markToSync( 'children', viewRoot.getChild( 0 ) );
  2140. renderer.render();
  2141. // Assert content.
  2142. expect( domRoot.innerHTML ).to.equal( '<p>Foo Bar<strong>a</strong></p>' );
  2143. // Assert if DOM elements did not change.
  2144. expect( domRoot.childNodes[ 0 ] ).to.equal( domP );
  2145. expect( domRoot.childNodes[ 0 ].childNodes[ 0 ] ).to.equal( domText );
  2146. expect( domRoot.childNodes[ 0 ].childNodes[ 1 ] ).to.equal( domB );
  2147. // Assert mappings.
  2148. const mappings = renderer.domConverter._domToViewMapping;
  2149. expect( mappings.get( domP ) ).to.equal( viewP );
  2150. expect( mappings.get( domB ) ).to.equal( viewP.getChild( 1 ) );
  2151. } );
  2152. it( 'should handle complex view duplication', () => {
  2153. const content = '' +
  2154. '<container:blockquote>' +
  2155. '<container:ul>' +
  2156. '<container:li>Quoted <attribute:strong>item 1</attribute:strong></container:li>' +
  2157. '<container:li>Item 2</container:li>' +
  2158. '<container:li>' +
  2159. '<attribute:a href="https://cksource.com">Li<attribute:strong>nk</attribute:strong></attribute:a>' +
  2160. '</container:li>' +
  2161. '</container:ul>' +
  2162. '</container:blockquote>';
  2163. const expected = '' +
  2164. '<blockquote>' +
  2165. '<ul>' +
  2166. '<li>Quoted <strong>item 1</strong></li>' +
  2167. '<li>Item 2</li>' +
  2168. '<li><a href="https://cksource.com">Li<strong>nk</strong></a></li>' +
  2169. '</ul>' +
  2170. '</blockquote>';
  2171. viewRoot._appendChild( parse( content ) );
  2172. renderer.markToSync( 'children', viewRoot );
  2173. renderer.render();
  2174. expect( domRoot.innerHTML ).to.equal( expected );
  2175. viewRoot._removeChildren( 0, viewRoot.childCount );
  2176. viewRoot._appendChild( parse( content + content ) );
  2177. const domBQ = domRoot.childNodes[ 0 ];
  2178. const domUL = domBQ.childNodes[ 0 ];
  2179. const domLI1 = domUL.childNodes[ 0 ];
  2180. const domLI2 = domUL.childNodes[ 1 ];
  2181. const domLI3 = domUL.childNodes[ 2 ];
  2182. renderer.markToSync( 'children', viewRoot );
  2183. renderer.render();
  2184. // Assert content.
  2185. expect( domRoot.innerHTML ).to.equal( expected + expected );
  2186. // Assert if DOM elements did not change.
  2187. expect( domRoot.childNodes[ 0 ] ).to.equal( domBQ );
  2188. expect( domBQ.childNodes[ 0 ] ).to.equal( domUL );
  2189. expect( domUL.childNodes[ 0 ] ).to.equal( domLI1 );
  2190. expect( domUL.childNodes[ 1 ] ).to.equal( domLI2 );
  2191. expect( domUL.childNodes[ 2 ] ).to.equal( domLI3 );
  2192. // Assert mappings.
  2193. const domMappings = renderer.domConverter._domToViewMapping;
  2194. expect( domMappings.get( domBQ ) ).to.equal( viewRoot.getChild( 0 ) );
  2195. expect( domMappings.get( domUL ) ).to.equal( viewRoot.getChild( 0 ).getChild( 0 ) );
  2196. expect( domMappings.get( domLI1 ) ).to.equal( viewRoot.getChild( 0 ).getChild( 0 ).getChild( 0 ) );
  2197. expect( domMappings.get( domLI2 ) ).to.equal( viewRoot.getChild( 0 ).getChild( 0 ).getChild( 1 ) );
  2198. expect( domMappings.get( domLI3 ) ).to.equal( viewRoot.getChild( 0 ).getChild( 0 ).getChild( 2 ) );
  2199. // Assert if new view elements are bind to new DOM elements.
  2200. const viewMappings = renderer.domConverter._domToViewMapping;
  2201. expect( viewMappings.get( viewRoot.getChild( 1 ) ) ).not.equal( domBQ );
  2202. expect( viewMappings.get( viewRoot.getChild( 1 ).getChild( 0 ) ) ).not.equal( domUL );
  2203. expect( viewMappings.get( viewRoot.getChild( 1 ).getChild( 0 ).getChild( 0 ) ) ).not.equal( domLI1 );
  2204. expect( viewMappings.get( viewRoot.getChild( 1 ).getChild( 0 ).getChild( 1 ) ) ).not.equal( domLI2 );
  2205. expect( viewMappings.get( viewRoot.getChild( 1 ).getChild( 0 ).getChild( 2 ) ) ).not.equal( domLI3 );
  2206. } );
  2207. it( 'should handle complex view replace', () => {
  2208. const content = '' +
  2209. '<container:h2>He' +
  2210. '<attribute:i>ading 1</attribute:i>' +
  2211. '</container:h2>' +
  2212. '<container:p>Ph ' +
  2213. '<attribute:strong>Bold</attribute:strong>' +
  2214. '<attribute:a href="https://ckeditor.com">' +
  2215. '<attribute:strong>Lin<attribute:i>k</attribute:i></attribute:strong>' +
  2216. '</attribute:a>' +
  2217. '</container:p>' +
  2218. '<container:blockquote>' +
  2219. '<container:ul>' +
  2220. '<container:li>Quoted <attribute:strong>item 1</attribute:strong></container:li>' +
  2221. '<container:li>Item 2</container:li>' +
  2222. '<container:li>' +
  2223. '<attribute:a href="https://cksource.com">Li<attribute:strong>nk</attribute:strong></attribute:a>' +
  2224. '</container:li>' +
  2225. '</container:ul>' +
  2226. '</container:blockquote>';
  2227. const replacement = '' +
  2228. '<container:p>' +
  2229. '1' +
  2230. '<attribute:i>A</attribute:i>' +
  2231. '</container:p>' +
  2232. '<container:p>' +
  2233. '<attribute:a href="https://cksource.com">' +
  2234. 'Li' +
  2235. '<attribute:strong>nk</attribute:strong>' +
  2236. '</attribute:a>' +
  2237. '</container:p>' +
  2238. '<container:h1>' +
  2239. 'Heading ' +
  2240. '<attribute:strong>1</attribute:strong>' +
  2241. '</container:h1>' +
  2242. '<container:h2>' +
  2243. '<attribute:a href="https://ckeditor.com">Heading 2</attribute:a>' +
  2244. '</container:h2>' +
  2245. '<container:h3>' +
  2246. 'Heading' +
  2247. '<attribute:i> 3</attribute:i>' +
  2248. '</container:h3>' +
  2249. '<container:blockquote>' +
  2250. 'Foo Bar Baz' +
  2251. '</container:blockquote>' +
  2252. '<container:ul>' +
  2253. '<container:li>' +
  2254. 'Item ' +
  2255. '<attribute:strong>1</attribute:strong>' +
  2256. '</container:li>' +
  2257. '<container:li>' +
  2258. '<attribute:a href="https://ckeditor.com">Item</attribute:a>' +
  2259. ' 2' +
  2260. '</container:li>' +
  2261. '</container:ul>';
  2262. viewRoot._appendChild( parse( content ) );
  2263. renderer.markToSync( 'children', viewRoot );
  2264. renderer.render();
  2265. expect( domRoot.innerHTML ).to.equal( '' +
  2266. '<h2>He<i>ading 1</i></h2>' +
  2267. '<p>Ph <strong>Bold</strong><a href="https://ckeditor.com"><strong>Lin<i>k</i></strong></a></p>' +
  2268. '<blockquote><ul>' +
  2269. '<li>Quoted <strong>item 1</strong></li>' +
  2270. '<li>Item 2</li><li><a href="https://cksource.com">Li<strong>nk</strong></a></li>' +
  2271. '</ul></blockquote>' );
  2272. viewRoot._removeChildren( 0, viewRoot.childCount );
  2273. viewRoot._appendChild( parse( replacement ) );
  2274. renderer.markToSync( 'children', viewRoot );
  2275. renderer.render();
  2276. // Here we just check if new DOM structure was properly rendered.
  2277. expect( domRoot.innerHTML ).to.equal( '' +
  2278. '<p>1<i>A</i></p>' +
  2279. '<p><a href="https://cksource.com">Li<strong>nk</strong></a></p>' +
  2280. '<h1>Heading <strong>1</strong></h1>' +
  2281. '<h2><a href="https://ckeditor.com">Heading 2</a></h2>' +
  2282. '<h3>Heading<i> 3</i></h3>' +
  2283. '<blockquote>Foo Bar Baz</blockquote>' +
  2284. '<ul><li>Item <strong>1</strong></li><li><a href="https://ckeditor.com">Item</a> 2</li></ul>' );
  2285. } );
  2286. it( 'should handle br elements while refreshing bindings', () => {
  2287. const expected = `<p>Foo Bar</p><p>${ BR_FILLER( document ).outerHTML }</p>`; // eslint-disable-line new-cap
  2288. viewRoot._appendChild( parse( '<container:p>Foo Bar</container:p><container:p></container:p>' ) );
  2289. renderer.markToSync( 'children', viewRoot );
  2290. renderer.render();
  2291. expect( domRoot.innerHTML ).to.equal( expected );
  2292. // There is a case in Safari that during accent panel navigation on macOS our 'BR_FILLER' is replaced with
  2293. // just '<br>' element which breaks accent composition in an empty paragraph. It also throws an error while
  2294. // refreshing mappings in a renderer. Simulate such behaviour (#1354).
  2295. domRoot.childNodes[ 1 ].innerHTML = '<br>';
  2296. viewRoot._removeChildren( 1 );
  2297. viewRoot._insertChild( 1, parse( '<container:p></container:p>' ) );
  2298. renderer.markToSync( 'children', viewRoot );
  2299. renderer.render();
  2300. expect( domRoot.innerHTML ).to.equal( expected );
  2301. } );
  2302. it( 'should handle list to paragraph conversion', () => {
  2303. const view = '' +
  2304. '<container:ol>' +
  2305. '<container:li>Item 1' +
  2306. '<container:ol>' +
  2307. '<container:li>Item 2</container:li>' +
  2308. '</container:ol>' +
  2309. '</container:li>' +
  2310. '</container:ol>' +
  2311. '<container:p>Paragraph</container:p>' +
  2312. '<container:ol>' +
  2313. '<container:li>Item 3' +
  2314. '<container:ol>' +
  2315. '<container:li>Item 4</container:li>' +
  2316. '</container:ol>' +
  2317. '</container:li>' +
  2318. '</container:ol>';
  2319. viewRoot._appendChild( parse( view ) );
  2320. renderer.markToSync( 'children', viewRoot );
  2321. renderer.render();
  2322. expect( domRoot.innerHTML ).to.equal(
  2323. '<ol><li>Item 1<ol><li>Item 2</li></ol></li></ol><p>Paragraph</p><ol><li>Item 3<ol><li>Item 4</li></ol></li></ol>' );
  2324. const viewOL1 = viewRoot.getChild( 0 );
  2325. viewOL1.getChild( 0 )._removeChildren( 1 );
  2326. viewRoot._removeChildren( 2 );
  2327. viewRoot._insertChild( 1, parse( '<container:p>Item 2</container:p>' ) );
  2328. viewRoot._insertChild( 3, parse( '<container:p>Item 3</container:p>' ) );
  2329. viewRoot._insertChild( 4, parse( '<container:ol><container:li>Item 4</container:li></container:ol>' ) );
  2330. const domOL1 = domRoot.childNodes[ 0 ];
  2331. const domOL2 = domRoot.childNodes[ 2 ];
  2332. const domP = domRoot.childNodes[ 1 ];
  2333. renderer.markToSync( 'children', viewRoot );
  2334. renderer.markToSync( 'children', viewOL1.getChild( 0 ) );
  2335. renderer.render();
  2336. expect( domRoot.innerHTML ).to.equal(
  2337. '<ol><li>Item 1</li></ol><p>Item 2</p><p>Paragraph</p><p>Item 3</p><ol><li>Item 4</li></ol>' );
  2338. expect( domRoot.childNodes[ 0 ] ).to.equal( domOL1 );
  2339. expect( domRoot.childNodes[ 2 ] ).to.equal( domP );
  2340. expect( domRoot.childNodes[ 4 ] ).to.equal( domOL2 );
  2341. } );
  2342. it( 'should handle attributes change in replaced elements', () => {
  2343. const view = '' +
  2344. '<container:ol>' +
  2345. '<container:li data-index="1" align="left">Item 1</container:li>' +
  2346. '</container:ol>' +
  2347. '<container:p>Paragraph ' +
  2348. '<attribute:a href="123">Link</attribute:a>' +
  2349. '</container:p>' +
  2350. '<container:p id="p1"><attribute:i>Bar</attribute:i>Baz</container:p>';
  2351. viewRoot._appendChild( parse( view ) );
  2352. renderer.markToSync( 'children', viewRoot );
  2353. renderer.render();
  2354. expect( normalizeHtml( domRoot.innerHTML ) ).to.equal( normalizeHtml(
  2355. '<ol><li data-index="1" align="left">Item 1</li></ol>' +
  2356. '<p>Paragraph <a href="123">Link</a></p><p id="p1"><i>Bar</i>Baz</p>' ) );
  2357. const viewOL = viewRoot.getChild( 0 );
  2358. viewOL._removeChildren( 0 );
  2359. viewOL._insertChild( 0, parse( '<container:li data-index="2" data-attr="foo">Item 1</container:li>' ) );
  2360. const viewP1 = viewRoot.getChild( 1 );
  2361. viewP1._removeChildren( 1 );
  2362. viewP1._insertChild( 1, parse( '<attribute:a href="456" class="cke">Foo</attribute:a>' ) );
  2363. viewRoot._removeChildren( 2 );
  2364. viewRoot._insertChild( 2, parse( '<container:p>Bar</container:p>' ) );
  2365. renderer.markToSync( 'children', viewRoot );
  2366. renderer.markToSync( 'children', viewOL );
  2367. renderer.markToSync( 'children', viewP1 );
  2368. renderer.render();
  2369. expect( normalizeHtml( domRoot.innerHTML ) ).to.equal( normalizeHtml(
  2370. '<ol><li data-index="2" data-attr="foo">Item 1</li></ol>' +
  2371. '<p>Paragraph <a href="456" class="cke">Foo</a></p><p>Bar</p>' ) );
  2372. } );
  2373. it( 'should handle classes change in replaced elements', () => {
  2374. const view = '' +
  2375. '<container:ol>' +
  2376. '<container:li class="foo1 bar2 baz3">Item 1</container:li>' +
  2377. '</container:ol>' +
  2378. '<container:p><attribute:i class="i1 i2">Bar</attribute:i>Baz</container:p>';
  2379. viewRoot._appendChild( parse( view ) );
  2380. renderer.markToSync( 'children', viewRoot );
  2381. renderer.render();
  2382. expect( normalizeHtml( domRoot.innerHTML ) ).to.equal( normalizeHtml(
  2383. '<ol><li class="foo1 bar2 baz3">Item 1</li></ol><p><i class="i1 i2">Bar</i>Baz</p>' ) );
  2384. const viewOL = viewRoot.getChild( 0 );
  2385. const oldViewLI = viewOL.getChild( 0 );
  2386. viewOL._removeChildren( 0 );
  2387. viewOL._insertChild( 0, parse( '<container:li class="bar2 baz4 bax5">Item 1</container:li>' ) );
  2388. const oldViewP = viewRoot.getChild( 1 );
  2389. viewRoot._removeChildren( 1 );
  2390. viewRoot._insertChild( 1, parse( '<container:p class="p1 p2"><attribute:i>Foo</attribute:i></container:p>' ) );
  2391. renderer.markToSync( 'attributes', oldViewLI );
  2392. renderer.markToSync( 'attributes', oldViewP );
  2393. renderer.markToSync( 'children', viewRoot );
  2394. renderer.markToSync( 'children', viewOL );
  2395. renderer.render();
  2396. expect( normalizeHtml( domRoot.innerHTML ) ).to.equal( normalizeHtml(
  2397. '<ol><li class="bar2 baz4 bax5">Item 1</li></ol><p class="p1 p2"><i>Foo</i></p>' ) );
  2398. } );
  2399. it( 'should handle styles change in replaced elements', () => {
  2400. const view = '' +
  2401. '<container:ol>' +
  2402. '<container:li style="color:#000;font-weight:bold;">Foo</container:li>' +
  2403. '<container:li>Bar ' +
  2404. '<attribute:i>' +
  2405. '<attribute:b style="color:#00F;background-color:#000;font-size:12px;">Baz</attribute:b>' +
  2406. ' Bax</attribute:i>' +
  2407. '</container:li>' +
  2408. '</container:ol>';
  2409. viewRoot._appendChild( parse( view ) );
  2410. renderer.markToSync( 'children', viewRoot );
  2411. renderer.render();
  2412. expect( normalizeHtml( domRoot.innerHTML ) ).to.equal( normalizeHtml(
  2413. '<ol><li style="color:#000;font-weight:bold;">Foo</li>' +
  2414. '<li>Bar <i><b style="color:#00F;background-color:#000;font-size:12px;">Baz</b> Bax</i></li></ol>' ) );
  2415. const viewOL = viewRoot.getChild( 0 );
  2416. const viewLI1 = viewOL.getChild( 0 );
  2417. const viewLI2 = viewOL.getChild( 1 );
  2418. viewLI1._removeStyle( 'font-weight' );
  2419. viewLI1._setStyle( { color: '#FFF' } );
  2420. viewLI2._setStyle( { 'font-weight': 'bold' } );
  2421. viewLI2._removeChildren( 0, viewLI2.childCount );
  2422. viewLI2._insertChild( 0, parse( 'Ba1 <attribute:i style="color:#000;border-width:1px;">Ba3 ' +
  2423. '<attribute:b style="font-size:15px;">Ba2</attribute:b></attribute:i>' ) );
  2424. renderer.markToSync( 'attributes', viewLI1 );
  2425. renderer.markToSync( 'attributes', viewLI2 );
  2426. renderer.markToSync( 'children', viewRoot );
  2427. renderer.markToSync( 'children', viewLI2 );
  2428. renderer.render();
  2429. expect( normalizeHtml( domRoot.innerHTML ) ).to.equal( normalizeHtml(
  2430. '<ol><li style="color:#FFF;">Foo</li>' +
  2431. '<li style="font-weight:bold;">Ba1 <i style="color:#000;border-width:1px;">Ba3 ' +
  2432. '<b style="font-size:15px;">Ba2</b></i></li></ol>' ) );
  2433. } );
  2434. it( 'should handle uiElement rendering', () => {
  2435. function createUIElement( id, text ) {
  2436. const element = new UIElement( viewDocument, 'span' );
  2437. element.render = function( domDocument ) {
  2438. const domElement = this.toDomElement( domDocument );
  2439. domElement.innerText = `<span id="${ id }"><b>${ text }</b></span>`;
  2440. return domElement;
  2441. };
  2442. return element;
  2443. }
  2444. const ui1 = createUIElement( 'id1', 'UI1' );
  2445. const ui2 = createUIElement( 'id2', 'UI2' );
  2446. const viewP = new ViewContainerElement( viewDocument, 'p', null, [
  2447. new ViewText( viewDocument, 'Foo ' ),
  2448. ui1,
  2449. new ViewText( viewDocument, 'Bar' )
  2450. ] );
  2451. viewRoot._appendChild( viewP );
  2452. renderer.markToSync( 'children', viewRoot );
  2453. renderer.render();
  2454. expect( normalizeHtml( domRoot.innerHTML ) ).to.equal( normalizeHtml(
  2455. '<p>Foo <span><span id="id1"><b>UI1</b></span></span>Bar</p>' ) );
  2456. viewP._removeChildren( 0, viewP.childCount );
  2457. viewP._insertChild( 0, [ new ViewText( viewDocument, 'Foo' ), ui2, new ViewText( viewDocument, ' Bar' ) ] );
  2458. renderer.markToSync( 'children', viewRoot );
  2459. renderer.markToSync( 'children', viewP );
  2460. renderer.render();
  2461. expect( normalizeHtml( domRoot.innerHTML ) ).to.equal( normalizeHtml(
  2462. '<p>Foo<span><span id="id2"><b>UI2</b></span></span> Bar</p>' ) );
  2463. } );
  2464. it( 'should handle linking entire content', () => {
  2465. viewRoot._appendChild( parse( '<container:p>Foo<attribute:i>Bar</attribute:i></container:p>' ) );
  2466. renderer.markToSync( 'children', viewRoot );
  2467. renderer.render();
  2468. expect( domRoot.innerHTML ).to.equal( '<p>Foo<i>Bar</i></p>' );
  2469. const viewP = viewRoot.getChild( 0 );
  2470. // While linking, the existing DOM children are moved to a new `a` element during binding
  2471. // inside the `domConverter.viewToDom()` method. It happens because of a modified view structure
  2472. // where view elements were moved to a newly created link view element.
  2473. const viewA = new ViewAttributeElement( viewDocument, 'a', { href: '#href' }, [
  2474. new ViewText( viewDocument, 'Foo' ),
  2475. viewP.getChild( 1 )
  2476. ] );
  2477. viewP._removeChildren( 0, viewP.childCount );
  2478. viewP._insertChild( 0, viewA );
  2479. renderer.markToSync( 'children', viewRoot );
  2480. renderer.markToSync( 'children', viewP );
  2481. renderer.render();
  2482. expect( domRoot.innerHTML ).to.equal( '<p><a href="#href">Foo<i>Bar</i></a></p>' );
  2483. } );
  2484. // https://github.com/ckeditor/ckeditor5/issues/6367.
  2485. it( 'should correctly handle moving a DOM element when rendering children', () => {
  2486. viewRoot._insertChild( 0, parse( 'y<attribute:span>x</attribute:span>' ) );
  2487. renderer.markToSync( 'children', viewRoot );
  2488. renderer.render();
  2489. const viewSpan = viewRoot._removeChildren( 1, 1 )[ 0 ];
  2490. viewRoot._insertChild( 0, viewSpan );
  2491. viewRoot._insertChild( 2, parse( '<attribute:strong>z</attribute:strong>' ) );
  2492. renderer.markToSync( 'children', viewRoot );
  2493. // This would throw without a fix.
  2494. renderer.render();
  2495. expect( domRoot.innerHTML ).to.equal( '<span>x</span>y<strong>z</strong>' );
  2496. } );
  2497. // https://github.com/ckeditor/ckeditor5/issues/6367, but more complex
  2498. it( 'should correctly handle moving a DOM element when rendering children (more complex case)', () => {
  2499. viewRoot._insertChild( 0,
  2500. parse( '1<attribute:span>2</attribute:span><attribute:span>3</attribute:span>4<attribute:span>5</attribute:span>' )
  2501. );
  2502. renderer.markToSync( 'children', viewRoot );
  2503. renderer.render();
  2504. const viewSpan5 = viewRoot._removeChildren( 4, 1 )[ 0 ];
  2505. const viewSpan2 = viewRoot._removeChildren( 1, 1 )[ 0 ];
  2506. viewRoot._insertChild( 0, viewSpan2 );
  2507. viewRoot._insertChild( 1, parse( '<attribute:strong>6</attribute:strong>' ) );
  2508. viewRoot._insertChild( 4, parse( '<attribute:strong>7</attribute:strong>' ) );
  2509. viewRoot._insertChild( 2, viewSpan5 );
  2510. renderer.markToSync( 'children', viewRoot );
  2511. // This would throw without a fix.
  2512. renderer.render();
  2513. expect( domRoot.innerHTML ).to.equal( '<span>2</span><strong>6</strong><span>5</span>1<span>3</span><strong>7</strong>4' );
  2514. } );
  2515. } );
  2516. describe( 'optimal (minimal) rendering – minimal children changes', () => {
  2517. let observer;
  2518. beforeEach( () => {
  2519. observer = new MutationObserver( () => {} );
  2520. observer.observe( domRoot, {
  2521. childList: true,
  2522. attributes: false,
  2523. subtree: false
  2524. } );
  2525. } );
  2526. afterEach( () => {
  2527. observer.disconnect();
  2528. } );
  2529. it( 'should add only one child (at the beginning)', () => {
  2530. viewRoot._appendChild( parse( '<container:p>1</container:p>' ) );
  2531. renderer.markToSync( 'children', viewRoot );
  2532. renderer.render();
  2533. cleanObserver( observer );
  2534. viewRoot._insertChild( 0, parse( '<container:p>2</container:p>' ) );
  2535. renderer.markToSync( 'children', viewRoot );
  2536. renderer.render();
  2537. expect( getMutationStats( observer.takeRecords() ) ).to.deep.equal( [
  2538. 'added: 1, removed: 0'
  2539. ] );
  2540. } );
  2541. it( 'should add only one child (at the end)', () => {
  2542. viewRoot._appendChild( parse( '<container:p>1</container:p>' ) );
  2543. renderer.markToSync( 'children', viewRoot );
  2544. renderer.render();
  2545. cleanObserver( observer );
  2546. viewRoot._appendChild( parse( '<container:p>2</container:p>' ) );
  2547. renderer.markToSync( 'children', viewRoot );
  2548. renderer.render();
  2549. expect( getMutationStats( observer.takeRecords() ) ).to.deep.equal( [
  2550. 'added: 1, removed: 0'
  2551. ] );
  2552. } );
  2553. it( 'should add only one child (in the middle)', () => {
  2554. viewRoot._appendChild( parse( '<container:p>1</container:p><container:p>2</container:p>' ) );
  2555. renderer.markToSync( 'children', viewRoot );
  2556. renderer.render();
  2557. cleanObserver( observer );
  2558. viewRoot._insertChild( 1, parse( '<container:p>3</container:p>' ) );
  2559. renderer.markToSync( 'children', viewRoot );
  2560. renderer.render();
  2561. expect( getMutationStats( observer.takeRecords() ) ).to.deep.equal( [
  2562. 'added: 1, removed: 0'
  2563. ] );
  2564. } );
  2565. it( 'should not touch elements at all (rendering texts is enough)', () => {
  2566. viewRoot._appendChild( parse( '<container:p>1</container:p><container:p>2</container:p>' ) );
  2567. renderer.markToSync( 'children', viewRoot );
  2568. renderer.render();
  2569. cleanObserver( observer );
  2570. viewRoot._insertChild( 1, parse( '<container:p>3</container:p>' ) );
  2571. viewRoot._removeChildren( 0, 1 );
  2572. renderer.markToSync( 'children', viewRoot );
  2573. renderer.render();
  2574. expect( getMutationStats( observer.takeRecords() ) ).to.be.empty;
  2575. } );
  2576. it( 'should remove and add one', () => {
  2577. viewRoot._appendChild( parse( '<container:p>1</container:p><container:p>2</container:p>' ) );
  2578. renderer.markToSync( 'children', viewRoot );
  2579. renderer.render();
  2580. cleanObserver( observer );
  2581. viewRoot._insertChild( 1, parse( '<container:h1>3</container:h1>' ) );
  2582. viewRoot._removeChildren( 0, 1 );
  2583. renderer.markToSync( 'children', viewRoot );
  2584. renderer.render();
  2585. expect( getMutationStats( observer.takeRecords() ) ).to.deep.equal( [
  2586. 'added: 0, removed: 1',
  2587. 'added: 1, removed: 0'
  2588. ] );
  2589. } );
  2590. it( 'should not touch the FSC when rendering children', () => {
  2591. viewRoot._appendChild( parse( '<container:p>1</container:p><container:p>2</container:p>' ) );
  2592. // Set fake selection on the second paragraph.
  2593. selection._setTo( viewRoot.getChild( 1 ), 'on', { fake: true } );
  2594. renderer.markToSync( 'children', viewRoot );
  2595. renderer.render();
  2596. cleanObserver( observer );
  2597. // Remove the second paragraph.
  2598. viewRoot._removeChildren( 1, 1 );
  2599. // And set the fake selection on the first one.
  2600. selection._setTo( viewRoot.getChild( 0 ), 'on', { fake: true } );
  2601. renderer.markToSync( 'children', viewRoot );
  2602. renderer.render();
  2603. expect( getMutationStats( observer.takeRecords() ) ).to.deep.equal( [
  2604. 'added: 0, removed: 1'
  2605. ] );
  2606. } );
  2607. it( 'should not incorrectly remove element which is not a FSC when rendering children', () => {
  2608. // This test's purpose is mostly reaching 100% CC.
  2609. observer = new MutationObserver( () => {} );
  2610. viewRoot._appendChild( parse( '<container:div><container:p>1</container:p><container:p>2</container:p></container:div>' ) );
  2611. const viewDiv = viewRoot.getChild( 0 );
  2612. // Set fake selection on the second paragraph.
  2613. selection._setTo( viewDiv.getChild( 1 ), 'on', { fake: true } );
  2614. renderer.markToSync( 'children', viewDiv );
  2615. renderer.markToSync( 'children', viewRoot );
  2616. renderer.render();
  2617. observer.observe( domRoot.childNodes[ 0 ], {
  2618. childList: true,
  2619. attributes: false,
  2620. subtree: false
  2621. } );
  2622. // Remove the second paragraph.
  2623. viewDiv._removeChildren( 1, 1 );
  2624. // And set the fake selection on the first one.
  2625. selection._setTo( viewDiv.getChild( 0 ), 'on', { fake: true } );
  2626. renderer.markToSync( 'children', viewDiv );
  2627. renderer.markToSync( 'children', viewRoot );
  2628. renderer.render();
  2629. expect( getMutationStats( observer.takeRecords() ) ).to.deep.equal( [
  2630. 'added: 0, removed: 1'
  2631. ] );
  2632. observer.disconnect();
  2633. } );
  2634. describe( 'using fastDiff() - significant number of nodes in the editor', () => {
  2635. it( 'should add only one child (at the beginning)', () => {
  2636. viewRoot._appendChild( parse( makeContainers( 151 ) ) );
  2637. renderer.markToSync( 'children', viewRoot );
  2638. renderer.render();
  2639. cleanObserver( observer );
  2640. viewRoot._insertChild( 0, parse( '<container:p>x</container:p>' ) );
  2641. renderer.markToSync( 'children', viewRoot );
  2642. renderer.render();
  2643. expect( getMutationStats( observer.takeRecords() ) ).to.deep.equal( [
  2644. 'added: 1, removed: 0'
  2645. ] );
  2646. } );
  2647. it( 'should add only one child (at the end)', () => {
  2648. viewRoot._appendChild( parse( makeContainers( 151 ) ) );
  2649. renderer.markToSync( 'children', viewRoot );
  2650. renderer.render();
  2651. cleanObserver( observer );
  2652. viewRoot._appendChild( parse( '<container:p>x</container:p>' ) );
  2653. renderer.markToSync( 'children', viewRoot );
  2654. renderer.render();
  2655. expect( getMutationStats( observer.takeRecords() ) ).to.deep.equal( [
  2656. 'added: 1, removed: 0'
  2657. ] );
  2658. } );
  2659. it( 'should add only one child (in the middle)', () => {
  2660. viewRoot._appendChild( parse( makeContainers( 151 ) ) );
  2661. renderer.markToSync( 'children', viewRoot );
  2662. renderer.render();
  2663. cleanObserver( observer );
  2664. viewRoot._insertChild( 75, parse( '<container:p>x</container:p>' ) );
  2665. renderer.markToSync( 'children', viewRoot );
  2666. renderer.render();
  2667. expect( getMutationStats( observer.takeRecords() ) ).to.deep.equal( [
  2668. 'added: 1, removed: 0'
  2669. ] );
  2670. } );
  2671. it( 'should not touch elements at all (rendering texts is enough)', () => {
  2672. viewRoot._appendChild( parse( makeContainers( 151 ) ) );
  2673. renderer.markToSync( 'children', viewRoot );
  2674. renderer.render();
  2675. cleanObserver( observer );
  2676. viewRoot._insertChild( 1, parse( '<container:p>x</container:p>' ) );
  2677. viewRoot._removeChildren( 0, 1 );
  2678. renderer.markToSync( 'children', viewRoot );
  2679. renderer.render();
  2680. expect( getMutationStats( observer.takeRecords() ) ).to.be.empty;
  2681. } );
  2682. it( 'should remove and add one', () => {
  2683. viewRoot._appendChild( parse( makeContainers( 151 ) ) );
  2684. renderer.markToSync( 'children', viewRoot );
  2685. renderer.render();
  2686. cleanObserver( observer );
  2687. viewRoot._insertChild( 1, parse( '<container:h1>x</container:h1>' ) );
  2688. viewRoot._removeChildren( 0, 1 );
  2689. renderer.markToSync( 'children', viewRoot );
  2690. renderer.render();
  2691. expect( getMutationStats( observer.takeRecords() ) ).to.deep.equal( [
  2692. 'added: 0, removed: 1',
  2693. 'added: 1, removed: 0'
  2694. ] );
  2695. } );
  2696. it( 'should not touch the FSC when rendering children', () => {
  2697. viewRoot._appendChild( parse( makeContainers( 151 ) ) );
  2698. // Set fake selection on the second paragraph.
  2699. selection._setTo( viewRoot.getChild( 1 ), 'on', { fake: true } );
  2700. renderer.markToSync( 'children', viewRoot );
  2701. renderer.render();
  2702. cleanObserver( observer );
  2703. // Remove the second paragraph.
  2704. viewRoot._removeChildren( 1, 1 );
  2705. // And set the fake selection on the first one.
  2706. selection._setTo( viewRoot.getChild( 0 ), 'on', { fake: true } );
  2707. renderer.markToSync( 'children', viewRoot );
  2708. renderer.render();
  2709. expect( getMutationStats( observer.takeRecords() ) ).to.deep.equal( [
  2710. 'added: 0, removed: 1'
  2711. ] );
  2712. } );
  2713. } );
  2714. function getMutationStats( mutationList ) {
  2715. return mutationList.map( mutation => {
  2716. return `added: ${ mutation.addedNodes.length }, removed: ${ mutation.removedNodes.length }`;
  2717. } );
  2718. }
  2719. function cleanObserver( observer ) {
  2720. observer.takeRecords();
  2721. }
  2722. function makeContainers( howMany ) {
  2723. const containers = [];
  2724. for ( let i = 1; i <= howMany; i++ ) {
  2725. containers.push( `<container:p>${ i }</container:p>` );
  2726. }
  2727. return containers.join( '' );
  2728. }
  2729. } );
  2730. // #1560
  2731. describe( 'attributes manipulation on replaced element', () => {
  2732. it( 'should rerender element if it was removed after having its attributes removed (attribute)', () => {
  2733. const writer = new DowncastWriter( viewDocument );
  2734. // 1. Setup initial view/DOM.
  2735. viewRoot._appendChild( parse( '<container:p>1</container:p>' ) );
  2736. const viewP = viewRoot.getChild( 0 );
  2737. writer.setAttribute( 'data-placeholder', 'Body', viewP );
  2738. renderer.markToSync( 'children', viewRoot );
  2739. renderer.render();
  2740. expect( domRoot.innerHTML ).to.equal( '<p data-placeholder="Body">1</p>' );
  2741. // 2. Modify view.
  2742. writer.removeAttribute( 'data-placeholder', viewP );
  2743. viewRoot._removeChildren( 0, viewRoot.childCount );
  2744. viewRoot._appendChild( parse( '<container:p>1</container:p><container:p>2</container:p>' ) );
  2745. renderer.markToSync( 'attributes', viewP );
  2746. renderer.markToSync( 'children', viewRoot );
  2747. renderer.render();
  2748. expect( domRoot.innerHTML ).to.equal( '<p>1</p><p>2</p>' );
  2749. } );
  2750. it( 'should rerender element if it was removed after having its attributes removed (classes)', () => {
  2751. const writer = new DowncastWriter( viewDocument );
  2752. // 1. Setup initial view/DOM.
  2753. viewRoot._appendChild( parse( '<container:h1>h1</container:h1><container:p>p</container:p>' ) );
  2754. const viewP = viewRoot.getChild( 1 );
  2755. writer.addClass( [ 'cke-test1', 'cke-test2' ], viewP );
  2756. renderer.markToSync( 'children', viewRoot );
  2757. renderer.render();
  2758. expect( domRoot.innerHTML ).to.equal( '<h1>h1</h1><p class="cke-test1 cke-test2">p</p>' );
  2759. // 2. Modify view.
  2760. writer.removeClass( 'cke-test2', viewP );
  2761. viewRoot._removeChildren( 0, viewRoot.childCount );
  2762. viewRoot._appendChild( parse( '<container:h1>h1</container:h1>' +
  2763. '<container:p class="cke-test1">p</container:p><container:p>p2</container:p>' ) );
  2764. renderer.markToSync( 'attributes', viewP );
  2765. renderer.markToSync( 'children', viewRoot );
  2766. renderer.render();
  2767. expect( domRoot.innerHTML ).to.equal( '<h1>h1</h1><p class="cke-test1">p</p><p>p2</p>' );
  2768. } );
  2769. it( 'should rerender element if it was removed and have its attributes removed after', () => {
  2770. const writer = new DowncastWriter( viewDocument );
  2771. // 1. Setup initial view/DOM.
  2772. viewRoot._appendChild( parse( '<container:p>1</container:p>' ) );
  2773. const viewP = viewRoot.getChild( 0 );
  2774. writer.setAttribute( 'data-placeholder', 'Body', viewP );
  2775. renderer.markToSync( 'children', viewRoot );
  2776. renderer.render();
  2777. expect( domRoot.innerHTML ).to.equal( '<p data-placeholder="Body">1</p>' );
  2778. // 2. Modify view.
  2779. viewRoot._removeChildren( 0, viewRoot.childCount );
  2780. writer.removeAttribute( 'data-placeholder', viewP );
  2781. viewRoot._appendChild( parse( '<container:p>1</container:p><container:p>2</container:p>' ) );
  2782. renderer.markToSync( 'children', viewRoot );
  2783. renderer.render();
  2784. expect( domRoot.innerHTML ).to.equal( '<p>1</p><p>2</p>' );
  2785. } );
  2786. } );
  2787. // ckeditor/ckeditor5-utils#269
  2788. // The expected times has a significant margin above the usual execution time (which is around 40-50%
  2789. // of the expected time) because it depends on the browser and environment in which tests are run.
  2790. // However, for larger data sets the difference between using `diff()` and `fastDiff()` (see above issue for context)
  2791. // is more than 10x in execution time so it is clearly visible in these tests when something goes wrong.
  2792. describe( 'rendering performance', () => {
  2793. before( function() {
  2794. // Ignore on Edge browser where performance is quite poor.
  2795. if ( env.isEdge ) {
  2796. this.skip();
  2797. }
  2798. } );
  2799. it( 'should not take more than 350ms to render around 300 element nodes (same html)', () => {
  2800. const renderingTime = measureRenderingTime( viewRoot, generateViewData1( 65 ), generateViewData1( 55 ) );
  2801. expect( renderingTime ).to.be.within( 0, 350 );
  2802. } );
  2803. it( 'should not take more than 350ms to render around 300 element nodes (different html)', () => {
  2804. const renderingTime = measureRenderingTime( viewRoot, generateViewData1( 55 ), generateViewData2( 65 ) );
  2805. expect( renderingTime ).to.be.within( 0, 350 );
  2806. } );
  2807. it( 'should not take more than 350ms to render around 500 element nodes (same html)', () => {
  2808. const renderingTime = measureRenderingTime( viewRoot, generateViewData1( 105 ), generateViewData1( 95 ) );
  2809. expect( renderingTime ).to.be.within( 0, 350 );
  2810. } );
  2811. it( 'should not take more than 350ms to render around 500 element nodes (different html)', () => {
  2812. const renderingTime = measureRenderingTime( viewRoot, generateViewData1( 95 ), generateViewData2( 105 ) );
  2813. expect( renderingTime ).to.be.within( 0, 350 );
  2814. } );
  2815. it( 'should not take more than 350ms to render around 1000 element nodes (same html)', () => {
  2816. const renderingTime = measureRenderingTime( viewRoot, generateViewData1( 195 ), generateViewData1( 205 ) );
  2817. expect( renderingTime ).to.be.within( 0, 350 );
  2818. } );
  2819. it( 'should not take more than 350ms to render around 1000 element nodes (different html)', () => {
  2820. const renderingTime = measureRenderingTime( viewRoot, generateViewData1( 205 ), generateViewData2( 195 ) );
  2821. expect( renderingTime ).to.be.within( 0, 350 );
  2822. } );
  2823. function measureRenderingTime( viewRoot, initialData, newData ) {
  2824. // Set initial data.
  2825. const initialView = parse( initialData );
  2826. viewRoot._appendChild( initialView );
  2827. renderer.markToSync( 'children', viewRoot );
  2828. renderer.render();
  2829. // Set new data.
  2830. const newView = parse( newData );
  2831. viewRoot._removeChildren( 0, viewRoot.childCount );
  2832. viewRoot._appendChild( newView );
  2833. renderer.markToSync( 'children', viewRoot );
  2834. // Measure render time.
  2835. const start = Date.now();
  2836. renderer.render();
  2837. return Date.now() - start;
  2838. }
  2839. function generateViewData1( repeat = 1 ) {
  2840. const viewData = '' +
  2841. '<container:h1>' +
  2842. 'CKEditor 5 <attribute:strong>h1</attribute:strong> heading!' +
  2843. '</container:h1>' +
  2844. '<container:p>' +
  2845. 'Foo <attribute:strong>Bar</attribute:strong> Baz and some text' +
  2846. '</container:p>' +
  2847. '<container:ul>' +
  2848. '<container:li>Item 1</container:li>' +
  2849. '</container:ul>' +
  2850. '<container:ul>' +
  2851. '<container:li>Item 2</container:li>' +
  2852. '</container:ul>' +
  2853. '<container:ul>' +
  2854. '<container:li>Item 3</container:li>' +
  2855. '</container:ul>';
  2856. return viewData.repeat( repeat );
  2857. }
  2858. function generateViewData2( repeat = 1 ) {
  2859. const viewData = '' +
  2860. '<container:ol>' +
  2861. '<container:li>' +
  2862. '<attribute:strong>Foo</attribute:strong>' +
  2863. '</container:li>' +
  2864. '</container:ol>' +
  2865. '<container:ol>' +
  2866. '<container:li>Item 1</container:li>' +
  2867. '</container:ol>' +
  2868. '<container:h1>Heading 1</container:h1>' +
  2869. '<container:h2>' +
  2870. '<attribute:strong>Heading</attribute:strong> 2' +
  2871. '</container:h2>' +
  2872. '<container:h3>Heading 4</container:h3>';
  2873. return viewData.repeat( repeat );
  2874. }
  2875. } );
  2876. } );
  2877. describe( '#922', () => {
  2878. let view, viewDoc, viewRoot, domRoot, converter;
  2879. beforeEach( () => {
  2880. view = new View( new StylesProcessor() );
  2881. viewDoc = view.document;
  2882. domRoot = document.createElement( 'div' );
  2883. document.body.appendChild( domRoot );
  2884. viewRoot = createViewRoot( viewDoc );
  2885. view.attachDomRoot( domRoot );
  2886. converter = view.domConverter;
  2887. } );
  2888. afterEach( () => {
  2889. view.destroy();
  2890. domRoot.remove();
  2891. } );
  2892. it( 'should properly render unwrapped attributes #1', () => {
  2893. setViewData( view,
  2894. '<container:p>' +
  2895. '[<attribute:italic>' +
  2896. '<attribute:strong>f</attribute:strong>' +
  2897. '</attribute:italic>]' +
  2898. '<attribute:strong>oo</attribute:strong>' +
  2899. '</container:p>'
  2900. );
  2901. // Render it to DOM to create initial DOM <-> view mappings.
  2902. view.forceRender();
  2903. // Unwrap italic attribute element.
  2904. view.change( writer => {
  2905. writer.unwrap( viewDoc.selection.getFirstRange(), new ViewAttributeElement( viewDocument, 'italic' ) );
  2906. } );
  2907. expect( getViewData( view ) ).to.equal( '<p>[<strong>foo</strong>]</p>' );
  2908. // Re-render changes in view to DOM.
  2909. view.forceRender();
  2910. // Check if DOM is rendered correctly.
  2911. expect( normalizeHtml( domRoot.innerHTML ) ).to.equal( '<p><strong>foo</strong></p>' );
  2912. expect( checkMappings() ).to.be.true;
  2913. } );
  2914. it( 'should properly render unwrapped attributes #2', () => {
  2915. setViewData( view,
  2916. '<container:p>' +
  2917. '[<attribute:italic>' +
  2918. '<attribute:strong>foo</attribute:strong>' +
  2919. '</attribute:italic>]' +
  2920. '</container:p>' );
  2921. // Render it to DOM to create initial DOM <-> view mappings.
  2922. view.forceRender();
  2923. // Unwrap italic attribute element and change text inside.
  2924. view.change( writer => {
  2925. writer.unwrap( viewDoc.selection.getFirstRange(), new ViewAttributeElement( viewDocument, 'italic' ) );
  2926. } );
  2927. viewRoot.getChild( 0 ).getChild( 0 ).getChild( 0 )._data = 'bar';
  2928. expect( getViewData( view ) ).to.equal( '<p>[<strong>bar</strong>]</p>' );
  2929. // Re-render changes in view to DOM.
  2930. view.forceRender();
  2931. // Check if DOM is rendered correctly.
  2932. expect( normalizeHtml( domRoot.innerHTML ) ).to.equal( '<p><strong>bar</strong></p>' );
  2933. expect( checkMappings() ).to.be.true;
  2934. } );
  2935. it( 'should properly render if text is changed and element is inserted into same node #1', () => {
  2936. setViewData( view,
  2937. '<container:p>foo</container:p>'
  2938. );
  2939. // Render it to DOM to create initial DOM <-> view mappings.
  2940. view.forceRender();
  2941. // Change text and insert new element into paragraph.
  2942. const textNode = viewRoot.getChild( 0 ).getChild( 0 );
  2943. textNode._data = 'foobar';
  2944. view.change( writer => {
  2945. writer.insert( ViewPosition._createAfter( textNode ), new ViewAttributeElement( viewDocument, 'img' ) );
  2946. } );
  2947. expect( getViewData( view ) ).to.equal( '<p>foobar<img></img></p>' );
  2948. // Re-render changes in view to DOM.
  2949. view.forceRender();
  2950. // Check if DOM is rendered correctly.
  2951. expect( normalizeHtml( domRoot.innerHTML ) ).to.equal( '<p>foobar<img></img></p>' );
  2952. expect( checkMappings() ).to.be.true;
  2953. } );
  2954. it( 'should properly render if text is changed and element is inserted into same node #2', () => {
  2955. setViewData( view,
  2956. '<container:p>foo</container:p>'
  2957. );
  2958. // Render it to DOM to create initial DOM <-> view mappings.
  2959. view.forceRender();
  2960. // Change text and insert new element into paragraph.
  2961. const textNode = viewRoot.getChild( 0 ).getChild( 0 );
  2962. textNode._data = 'foobar';
  2963. view.change( writer => {
  2964. writer.insert( ViewPosition._createBefore( textNode ), new ViewAttributeElement( viewDocument, 'img' ) );
  2965. } );
  2966. expect( getViewData( view ) ).to.equal( '<p><img></img>foobar</p>' );
  2967. // Re-render changes in view to DOM.
  2968. view.forceRender();
  2969. // Check if DOM is rendered correctly.
  2970. expect( normalizeHtml( domRoot.innerHTML ) ).to.equal( '<p><img></img>foobar</p>' );
  2971. expect( checkMappings() ).to.be.true;
  2972. } );
  2973. it( 'should not unbind elements that are removed and reinserted to DOM', () => {
  2974. setViewData( view,
  2975. '<container:p>' +
  2976. '<attribute:b></attribute:b>' +
  2977. '<attribute:i></attribute:i>' +
  2978. '<attribute:span></attribute:span>' +
  2979. '</container:p>'
  2980. );
  2981. // Render it to DOM to create initial DOM <-> view mappings.
  2982. view.forceRender();
  2983. // Remove first element and reinsert it at the end.
  2984. const container = viewRoot.getChild( 0 );
  2985. const firstElement = container.getChild( 0 );
  2986. view.change( writer => {
  2987. writer.remove( ViewRange._createOn( firstElement ) );
  2988. writer.insert( new ViewPosition( container, 2 ), firstElement );
  2989. } );
  2990. expect( getViewData( view ) ).to.equal( '<p><i></i><span></span><b></b></p>' );
  2991. // Re-render changes in view to DOM.
  2992. view.forceRender();
  2993. // Check if DOM is rendered correctly.
  2994. expect( normalizeHtml( domRoot.innerHTML ) ).to.equal( '<p><i></i><span></span><b></b></p>' );
  2995. expect( checkMappings() ).to.be.true;
  2996. } );
  2997. // Checks if every node in DOM tree is mapped to the view.
  2998. function checkMappings() {
  2999. const domWalker = document.createTreeWalker( domRoot, NodeFilter.SHOW_ELEMENT | NodeFilter.SHOW_TEXT );
  3000. while ( domWalker.nextNode() ) {
  3001. const node = domWalker.currentNode;
  3002. if ( !converter.mapDomToView( node ) && !converter.findCorrespondingViewText( node ) ) {
  3003. return false;
  3004. }
  3005. }
  3006. return true;
  3007. }
  3008. } );
  3009. describe( '_markDescendantTextToSync', () => {
  3010. let viewRoot;
  3011. beforeEach( () => {
  3012. viewRoot = new ViewElement( viewDocument, 'div' );
  3013. renderer.markedTexts.clear();
  3014. renderer.markedAttributes.clear();
  3015. renderer.markedChildren.clear();
  3016. } );
  3017. it( 'should handle null values', () => {
  3018. // Such situation occurs when renderer encounters inline filler in 'renderer._updateChildren'.
  3019. renderer._markDescendantTextToSync( null );
  3020. expect( renderer.markedChildren.size ).to.equal( 0 );
  3021. expect( renderer.markedAttributes.size ).to.equal( 0 );
  3022. expect( renderer.markedTexts.size ).to.equal( 0 );
  3023. } );
  3024. it( 'should handle element nodes', () => {
  3025. const viewP = parse( '<container:p>foo<attribute:b>bar<attribute:i>baz</attribute:i></attribute:b></container:p>' );
  3026. viewRoot._appendChild( viewP );
  3027. renderer._markDescendantTextToSync( viewP );
  3028. expect( renderer.markedChildren.size ).to.equal( 0 );
  3029. expect( renderer.markedAttributes.size ).to.equal( 0 );
  3030. expect( renderer.markedTexts.size ).to.equal( 3 );
  3031. } );
  3032. it( 'should handle text nodes', () => {
  3033. const viewP = parse( '<container:p><attribute:b>bar<attribute:i>baz</attribute:i></attribute:b></container:p>' );
  3034. viewRoot._appendChild( viewP );
  3035. renderer._markDescendantTextToSync( viewP.getChild( 0 ).getChild( 0 ) );
  3036. expect( renderer.markedChildren.size ).to.equal( 0 );
  3037. expect( renderer.markedAttributes.size ).to.equal( 0 );
  3038. expect( renderer.markedTexts.size ).to.equal( 1 );
  3039. } );
  3040. it( 'should handle document fragment', () => {
  3041. const fragment = new DocumentFragment();
  3042. renderer._markDescendantTextToSync( fragment );
  3043. expect( renderer.markedChildren.size ).to.equal( 0 );
  3044. expect( renderer.markedAttributes.size ).to.equal( 0 );
  3045. expect( renderer.markedTexts.size ).to.equal( 0 );
  3046. } );
  3047. it( 'should handle empty element nodes', () => {
  3048. const viewP = parse( '<container:p></container:p>' );
  3049. viewRoot._appendChild( viewP );
  3050. renderer._markDescendantTextToSync( viewP );
  3051. expect( renderer.markedChildren.size ).to.equal( 0 );
  3052. expect( renderer.markedAttributes.size ).to.equal( 0 );
  3053. expect( renderer.markedTexts.size ).to.equal( 0 );
  3054. } );
  3055. } );
  3056. describe( '_updateText', () => {
  3057. let viewRoot, domRoot;
  3058. beforeEach( () => {
  3059. viewRoot = new ViewElement( viewDocument, 'div' );
  3060. domRoot = document.createElement( 'div' );
  3061. document.body.appendChild( domRoot );
  3062. domConverter.bindElements( domRoot, viewRoot );
  3063. renderer.markedTexts.clear();
  3064. renderer.markedAttributes.clear();
  3065. renderer.markedChildren.clear();
  3066. renderer.isFocused = true;
  3067. } );
  3068. afterEach( () => {
  3069. domRoot.remove();
  3070. } );
  3071. it( 'should update text - change on end', () => {
  3072. const viewText = new ViewText( viewDocument, 'foo' );
  3073. viewRoot._appendChild( viewText );
  3074. renderer.markToSync( 'children', viewRoot );
  3075. renderer.render();
  3076. expect( domRoot.childNodes.length ).to.equal( 1 );
  3077. expect( domRoot.childNodes[ 0 ].data ).to.equal( 'foo' );
  3078. viewText._data = 'fobar';
  3079. renderer._updateText( viewText, {} );
  3080. expect( domRoot.childNodes.length ).to.equal( 1 );
  3081. expect( domRoot.childNodes[ 0 ].data ).to.equal( 'fobar' );
  3082. } );
  3083. it( 'should update text - change on start', () => {
  3084. const viewText = new ViewText( viewDocument, 'foo' );
  3085. viewRoot._appendChild( viewText );
  3086. renderer.markToSync( 'children', viewRoot );
  3087. renderer.render();
  3088. expect( domRoot.childNodes.length ).to.equal( 1 );
  3089. expect( domRoot.childNodes[ 0 ].data ).to.equal( 'foo' );
  3090. viewText._data = 'baro';
  3091. renderer._updateText( viewText, {} );
  3092. expect( domRoot.childNodes.length ).to.equal( 1 );
  3093. expect( domRoot.childNodes[ 0 ].data ).to.equal( 'baro' );
  3094. } );
  3095. it( 'should update text - change in the middle', () => {
  3096. const viewText = new ViewText( viewDocument, 'foobar' );
  3097. viewRoot._appendChild( viewText );
  3098. renderer.markToSync( 'children', viewRoot );
  3099. renderer.render();
  3100. expect( domRoot.childNodes.length ).to.equal( 1 );
  3101. expect( domRoot.childNodes[ 0 ].data ).to.equal( 'foobar' );
  3102. viewText._data = 'fobazr';
  3103. renderer._updateText( viewText, {} );
  3104. expect( domRoot.childNodes.length ).to.equal( 1 );
  3105. expect( domRoot.childNodes[ 0 ].data ).to.equal( 'fobazr' );
  3106. } );
  3107. it( 'should update text - empty expected', () => {
  3108. const viewText = new ViewText( viewDocument, 'foo' );
  3109. viewRoot._appendChild( viewText );
  3110. renderer.markToSync( 'children', viewRoot );
  3111. renderer.render();
  3112. expect( domRoot.childNodes.length ).to.equal( 1 );
  3113. expect( domRoot.childNodes[ 0 ].data ).to.equal( 'foo' );
  3114. viewText._data = '';
  3115. renderer._updateText( viewText, {} );
  3116. expect( domRoot.childNodes.length ).to.equal( 1 );
  3117. expect( domRoot.childNodes[ 0 ].data ).to.equal( '' );
  3118. } );
  3119. it( 'should update text - empty actual', () => {
  3120. const viewText = new ViewText( viewDocument, '' );
  3121. viewRoot._appendChild( viewText );
  3122. renderer.markToSync( 'children', viewRoot );
  3123. renderer.render();
  3124. expect( domRoot.childNodes.length ).to.equal( 1 );
  3125. expect( domRoot.childNodes[ 0 ].data ).to.equal( '' );
  3126. viewText._data = 'fobar';
  3127. renderer._updateText( viewText, {} );
  3128. expect( domRoot.childNodes.length ).to.equal( 1 );
  3129. expect( domRoot.childNodes[ 0 ].data ).to.equal( 'fobar' );
  3130. } );
  3131. it( 'should handle filler during text modifications', () => {
  3132. const viewText = new ViewText( viewDocument, 'foo' );
  3133. viewRoot._appendChild( viewText );
  3134. renderer.markToSync( 'children', viewRoot );
  3135. renderer.render();
  3136. expect( domRoot.childNodes.length ).to.equal( 1 );
  3137. expect( domRoot.childNodes[ 0 ].data ).to.equal( 'foo' );
  3138. // 1. Insert filler.
  3139. renderer._updateText( viewText, {
  3140. inlineFillerPosition: {
  3141. parent: viewText.parent,
  3142. offset: 0
  3143. }
  3144. } );
  3145. expect( domRoot.childNodes.length ).to.equal( 1 );
  3146. expect( domRoot.childNodes[ 0 ].data ).to.equal( INLINE_FILLER + 'foo' );
  3147. // 2. Edit text - filler should be preserved.
  3148. viewText._data = 'barfoo';
  3149. renderer._updateText( viewText, {
  3150. inlineFillerPosition: {
  3151. parent: viewText.parent,
  3152. offset: 0
  3153. }
  3154. } );
  3155. expect( domRoot.childNodes.length ).to.equal( 1 );
  3156. expect( domRoot.childNodes[ 0 ].data ).to.equal( INLINE_FILLER + 'barfoo' );
  3157. // 3. Remove filler.
  3158. renderer._updateText( viewText, {} );
  3159. expect( domRoot.childNodes.length ).to.equal( 1 );
  3160. expect( domRoot.childNodes[ 0 ].data ).to.equal( 'barfoo' );
  3161. } );
  3162. it( 'should handle filler during text modifications - empty text', () => {
  3163. const viewText = new ViewText( viewDocument, '' );
  3164. viewRoot._appendChild( viewText );
  3165. renderer.markToSync( 'children', viewRoot );
  3166. renderer.render();
  3167. expect( domRoot.childNodes.length ).to.equal( 1 );
  3168. expect( domRoot.childNodes[ 0 ].data ).to.equal( '' );
  3169. // 1. Insert filler.
  3170. renderer._updateText( viewText, {
  3171. inlineFillerPosition: {
  3172. parent: viewText.parent,
  3173. offset: 0
  3174. }
  3175. } );
  3176. expect( domRoot.childNodes.length ).to.equal( 1 );
  3177. expect( domRoot.childNodes[ 0 ].data ).to.equal( INLINE_FILLER );
  3178. // 2. Edit text - filler should be preserved.
  3179. viewText._data = 'foo';
  3180. renderer._updateText( viewText, {
  3181. inlineFillerPosition: {
  3182. parent: viewText.parent,
  3183. offset: 0
  3184. }
  3185. } );
  3186. expect( domRoot.childNodes.length ).to.equal( 1 );
  3187. expect( domRoot.childNodes[ 0 ].data ).to.equal( INLINE_FILLER + 'foo' );
  3188. // 3. Remove filler.
  3189. viewText._data = '';
  3190. renderer._updateText( viewText, {} );
  3191. expect( domRoot.childNodes.length ).to.equal( 1 );
  3192. expect( domRoot.childNodes[ 0 ].data ).to.equal( '' );
  3193. } );
  3194. it( 'should handle filler during text modifications inside inline element', () => {
  3195. const viewB = new ViewElement( viewDocument, 'b' );
  3196. const viewText = new ViewText( viewDocument, 'foo' );
  3197. viewB._appendChild( viewText );
  3198. viewRoot._appendChild( viewB );
  3199. renderer.markToSync( 'children', viewRoot );
  3200. renderer.render();
  3201. expect( domRoot.childNodes.length ).to.equal( 1 );
  3202. expect( domRoot.childNodes[ 0 ].tagName ).to.equal( 'B' );
  3203. expect( domRoot.childNodes[ 0 ].childNodes.length ).to.equal( 1 );
  3204. expect( domRoot.childNodes[ 0 ].childNodes[ 0 ].data ).to.equal( 'foo' );
  3205. // 1. Insert filler.
  3206. renderer._updateText( viewText, {
  3207. inlineFillerPosition: {
  3208. parent: viewText.parent,
  3209. offset: 0
  3210. }
  3211. } );
  3212. expect( domRoot.childNodes.length ).to.equal( 1 );
  3213. expect( domRoot.childNodes[ 0 ].tagName ).to.equal( 'B' );
  3214. expect( domRoot.childNodes[ 0 ].childNodes.length ).to.equal( 1 );
  3215. expect( domRoot.childNodes[ 0 ].childNodes[ 0 ].data ).to.equal( INLINE_FILLER + 'foo' );
  3216. // 2. Edit text - filler should be preserved.
  3217. viewText._data = 'bar';
  3218. renderer._updateText( viewText, {
  3219. inlineFillerPosition: {
  3220. parent: viewText.parent,
  3221. offset: 0
  3222. }
  3223. } );
  3224. expect( domRoot.childNodes.length ).to.equal( 1 );
  3225. expect( domRoot.childNodes[ 0 ].tagName ).to.equal( 'B' );
  3226. expect( domRoot.childNodes[ 0 ].childNodes.length ).to.equal( 1 );
  3227. expect( domRoot.childNodes[ 0 ].childNodes[ 0 ].data ).to.equal( INLINE_FILLER + 'bar' );
  3228. // 3. Remove filler.
  3229. viewText._data = 'bar';
  3230. renderer._updateText( viewText, {} );
  3231. expect( domRoot.childNodes.length ).to.equal( 1 );
  3232. expect( domRoot.childNodes[ 0 ].tagName ).to.equal( 'B' );
  3233. expect( domRoot.childNodes[ 0 ].childNodes.length ).to.equal( 1 );
  3234. expect( domRoot.childNodes[ 0 ].childNodes[ 0 ].data ).to.equal( 'bar' );
  3235. } );
  3236. } );
  3237. } );
  3238. function renderAndExpectNoChanges( renderer, domRoot ) {
  3239. const config = {
  3240. childList: true,
  3241. characterData: true,
  3242. characterDataOldValue: true,
  3243. subtree: true
  3244. };
  3245. const mutationObserver = new window.MutationObserver( () => {
  3246. throw 'There should be not mutations';
  3247. } );
  3248. mutationObserver.observe( domRoot, config );
  3249. renderer.render();
  3250. const records = mutationObserver.takeRecords();
  3251. mutationObserver.disconnect();
  3252. expect( records.length ).to.equal( 0 );
  3253. }