renderer.js 73 KB

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