renderer.js 73 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046
  1. /**
  2. * @license Copyright (c) 2003-2018, CKSource - Frederico Knabben. All rights reserved.
  3. * For licensing, see LICENSE.md.
  4. */
  5. /* globals document, window, NodeFilter */
  6. import View from '../../src/view/view';
  7. import ViewElement from '../../src/view/element';
  8. import ViewContainerElement from '../../src/view/containerelement';
  9. import ViewAttributeElement from '../../src/view/attributeelement';
  10. import ViewText from '../../src/view/text';
  11. import ViewRange from '../../src/view/range';
  12. import ViewPosition from '../../src/view/position';
  13. import DocumentSelection from '../../src/view/documentselection';
  14. import DomConverter from '../../src/view/domconverter';
  15. import Renderer from '../../src/view/renderer';
  16. import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror';
  17. import { parse, setData as setViewData, getData as getViewData } from '../../src/dev-utils/view';
  18. import { INLINE_FILLER, INLINE_FILLER_LENGTH, isBlockFiller, BR_FILLER } from '../../src/view/filler';
  19. import testUtils from '@ckeditor/ckeditor5-core/tests/_utils/utils';
  20. import createViewRoot from './_utils/createroot';
  21. import createElement from '@ckeditor/ckeditor5-utils/src/dom/createelement';
  22. import normalizeHtml from '@ckeditor/ckeditor5-utils/tests/_utils/normalizehtml';
  23. testUtils.createSinonSandbox();
  24. describe( 'Renderer', () => {
  25. let selection, domConverter, renderer;
  26. beforeEach( () => {
  27. selection = new DocumentSelection();
  28. domConverter = new DomConverter();
  29. renderer = new Renderer( domConverter, selection );
  30. renderer.domDocuments.add( document );
  31. } );
  32. describe( 'markToSync', () => {
  33. let viewRoot;
  34. beforeEach( () => {
  35. viewRoot = new ViewElement( 'p' );
  36. const domRoot = document.createElement( 'p' );
  37. domConverter.bindElements( domRoot, viewRoot );
  38. viewRoot._appendChildren( new ViewText( 'foo' ) );
  39. renderer.markedTexts.clear();
  40. renderer.markedAttributes.clear();
  41. renderer.markedChildren.clear();
  42. } );
  43. it( 'should mark attributes which need update', () => {
  44. viewRoot._setAttribute( 'class', 'foo' );
  45. renderer.markToSync( 'attributes', viewRoot );
  46. expect( renderer.markedAttributes.has( viewRoot ) ).to.be.true;
  47. } );
  48. it( 'should mark children which need update', () => {
  49. viewRoot._appendChildren( new ViewText( 'foo' ) );
  50. renderer.markToSync( 'children', viewRoot );
  51. expect( renderer.markedChildren.has( viewRoot ) ).to.be.true;
  52. } );
  53. it( 'should not mark children if element has no corresponding node', () => {
  54. // Overwrite viewRoot with node without coresponding DOM node.
  55. viewRoot = new ViewElement( 'p' );
  56. viewRoot._appendChildren( new ViewText( 'foo' ) );
  57. renderer.markToSync( 'children', viewRoot );
  58. expect( renderer.markedTexts.has( viewRoot ) ).to.be.false;
  59. } );
  60. it( 'should mark text which need update', () => {
  61. const viewText = new ViewText( 'foo' );
  62. viewRoot._appendChildren( viewText );
  63. viewText._data = 'bar';
  64. renderer.markToSync( 'text', viewText );
  65. expect( renderer.markedTexts.has( viewText ) ).to.be.true;
  66. } );
  67. it( 'should not mark text if parent has no corresponding node', () => {
  68. const viewText = new ViewText( 'foo' );
  69. // Overwrite viewRoot with node without coresponding DOM node.
  70. viewRoot = new ViewElement( 'p' );
  71. viewRoot._appendChildren( viewText );
  72. viewText._data = 'bar';
  73. renderer.markToSync( 'text', viewText );
  74. expect( renderer.markedTexts.has( viewText ) ).to.be.false;
  75. } );
  76. it( 'should throw if the type is unknown', () => {
  77. expect( () => {
  78. renderer.markToSync( 'UNKNOWN', viewRoot );
  79. } ).to.throw( CKEditorError, /^view-renderer-unknown-type/ );
  80. } );
  81. } );
  82. describe( 'render', () => {
  83. let viewRoot, domRoot, selectionEditable;
  84. beforeEach( () => {
  85. viewRoot = new ViewElement( 'div' );
  86. domRoot = document.createElement( 'div' );
  87. document.body.appendChild( domRoot );
  88. domConverter.bindElements( domRoot, viewRoot );
  89. renderer.markedTexts.clear();
  90. renderer.markedAttributes.clear();
  91. renderer.markedChildren.clear();
  92. selection._setTo( null );
  93. selectionEditable = viewRoot;
  94. renderer.isFocused = true;
  95. // Fake selection editable - it is needed to render selection properly.
  96. Object.defineProperty( selection, 'editableElement', {
  97. get() {
  98. return selectionEditable;
  99. }
  100. } );
  101. } );
  102. afterEach( () => {
  103. domRoot.remove();
  104. } );
  105. it( 'should update attributes', () => {
  106. viewRoot._setAttribute( 'class', 'foo' );
  107. renderer.markToSync( 'attributes', viewRoot );
  108. renderer.render();
  109. expect( domRoot.getAttribute( 'class' ) ).to.equal( 'foo' );
  110. expect( renderer.markedAttributes.size ).to.equal( 0 );
  111. } );
  112. it( 'should remove attributes', () => {
  113. viewRoot._setAttribute( 'class', 'foo' );
  114. domRoot.setAttribute( 'id', 'bar' );
  115. domRoot.setAttribute( 'class', 'bar' );
  116. renderer.markToSync( 'attributes', viewRoot );
  117. renderer.render();
  118. expect( domRoot.getAttribute( 'class' ) ).to.equal( 'foo' );
  119. expect( domRoot.getAttribute( 'id' ) ).to.be.not.ok;
  120. expect( renderer.markedAttributes.size ).to.equal( 0 );
  121. } );
  122. it( 'should add children', () => {
  123. viewRoot._appendChildren( new ViewText( 'foo' ) );
  124. renderer.markToSync( 'children', viewRoot );
  125. renderer.render();
  126. expect( domRoot.childNodes.length ).to.equal( 1 );
  127. expect( domRoot.childNodes[ 0 ].data ).to.equal( 'foo' );
  128. expect( renderer.markedChildren.size ).to.equal( 0 );
  129. } );
  130. it( 'should remove children', () => {
  131. viewRoot._appendChildren( new ViewText( 'foo' ) );
  132. renderer.markToSync( 'children', viewRoot );
  133. renderer.render();
  134. expect( domRoot.childNodes.length ).to.equal( 1 );
  135. expect( domRoot.childNodes[ 0 ].data ).to.equal( 'foo' );
  136. viewRoot._removeChildren( 0, 1 );
  137. renderer.markToSync( 'children', viewRoot );
  138. renderer.render();
  139. expect( domRoot.childNodes.length ).to.equal( 0 );
  140. expect( renderer.markedChildren.size ).to.equal( 0 );
  141. } );
  142. it( 'should update text', () => {
  143. const viewText = new ViewText( 'foo' );
  144. viewRoot._appendChildren( viewText );
  145. renderer.markToSync( 'children', viewRoot );
  146. renderer.render();
  147. expect( domRoot.childNodes.length ).to.equal( 1 );
  148. expect( domRoot.childNodes[ 0 ].data ).to.equal( 'foo' );
  149. viewText._data = 'bar';
  150. renderer.markToSync( 'text', viewText );
  151. renderer.render();
  152. expect( domRoot.childNodes.length ).to.equal( 1 );
  153. expect( domRoot.childNodes[ 0 ].data ).to.equal( 'bar' );
  154. expect( renderer.markedTexts.size ).to.equal( 0 );
  155. } );
  156. it( 'should not update text parent child list changed', () => {
  157. const viewImg = new ViewElement( 'img' );
  158. const viewText = new ViewText( 'foo' );
  159. viewRoot._appendChildren( [ viewImg, viewText ] );
  160. renderer.markToSync( 'children', viewRoot );
  161. renderer.markToSync( 'text', viewText );
  162. renderer.render();
  163. expect( domRoot.childNodes.length ).to.equal( 2 );
  164. expect( domRoot.childNodes[ 0 ].tagName ).to.equal( 'IMG' );
  165. expect( domRoot.childNodes[ 1 ].data ).to.equal( 'foo' );
  166. } );
  167. it( 'should not change text if it is the same during text rendering', () => {
  168. const viewText = new ViewText( 'foo' );
  169. viewRoot._appendChildren( viewText );
  170. renderer.markToSync( 'children', viewRoot );
  171. renderer.render();
  172. // This should not be changed during the render.
  173. const domText = domRoot.childNodes[ 0 ];
  174. renderer.markToSync( 'text', viewText );
  175. renderer.render();
  176. expect( domRoot.childNodes.length ).to.equal( 1 );
  177. expect( domRoot.childNodes[ 0 ] ).to.equal( domText );
  178. } );
  179. it( 'should not change text if it is the same during children rendering', () => {
  180. const viewText = new ViewText( 'foo' );
  181. viewRoot._appendChildren( viewText );
  182. renderer.markToSync( 'children', viewRoot );
  183. renderer.render();
  184. // This should not be changed during the render.
  185. const domText = domRoot.childNodes[ 0 ];
  186. renderer.markToSync( 'children', viewRoot );
  187. renderer.render();
  188. expect( domRoot.childNodes.length ).to.equal( 1 );
  189. expect( domRoot.childNodes[ 0 ] ).to.equal( domText );
  190. } );
  191. it( 'should not change element if it is the same', () => {
  192. const viewImg = new ViewElement( 'img' );
  193. viewRoot._appendChildren( viewImg );
  194. // This should not be changed during the render.
  195. const domImg = document.createElement( 'img' );
  196. domRoot.appendChild( domImg );
  197. domConverter.bindElements( domImg, viewImg );
  198. renderer.markToSync( 'children', viewRoot );
  199. renderer.render();
  200. expect( domRoot.childNodes.length ).to.equal( 1 );
  201. expect( domRoot.childNodes[ 0 ] ).to.equal( domImg );
  202. } );
  203. it( 'should change element if it is different', () => {
  204. const viewImg = new ViewElement( 'img' );
  205. viewRoot._appendChildren( viewImg );
  206. renderer.markToSync( 'children', viewRoot );
  207. renderer.render();
  208. const viewP = new ViewElement( 'p' );
  209. viewRoot._removeChildren( 0, 1 );
  210. viewRoot._appendChildren( viewP );
  211. renderer.markToSync( 'children', viewRoot );
  212. renderer.render();
  213. expect( domRoot.childNodes.length ).to.equal( 1 );
  214. expect( domRoot.childNodes[ 0 ].tagName ).to.equal( 'P' );
  215. } );
  216. it( 'should update removed item when it is reinserted', () => {
  217. const viewFoo = new ViewText( 'foo' );
  218. const viewP = new ViewElement( 'p', null, viewFoo );
  219. const viewDiv = new ViewElement( 'div', null, viewP );
  220. viewRoot._appendChildren( viewDiv );
  221. renderer.markToSync( 'children', viewRoot );
  222. renderer.render();
  223. viewDiv._removeChildren( 0, 1 );
  224. renderer.markToSync( 'children', viewDiv );
  225. renderer.render();
  226. viewP._removeChildren( 0, 1 );
  227. viewDiv._appendChildren( viewP );
  228. renderer.markToSync( 'children', viewDiv );
  229. renderer.render();
  230. expect( domRoot.childNodes.length ).to.equal( 1 );
  231. const domDiv = domRoot.childNodes[ 0 ];
  232. expect( domDiv.tagName ).to.equal( 'DIV' );
  233. expect( domDiv.childNodes.length ).to.equal( 1 );
  234. const domP = domDiv.childNodes[ 0 ];
  235. expect( domP.tagName ).to.equal( 'P' );
  236. expect( domP.childNodes.length ).to.equal( 0 );
  237. } );
  238. it( 'should update removed item when it is reinserted #2', () => {
  239. // Prepare view: root -> div "outer" -> div "inner" -> p.
  240. const viewP = new ViewElement( 'p' );
  241. const viewDivInner = new ViewElement( 'div', null, viewP );
  242. const viewDivOuter = new ViewElement( 'div', null, viewDivInner );
  243. viewRoot._appendChildren( viewDivOuter );
  244. // Render view tree to DOM.
  245. renderer.markToSync( 'children', viewRoot );
  246. renderer.render();
  247. // Remove div "outer" from root and render it.
  248. viewDivOuter._remove();
  249. renderer.markToSync( 'children', viewRoot );
  250. renderer.render();
  251. // Remove p from div "child" -- div "inner" won't be marked because it is in document fragment not view root.
  252. viewP._remove();
  253. // Add div "outer" back to root.
  254. viewRoot._appendChildren( viewDivOuter );
  255. renderer.markToSync( 'children', viewRoot );
  256. // Render changes, view is: root -> div "outer" -> div "inner".
  257. renderer.render();
  258. // Same is expected in DOM.
  259. expect( domRoot.childNodes.length ).to.equal( 1 );
  260. const domDivOuter = domRoot.childNodes[ 0 ];
  261. expect( renderer.domConverter.viewToDom( viewDivOuter, domRoot.document ) ).to.equal( domDivOuter );
  262. expect( domDivOuter.tagName ).to.equal( 'DIV' );
  263. expect( domDivOuter.childNodes.length ).to.equal( 1 );
  264. const domDivInner = domDivOuter.childNodes[ 0 ];
  265. expect( renderer.domConverter.viewToDom( viewDivInner, domRoot.document ) ).to.equal( domDivInner );
  266. expect( domDivInner.tagName ).to.equal( 'DIV' );
  267. expect( domDivInner.childNodes.length ).to.equal( 0 );
  268. } );
  269. it( 'should not throw when trying to update children of view element that got removed and lost its binding', () => {
  270. const viewFoo = new ViewText( 'foo' );
  271. const viewP = new ViewElement( 'p', null, viewFoo );
  272. const viewDiv = new ViewElement( 'div', null, viewP );
  273. viewRoot._appendChildren( viewDiv );
  274. renderer.markToSync( 'children', viewRoot );
  275. renderer.render();
  276. viewRoot._removeChildren( 0, 1 );
  277. renderer.markToSync( 'children', viewRoot );
  278. viewDiv._removeChildren( 0, 1 );
  279. renderer.markToSync( 'children', viewDiv );
  280. viewP._removeChildren( 0, 1 );
  281. renderer.markToSync( 'children', viewP );
  282. renderer.render();
  283. expect( domRoot.childNodes.length ).to.equal( 0 );
  284. } );
  285. it( 'should not care about filler if there is no DOM', () => {
  286. selectionEditable = null;
  287. const { view: viewP, selection: newSelection } = parse(
  288. '<container:p>foo<attribute:b>[]</attribute:b>bar</container:p>' );
  289. const viewRoot = new ViewElement( 'p' );
  290. viewRoot._appendChildren( viewP );
  291. selection._setTo( newSelection );
  292. renderer.markToSync( 'children', viewRoot );
  293. renderer.render();
  294. // Expect no error on render.
  295. expect( viewRoot ).to.be.ok;
  296. } );
  297. it( 'should not add filler when inside contenteditable=false parent', () => {
  298. const { view: viewP, selection: newSelection } = parse(
  299. '<container:p>foo<attribute:b contenteditable="false">[]</attribute:b>bar</container:p>' );
  300. viewRoot._appendChildren( viewP );
  301. selection._setTo( newSelection );
  302. renderer.markToSync( 'children', viewRoot );
  303. renderer.render();
  304. expect( domRoot.childNodes.length ).to.equal( 1 );
  305. expect( domRoot.childNodes[ 0 ].tagName.toLowerCase() ).to.equal( 'p' );
  306. const domP = domRoot.childNodes[ 0 ];
  307. expect( domP.childNodes.length ).to.equal( 3 );
  308. expect( domP.childNodes[ 0 ].data ).to.equal( 'foo' );
  309. expect( domP.childNodes[ 2 ].data ).to.equal( 'bar' );
  310. expect( domP.childNodes[ 1 ].tagName.toLowerCase() ).to.equal( 'b' );
  311. expect( domP.childNodes[ 1 ].childNodes.length ).to.equal( 0 );
  312. } );
  313. it( 'should not add filler when inside contenteditable=false ancestor', () => {
  314. const { view: viewP, selection: newSelection } = parse(
  315. '<container:p contenteditable="false">foo<attribute:b>[]</attribute:b>bar</container:p>' );
  316. viewRoot._appendChildren( viewP );
  317. selection._setTo( newSelection );
  318. renderer.markToSync( 'children', viewRoot );
  319. renderer.render();
  320. expect( domRoot.childNodes.length ).to.equal( 1 );
  321. expect( domRoot.childNodes[ 0 ].tagName.toLowerCase() ).to.equal( 'p' );
  322. const domP = domRoot.childNodes[ 0 ];
  323. expect( domP.childNodes.length ).to.equal( 3 );
  324. expect( domP.childNodes[ 0 ].data ).to.equal( 'foo' );
  325. expect( domP.childNodes[ 2 ].data ).to.equal( 'bar' );
  326. expect( domP.childNodes[ 1 ].tagName.toLowerCase() ).to.equal( 'b' );
  327. expect( domP.childNodes[ 1 ].childNodes.length ).to.equal( 0 );
  328. } );
  329. it( 'should add and remove inline filler in case <p>foo<b>[]</b>bar</p>', () => {
  330. const domSelection = document.getSelection();
  331. // Step 1: <p>foo<b>"FILLER{}"</b></p>
  332. const { view: viewP, selection: newSelection } = parse(
  333. '<container:p>foo<attribute:b>[]</attribute:b>bar</container:p>' );
  334. viewRoot._appendChildren( viewP );
  335. selection._setTo( newSelection );
  336. renderer.markToSync( 'children', viewRoot );
  337. renderer.render();
  338. expect( domRoot.childNodes.length ).to.equal( 1 );
  339. expect( domRoot.childNodes[ 0 ].tagName.toLowerCase() ).to.equal( 'p' );
  340. const domP = domRoot.childNodes[ 0 ];
  341. expect( domP.childNodes.length ).to.equal( 3 );
  342. expect( domP.childNodes[ 0 ].data ).to.equal( 'foo' );
  343. expect( domP.childNodes[ 2 ].data ).to.equal( 'bar' );
  344. expect( domP.childNodes[ 1 ].tagName.toLowerCase() ).to.equal( 'b' );
  345. expect( domP.childNodes[ 1 ].childNodes.length ).to.equal( 1 );
  346. expect( domP.childNodes[ 1 ].childNodes[ 0 ].data ).to.equal( INLINE_FILLER );
  347. expect( domSelection.rangeCount ).to.equal( 1 );
  348. expect( domSelection.getRangeAt( 0 ).startContainer ).to.equal( domP.childNodes[ 1 ].childNodes[ 0 ] );
  349. expect( domSelection.getRangeAt( 0 ).startOffset ).to.equal( INLINE_FILLER_LENGTH );
  350. expect( domSelection.getRangeAt( 0 ).collapsed ).to.be.true;
  351. // Step 2: No mutation on second render
  352. renderer.markToSync( 'children', viewRoot );
  353. renderer.markToSync( 'children', viewP );
  354. renderAndExpectNoChanges( renderer, domRoot );
  355. // Step 3: <p>foo{}<b></b></p>
  356. selection._setTo( ViewRange.createFromParentsAndOffsets( viewP.getChild( 0 ), 3, viewP.getChild( 0 ), 3 ) );
  357. renderer.render();
  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. expect( domSelection.rangeCount ).to.equal( 1 );
  364. expect( domSelection.getRangeAt( 0 ).startContainer ).to.equal( domP.childNodes[ 0 ] );
  365. expect( domSelection.getRangeAt( 0 ).startOffset ).to.equal( 3 );
  366. expect( domSelection.getRangeAt( 0 ).collapsed ).to.be.true;
  367. // Step 4: No mutation on second render
  368. renderer.markToSync( 'children', viewRoot );
  369. renderer.markToSync( 'children', viewP );
  370. renderAndExpectNoChanges( renderer, domRoot );
  371. } );
  372. it( 'should add and remove inline filler in case <p>[]<b>foo</b></p>', () => {
  373. const domSelection = document.getSelection();
  374. // Step 1: <p>"FILLER{}"<b>foo</b></p>
  375. const { view: viewP, selection: newSelection } = parse(
  376. '<container:p>[]<attribute:b>foo</attribute:b></container:p>' );
  377. viewRoot._appendChildren( viewP );
  378. selection._setTo( newSelection );
  379. renderer.markToSync( 'children', viewRoot );
  380. renderer.render();
  381. const domP = domRoot.childNodes[ 0 ];
  382. expect( domP.childNodes.length ).to.equal( 2 );
  383. expect( domP.childNodes[ 0 ].data ).to.equal( INLINE_FILLER );
  384. expect( domP.childNodes[ 1 ].tagName.toLowerCase() ).to.equal( 'b' );
  385. expect( domP.childNodes[ 1 ].childNodes.length ).to.equal( 1 );
  386. expect( domP.childNodes[ 1 ].childNodes[ 0 ].data ).to.equal( 'foo' );
  387. expect( domSelection.rangeCount ).to.equal( 1 );
  388. expect( domSelection.getRangeAt( 0 ).startContainer ).to.equal( domP.childNodes[ 0 ] );
  389. expect( domSelection.getRangeAt( 0 ).startOffset ).to.equal( INLINE_FILLER_LENGTH );
  390. expect( domSelection.getRangeAt( 0 ).collapsed ).to.be.true;
  391. // Step 2: No mutation on second render
  392. renderer.markToSync( 'children', viewP );
  393. renderAndExpectNoChanges( renderer, domRoot );
  394. // Step 3: <p><b>{}foo</b></p>
  395. selection._setTo( ViewRange.createFromParentsAndOffsets(
  396. viewP.getChild( 0 ).getChild( 0 ), 0, viewP.getChild( 0 ).getChild( 0 ), 0 ) );
  397. renderer.render();
  398. expect( domP.childNodes.length ).to.equal( 1 );
  399. expect( domP.childNodes[ 0 ].tagName.toLowerCase() ).to.equal( 'b' );
  400. expect( domP.childNodes[ 0 ].childNodes.length ).to.equal( 1 );
  401. expect( domP.childNodes[ 0 ].childNodes[ 0 ].data ).to.equal( 'foo' );
  402. expect( domSelection.rangeCount ).to.equal( 1 );
  403. expect( domSelection.getRangeAt( 0 ).startContainer ).to.equal( domP.childNodes[ 0 ].childNodes[ 0 ] );
  404. expect( domSelection.getRangeAt( 0 ).startOffset ).to.equal( 0 );
  405. expect( domSelection.getRangeAt( 0 ).collapsed ).to.be.true;
  406. // Step 4: No mutation on second render
  407. renderer.markToSync( 'children', viewP );
  408. renderAndExpectNoChanges( renderer, domRoot );
  409. } );
  410. it( 'should add and remove inline filler in case <p><b>foo</b>[]</p>', () => {
  411. const domSelection = document.getSelection();
  412. // Step 1: <p>"FILLER{}"<b>foo</b></p>
  413. const { view: viewP, selection: newSelection } = parse(
  414. '<container:p><attribute:b>foo</attribute:b>[]</container:p>' );
  415. viewRoot._appendChildren( viewP );
  416. selection._setTo( newSelection );
  417. renderer.markToSync( 'children', viewRoot );
  418. renderer.render();
  419. const domP = domRoot.childNodes[ 0 ];
  420. expect( domP.childNodes.length ).to.equal( 2 );
  421. expect( domP.childNodes[ 0 ].tagName.toLowerCase() ).to.equal( 'b' );
  422. expect( domP.childNodes[ 0 ].childNodes.length ).to.equal( 1 );
  423. expect( domP.childNodes[ 0 ].childNodes[ 0 ].data ).to.equal( 'foo' );
  424. expect( domP.childNodes[ 1 ].data ).to.equal( INLINE_FILLER );
  425. expect( domSelection.rangeCount ).to.equal( 1 );
  426. expect( domSelection.getRangeAt( 0 ).startContainer ).to.equal( domP.childNodes[ 1 ] );
  427. expect( domSelection.getRangeAt( 0 ).startOffset ).to.equal( INLINE_FILLER_LENGTH );
  428. expect( domSelection.getRangeAt( 0 ).collapsed ).to.be.true;
  429. // Step 2: No mutation on second render
  430. renderer.markToSync( 'children', viewP );
  431. renderAndExpectNoChanges( renderer, domRoot );
  432. // Step 3: <p><b>foo{}</b></p>
  433. selection._setTo( ViewRange.createFromParentsAndOffsets(
  434. viewP.getChild( 0 ).getChild( 0 ), 3, viewP.getChild( 0 ).getChild( 0 ), 3 ) );
  435. renderer.render();
  436. expect( domP.childNodes.length ).to.equal( 1 );
  437. expect( domP.childNodes[ 0 ].tagName.toLowerCase() ).to.equal( 'b' );
  438. expect( domP.childNodes[ 0 ].childNodes.length ).to.equal( 1 );
  439. expect( domP.childNodes[ 0 ].childNodes[ 0 ].data ).to.equal( 'foo' );
  440. expect( domSelection.rangeCount ).to.equal( 1 );
  441. expect( domSelection.getRangeAt( 0 ).startContainer ).to.equal( domP.childNodes[ 0 ].childNodes[ 0 ] );
  442. expect( domSelection.getRangeAt( 0 ).startOffset ).to.equal( 3 );
  443. expect( domSelection.getRangeAt( 0 ).collapsed ).to.be.true;
  444. // Step 4: No mutation on second render
  445. renderer.markToSync( 'children', viewP );
  446. renderAndExpectNoChanges( renderer, domRoot );
  447. } );
  448. it( 'should add and remove inline filler in case <p><b>foo</b>[]<b>bar</b></p>', () => {
  449. const domSelection = document.getSelection();
  450. const { view: viewP, selection: newSelection } = parse(
  451. '<container:p><attribute:b>foo</attribute:b>[]<attribute:b>bar</attribute:b></container:p>' );
  452. viewRoot._appendChildren( viewP );
  453. selection._setTo( newSelection );
  454. renderer.markToSync( 'children', viewRoot );
  455. renderer.render();
  456. const domP = domRoot.childNodes[ 0 ];
  457. expect( domP.childNodes.length ).to.equal( 3 );
  458. expect( domP.childNodes[ 0 ].tagName.toLowerCase() ).to.equal( 'b' );
  459. expect( domP.childNodes[ 0 ].childNodes.length ).to.equal( 1 );
  460. expect( domP.childNodes[ 0 ].childNodes[ 0 ].data ).to.equal( 'foo' );
  461. expect( domP.childNodes[ 1 ].data ).to.equal( INLINE_FILLER );
  462. expect( domP.childNodes[ 2 ].tagName.toLowerCase() ).to.equal( 'b' );
  463. expect( domP.childNodes[ 2 ].childNodes.length ).to.equal( 1 );
  464. expect( domP.childNodes[ 2 ].childNodes[ 0 ].data ).to.equal( 'bar' );
  465. expect( domSelection.rangeCount ).to.equal( 1 );
  466. expect( domSelection.getRangeAt( 0 ).startContainer ).to.equal( domP.childNodes[ 1 ] );
  467. expect( domSelection.getRangeAt( 0 ).startOffset ).to.equal( INLINE_FILLER_LENGTH );
  468. expect( domSelection.getRangeAt( 0 ).collapsed ).to.be.true;
  469. } );
  470. it( 'should move filler when selection is moved', () => {
  471. // Step 1: <p>foo<b>"FILLER{}"</b></p>
  472. const { view: viewP, selection: newSelection } = parse(
  473. '<container:p>foo<attribute:b>[]</attribute:b><attribute:i></attribute:i></container:p>' );
  474. viewRoot._appendChildren( viewP );
  475. selection._setTo( newSelection );
  476. renderer.markToSync( 'children', viewRoot );
  477. renderer.render();
  478. const domP = domRoot.childNodes[ 0 ];
  479. expect( domP.childNodes.length ).to.equal( 3 );
  480. expect( domP.childNodes[ 0 ].data ).to.equal( 'foo' );
  481. expect( domP.childNodes[ 1 ].tagName.toLowerCase() ).to.equal( 'b' );
  482. expect( domP.childNodes[ 1 ].childNodes.length ).to.equal( 1 );
  483. expect( domP.childNodes[ 1 ].childNodes[ 0 ].data ).to.equal( INLINE_FILLER );
  484. expect( domP.childNodes[ 2 ].tagName.toLowerCase() ).to.equal( 'i' );
  485. expect( domP.childNodes[ 2 ].childNodes.length ).to.equal( 0 );
  486. // Step 2: <p>foo<b></b><i>"FILLER{}"</i></p>
  487. const viewI = viewP.getChild( 2 );
  488. selection._setTo( ViewRange.createFromParentsAndOffsets( viewI, 0, viewI, 0 ) );
  489. renderer.render();
  490. expect( domP.childNodes.length ).to.equal( 3 );
  491. expect( domP.childNodes[ 0 ].data ).to.equal( 'foo' );
  492. expect( domP.childNodes[ 1 ].tagName.toLowerCase() ).to.equal( 'b' );
  493. expect( domP.childNodes[ 1 ].childNodes.length ).to.equal( 0 );
  494. expect( domP.childNodes[ 2 ].tagName.toLowerCase() ).to.equal( 'i' );
  495. expect( domP.childNodes[ 2 ].childNodes.length ).to.equal( 1 );
  496. expect( domP.childNodes[ 2 ].childNodes[ 0 ].data ).to.equal( INLINE_FILLER );
  497. } );
  498. it( 'should remove filler when text is added and selection removed', () => {
  499. // Step 1: <p>foo<b>"FILLER{}"</b></p>
  500. const { view: viewP, selection: newSelection } = parse( '<container:p>foo<attribute:b>[]</attribute:b></container:p>' );
  501. const viewB = viewP.getChild( 1 );
  502. viewRoot._appendChildren( viewP );
  503. selection._setTo( newSelection );
  504. renderer.markToSync( 'children', viewRoot );
  505. renderer.render();
  506. const domP = domRoot.childNodes[ 0 ];
  507. expect( domP.childNodes.length ).to.equal( 2 );
  508. expect( domP.childNodes[ 0 ].data ).to.equal( 'foo' );
  509. expect( domP.childNodes[ 1 ].tagName.toLowerCase() ).to.equal( 'b' );
  510. expect( domP.childNodes[ 1 ].childNodes.length ).to.equal( 1 );
  511. expect( domP.childNodes[ 1 ].childNodes[ 0 ].data ).to.equal( INLINE_FILLER );
  512. // Step 2: Add text node.
  513. const viewText = new ViewText( 'x' );
  514. viewB._appendChildren( viewText );
  515. selection._setTo( ViewRange.createFromParentsAndOffsets( viewText, 1, viewText, 1 ) );
  516. renderer.markToSync( 'children', viewB );
  517. renderer.render();
  518. // Step 3: Remove selection from the view.
  519. selection._setTo( null );
  520. renderer.render();
  521. expect( domP.childNodes.length ).to.equal( 2 );
  522. expect( domP.childNodes[ 0 ].data ).to.equal( 'foo' );
  523. expect( domP.childNodes[ 1 ].tagName.toLowerCase() ).to.equal( 'b' );
  524. expect( domP.childNodes[ 1 ].childNodes.length ).to.equal( 1 );
  525. expect( domP.childNodes[ 1 ].childNodes[ 0 ].data ).to.equal( 'x' );
  526. } );
  527. // #659
  528. // The element before the filler is removed so the position of the filler
  529. // cannot be remembered as parent+offset.
  530. it( 'should remove filler from a modified DOM in case <p>bar<b>foo</b>[]</p>', () => {
  531. // Step 1: <p>bar<b>foo</b>"FILLER{}"</p>
  532. const { view: viewP, selection: newSelection } = parse( '<container:p>bar<attribute:b>foo</attribute:b>[]</container:p>' );
  533. viewRoot._appendChildren( viewP );
  534. selection._setTo( newSelection );
  535. renderer.markToSync( 'children', viewRoot );
  536. renderer.render();
  537. const domP = domRoot.childNodes[ 0 ];
  538. expect( domP.childNodes.length ).to.equal( 3 );
  539. expect( domP.childNodes[ 2 ].data ).to.equal( INLINE_FILLER );
  540. // Step 2: Remove the <b> and update the selection (<p>bar[]</p>).
  541. viewP._removeChildren( 1 );
  542. selection._setTo( ViewRange.createFromParentsAndOffsets( viewP, 1, viewP, 1 ) );
  543. renderer.markToSync( 'children', viewP );
  544. renderer.render();
  545. // Step 3: Check whether there's no filler in the DOM.
  546. expect( domP.childNodes.length ).to.equal( 1 );
  547. expect( domP.childNodes[ 0 ].data ).to.equal( 'bar' );
  548. } );
  549. // #659
  550. it( 'should remove filler from a modified DOM when children moved', () => {
  551. // Step 1: <p><b>foo</b>"FILLER{}"<b>bar</b></p><p></p>
  552. const { view: viewFragment, selection: newSelection } = parse(
  553. '<container:p><attribute:b>foo</attribute:b>[]<attribute:b>bar</attribute:b></container:p><container:p></container:p>'
  554. );
  555. viewRoot._appendChildren( viewFragment );
  556. selection._setTo( newSelection );
  557. renderer.markToSync( 'children', viewRoot );
  558. renderer.render();
  559. expect( domRoot.childNodes.length ).to.equal( 2 );
  560. const domP = domRoot.childNodes[ 0 ];
  561. const domP2 = domRoot.childNodes[ 1 ];
  562. expect( domP.childNodes.length ).to.equal( 3 );
  563. expect( domP.childNodes[ 1 ].data ).to.equal( INLINE_FILLER );
  564. // Step 2: Move <b>foo</b><b>bar</b> to the second paragraph and leave collapsed selection in the first one.
  565. // <p>[]</p><p><b>foo</b><b>bar</b></p>
  566. const viewP = viewRoot.getChild( 0 );
  567. const viewP2 = viewRoot.getChild( 1 );
  568. const removedChildren = viewP._removeChildren( 0, 2 );
  569. viewP2._appendChildren( removedChildren );
  570. selection._setTo( ViewRange.createFromParentsAndOffsets( viewP, 0, viewP, 0 ) );
  571. renderer.markToSync( 'children', viewP );
  572. renderer.markToSync( 'children', viewP2 );
  573. renderer.render();
  574. // Step 3: Check whether in the first paragraph there's a <br> filler and that
  575. // in the second one there are two <b> tags.
  576. expect( domP.childNodes.length ).to.equal( 1 );
  577. expect( isBlockFiller( domP.childNodes[ 0 ], BR_FILLER ) ).to.be.true;
  578. expect( domP2.childNodes.length ).to.equal( 2 );
  579. expect( domP2.childNodes[ 0 ].tagName.toLowerCase() ).to.equal( 'b' );
  580. expect( domP2.childNodes[ 1 ].tagName.toLowerCase() ).to.equal( 'b' );
  581. } );
  582. // Test for an edge case in the _isSelectionInInlineFiller which can be triggered like
  583. // in one of ckeditor/ckeditor5-typing#59 automated tests.
  584. it( 'should not break when selection is moved to a new element, when filler exists', () => {
  585. // Step 1: <p>bar<b>"FILLER{}"</b></p>
  586. const { view: viewP, selection: newSelection } = parse( '<container:p>bar<attribute:b>[]</attribute:b></container:p>' );
  587. viewRoot._appendChildren( viewP );
  588. selection._setTo( newSelection );
  589. renderer.markToSync( 'children', viewRoot );
  590. renderer.render();
  591. const domP = domRoot.childNodes[ 0 ];
  592. expect( domP.childNodes.length ).to.equal( 2 );
  593. expect( domP.childNodes[ 1 ].childNodes[ 0 ].data ).to.equal( INLINE_FILLER );
  594. // Step 2: Move selection to a new attribute element and remove the previous one
  595. viewP._removeChildren( 1 ); // Remove <b>.
  596. const viewI = parse( '<attribute:i></attribute:i>' );
  597. viewP._appendChildren( viewI );
  598. selection._setTo( ViewRange.createFromParentsAndOffsets( viewI, 0, viewI, 0 ) );
  599. renderer.markToSync( 'children', viewP );
  600. renderer.render();
  601. // Step 3: Check whether new filler was created in the <i> element.
  602. expect( domP.childNodes.length ).to.equal( 2 );
  603. expect( domP.childNodes[ 1 ].tagName.toLowerCase() ).to.equal( 'i' );
  604. expect( domP.childNodes[ 1 ].childNodes[ 0 ].data ).to.equal( INLINE_FILLER );
  605. } );
  606. // Test for an edge case in the _isSelectionInInlineFiller, when selection is before a view element
  607. // that has not been yet rendered/bound to DOM.
  608. it( 'should remove inline filler if selection is before a view element not bound to dom', () => {
  609. // Step 1: <p>bar<b>abc</b>"FILLER"{}</p>
  610. const { view: viewP, selection: newSelection } = parse( '<container:p>bar<attribute:b>abc</attribute:b>[]</container:p>' );
  611. viewRoot._appendChildren( viewP );
  612. selection._setTo( newSelection );
  613. renderer.markToSync( 'children', viewRoot );
  614. renderer.render();
  615. const domP = domRoot.childNodes[ 0 ];
  616. expect( domP.childNodes.length ).to.equal( 3 );
  617. expect( domP.childNodes[ 2 ].data ).to.equal( INLINE_FILLER );
  618. // Step 2: Move selection to a new attribute element.
  619. const viewAbc = parse( 'abc' );
  620. viewP._appendChildren( viewAbc );
  621. selection._setTo( ViewRange.createFromParentsAndOffsets( viewP, 3, viewP, 3 ) );
  622. renderer.markToSync( 'children', viewP );
  623. renderer.render();
  624. // Step 3: Check whether old filler was removed.
  625. expect( domP.childNodes.length ).to.equal( 3 );
  626. expect( domP.textContent.indexOf( INLINE_FILLER ) ).to.equal( -1 );
  627. } );
  628. it( 'should handle typing in empty block, do nothing if changes are already applied', () => {
  629. const domSelection = document.getSelection();
  630. const { view: viewP, selection: newSelection } = parse( '<container:p>[]</container:p>' );
  631. viewRoot._appendChildren( viewP );
  632. selection._setTo( newSelection );
  633. renderer.markToSync( 'children', viewRoot );
  634. renderer.render();
  635. const domP = domRoot.childNodes[ 0 ];
  636. expect( domP.childNodes.length ).to.equal( 1 );
  637. expect( isBlockFiller( domP.childNodes[ 0 ], BR_FILLER ) ).to.be.true;
  638. expect( domSelection.rangeCount ).to.equal( 1 );
  639. expect( domSelection.getRangeAt( 0 ).startContainer ).to.equal( domP );
  640. expect( domSelection.getRangeAt( 0 ).startOffset ).to.equal( 0 );
  641. expect( domSelection.getRangeAt( 0 ).collapsed ).to.be.true;
  642. // Remove filler and add text node to both DOM and View <p>x{}</p>
  643. domP.removeChild( domP.childNodes[ 0 ] );
  644. domP.appendChild( document.createTextNode( 'x' ) );
  645. domSelection.removeAllRanges();
  646. const domRange = document.createRange();
  647. domRange.setStart( domP.childNodes[ 0 ], 1 );
  648. domRange.collapse( true );
  649. domSelection.addRange( domRange );
  650. const viewText = new ViewText( 'x' );
  651. viewP._appendChildren( viewText );
  652. selection._setTo( ViewRange.createFromParentsAndOffsets( viewText, 1, viewText, 1 ) );
  653. renderer.markToSync( 'children', viewP );
  654. renderAndExpectNoChanges( renderer, domRoot );
  655. } );
  656. it( 'should handle typing in empty block, render if needed', () => {
  657. const domSelection = document.getSelection();
  658. const { view: viewP, selection: newSelection } = parse( '<container:p>[]</container:p>' );
  659. viewRoot._appendChildren( viewP );
  660. selection._setTo( newSelection );
  661. renderer.markToSync( 'children', viewRoot );
  662. renderer.render();
  663. const domP = domRoot.childNodes[ 0 ];
  664. expect( domP.childNodes.length ).to.equal( 1 );
  665. expect( isBlockFiller( domP.childNodes[ 0 ], BR_FILLER ) ).to.be.true;
  666. expect( domSelection.rangeCount ).to.equal( 1 );
  667. expect( domSelection.getRangeAt( 0 ).startContainer ).to.equal( domP );
  668. expect( domSelection.getRangeAt( 0 ).startOffset ).to.equal( 0 );
  669. expect( domSelection.getRangeAt( 0 ).collapsed ).to.be.true;
  670. // Add text node only in View <p>x{}</p>
  671. const viewText = new ViewText( 'x' );
  672. viewP._appendChildren( viewText );
  673. selection._setTo( ViewRange.createFromParentsAndOffsets( viewText, 1, viewText, 1 ) );
  674. renderer.markToSync( 'children', viewP );
  675. renderer.render();
  676. expect( domP.childNodes.length ).to.equal( 1 );
  677. expect( domP.childNodes[ 0 ].data ).to.equal( 'x' );
  678. expect( domSelection.rangeCount ).to.equal( 1 );
  679. expect( domSelection.getRangeAt( 0 ).startContainer ).to.equal( domP.childNodes[ 0 ] );
  680. expect( domSelection.getRangeAt( 0 ).startOffset ).to.equal( 1 );
  681. expect( domSelection.getRangeAt( 0 ).collapsed ).to.be.true;
  682. } );
  683. it( 'should handle removing last character', () => {
  684. const domSelection = document.getSelection();
  685. const { view: viewP, selection: newSelection } = parse( '<container:p>x{}</container:p>' );
  686. viewRoot._appendChildren( viewP );
  687. selection._setTo( newSelection );
  688. renderer.markToSync( 'children', viewRoot );
  689. renderer.render();
  690. const domP = domRoot.childNodes[ 0 ];
  691. expect( domP.childNodes.length ).to.equal( 1 );
  692. expect( domP.childNodes[ 0 ].data ).to.equal( 'x' );
  693. expect( domSelection.rangeCount ).to.equal( 1 );
  694. expect( domSelection.getRangeAt( 0 ).startContainer ).to.equal( domP.childNodes[ 0 ] );
  695. expect( domSelection.getRangeAt( 0 ).startOffset ).to.equal( 1 );
  696. expect( domSelection.getRangeAt( 0 ).collapsed ).to.be.true;
  697. // Remove text and add filler to both DOM and View <p>{}</p>
  698. domP.removeChild( domP.childNodes[ 0 ] );
  699. domP.appendChild( BR_FILLER( document ) ); // eslint-disable-line new-cap
  700. domSelection.removeAllRanges();
  701. const domRange = document.createRange();
  702. domRange.setStart( domP.childNodes[ 0 ], 0 );
  703. domRange.collapse( true );
  704. domSelection.addRange( domRange );
  705. viewP._removeChildren( 0 );
  706. selection._setTo( ViewRange.createFromParentsAndOffsets( viewP, 0, viewP, 0 ) );
  707. renderer.markToSync( 'children', viewP );
  708. renderAndExpectNoChanges( renderer, domRoot );
  709. } );
  710. it( 'should handle typing in empty attribute, do nothing if changes are already applied', () => {
  711. const domSelection = document.getSelection();
  712. // 1. Render <p><b>FILLER{}</b>foo</p>.
  713. const { view: viewP, selection: newSelection } = parse(
  714. '<container:p><attribute:b>[]</attribute:b>foo</container:p>' );
  715. viewRoot._appendChildren( viewP );
  716. selection._setTo( newSelection );
  717. renderer.markToSync( 'children', viewRoot );
  718. renderer.render();
  719. // 2. Check the DOM.
  720. const domP = domRoot.childNodes[ 0 ];
  721. expect( domP.childNodes.length ).to.equal( 2 );
  722. expect( domP.childNodes[ 0 ].tagName.toLowerCase() ).to.equal( 'b' );
  723. expect( domP.childNodes[ 1 ].data ).to.equal( 'foo' );
  724. const domB = domP.childNodes[ 0 ];
  725. const viewB = viewP.getChild( 0 );
  726. expect( domB.childNodes.length ).to.equal( 1 );
  727. expect( domB.childNodes[ 0 ].data ).to.equal( INLINE_FILLER );
  728. expect( domSelection.rangeCount ).to.equal( 1 );
  729. expect( domSelection.getRangeAt( 0 ).startContainer ).to.equal( domB.childNodes[ 0 ] );
  730. expect( domSelection.getRangeAt( 0 ).startOffset ).to.equal( INLINE_FILLER_LENGTH );
  731. expect( domSelection.getRangeAt( 0 ).collapsed ).to.be.true;
  732. // 3. Add text node to both the DOM and the view: <p><b>FILLERx</b>foo</p>.
  733. domB.childNodes[ 0 ].data += 'x';
  734. domSelection.removeAllRanges();
  735. const domRange = document.createRange();
  736. domRange.setStart( domB.childNodes[ 0 ], INLINE_FILLER_LENGTH + 1 );
  737. domRange.collapse( true );
  738. domSelection.addRange( domRange );
  739. const viewText = new ViewText( 'x' );
  740. viewB._appendChildren( viewText );
  741. selection._setTo( ViewRange.createFromParentsAndOffsets( viewText, 1, viewText, 1 ) );
  742. renderer.markToSync( 'children', viewP );
  743. renderAndExpectNoChanges( renderer, domRoot );
  744. } );
  745. it( 'should handle typing in empty attribute as a children change, render if needed', () => {
  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._appendChildren( 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. domSelection.removeAllRanges();
  768. // 3. Add text node only to the view: <p><b>x{}</b>foo</p>.
  769. const viewText = new ViewText( 'x' );
  770. viewB._appendChildren( viewText );
  771. selection._setTo( ViewRange.createFromParentsAndOffsets( viewText, 1, viewText, 1 ) );
  772. renderer.markToSync( 'children', viewB );
  773. renderer.render();
  774. expect( domB.childNodes.length ).to.equal( 1 );
  775. expect( domB.childNodes[ 0 ].data ).to.equal( INLINE_FILLER + 'x' );
  776. expect( domSelection.rangeCount ).to.equal( 1 );
  777. // Depending on the browser selection may end up at the end of the text node or after the text node.
  778. const firstRange = domSelection.getRangeAt( 0 );
  779. const assertSelectionAtEndOfTextNode = () => {
  780. expect( firstRange.startOffset ).to.equal( INLINE_FILLER_LENGTH + 1 );
  781. };
  782. const assertSelectionInsideTextNode = () => {
  783. expect( firstRange.startContainer ).to.equal( domB );
  784. expect( firstRange.startOffset ).to.equal( 1 );
  785. };
  786. testUtils.checkAssertions( assertSelectionAtEndOfTextNode, assertSelectionInsideTextNode );
  787. expect( firstRange.collapsed ).to.be.true;
  788. } );
  789. it( 'should handle typing in empty attribute as a text change, render if needed', () => {
  790. const domSelection = document.getSelection();
  791. // 1. Render <p><b>FILLER{}</b>foo</p>.
  792. const { view: viewP, selection: newSelection } = parse(
  793. '<container:p><attribute:b>[]</attribute:b>foo</container:p>' );
  794. viewRoot._appendChildren( viewP );
  795. selection._setTo( newSelection );
  796. renderer.markToSync( 'children', viewRoot );
  797. renderer.render();
  798. // 2. Check the DOM.
  799. const domP = domRoot.childNodes[ 0 ];
  800. expect( domP.childNodes.length ).to.equal( 2 );
  801. expect( domP.childNodes[ 0 ].tagName.toLowerCase() ).to.equal( 'b' );
  802. expect( domP.childNodes[ 1 ].data ).to.equal( 'foo' );
  803. const domB = domP.childNodes[ 0 ];
  804. const viewB = viewP.getChild( 0 );
  805. expect( domB.childNodes.length ).to.equal( 1 );
  806. expect( domB.childNodes[ 0 ].data ).to.equal( INLINE_FILLER );
  807. expect( domSelection.rangeCount ).to.equal( 1 );
  808. expect( domSelection.getRangeAt( 0 ).startContainer ).to.equal( domB.childNodes[ 0 ] );
  809. expect( domSelection.getRangeAt( 0 ).startOffset ).to.equal( INLINE_FILLER_LENGTH );
  810. expect( domSelection.getRangeAt( 0 ).collapsed ).to.be.true;
  811. // 3. Add text node only to the view: <p><b>x{}</b>foo</p>.
  812. const viewText = new ViewText( 'x' );
  813. viewB._appendChildren( viewText );
  814. selection._setTo( ViewRange.createFromParentsAndOffsets( viewText, 1, viewText, 1 ) );
  815. renderer.markToSync( 'text', viewText );
  816. renderer.render();
  817. // 4. Check the DOM.
  818. expect( domB.childNodes.length ).to.equal( 1 );
  819. expect( domB.childNodes[ 0 ].data ).to.equal( INLINE_FILLER + 'x' );
  820. expect( domSelection.rangeCount ).to.equal( 1 );
  821. expect( domSelection.getRangeAt( 0 ).startContainer ).to.equal( domB.childNodes[ 0 ] );
  822. expect( domSelection.getRangeAt( 0 ).startOffset ).to.equal( INLINE_FILLER_LENGTH + 1 );
  823. expect( domSelection.getRangeAt( 0 ).collapsed ).to.be.true;
  824. } );
  825. it( 'should handle not collapsed range', () => {
  826. const domSelection = document.getSelection();
  827. const { view: viewP, selection: newSelection } = parse(
  828. '<container:p>fo{o<attribute:b>b}ar</attribute:b></container:p>' );
  829. viewRoot._appendChildren( viewP );
  830. selection._setTo( newSelection );
  831. renderer.markToSync( 'children', viewRoot );
  832. renderer.render();
  833. const domP = domRoot.childNodes[ 0 ];
  834. expect( domP.childNodes.length ).to.equal( 2 );
  835. expect( domP.childNodes[ 0 ].data ).to.equal( 'foo' );
  836. expect( domP.childNodes[ 1 ].tagName.toLowerCase() ).to.equal( 'b' );
  837. expect( domP.childNodes[ 1 ].childNodes.length ).to.equal( 1 );
  838. expect( domP.childNodes[ 1 ].childNodes[ 0 ].data ).to.equal( 'bar' );
  839. expect( domSelection.rangeCount ).to.equal( 1 );
  840. expect( domSelection.getRangeAt( 0 ).startContainer ).to.equal( domP.childNodes[ 0 ] );
  841. expect( domSelection.getRangeAt( 0 ).startOffset ).to.equal( 2 );
  842. expect( domSelection.getRangeAt( 0 ).endContainer ).to.equal( domP.childNodes[ 1 ].childNodes[ 0 ] );
  843. expect( domSelection.getRangeAt( 0 ).endOffset ).to.equal( 1 );
  844. renderer.markToSync( 'children', viewP );
  845. renderAndExpectNoChanges( renderer, domRoot );
  846. } );
  847. it( 'should not change selection if there is no editable with selection', () => {
  848. const domDiv = createElement( document, 'div', { contenteditable: true }, 'not editable' );
  849. document.body.appendChild( domDiv );
  850. domDiv.focus();
  851. const domSelection = document.getSelection();
  852. domSelection.removeAllRanges();
  853. domSelection.collapse( domDiv, 0 );
  854. selectionEditable = null;
  855. const { view: viewP, selection: newSelection } = parse( '<container:p>fo{o}</container:p>' );
  856. viewRoot._appendChildren( viewP );
  857. selection._setTo( newSelection );
  858. renderer.render();
  859. expect( domSelection.rangeCount ).to.equal( 1 );
  860. // Depending on the browser selection may end up before the text node or at the beginning of it.
  861. const domRange = domSelection.getRangeAt( 0 );
  862. const assertSelectionAtEndOfTextNode = () => {
  863. expect( domRange.startContainer ).to.equal( domDiv );
  864. };
  865. const assertSelectionInsideTextNode = () => {
  866. expect( domRange.startContainer ).to.equal( domDiv.childNodes[ 0 ] );
  867. };
  868. testUtils.checkAssertions( assertSelectionAtEndOfTextNode, assertSelectionInsideTextNode );
  869. expect( domRange.startOffset ).to.equal( 0 );
  870. expect( domRange.collapsed ).to.be.true;
  871. domDiv.remove();
  872. } );
  873. it( 'should not change selection if there is no focus', () => {
  874. const domDiv = createElement( document, 'div', null, 'not editable' );
  875. document.body.appendChild( domDiv );
  876. const domSelection = document.getSelection();
  877. domSelection.removeAllRanges();
  878. const domRange = document.createRange();
  879. domRange.setStart( domDiv, 0 );
  880. domRange.collapse( true );
  881. domSelection.addRange( domRange );
  882. renderer.isFocused = false;
  883. const { view: viewP, selection: newSelection } = parse( '<container:p>fo{o}</container:p>' );
  884. viewRoot._appendChildren( viewP );
  885. selection._setTo( newSelection );
  886. renderer.render();
  887. expect( domSelection.rangeCount ).to.equal( 1 );
  888. // Depending on the browser selection may end up before the text node or at the beginning of it.
  889. const domSelectionRange = domSelection.getRangeAt( 0 );
  890. const assertSelectionAtEndOfTextNode = () => {
  891. expect( domSelectionRange.startContainer ).to.equal( domDiv );
  892. };
  893. const assertSelectionInsideTextNode = () => {
  894. expect( domSelectionRange.startContainer ).to.equal( domDiv.childNodes[ 0 ] );
  895. };
  896. testUtils.checkAssertions( assertSelectionAtEndOfTextNode, assertSelectionInsideTextNode );
  897. expect( domSelectionRange.startOffset ).to.equal( 0 );
  898. expect( domSelectionRange.collapsed ).to.be.true;
  899. domDiv.remove();
  900. } );
  901. it( 'should not add inline filler after text node', () => {
  902. const { view: viewP, selection: newSelection } = parse( '<container:p>foo[]</container:p>' );
  903. viewRoot._appendChildren( viewP );
  904. selection._setTo( newSelection );
  905. renderer.markToSync( 'children', viewRoot );
  906. renderer.render();
  907. const domP = domRoot.childNodes[ 0 ];
  908. expect( domP.innerHTML.indexOf( INLINE_FILLER ) ).to.equal( -1 );
  909. } );
  910. it( 'should throw if there is no filler in expected position', () => {
  911. const { view: viewP, selection: newSelection } = parse(
  912. '<container:p>foo<attribute:b>[]</attribute:b>bar</container:p>' );
  913. viewRoot._appendChildren( viewP );
  914. selection._setTo( newSelection );
  915. renderer.markToSync( 'children', viewRoot );
  916. renderer.render();
  917. const domB = domRoot.childNodes[ 0 ].childNodes[ 1 ];
  918. const viewB = viewP.getChild( 1 );
  919. expect( domB.childNodes[ 0 ].data ).to.equal( INLINE_FILLER );
  920. // Remove filler.
  921. domB.childNodes[ 0 ].data = '';
  922. selection._setTo( null );
  923. renderer.markToSync( 'children', viewB );
  924. expect( () => {
  925. renderer.render();
  926. } ).to.throw( CKEditorError, /^view-renderer-filler-was-lost/ );
  927. } );
  928. // #1014.
  929. it( 'should create inline filler in newly created dom nodes', () => {
  930. // 1. Create the view structure which needs inline filler.
  931. const inputView =
  932. '<container:ul>' +
  933. '<container:li>Foobar.</container:li>' +
  934. '<container:li>[]<container:div></container:div></container:li>' +
  935. '</container:ul>';
  936. const { view: view, selection: newSelection } = parse( inputView );
  937. viewRoot._appendChildren( view );
  938. selection._setTo( newSelection );
  939. renderer.markToSync( 'children', viewRoot );
  940. renderer.render();
  941. // 2. Check if filler element has been (correctly) created.
  942. expect( domRoot.innerHTML.indexOf( INLINE_FILLER ) ).not.to.equal( -1 );
  943. // 3. Move the inline filler parent to a newly created element.
  944. const viewLi = view.getChild( 0 );
  945. const viewLiIndented = view._removeChildren( 1, 1 ); // Array with one element.
  946. const viewUl = new ViewContainerElement( 'ul', null, viewLiIndented );
  947. viewLi._appendChildren( viewUl );
  948. // 4. Mark changed items and render the view.
  949. renderer.markToSync( 'children', view );
  950. renderer.markToSync( 'children', viewLi );
  951. renderer.render();
  952. expect( domRoot.innerHTML.indexOf( INLINE_FILLER ) ).not.to.equal( -1 );
  953. const domSelection = document.getSelection();
  954. expect( domSelection.getRangeAt( 0 ).startOffset ).to.equal( 7 ); // After inline filler.
  955. } );
  956. it( 'should handle focusing element', () => {
  957. const domFocusSpy = testUtils.sinon.spy( domRoot, 'focus' );
  958. const editable = selection.editableElement;
  959. renderer.render();
  960. expect( editable ).to.equal( viewRoot );
  961. expect( domFocusSpy.calledOnce ).to.be.true;
  962. } );
  963. it( 'should not focus editable if isFocues is set to false', () => {
  964. const domFocusSpy = testUtils.sinon.spy( domRoot, 'focus' );
  965. renderer.isFocused = false;
  966. renderer.render();
  967. expect( domFocusSpy.calledOnce ).to.be.false;
  968. } );
  969. it( 'should not focus already focused DOM element', () => {
  970. domRoot.setAttribute( 'contentEditable', true );
  971. domRoot.focus();
  972. const domFocusSpy = testUtils.sinon.spy( domRoot, 'focus' );
  973. renderer.render();
  974. expect( domFocusSpy.called ).to.be.false;
  975. } );
  976. describe( 'fake selection', () => {
  977. beforeEach( () => {
  978. const { view: viewP, selection: newSelection } = parse(
  979. '<container:p>[foo bar]</container:p>'
  980. );
  981. viewRoot._appendChildren( viewP );
  982. selection._setTo( newSelection );
  983. renderer.markToSync( 'children', viewRoot );
  984. renderer.render();
  985. } );
  986. it( 'should render fake selection', () => {
  987. const label = 'fake selection label';
  988. selection._setTo( selection.getRanges(), { fake: true, label } );
  989. renderer.render();
  990. expect( domRoot.childNodes.length ).to.equal( 2 );
  991. const container = domRoot.childNodes[ 1 ];
  992. expect( domConverter.mapDomToView( container ) ).to.be.undefined;
  993. expect( container.childNodes.length ).to.equal( 1 );
  994. const textNode = container.childNodes[ 0 ];
  995. expect( textNode.textContent ).to.equal( label );
  996. const domSelection = domRoot.ownerDocument.getSelection();
  997. assertDomSelectionContents( domSelection, container, /^fake selection label$/ );
  998. } );
  999. it( 'should render &nbsp; if no selection label is provided', () => {
  1000. selection._setTo( selection.getRanges(), { fake: true } );
  1001. renderer.render();
  1002. expect( domRoot.childNodes.length ).to.equal( 2 );
  1003. const container = domRoot.childNodes[ 1 ];
  1004. expect( container.childNodes.length ).to.equal( 1 );
  1005. const textNode = container.childNodes[ 0 ];
  1006. expect( textNode.textContent ).to.equal( '\u00A0' );
  1007. const domSelection = domRoot.ownerDocument.getSelection();
  1008. assertDomSelectionContents( domSelection, container, /^[ \u00A0]$/ );
  1009. } );
  1010. it( 'should remove fake selection container when selection is no longer fake', () => {
  1011. selection._setTo( selection.getRanges(), { fake: true } );
  1012. renderer.render();
  1013. selection._setTo( selection.getRanges(), { fake: false } );
  1014. renderer.render();
  1015. expect( domRoot.childNodes.length ).to.equal( 1 );
  1016. const domParagraph = domRoot.childNodes[ 0 ];
  1017. expect( domParagraph.childNodes.length ).to.equal( 1 );
  1018. expect( domParagraph.tagName.toLowerCase() ).to.equal( 'p' );
  1019. const domSelection = domRoot.ownerDocument.getSelection();
  1020. assertDomSelectionContents( domSelection, domParagraph, /^foo bar$/ );
  1021. } );
  1022. it( 'should reuse fake selection container #1', () => {
  1023. const label = 'fake selection label';
  1024. selection._setTo( selection.getRanges(), { fake: true, label } );
  1025. renderer.render();
  1026. expect( domRoot.childNodes.length ).to.equal( 2 );
  1027. const container = domRoot.childNodes[ 1 ];
  1028. selection._setTo( selection.getRanges(), { fake: true, label } );
  1029. renderer.render();
  1030. expect( domRoot.childNodes.length ).to.equal( 2 );
  1031. const newContainer = domRoot.childNodes[ 1 ];
  1032. expect( newContainer ).equals( container );
  1033. expect( newContainer.childNodes.length ).to.equal( 1 );
  1034. const textNode = newContainer.childNodes[ 0 ];
  1035. expect( textNode.textContent ).to.equal( label );
  1036. } );
  1037. it( 'should reuse fake selection container #2', () => {
  1038. selection._setTo( selection.getRanges(), { fake: true, label: 'label 1' } );
  1039. renderer.render();
  1040. expect( domRoot.childNodes.length ).to.equal( 2 );
  1041. const container = domRoot.childNodes[ 1 ];
  1042. selection._setTo( selection.getRanges(), { fake: false } );
  1043. renderer.render();
  1044. expect( domRoot.childNodes.length ).to.equal( 1 );
  1045. selection._setTo( selection.getRanges(), { fake: true, label: 'label 2' } );
  1046. renderer.render();
  1047. expect( domRoot.childNodes.length ).to.equal( 2 );
  1048. const newContainer = domRoot.childNodes[ 1 ];
  1049. expect( newContainer ).equals( container );
  1050. expect( newContainer.childNodes.length ).to.equal( 1 );
  1051. const textNode = newContainer.childNodes[ 0 ];
  1052. expect( textNode.textContent ).to.equal( 'label 2' );
  1053. } );
  1054. it( 'should reuse fake selection container #3', () => {
  1055. selection._setTo( selection.getRanges(), { fake: true, label: 'label 1' } );
  1056. renderer.render();
  1057. expect( domRoot.childNodes.length ).to.equal( 2 );
  1058. const container = domRoot.childNodes[ 1 ];
  1059. selection._setTo( selection.getRanges(), { fake: true, label: 'label 2' } );
  1060. renderer.render();
  1061. expect( domRoot.childNodes.length ).to.equal( 2 );
  1062. const newContainer = domRoot.childNodes[ 1 ];
  1063. expect( newContainer ).equals( container );
  1064. expect( newContainer.childNodes.length ).to.equal( 1 );
  1065. const textNode = newContainer.childNodes[ 0 ];
  1066. expect( textNode.textContent ).to.equal( 'label 2' );
  1067. } );
  1068. it( 'should style fake selection container properly', () => {
  1069. selection._setTo( selection.getRanges(), { fake: true, label: 'fake selection' } );
  1070. renderer.render();
  1071. expect( domRoot.childNodes.length ).to.equal( 2 );
  1072. const container = domRoot.childNodes[ 1 ];
  1073. expect( container.style.position ).to.equal( 'fixed' );
  1074. expect( container.style.top ).to.equal( '0px' );
  1075. expect( container.style.left ).to.equal( '-9999px' );
  1076. } );
  1077. it( 'should bind fake selection container to view selection', () => {
  1078. selection._setTo( selection.getRanges(), { fake: true, label: 'fake selection' } );
  1079. renderer.render();
  1080. expect( domRoot.childNodes.length ).to.equal( 2 );
  1081. const container = domRoot.childNodes[ 1 ];
  1082. const bindSelection = renderer.domConverter.fakeSelectionToView( container );
  1083. expect( bindSelection ).to.not.be.undefined;
  1084. expect( bindSelection.isEqual( selection ) ).to.be.true;
  1085. } );
  1086. // Use a forgiving way of checking what the selection contains
  1087. // because Safari normalizes the selection ranges so precise checking is troublesome.
  1088. // Also, Edge returns a normal space instead of nbsp so we need to use even more alternatives.
  1089. function assertDomSelectionContents( domSelection, expectedContainer, expectedText ) {
  1090. const domSelectionContainer = domSelection.getRangeAt( 0 ).commonAncestorContainer;
  1091. expect( domSelection.toString() ).to.match( expectedText );
  1092. expect(
  1093. domSelectionContainer == expectedContainer.firstChild || domSelectionContainer == expectedContainer
  1094. ).to.be.true;
  1095. }
  1096. } );
  1097. // #887
  1098. describe( 'similar selection', () => {
  1099. // Use spies to check selection updates. Some selection positions are not achievable in some
  1100. // browsers (e.g. <p>Foo<b>{}Bar</b></p> in Chrome) so asserting dom selection after rendering would fail.
  1101. let selectionCollapseSpy, selectionExtendSpy;
  1102. afterEach( () => {
  1103. if ( selectionCollapseSpy ) {
  1104. selectionCollapseSpy.restore();
  1105. selectionCollapseSpy = null;
  1106. }
  1107. if ( selectionExtendSpy ) {
  1108. selectionExtendSpy.restore();
  1109. selectionExtendSpy = null;
  1110. }
  1111. } );
  1112. it( 'should always render collapsed selection even if it is similar', () => {
  1113. const domSelection = document.getSelection();
  1114. const { view: viewP, selection: newSelection } = parse(
  1115. '<container:p>foo{}<attribute:b>bar</attribute:b></container:p>' );
  1116. viewRoot._appendChildren( viewP );
  1117. selection._setTo( newSelection );
  1118. renderer.markToSync( 'children', viewRoot );
  1119. renderer.render();
  1120. const domP = domRoot.childNodes[ 0 ];
  1121. const domB = domP.childNodes[ 1 ];
  1122. const viewB = viewRoot.getChild( 0 ).getChild( 1 );
  1123. expect( domSelection.isCollapsed ).to.true;
  1124. expect( domSelection.rangeCount ).to.equal( 1 );
  1125. expect( domSelection.getRangeAt( 0 ).startContainer ).to.equal( domP.childNodes[ 0 ] );
  1126. expect( domSelection.getRangeAt( 0 ).startOffset ).to.equal( 3 );
  1127. expect( domSelection.getRangeAt( 0 ).endContainer ).to.equal( domP.childNodes[ 0 ] );
  1128. expect( domSelection.getRangeAt( 0 ).endOffset ).to.equal( 3 );
  1129. selectionCollapseSpy = sinon.spy( window.Selection.prototype, 'collapse' );
  1130. selectionExtendSpy = sinon.spy( window.Selection.prototype, 'extend' );
  1131. // <container:p>foo<attribute:b>{}bar</attribute:b></container:p>
  1132. selection._setTo( [
  1133. new ViewRange( new ViewPosition( viewB.getChild( 0 ), 0 ), new ViewPosition( viewB.getChild( 0 ), 0 ) )
  1134. ] );
  1135. renderer.markToSync( 'children', viewP );
  1136. renderer.render();
  1137. expect( selectionCollapseSpy.calledOnce ).to.true;
  1138. expect( selectionCollapseSpy.calledWith( domB.childNodes[ 0 ], 0 ) ).to.true;
  1139. expect( selectionExtendSpy.calledOnce ).to.true;
  1140. expect( selectionExtendSpy.calledWith( domB.childNodes[ 0 ], 0 ) ).to.true;
  1141. } );
  1142. it( 'should always render collapsed selection even if it is similar (with empty element)', () => {
  1143. const domSelection = document.getSelection();
  1144. const { view: viewP, selection: newSelection } = parse(
  1145. '<container:p>foo<attribute:b>[]</attribute:b></container:p>' );
  1146. viewRoot._appendChildren( viewP );
  1147. selection._setTo( newSelection );
  1148. renderer.markToSync( 'children', viewRoot );
  1149. renderer.render();
  1150. const domP = domRoot.childNodes[ 0 ];
  1151. const domB = domP.childNodes[ 1 ];
  1152. expect( domSelection.isCollapsed ).to.true;
  1153. expect( domSelection.rangeCount ).to.equal( 1 );
  1154. expect( domSelection.getRangeAt( 0 ).startContainer ).to.equal( domB.childNodes[ 0 ] );
  1155. expect( domSelection.getRangeAt( 0 ).startOffset ).to.equal( INLINE_FILLER_LENGTH );
  1156. expect( domSelection.getRangeAt( 0 ).endContainer ).to.equal( domB.childNodes[ 0 ] );
  1157. expect( domSelection.getRangeAt( 0 ).endOffset ).to.equal( INLINE_FILLER_LENGTH );
  1158. selectionCollapseSpy = sinon.spy( window.Selection.prototype, 'collapse' );
  1159. selectionExtendSpy = sinon.spy( window.Selection.prototype, 'extend' );
  1160. // <container:p>foo{}<attribute:b></attribute:b></container:p>
  1161. selection._setTo( [
  1162. new ViewRange( new ViewPosition( viewP.getChild( 0 ), 3 ), new ViewPosition( viewP.getChild( 0 ), 3 ) )
  1163. ] );
  1164. renderer.markToSync( 'children', viewP );
  1165. renderer.render();
  1166. expect( selectionCollapseSpy.calledOnce ).to.true;
  1167. expect( selectionCollapseSpy.calledWith( domP.childNodes[ 0 ], 3 ) ).to.true;
  1168. expect( selectionExtendSpy.calledOnce ).to.true;
  1169. expect( selectionExtendSpy.calledWith( domP.childNodes[ 0 ], 3 ) ).to.true;
  1170. } );
  1171. it( 'should always render non-collapsed selection if it not is similar', () => {
  1172. const domSelection = document.getSelection();
  1173. const { view: viewP, selection: newSelection } = parse(
  1174. '<container:p>fo{o}<attribute:b>bar</attribute:b></container:p>' );
  1175. viewRoot._appendChildren( viewP );
  1176. selection._setTo( newSelection );
  1177. renderer.markToSync( 'children', viewRoot );
  1178. renderer.render();
  1179. const domP = domRoot.childNodes[ 0 ];
  1180. const domB = domP.childNodes[ 1 ];
  1181. const viewB = viewRoot.getChild( 0 ).getChild( 1 );
  1182. expect( domSelection.isCollapsed ).to.false;
  1183. expect( domSelection.rangeCount ).to.equal( 1 );
  1184. expect( domSelection.getRangeAt( 0 ).startContainer ).to.equal( domP.childNodes[ 0 ] );
  1185. expect( domSelection.getRangeAt( 0 ).startOffset ).to.equal( 2 );
  1186. expect( domSelection.getRangeAt( 0 ).endContainer ).to.equal( domP.childNodes[ 0 ] );
  1187. expect( domSelection.getRangeAt( 0 ).endOffset ).to.equal( 3 );
  1188. selectionCollapseSpy = sinon.spy( window.Selection.prototype, 'collapse' );
  1189. selectionExtendSpy = sinon.spy( window.Selection.prototype, 'extend' );
  1190. // <container:p>fo{o<attribute:b>b}ar</attribute:b></container:p>
  1191. selection._setTo( [
  1192. new ViewRange( new ViewPosition( viewP.getChild( 0 ), 2 ), new ViewPosition( viewB.getChild( 0 ), 1 ) )
  1193. ] );
  1194. renderer.markToSync( 'children', viewP );
  1195. renderer.render();
  1196. expect( selectionCollapseSpy.calledOnce ).to.true;
  1197. expect( selectionCollapseSpy.calledWith( domP.childNodes[ 0 ], 2 ) ).to.true;
  1198. expect( selectionExtendSpy.calledOnce ).to.true;
  1199. expect( selectionExtendSpy.calledWith( domB.childNodes[ 0 ], 1 ) ).to.true;
  1200. } );
  1201. it( 'should always render selection (even if it is same in view) if current dom selection is in incorrect place', () => {
  1202. const domSelection = document.getSelection();
  1203. const { view: viewP, selection: newSelection } = parse( '<container:p>foo[]<ui:span></ui:span></container:p>' );
  1204. viewRoot._appendChildren( viewP );
  1205. selection._setTo( newSelection );
  1206. renderer.markToSync( 'children', viewRoot );
  1207. renderer.render();
  1208. // In DOM, set position to: <p>foo<span>[]</span></p>. This is incorrect DOM selection (it is in view ui element).
  1209. // Do not change view selection.
  1210. // When renderer will check if the DOM selection changed, it will convert DOM selection to a view selection.
  1211. // Selections (current view selection and view-from-dom selection) will be equal but we will still expect re-render
  1212. // because DOM selection is in incorrect place.
  1213. const domP = domRoot.childNodes[ 0 ];
  1214. const domSpan = domP.childNodes[ 1 ];
  1215. domSelection.collapse( domSpan, 0 );
  1216. renderer.render();
  1217. // Expect that after calling `renderer.render()` the DOM selection was re-rendered (and set at correct position).
  1218. // Depending on the browser selection may end up at the end of the text node or after the text node.
  1219. const assertSelectionAtEndOfTextNode = () => {
  1220. expect( domSelection.anchorNode ).to.equal( domP );
  1221. expect( domSelection.anchorOffset ).to.equal( 1 );
  1222. };
  1223. const assertSelectionInsideTextNode = () => {
  1224. const textNode = domP.childNodes[ 0 ];
  1225. expect( domSelection.anchorNode ).to.equal( textNode );
  1226. expect( domSelection.anchorOffset ).to.equal( 3 );
  1227. };
  1228. testUtils.checkAssertions( assertSelectionAtEndOfTextNode, assertSelectionInsideTextNode );
  1229. expect( domSelection.getRangeAt( 0 ).collapsed ).to.be.true;
  1230. } );
  1231. it( 'should not render non-collapsed selection it is similar (element start)', () => {
  1232. const domSelection = document.getSelection();
  1233. const { view: viewP, selection: newSelection } = parse(
  1234. '<container:p>foo<attribute:b>{ba}r</attribute:b></container:p>' );
  1235. viewRoot._appendChildren( viewP );
  1236. selection._setTo( newSelection );
  1237. renderer.markToSync( 'children', viewRoot );
  1238. renderer.render();
  1239. const domP = domRoot.childNodes[ 0 ];
  1240. const domB = domP.childNodes[ 1 ];
  1241. const viewB = viewRoot.getChild( 0 ).getChild( 1 );
  1242. expect( domSelection.isCollapsed ).to.false;
  1243. expect( domSelection.rangeCount ).to.equal( 1 );
  1244. expect( domSelection.getRangeAt( 0 ).startContainer ).to.equal( domB.childNodes[ 0 ] );
  1245. expect( domSelection.getRangeAt( 0 ).startOffset ).to.equal( 0 );
  1246. expect( domSelection.getRangeAt( 0 ).endContainer ).to.equal( domB.childNodes[ 0 ] );
  1247. expect( domSelection.getRangeAt( 0 ).endOffset ).to.equal( 2 );
  1248. selectionCollapseSpy = sinon.spy( window.Selection.prototype, 'collapse' );
  1249. selectionExtendSpy = sinon.spy( window.Selection.prototype, 'extend' );
  1250. // <container:p>foo{<attribute:b>ba}r</attribute:b></container:p>
  1251. selection._setTo( [
  1252. new ViewRange( new ViewPosition( viewP.getChild( 0 ), 3 ), new ViewPosition( viewB.getChild( 0 ), 2 ) )
  1253. ] );
  1254. renderer.markToSync( 'children', viewP );
  1255. renderer.render();
  1256. expect( selectionCollapseSpy.notCalled ).to.true;
  1257. expect( selectionExtendSpy.notCalled ).to.true;
  1258. } );
  1259. it( 'should not render non-collapsed selection it is similar (element end)', () => {
  1260. const domSelection = document.getSelection();
  1261. const { view: viewP, selection: newSelection } = parse(
  1262. '<container:p>foo<attribute:b>b{ar}</attribute:b>baz</container:p>' );
  1263. viewRoot._appendChildren( viewP );
  1264. selection._setTo( newSelection );
  1265. renderer.markToSync( 'children', viewRoot );
  1266. renderer.render();
  1267. const domP = domRoot.childNodes[ 0 ];
  1268. const domB = domP.childNodes[ 1 ];
  1269. const viewB = viewRoot.getChild( 0 ).getChild( 1 );
  1270. expect( domSelection.isCollapsed ).to.false;
  1271. expect( domSelection.rangeCount ).to.equal( 1 );
  1272. expect( domSelection.getRangeAt( 0 ).startContainer ).to.equal( domB.childNodes[ 0 ] );
  1273. expect( domSelection.getRangeAt( 0 ).startOffset ).to.equal( 1 );
  1274. expect( domSelection.getRangeAt( 0 ).endContainer ).to.equal( domB.childNodes[ 0 ] );
  1275. expect( domSelection.getRangeAt( 0 ).endOffset ).to.equal( 3 );
  1276. selectionCollapseSpy = sinon.spy( window.Selection.prototype, 'collapse' );
  1277. selectionExtendSpy = sinon.spy( window.Selection.prototype, 'extend' );
  1278. // <container:p>foo<attribute:b>b{ar</attribute:b>}baz</container:p>
  1279. selection._setTo( [
  1280. new ViewRange( new ViewPosition( viewB.getChild( 0 ), 1 ), new ViewPosition( viewP.getChild( 2 ), 0 ) )
  1281. ] );
  1282. renderer.markToSync( 'children', viewP );
  1283. renderer.render();
  1284. expect( selectionCollapseSpy.notCalled ).to.true;
  1285. expect( selectionExtendSpy.notCalled ).to.true;
  1286. } );
  1287. it( 'should not render non-collapsed selection it is similar (element start - nested)', () => {
  1288. const domSelection = document.getSelection();
  1289. const { view: viewP, selection: newSelection } = parse(
  1290. '<container:p>foo<attribute:b><attribute:i>{ba}r</attribute:i></attribute:b></container:p>' );
  1291. viewRoot._appendChildren( viewP );
  1292. selection._setTo( newSelection );
  1293. renderer.markToSync( 'children', viewRoot );
  1294. renderer.render();
  1295. const domP = domRoot.childNodes[ 0 ];
  1296. const domB = domP.childNodes[ 1 ];
  1297. const viewI = viewRoot.getChild( 0 ).getChild( 1 ).getChild( 0 );
  1298. expect( domSelection.isCollapsed ).to.false;
  1299. expect( domSelection.rangeCount ).to.equal( 1 );
  1300. expect( domSelection.getRangeAt( 0 ).startContainer ).to.equal( domB.childNodes[ 0 ].childNodes[ 0 ] );
  1301. expect( domSelection.getRangeAt( 0 ).startOffset ).to.equal( 0 );
  1302. expect( domSelection.getRangeAt( 0 ).endContainer ).to.equal( domB.childNodes[ 0 ].childNodes[ 0 ] );
  1303. expect( domSelection.getRangeAt( 0 ).endOffset ).to.equal( 2 );
  1304. selectionCollapseSpy = sinon.spy( window.Selection.prototype, 'collapse' );
  1305. selectionExtendSpy = sinon.spy( window.Selection.prototype, 'extend' );
  1306. // <container:p>foo{<attribute:b><attribute:i>ba}r</attribute:i></attribute:b></container:p>
  1307. selection._setTo( [
  1308. new ViewRange( new ViewPosition( viewP.getChild( 0 ), 3 ), new ViewPosition( viewI.getChild( 0 ), 2 ) )
  1309. ] );
  1310. renderer.markToSync( 'children', viewP );
  1311. renderer.render();
  1312. expect( selectionCollapseSpy.notCalled ).to.true;
  1313. expect( selectionExtendSpy.notCalled ).to.true;
  1314. } );
  1315. it( 'should not render non-collapsed selection it is similar (element end - nested)', () => {
  1316. const domSelection = document.getSelection();
  1317. const { view: viewP, selection: newSelection } = parse(
  1318. '<container:p>f{oo<attribute:b><attribute:i>bar}</attribute:i></attribute:b>baz</container:p>' );
  1319. viewRoot._appendChildren( viewP );
  1320. selection._setTo( newSelection );
  1321. renderer.markToSync( 'children', viewRoot );
  1322. renderer.render();
  1323. const domP = domRoot.childNodes[ 0 ];
  1324. const domB = domP.childNodes[ 1 ];
  1325. expect( domSelection.isCollapsed ).to.false;
  1326. expect( domSelection.rangeCount ).to.equal( 1 );
  1327. expect( domSelection.getRangeAt( 0 ).startContainer ).to.equal( domP.childNodes[ 0 ] );
  1328. expect( domSelection.getRangeAt( 0 ).startOffset ).to.equal( 1 );
  1329. expect( domSelection.getRangeAt( 0 ).endContainer ).to.equal( domB.childNodes[ 0 ].childNodes[ 0 ] );
  1330. expect( domSelection.getRangeAt( 0 ).endOffset ).to.equal( 3 );
  1331. selectionCollapseSpy = sinon.spy( window.Selection.prototype, 'collapse' );
  1332. selectionExtendSpy = sinon.spy( window.Selection.prototype, 'extend' );
  1333. // <container:p>f{oo<attribute:b><attribute:i>bar</attribute:i></attribute:b>}baz</container:p>
  1334. selection._setTo( [
  1335. new ViewRange( new ViewPosition( viewP.getChild( 0 ), 1 ), new ViewPosition( viewP.getChild( 2 ), 0 ) )
  1336. ] );
  1337. renderer.markToSync( 'children', viewP );
  1338. renderer.render();
  1339. expect( selectionCollapseSpy.notCalled ).to.true;
  1340. expect( selectionExtendSpy.notCalled ).to.true;
  1341. } );
  1342. } );
  1343. } );
  1344. describe( '#922', () => {
  1345. let view, viewDoc, viewRoot, domRoot, converter;
  1346. beforeEach( () => {
  1347. view = new View();
  1348. viewDoc = view.document;
  1349. domRoot = document.createElement( 'div' );
  1350. document.body.appendChild( domRoot );
  1351. viewRoot = createViewRoot( viewDoc );
  1352. view.attachDomRoot( domRoot );
  1353. converter = view.domConverter;
  1354. } );
  1355. it( 'should properly render unwrapped attributes #1', () => {
  1356. setViewData( view,
  1357. '<container:p>' +
  1358. '[<attribute:italic>' +
  1359. '<attribute:strong>f</attribute:strong>' +
  1360. '</attribute:italic>]' +
  1361. '<attribute:strong>oo</attribute:strong>' +
  1362. '</container:p>'
  1363. );
  1364. // Render it to DOM to create initial DOM <-> view mappings.
  1365. view.render();
  1366. // Unwrap italic attribute element.
  1367. view.change( writer => {
  1368. writer.unwrap( viewDoc.selection.getFirstRange(), new ViewAttributeElement( 'italic' ) );
  1369. } );
  1370. expect( getViewData( view ) ).to.equal( '<p>[<strong>foo</strong>]</p>' );
  1371. // Re-render changes in view to DOM.
  1372. view.render();
  1373. // Check if DOM is rendered correctly.
  1374. expect( normalizeHtml( domRoot.innerHTML ) ).to.equal( '<p><strong>foo</strong></p>' );
  1375. expect( checkMappings() ).to.be.true;
  1376. } );
  1377. it( 'should properly render unwrapped attributes #2', () => {
  1378. setViewData( view,
  1379. '<container:p>' +
  1380. '[<attribute:italic>' +
  1381. '<attribute:strong>foo</attribute:strong>' +
  1382. '</attribute:italic>]' +
  1383. '</container:p>' );
  1384. // Render it to DOM to create initial DOM <-> view mappings.
  1385. view.render();
  1386. // Unwrap italic attribute element and change text inside.
  1387. view.change( writer => {
  1388. writer.unwrap( viewDoc.selection.getFirstRange(), new ViewAttributeElement( 'italic' ) );
  1389. } );
  1390. viewRoot.getChild( 0 ).getChild( 0 ).getChild( 0 )._data = 'bar';
  1391. expect( getViewData( view ) ).to.equal( '<p>[<strong>bar</strong>]</p>' );
  1392. // Re-render changes in view to DOM.
  1393. view.render();
  1394. // Check if DOM is rendered correctly.
  1395. expect( normalizeHtml( domRoot.innerHTML ) ).to.equal( '<p><strong>bar</strong></p>' );
  1396. expect( checkMappings() ).to.be.true;
  1397. } );
  1398. it( 'should properly render if text is changed and element is inserted into same node #1', () => {
  1399. setViewData( view,
  1400. '<container:p>foo</container:p>'
  1401. );
  1402. // Render it to DOM to create initial DOM <-> view mappings.
  1403. view.render();
  1404. // Change text and insert new element into paragraph.
  1405. const textNode = viewRoot.getChild( 0 ).getChild( 0 );
  1406. textNode._data = 'foobar';
  1407. view.change( writer => {
  1408. writer.insert( ViewPosition.createAfter( textNode ), new ViewAttributeElement( 'img' ) );
  1409. } );
  1410. expect( getViewData( view ) ).to.equal( '<p>foobar<img></img></p>' );
  1411. // Re-render changes in view to DOM.
  1412. view.render();
  1413. // Check if DOM is rendered correctly.
  1414. expect( normalizeHtml( domRoot.innerHTML ) ).to.equal( '<p>foobar<img></img></p>' );
  1415. expect( checkMappings() ).to.be.true;
  1416. } );
  1417. it( 'should properly render if text is changed and element is inserted into same node #2', () => {
  1418. setViewData( view,
  1419. '<container:p>foo</container:p>'
  1420. );
  1421. // Render it to DOM to create initial DOM <-> view mappings.
  1422. view.render();
  1423. // Change text and insert new element into paragraph.
  1424. const textNode = viewRoot.getChild( 0 ).getChild( 0 );
  1425. textNode._data = 'foobar';
  1426. view.change( writer => {
  1427. writer.insert( ViewPosition.createBefore( textNode ), new ViewAttributeElement( 'img' ) );
  1428. } );
  1429. expect( getViewData( view ) ).to.equal( '<p><img></img>foobar</p>' );
  1430. // Re-render changes in view to DOM.
  1431. view.render();
  1432. // Check if DOM is rendered correctly.
  1433. expect( normalizeHtml( domRoot.innerHTML ) ).to.equal( '<p><img></img>foobar</p>' );
  1434. expect( checkMappings() ).to.be.true;
  1435. } );
  1436. it( 'should not unbind elements that are removed and reinserted to DOM', () => {
  1437. setViewData( view,
  1438. '<container:p>' +
  1439. '<attribute:b></attribute:b>' +
  1440. '<attribute:i></attribute:i>' +
  1441. '<attribute:span></attribute:span>' +
  1442. '</container:p>'
  1443. );
  1444. // Render it to DOM to create initial DOM <-> view mappings.
  1445. view.render();
  1446. // Remove first element and reinsert it at the end.
  1447. const container = viewRoot.getChild( 0 );
  1448. const firstElement = container.getChild( 0 );
  1449. view.change( writer => {
  1450. writer.remove( ViewRange.createOn( firstElement ) );
  1451. writer.insert( new ViewPosition( container, 2 ), firstElement );
  1452. } );
  1453. expect( getViewData( view ) ).to.equal( '<p><i></i><span></span><b></b></p>' );
  1454. // Re-render changes in view to DOM.
  1455. view.render();
  1456. // Check if DOM is rendered correctly.
  1457. expect( normalizeHtml( domRoot.innerHTML ) ).to.equal( '<p><i></i><span></span><b></b></p>' );
  1458. expect( checkMappings() ).to.be.true;
  1459. } );
  1460. // Checks if every node in DOM tree is mapped to the view.
  1461. function checkMappings() {
  1462. const domWalker = document.createTreeWalker( domRoot, NodeFilter.SHOW_ELEMENT | NodeFilter.SHOW_TEXT );
  1463. while ( domWalker.nextNode() ) {
  1464. const node = domWalker.currentNode;
  1465. if ( !converter.mapDomToView( node ) && !converter.findCorrespondingViewText( node ) ) {
  1466. return false;
  1467. }
  1468. }
  1469. return true;
  1470. }
  1471. } );
  1472. } );
  1473. function renderAndExpectNoChanges( renderer, domRoot ) {
  1474. const config = {
  1475. childList: true,
  1476. characterData: true,
  1477. characterDataOldValue: true,
  1478. subtree: true
  1479. };
  1480. const mutationObserver = new window.MutationObserver( () => {
  1481. throw 'There should be not mutations';
  1482. } );
  1483. mutationObserver.observe( domRoot, config );
  1484. renderer.render();
  1485. const records = mutationObserver.takeRecords();
  1486. mutationObserver.disconnect();
  1487. expect( records.length ).to.equal( 0 );
  1488. }