8
0

renderer.js 73 KB

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