8
0

renderer.js 67 KB

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