renderer.js 71 KB

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