renderer.js 48 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373
  1. /**
  2. * @license Copyright (c) 2003-2017, CKSource - Frederico Knabben. All rights reserved.
  3. * For licensing, see LICENSE.md.
  4. */
  5. /* globals Range, document, window */
  6. import ViewElement from '../../src/view/element';
  7. import ViewText from '../../src/view/text';
  8. import ViewRange from '../../src/view/range';
  9. import Selection from '../../src/view/selection';
  10. import DomConverter from '../../src/view/domconverter';
  11. import Renderer from '../../src/view/renderer';
  12. import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror';
  13. import { parse } from '../../src/dev-utils/view';
  14. import { INLINE_FILLER, INLINE_FILLER_LENGTH, isBlockFiller, BR_FILLER } from '../../src/view/filler';
  15. import testUtils from '@ckeditor/ckeditor5-core/tests/_utils/utils';
  16. import createElement from '@ckeditor/ckeditor5-utils/src/dom/createelement';
  17. testUtils.createSinonSandbox();
  18. describe( 'Renderer', () => {
  19. let selection, domConverter, renderer;
  20. beforeEach( () => {
  21. selection = new Selection();
  22. domConverter = new DomConverter();
  23. renderer = new Renderer( domConverter, selection );
  24. renderer.domDocuments.add( document );
  25. } );
  26. describe( 'markToSync', () => {
  27. let viewRoot;
  28. beforeEach( () => {
  29. viewRoot = new ViewElement( 'p' );
  30. const domRoot = document.createElement( 'p' );
  31. domConverter.bindElements( domRoot, viewRoot );
  32. viewRoot.appendChildren( new ViewText( 'foo' ) );
  33. renderer.markedTexts.clear();
  34. renderer.markedAttributes.clear();
  35. renderer.markedChildren.clear();
  36. } );
  37. it( 'should mark attributes which need update', () => {
  38. viewRoot.setAttribute( 'class', 'foo' );
  39. renderer.markToSync( 'attributes', viewRoot );
  40. expect( renderer.markedAttributes.has( viewRoot ) ).to.be.true;
  41. } );
  42. it( 'should mark children which need update', () => {
  43. viewRoot.appendChildren( new ViewText( 'foo' ) );
  44. renderer.markToSync( 'children', viewRoot );
  45. expect( renderer.markedChildren.has( viewRoot ) ).to.be.true;
  46. } );
  47. it( 'should not mark children if element has no corresponding node', () => {
  48. // Overwrite viewRoot with node without coresponding DOM node.
  49. viewRoot = new ViewElement( 'p' );
  50. viewRoot.appendChildren( new ViewText( 'foo' ) );
  51. renderer.markToSync( 'children', viewRoot );
  52. expect( renderer.markedTexts.has( viewRoot ) ).to.be.false;
  53. } );
  54. it( 'should mark text which need update', () => {
  55. const viewText = new ViewText( 'foo' );
  56. viewRoot.appendChildren( viewText );
  57. viewText.data = 'bar';
  58. renderer.markToSync( 'text', viewText );
  59. expect( renderer.markedTexts.has( viewText ) ).to.be.true;
  60. } );
  61. it( 'should not mark text if parent has no corresponding node', () => {
  62. const viewText = new ViewText( 'foo' );
  63. // Overwrite viewRoot with node without coresponding DOM node.
  64. viewRoot = new ViewElement( 'p' );
  65. viewRoot.appendChildren( viewText );
  66. viewText.data = 'bar';
  67. renderer.markToSync( 'text', viewText );
  68. expect( renderer.markedTexts.has( viewText ) ).to.be.false;
  69. } );
  70. it( 'should throw if the type is unknown', () => {
  71. expect( () => {
  72. renderer.markToSync( 'UNKNOWN', viewRoot );
  73. } ).to.throw( CKEditorError, /^view-renderer-unknown-type/ );
  74. } );
  75. } );
  76. describe( 'render', () => {
  77. let viewRoot, domRoot, selectionEditable;
  78. beforeEach( () => {
  79. viewRoot = new ViewElement( 'div' );
  80. domRoot = document.createElement( 'div' );
  81. document.body.appendChild( domRoot );
  82. domConverter.bindElements( domRoot, viewRoot );
  83. renderer.markedTexts.clear();
  84. renderer.markedAttributes.clear();
  85. renderer.markedChildren.clear();
  86. selection.removeAllRanges();
  87. selection.setFake( false );
  88. selectionEditable = viewRoot;
  89. renderer.isFocused = true;
  90. // Fake selection editable - it is needed to render selection properly.
  91. Object.defineProperty( selection, 'editableElement', {
  92. get: function() {
  93. return selectionEditable;
  94. }
  95. } );
  96. } );
  97. it( 'should update attributes', () => {
  98. viewRoot.setAttribute( 'class', 'foo' );
  99. renderer.markToSync( 'attributes', viewRoot );
  100. renderer.render();
  101. expect( domRoot.getAttribute( 'class' ) ).to.equal( 'foo' );
  102. expect( renderer.markedAttributes.size ).to.equal( 0 );
  103. } );
  104. it( 'should remove attributes', () => {
  105. viewRoot.setAttribute( 'class', 'foo' );
  106. domRoot.setAttribute( 'id', 'bar' );
  107. domRoot.setAttribute( 'class', 'bar' );
  108. renderer.markToSync( 'attributes', viewRoot );
  109. renderer.render();
  110. expect( domRoot.getAttribute( 'class' ) ).to.equal( 'foo' );
  111. expect( domRoot.getAttribute( 'id' ) ).to.be.not.ok;
  112. expect( renderer.markedAttributes.size ).to.equal( 0 );
  113. } );
  114. it( 'should add children', () => {
  115. viewRoot.appendChildren( new ViewText( 'foo' ) );
  116. renderer.markToSync( 'children', viewRoot );
  117. renderer.render();
  118. expect( domRoot.childNodes.length ).to.equal( 1 );
  119. expect( domRoot.childNodes[ 0 ].data ).to.equal( 'foo' );
  120. expect( renderer.markedChildren.size ).to.equal( 0 );
  121. } );
  122. it( 'should remove children', () => {
  123. viewRoot.appendChildren( new ViewText( 'foo' ) );
  124. renderer.markToSync( 'children', viewRoot );
  125. renderer.render();
  126. expect( domRoot.childNodes.length ).to.equal( 1 );
  127. expect( domRoot.childNodes[ 0 ].data ).to.equal( 'foo' );
  128. viewRoot.removeChildren( 0, 1 );
  129. renderer.markToSync( 'children', viewRoot );
  130. renderer.render();
  131. expect( domRoot.childNodes.length ).to.equal( 0 );
  132. expect( renderer.markedChildren.size ).to.equal( 0 );
  133. } );
  134. it( 'should update text', () => {
  135. const viewText = new ViewText( 'foo' );
  136. viewRoot.appendChildren( viewText );
  137. renderer.markToSync( 'children', viewRoot );
  138. renderer.render();
  139. expect( domRoot.childNodes.length ).to.equal( 1 );
  140. expect( domRoot.childNodes[ 0 ].data ).to.equal( 'foo' );
  141. viewText.data = 'bar';
  142. renderer.markToSync( 'text', viewText );
  143. renderer.render();
  144. expect( domRoot.childNodes.length ).to.equal( 1 );
  145. expect( domRoot.childNodes[ 0 ].data ).to.equal( 'bar' );
  146. expect( renderer.markedTexts.size ).to.equal( 0 );
  147. } );
  148. it( 'should not update text parent child list changed', () => {
  149. const viewImg = new ViewElement( 'img' );
  150. const viewText = new ViewText( 'foo' );
  151. viewRoot.appendChildren( [ viewImg, viewText ] );
  152. renderer.markToSync( 'children', viewRoot );
  153. renderer.markToSync( 'text', viewText );
  154. renderer.render();
  155. expect( domRoot.childNodes.length ).to.equal( 2 );
  156. expect( domRoot.childNodes[ 0 ].tagName ).to.equal( 'IMG' );
  157. expect( domRoot.childNodes[ 1 ].data ).to.equal( 'foo' );
  158. } );
  159. it( 'should not change text if it is the same during text rendering', () => {
  160. const viewText = new ViewText( 'foo' );
  161. viewRoot.appendChildren( viewText );
  162. renderer.markToSync( 'children', viewRoot );
  163. renderer.render();
  164. // This should not be changed during the render.
  165. const domText = domRoot.childNodes[ 0 ];
  166. renderer.markToSync( 'text', viewText );
  167. renderer.render();
  168. expect( domRoot.childNodes.length ).to.equal( 1 );
  169. expect( domRoot.childNodes[ 0 ] ).to.equal( domText );
  170. } );
  171. it( 'should not change text if it is the same during children rendering', () => {
  172. const viewText = new ViewText( 'foo' );
  173. viewRoot.appendChildren( viewText );
  174. renderer.markToSync( 'children', viewRoot );
  175. renderer.render();
  176. // This should not be changed during the render.
  177. const domText = domRoot.childNodes[ 0 ];
  178. renderer.markToSync( 'children', viewRoot );
  179. renderer.render();
  180. expect( domRoot.childNodes.length ).to.equal( 1 );
  181. expect( domRoot.childNodes[ 0 ] ).to.equal( domText );
  182. } );
  183. it( 'should not change element if it is the same', () => {
  184. const viewImg = new ViewElement( 'img' );
  185. viewRoot.appendChildren( viewImg );
  186. // This should not be changed during the render.
  187. const domImg = document.createElement( 'img' );
  188. domRoot.appendChild( domImg );
  189. domConverter.bindElements( domImg, viewImg );
  190. renderer.markToSync( 'children', viewRoot );
  191. renderer.render();
  192. expect( domRoot.childNodes.length ).to.equal( 1 );
  193. expect( domRoot.childNodes[ 0 ] ).to.equal( domImg );
  194. } );
  195. it( 'should change element if it is different', () => {
  196. const viewImg = new ViewElement( 'img' );
  197. viewRoot.appendChildren( viewImg );
  198. renderer.markToSync( 'children', viewRoot );
  199. renderer.render();
  200. const viewP = new ViewElement( 'p' );
  201. viewRoot.removeChildren( 0, 1 );
  202. viewRoot.appendChildren( viewP );
  203. renderer.markToSync( 'children', viewRoot );
  204. renderer.render();
  205. expect( domRoot.childNodes.length ).to.equal( 1 );
  206. expect( domRoot.childNodes[ 0 ].tagName ).to.equal( 'P' );
  207. } );
  208. it( 'should update removed item when it is reinserted', () => {
  209. const viewFoo = new ViewText( 'foo' );
  210. const viewP = new ViewElement( 'p', null, viewFoo );
  211. const viewDiv = new ViewElement( 'div', null, viewP );
  212. viewRoot.appendChildren( viewDiv );
  213. renderer.markToSync( 'children', viewRoot );
  214. renderer.render();
  215. viewDiv.removeChildren( 0, 1 );
  216. renderer.markToSync( 'children', viewDiv );
  217. renderer.render();
  218. viewP.removeChildren( 0, 1 );
  219. viewDiv.appendChildren( viewP );
  220. renderer.markToSync( 'children', viewDiv );
  221. renderer.render();
  222. expect( domRoot.childNodes.length ).to.equal( 1 );
  223. const domDiv = domRoot.childNodes[ 0 ];
  224. expect( domDiv.tagName ).to.equal( 'DIV' );
  225. expect( domDiv.childNodes.length ).to.equal( 1 );
  226. const domP = domDiv.childNodes[ 0 ];
  227. expect( domP.tagName ).to.equal( 'P' );
  228. expect( domP.childNodes.length ).to.equal( 0 );
  229. } );
  230. it( 'should not throw when trying to update children of view element that got removed and lost its binding', () => {
  231. const viewFoo = new ViewText( 'foo' );
  232. const viewP = new ViewElement( 'p', null, viewFoo );
  233. const viewDiv = new ViewElement( 'div', null, viewP );
  234. viewRoot.appendChildren( viewDiv );
  235. renderer.markToSync( 'children', viewRoot );
  236. renderer.render();
  237. viewRoot.removeChildren( 0, 1 );
  238. renderer.markToSync( 'children', viewRoot );
  239. viewDiv.removeChildren( 0, 1 );
  240. renderer.markToSync( 'children', viewDiv );
  241. viewP.removeChildren( 0, 1 );
  242. renderer.markToSync( 'children', viewP );
  243. renderer.render();
  244. expect( domRoot.childNodes.length ).to.equal( 0 );
  245. } );
  246. it( 'should not care about filler if there is no DOM', () => {
  247. selectionEditable = null;
  248. const { view: viewP, selection: newSelection } = parse(
  249. '<container:p>foo<attribute:b>[]</attribute:b>bar</container:p>' );
  250. const viewRoot = new ViewElement( 'p' );
  251. viewRoot.appendChildren( viewP );
  252. selection.setTo( newSelection );
  253. renderer.markToSync( 'children', viewRoot );
  254. renderer.render();
  255. // Expect no error on render.
  256. expect( viewRoot ).to.be.ok;
  257. } );
  258. it( 'should add and remove inline filler in case <p>foo<b>[]</b>bar</p>', () => {
  259. const domSelection = document.getSelection();
  260. // Step 1: <p>foo<b>"FILLER{}"</b></p>
  261. const { view: viewP, selection: newSelection } = parse(
  262. '<container:p>foo<attribute:b>[]</attribute:b>bar</container:p>' );
  263. viewRoot.appendChildren( viewP );
  264. selection.setTo( newSelection );
  265. renderer.markToSync( 'children', viewRoot );
  266. renderer.render();
  267. expect( domRoot.childNodes.length ).to.equal( 1 );
  268. expect( domRoot.childNodes[ 0 ].tagName.toLowerCase() ).to.equal( 'p' );
  269. const domP = domRoot.childNodes[ 0 ];
  270. expect( domP.childNodes.length ).to.equal( 3 );
  271. expect( domP.childNodes[ 0 ].data ).to.equal( 'foo' );
  272. expect( domP.childNodes[ 2 ].data ).to.equal( 'bar' );
  273. expect( domP.childNodes[ 1 ].tagName.toLowerCase() ).to.equal( 'b' );
  274. expect( domP.childNodes[ 1 ].childNodes.length ).to.equal( 1 );
  275. expect( domP.childNodes[ 1 ].childNodes[ 0 ].data ).to.equal( INLINE_FILLER );
  276. expect( domSelection.rangeCount ).to.equal( 1 );
  277. expect( domSelection.getRangeAt( 0 ).startContainer ).to.equal( domP.childNodes[ 1 ].childNodes[ 0 ] );
  278. expect( domSelection.getRangeAt( 0 ).startOffset ).to.equal( INLINE_FILLER_LENGTH );
  279. expect( domSelection.getRangeAt( 0 ).collapsed ).to.be.true;
  280. // Step 2: No mutation on second render
  281. renderer.markToSync( 'children', viewRoot );
  282. renderer.markToSync( 'children', viewP );
  283. renderAndExpectNoChanges( renderer, domRoot );
  284. // Step 3: <p>foo{}<b></b></p>
  285. selection.removeAllRanges();
  286. selection.addRange( ViewRange.createFromParentsAndOffsets( viewP.getChild( 0 ), 3, viewP.getChild( 0 ), 3 ) );
  287. renderer.render();
  288. expect( domP.childNodes.length ).to.equal( 3 );
  289. expect( domP.childNodes[ 0 ].data ).to.equal( 'foo' );
  290. expect( domP.childNodes[ 2 ].data ).to.equal( 'bar' );
  291. expect( domP.childNodes[ 1 ].tagName.toLowerCase() ).to.equal( 'b' );
  292. expect( domP.childNodes[ 1 ].childNodes.length ).to.equal( 0 );
  293. expect( domSelection.rangeCount ).to.equal( 1 );
  294. expect( domSelection.getRangeAt( 0 ).startContainer ).to.equal( domP.childNodes[ 0 ] );
  295. expect( domSelection.getRangeAt( 0 ).startOffset ).to.equal( 3 );
  296. expect( domSelection.getRangeAt( 0 ).collapsed ).to.be.true;
  297. // Step 4: No mutation on second render
  298. renderer.markToSync( 'children', viewRoot );
  299. renderer.markToSync( 'children', viewP );
  300. renderAndExpectNoChanges( renderer, domRoot );
  301. } );
  302. it( 'should add and remove inline filler in case <p>[]<b>foo</b></p>', () => {
  303. const domSelection = document.getSelection();
  304. // Step 1: <p>"FILLER{}"<b>foo</b></p>
  305. const { view: viewP, selection: newSelection } = parse(
  306. '<container:p>[]<attribute:b>foo</attribute:b></container:p>' );
  307. viewRoot.appendChildren( viewP );
  308. selection.setTo( newSelection );
  309. renderer.markToSync( 'children', viewRoot );
  310. renderer.render();
  311. const domP = domRoot.childNodes[ 0 ];
  312. expect( domP.childNodes.length ).to.equal( 2 );
  313. expect( domP.childNodes[ 0 ].data ).to.equal( INLINE_FILLER );
  314. expect( domP.childNodes[ 1 ].tagName.toLowerCase() ).to.equal( 'b' );
  315. expect( domP.childNodes[ 1 ].childNodes.length ).to.equal( 1 );
  316. expect( domP.childNodes[ 1 ].childNodes[ 0 ].data ).to.equal( 'foo' );
  317. expect( domSelection.rangeCount ).to.equal( 1 );
  318. expect( domSelection.getRangeAt( 0 ).startContainer ).to.equal( domP.childNodes[ 0 ] );
  319. expect( domSelection.getRangeAt( 0 ).startOffset ).to.equal( INLINE_FILLER_LENGTH );
  320. expect( domSelection.getRangeAt( 0 ).collapsed ).to.be.true;
  321. // Step 2: No mutation on second render
  322. renderer.markToSync( 'children', viewP );
  323. renderAndExpectNoChanges( renderer, domRoot );
  324. // Step 3: <p><b>{}foo</b></p>
  325. selection.removeAllRanges();
  326. selection.addRange( ViewRange.createFromParentsAndOffsets(
  327. viewP.getChild( 0 ).getChild( 0 ), 0, viewP.getChild( 0 ).getChild( 0 ), 0 ) );
  328. renderer.render();
  329. expect( domP.childNodes.length ).to.equal( 1 );
  330. expect( domP.childNodes[ 0 ].tagName.toLowerCase() ).to.equal( 'b' );
  331. expect( domP.childNodes[ 0 ].childNodes.length ).to.equal( 1 );
  332. expect( domP.childNodes[ 0 ].childNodes[ 0 ].data ).to.equal( 'foo' );
  333. expect( domSelection.rangeCount ).to.equal( 1 );
  334. expect( domSelection.getRangeAt( 0 ).startContainer ).to.equal( domP.childNodes[ 0 ] .childNodes[ 0 ] );
  335. expect( domSelection.getRangeAt( 0 ).startOffset ).to.equal( 0 );
  336. expect( domSelection.getRangeAt( 0 ).collapsed ).to.be.true;
  337. // Step 4: No mutation on second render
  338. renderer.markToSync( 'children', viewP );
  339. renderAndExpectNoChanges( renderer, domRoot );
  340. } );
  341. it( 'should add and remove inline filler in case <p><b>foo</b>[]</p>', () => {
  342. const domSelection = document.getSelection();
  343. // Step 1: <p>"FILLER{}"<b>foo</b></p>
  344. const { view: viewP, selection: newSelection } = parse(
  345. '<container:p><attribute:b>foo</attribute:b>[]</container:p>' );
  346. viewRoot.appendChildren( viewP );
  347. selection.setTo( newSelection );
  348. renderer.markToSync( 'children', viewRoot );
  349. renderer.render();
  350. const domP = domRoot.childNodes[ 0 ];
  351. expect( domP.childNodes.length ).to.equal( 2 );
  352. expect( domP.childNodes[ 0 ].tagName.toLowerCase() ).to.equal( 'b' );
  353. expect( domP.childNodes[ 0 ].childNodes.length ).to.equal( 1 );
  354. expect( domP.childNodes[ 0 ].childNodes[ 0 ].data ).to.equal( 'foo' );
  355. expect( domP.childNodes[ 1 ].data ).to.equal( INLINE_FILLER );
  356. expect( domSelection.rangeCount ).to.equal( 1 );
  357. expect( domSelection.getRangeAt( 0 ).startContainer ).to.equal( domP.childNodes[ 1 ] );
  358. expect( domSelection.getRangeAt( 0 ).startOffset ).to.equal( INLINE_FILLER_LENGTH );
  359. expect( domSelection.getRangeAt( 0 ).collapsed ).to.be.true;
  360. // Step 2: No mutation on second render
  361. renderer.markToSync( 'children', viewP );
  362. renderAndExpectNoChanges( renderer, domRoot );
  363. // Step 3: <p><b>foo{}</b></p>
  364. selection.removeAllRanges();
  365. selection.addRange( ViewRange.createFromParentsAndOffsets(
  366. viewP.getChild( 0 ).getChild( 0 ), 3, viewP.getChild( 0 ).getChild( 0 ), 3 ) );
  367. renderer.render();
  368. expect( domP.childNodes.length ).to.equal( 1 );
  369. expect( domP.childNodes[ 0 ].tagName.toLowerCase() ).to.equal( 'b' );
  370. expect( domP.childNodes[ 0 ].childNodes.length ).to.equal( 1 );
  371. expect( domP.childNodes[ 0 ].childNodes[ 0 ].data ).to.equal( 'foo' );
  372. expect( domSelection.rangeCount ).to.equal( 1 );
  373. expect( domSelection.getRangeAt( 0 ).startContainer ).to.equal( domP.childNodes[ 0 ] .childNodes[ 0 ] );
  374. expect( domSelection.getRangeAt( 0 ).startOffset ).to.equal( 3 );
  375. expect( domSelection.getRangeAt( 0 ).collapsed ).to.be.true;
  376. // Step 4: No mutation on second render
  377. renderer.markToSync( 'children', viewP );
  378. renderAndExpectNoChanges( renderer, domRoot );
  379. } );
  380. it( 'should add and remove inline filler in case <p><b>foo</b>[]<b>bar</b></p>', () => {
  381. const domSelection = document.getSelection();
  382. const { view: viewP, selection: newSelection } = parse(
  383. '<container:p><attribute:b>foo</attribute:b>[]<attribute:b>bar</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( 3 );
  390. expect( domP.childNodes[ 0 ].tagName.toLowerCase() ).to.equal( 'b' );
  391. expect( domP.childNodes[ 0 ].childNodes.length ).to.equal( 1 );
  392. expect( domP.childNodes[ 0 ].childNodes[ 0 ].data ).to.equal( 'foo' );
  393. expect( domP.childNodes[ 1 ].data ).to.equal( INLINE_FILLER );
  394. expect( domP.childNodes[ 2 ].tagName.toLowerCase() ).to.equal( 'b' );
  395. expect( domP.childNodes[ 2 ].childNodes.length ).to.equal( 1 );
  396. expect( domP.childNodes[ 2 ].childNodes[ 0 ].data ).to.equal( 'bar' );
  397. expect( domSelection.rangeCount ).to.equal( 1 );
  398. expect( domSelection.getRangeAt( 0 ).startContainer ).to.equal( domP.childNodes[ 1 ] );
  399. expect( domSelection.getRangeAt( 0 ).startOffset ).to.equal( INLINE_FILLER_LENGTH );
  400. expect( domSelection.getRangeAt( 0 ).collapsed ).to.be.true;
  401. } );
  402. it( 'should move filler when selection is moved', () => {
  403. // Step 1: <p>foo<b>"FILLER{}"</b></p>
  404. const { view: viewP, selection: newSelection } = parse(
  405. '<container:p>foo<attribute:b>[]</attribute:b><attribute:i></attribute:i></container:p>' );
  406. viewRoot.appendChildren( viewP );
  407. selection.setTo( newSelection );
  408. renderer.markToSync( 'children', viewRoot );
  409. renderer.render();
  410. const domP = domRoot.childNodes[ 0 ];
  411. expect( domP.childNodes.length ).to.equal( 3 );
  412. expect( domP.childNodes[ 0 ].data ).to.equal( 'foo' );
  413. expect( domP.childNodes[ 1 ].tagName.toLowerCase() ).to.equal( 'b' );
  414. expect( domP.childNodes[ 1 ].childNodes.length ).to.equal( 1 );
  415. expect( domP.childNodes[ 1 ].childNodes[ 0 ].data ).to.equal( INLINE_FILLER );
  416. expect( domP.childNodes[ 2 ].tagName.toLowerCase() ).to.equal( 'i' );
  417. expect( domP.childNodes[ 2 ].childNodes.length ).to.equal( 0 );
  418. // Step 2: <p>foo<b></b><i>"FILLER{}"</i></p>
  419. selection.removeAllRanges();
  420. const viewI = viewP.getChild( 2 );
  421. selection.addRange( ViewRange.createFromParentsAndOffsets( viewI, 0, viewI, 0 ) );
  422. renderer.render();
  423. expect( domP.childNodes.length ).to.equal( 3 );
  424. expect( domP.childNodes[ 0 ].data ).to.equal( 'foo' );
  425. expect( domP.childNodes[ 1 ].tagName.toLowerCase() ).to.equal( 'b' );
  426. expect( domP.childNodes[ 1 ].childNodes.length ).to.equal( 0 );
  427. expect( domP.childNodes[ 2 ].tagName.toLowerCase() ).to.equal( 'i' );
  428. expect( domP.childNodes[ 2 ].childNodes.length ).to.equal( 1 );
  429. expect( domP.childNodes[ 2 ].childNodes[ 0 ].data ).to.equal( INLINE_FILLER );
  430. } );
  431. it( 'should remove filler when text is added and selection removed', () => {
  432. // Step 1: <p>foo<b>"FILLER{}"</b></p>
  433. const { view: viewP, selection: newSelection } = parse( '<container:p>foo<attribute:b>[]</attribute:b></container:p>' );
  434. const viewB = viewP.getChild( 1 );
  435. viewRoot.appendChildren( viewP );
  436. selection.setTo( newSelection );
  437. renderer.markToSync( 'children', viewRoot );
  438. renderer.render();
  439. const domP = domRoot.childNodes[ 0 ];
  440. expect( domP.childNodes.length ).to.equal( 2 );
  441. expect( domP.childNodes[ 0 ].data ).to.equal( 'foo' );
  442. expect( domP.childNodes[ 1 ].tagName.toLowerCase() ).to.equal( 'b' );
  443. expect( domP.childNodes[ 1 ].childNodes.length ).to.equal( 1 );
  444. expect( domP.childNodes[ 1 ].childNodes[ 0 ].data ).to.equal( INLINE_FILLER );
  445. // Step 2: Add text node.
  446. const viewText = new ViewText( 'x' );
  447. viewB.appendChildren( viewText );
  448. selection.removeAllRanges();
  449. selection.addRange( ViewRange.createFromParentsAndOffsets( viewText, 1, viewText, 1 ) );
  450. renderer.markToSync( 'children', viewB );
  451. renderer.render();
  452. // Step 3: Remove selection from the view.
  453. selection.removeAllRanges();
  454. renderer.render();
  455. expect( domP.childNodes.length ).to.equal( 2 );
  456. expect( domP.childNodes[ 0 ].data ).to.equal( 'foo' );
  457. expect( domP.childNodes[ 1 ].tagName.toLowerCase() ).to.equal( 'b' );
  458. expect( domP.childNodes[ 1 ].childNodes.length ).to.equal( 1 );
  459. expect( domP.childNodes[ 1 ].childNodes[ 0 ].data ).to.equal( 'x' );
  460. } );
  461. // #659
  462. // The element before the filler is removed so the position of the filler
  463. // cannot be remembered as parent+offset.
  464. it( 'should remove filler from a modified DOM in case <p>bar<b>foo</b>[]</p>', () => {
  465. // Step 1: <p>bar<b>foo</b>"FILLER{}"</p>
  466. const { view: viewP, selection: newSelection } = parse( '<container:p>bar<attribute:b>foo</attribute:b>[]</container:p>' );
  467. viewRoot.appendChildren( viewP );
  468. selection.setTo( newSelection );
  469. renderer.markToSync( 'children', viewRoot );
  470. renderer.render();
  471. const domP = domRoot.childNodes[ 0 ];
  472. expect( domP.childNodes.length ).to.equal( 3 );
  473. expect( domP.childNodes[ 2 ].data ).to.equal( INLINE_FILLER );
  474. // Step 2: Remove the <b> and update the selection (<p>bar[]</p>).
  475. viewP.removeChildren( 1 );
  476. selection.removeAllRanges();
  477. selection.addRange( ViewRange.createFromParentsAndOffsets( viewP, 1, viewP, 1 ) );
  478. renderer.markToSync( 'children', viewP );
  479. renderer.render();
  480. // Step 3: Check whether there's no filler in the DOM.
  481. expect( domP.childNodes.length ).to.equal( 1 );
  482. expect( domP.childNodes[ 0 ].data ).to.equal( 'bar' );
  483. } );
  484. // #659
  485. it( 'should remove filler from a modified DOM when children moved', () => {
  486. // Step 1: <p><b>foo</b>"FILLER{}"<b>bar</b></p><p></p>
  487. const { view: viewFragment, selection: newSelection }
  488. = parse( '<container:p><attribute:b>foo</attribute:b>[]<attribute:b>bar</attribute:b></container:p><container:p></container:p>' );
  489. viewRoot.appendChildren( viewFragment );
  490. selection.setTo( newSelection );
  491. renderer.markToSync( 'children', viewRoot );
  492. renderer.render();
  493. expect( domRoot.childNodes.length ).to.equal( 2 );
  494. const domP = domRoot.childNodes[ 0 ];
  495. const domP2 = domRoot.childNodes[ 1 ];
  496. expect( domP.childNodes.length ).to.equal( 3 );
  497. expect( domP.childNodes[ 1 ].data ).to.equal( INLINE_FILLER );
  498. // Step 2: Move <b>foo</b><b>bar</b> to the second paragraph and leave collapsed selection in the first one.
  499. // <p>[]</p><p><b>foo</b><b>bar</b></p>
  500. const viewP = viewRoot.getChild( 0 );
  501. const viewP2 = viewRoot.getChild( 1 );
  502. const removedChildren = viewP.removeChildren( 0, 2 );
  503. viewP2.appendChildren( removedChildren );
  504. selection.removeAllRanges();
  505. selection.addRange( ViewRange.createFromParentsAndOffsets( viewP, 0, viewP, 0 ) );
  506. renderer.markToSync( 'children', viewP );
  507. renderer.markToSync( 'children', viewP2 );
  508. renderer.render();
  509. // Step 3: Check whether in the first paragraph there's a <br> filler and that
  510. // in the second one there are two <b> tags.
  511. expect( domP.childNodes.length ).to.equal( 1 );
  512. expect( isBlockFiller( domP.childNodes[ 0 ], BR_FILLER ) ).to.be.true;
  513. expect( domP2.childNodes.length ).to.equal( 2 );
  514. expect( domP2.childNodes[ 0 ].tagName.toLowerCase() ).to.equal( 'b' );
  515. expect( domP2.childNodes[ 1 ].tagName.toLowerCase() ).to.equal( 'b' );
  516. } );
  517. // Test for an edge case in the _isSelectionInInlineFiller which can be triggered like
  518. // in one of ckeditor/ckeditor5-typing#59 automated tests.
  519. it( 'should not break when selection is moved to a new element, when filler exists', () => {
  520. // Step 1: <p>bar<b>"FILLER{}"</b></p>
  521. const { view: viewP, selection: newSelection } = parse( '<container:p>bar<attribute:b>[]</attribute:b></container:p>' );
  522. viewRoot.appendChildren( viewP );
  523. selection.setTo( newSelection );
  524. renderer.markToSync( 'children', viewRoot );
  525. renderer.render();
  526. const domP = domRoot.childNodes[ 0 ];
  527. expect( domP.childNodes.length ).to.equal( 2 );
  528. expect( domP.childNodes[ 1 ].childNodes[ 0 ].data ).to.equal( INLINE_FILLER );
  529. // Step 2: Move selection to a new attribute element and remove the previous one
  530. viewP.removeChildren( 1 ); // Remove <b>.
  531. const viewI = parse( '<attribute:i></attribute:i>' );
  532. viewP.appendChildren( viewI );
  533. selection.removeAllRanges();
  534. selection.addRange( ViewRange.createFromParentsAndOffsets( viewI, 0, viewI, 0 ) );
  535. renderer.markToSync( 'children', viewP );
  536. renderer.render();
  537. // Step 3: Check whether new filler was created in the <i> element.
  538. expect( domP.childNodes.length ).to.equal( 2 );
  539. expect( domP.childNodes[ 1 ].tagName.toLowerCase() ).to.equal( 'i' );
  540. expect( domP.childNodes[ 1 ].childNodes[ 0 ].data ).to.equal( INLINE_FILLER );
  541. } );
  542. // Test for an edge case in the _isSelectionInInlineFiller, when selection is before a view element
  543. // that has not been yet rendered/bound to DOM.
  544. it( 'should remove inline filler if selection is before a view element not bound to dom', () => {
  545. // Step 1: <p>bar<b>abc</b>"FILLER"{}</p>
  546. const { view: viewP, selection: newSelection } = parse( '<container:p>bar<attribute:b>abc</attribute:b>[]</container:p>' );
  547. viewRoot.appendChildren( viewP );
  548. selection.setTo( newSelection );
  549. renderer.markToSync( 'children', viewRoot );
  550. renderer.render();
  551. const domP = domRoot.childNodes[ 0 ];
  552. expect( domP.childNodes.length ).to.equal( 3 );
  553. expect( domP.childNodes[ 2 ].data ).to.equal( INLINE_FILLER );
  554. // Step 2: Move selection to a new attribute element.
  555. const viewAbc = parse( 'abc' );
  556. viewP.appendChildren( viewAbc );
  557. selection.removeAllRanges();
  558. selection.addRange( ViewRange.createFromParentsAndOffsets( viewP, 3, viewP, 3 ) );
  559. renderer.markToSync( 'children', viewP );
  560. renderer.render();
  561. // Step 3: Check whether old filler was removed.
  562. expect( domP.childNodes.length ).to.equal( 3 );
  563. expect( domP.textContent.indexOf( INLINE_FILLER ) ).to.equal( -1 );
  564. } );
  565. it( 'should handle typing in empty block, do nothing if changes are already applied', () => {
  566. const domSelection = document.getSelection();
  567. const { view: viewP, selection: newSelection } = parse( '<container:p>[]</container:p>' );
  568. viewRoot.appendChildren( viewP );
  569. selection.setTo( newSelection );
  570. renderer.markToSync( 'children', viewRoot );
  571. renderer.render();
  572. const domP = domRoot.childNodes[ 0 ];
  573. expect( domP.childNodes.length ).to.equal( 1 );
  574. expect( isBlockFiller( domP.childNodes[ 0 ], BR_FILLER ) ).to.be.true;
  575. expect( domSelection.rangeCount ).to.equal( 1 );
  576. expect( domSelection.getRangeAt( 0 ).startContainer ).to.equal( domP );
  577. expect( domSelection.getRangeAt( 0 ).startOffset ).to.equal( 0 );
  578. expect( domSelection.getRangeAt( 0 ).collapsed ).to.be.true;
  579. // Remove filler and add text node to both DOM and View <p>x{}</p>
  580. domP.removeChild( domP.childNodes[ 0 ] );
  581. domP.appendChild( document.createTextNode( 'x' ) );
  582. domSelection.removeAllRanges();
  583. const domRange = new Range();
  584. domRange.setStart( domP.childNodes[ 0 ], 1 );
  585. domRange.collapse( true );
  586. domSelection.addRange( domRange );
  587. const viewText = new ViewText( 'x' );
  588. viewP.appendChildren( viewText );
  589. selection.removeAllRanges();
  590. selection.addRange( ViewRange.createFromParentsAndOffsets( viewText, 1, viewText, 1 ) );
  591. renderer.markToSync( 'children', viewP );
  592. renderAndExpectNoChanges( renderer, domRoot );
  593. } );
  594. it( 'should handle typing in empty block, render if needed', () => {
  595. const domSelection = document.getSelection();
  596. const { view: viewP, selection: newSelection } = parse( '<container:p>[]</container:p>' );
  597. viewRoot.appendChildren( viewP );
  598. selection.setTo( newSelection );
  599. renderer.markToSync( 'children', viewRoot );
  600. renderer.render();
  601. const domP = domRoot.childNodes[ 0 ];
  602. expect( domP.childNodes.length ).to.equal( 1 );
  603. expect( isBlockFiller( domP.childNodes[ 0 ], BR_FILLER ) ).to.be.true;
  604. expect( domSelection.rangeCount ).to.equal( 1 );
  605. expect( domSelection.getRangeAt( 0 ).startContainer ).to.equal( domP );
  606. expect( domSelection.getRangeAt( 0 ).startOffset ).to.equal( 0 );
  607. expect( domSelection.getRangeAt( 0 ).collapsed ).to.be.true;
  608. // Add text node only in View <p>x{}</p>
  609. const viewText = new ViewText( 'x' );
  610. viewP.appendChildren( viewText );
  611. selection.removeAllRanges();
  612. selection.addRange( ViewRange.createFromParentsAndOffsets( viewText, 1, viewText, 1 ) );
  613. renderer.markToSync( 'children', viewP );
  614. renderer.render();
  615. expect( domP.childNodes.length ).to.equal( 1 );
  616. expect( domP.childNodes[ 0 ].data ).to.equal( 'x' );
  617. expect( domSelection.rangeCount ).to.equal( 1 );
  618. expect( domSelection.getRangeAt( 0 ).startContainer ).to.equal( domP.childNodes[ 0 ] );
  619. expect( domSelection.getRangeAt( 0 ).startOffset ).to.equal( 1 );
  620. expect( domSelection.getRangeAt( 0 ).collapsed ).to.be.true;
  621. } );
  622. it( 'should handle removing last character', () => {
  623. const domSelection = document.getSelection();
  624. const { view: viewP, selection: newSelection } = parse( '<container:p>x{}</container:p>' );
  625. viewRoot.appendChildren( viewP );
  626. selection.setTo( newSelection );
  627. renderer.markToSync( 'children', viewRoot );
  628. renderer.render();
  629. const domP = domRoot.childNodes[ 0 ];
  630. expect( domP.childNodes.length ).to.equal( 1 );
  631. expect( domP.childNodes[ 0 ].data ).to.equal( 'x' );
  632. expect( domSelection.rangeCount ).to.equal( 1 );
  633. expect( domSelection.getRangeAt( 0 ).startContainer ).to.equal( domP.childNodes[ 0 ] );
  634. expect( domSelection.getRangeAt( 0 ).startOffset ).to.equal( 1 );
  635. expect( domSelection.getRangeAt( 0 ).collapsed ).to.be.true;
  636. // Remove text and add filler to both DOM and View <p>{}</p>
  637. domP.removeChild( domP.childNodes[ 0 ] );
  638. domP.appendChild( BR_FILLER( document ) );
  639. domSelection.removeAllRanges();
  640. const domRange = new Range();
  641. domRange.setStart( domP.childNodes[ 0 ], 0 );
  642. domRange.collapse( true );
  643. domSelection.addRange( domRange );
  644. viewP.removeChildren( 0 );
  645. selection.removeAllRanges();
  646. selection.addRange( ViewRange.createFromParentsAndOffsets( viewP, 0, viewP, 0 ) );
  647. renderer.markToSync( 'children', viewP );
  648. renderAndExpectNoChanges( renderer, domRoot );
  649. } );
  650. it( 'should handle typing in empty attribute, do nothing if changes are already applied', () => {
  651. const domSelection = document.getSelection();
  652. // 1. Render <p><b>FILLER{}</b>foo</p>.
  653. const { view: viewP, selection: newSelection } = parse(
  654. '<container:p><attribute:b>[]</attribute:b>foo</container:p>' );
  655. viewRoot.appendChildren( viewP );
  656. selection.setTo( newSelection );
  657. renderer.markToSync( 'children', viewRoot );
  658. renderer.render();
  659. // 2. Check the DOM.
  660. const domP = domRoot.childNodes[ 0 ];
  661. expect( domP.childNodes.length ).to.equal( 2 );
  662. expect( domP.childNodes[ 0 ].tagName.toLowerCase() ).to.equal( 'b' );
  663. expect( domP.childNodes[ 1 ].data ).to.equal( 'foo' );
  664. const domB = domP.childNodes[ 0 ];
  665. const viewB = viewP.getChild( 0 );
  666. expect( domB.childNodes.length ).to.equal( 1 );
  667. expect( domB.childNodes[ 0 ].data ).to.equal( INLINE_FILLER );
  668. expect( domSelection.rangeCount ).to.equal( 1 );
  669. expect( domSelection.getRangeAt( 0 ).startContainer ).to.equal( domB.childNodes[ 0 ] );
  670. expect( domSelection.getRangeAt( 0 ).startOffset ).to.equal( INLINE_FILLER_LENGTH );
  671. expect( domSelection.getRangeAt( 0 ).collapsed ).to.be.true;
  672. // 3. Add text node to both the DOM and the view: <p><b>FILLERx</b>foo</p>.
  673. domB.childNodes[ 0 ].data += 'x';
  674. domSelection.removeAllRanges();
  675. const domRange = new Range();
  676. domRange.setStart( domB.childNodes[ 0 ], INLINE_FILLER_LENGTH + 1 );
  677. domRange.collapse( true );
  678. domSelection.addRange( domRange );
  679. const viewText = new ViewText( 'x' );
  680. viewB.appendChildren( viewText );
  681. selection.removeAllRanges();
  682. selection.addRange( ViewRange.createFromParentsAndOffsets( viewText, 1, viewText, 1 ) );
  683. renderer.markToSync( 'children', viewP );
  684. renderAndExpectNoChanges( renderer, domRoot );
  685. } );
  686. it( 'should handle typing in empty attribute as a children change, render if needed', () => {
  687. const domSelection = document.getSelection();
  688. // 1. Render <p><b>FILLER{}</b>foo</p>.
  689. const { view: viewP, selection: newSelection } = parse(
  690. '<container:p><attribute:b>[]</attribute:b>foo</container:p>' );
  691. viewRoot.appendChildren( viewP );
  692. selection.setTo( newSelection );
  693. renderer.markToSync( 'children', viewRoot );
  694. renderer.render();
  695. // 2. Check the DOM.
  696. const domP = domRoot.childNodes[ 0 ];
  697. expect( domP.childNodes.length ).to.equal( 2 );
  698. expect( domP.childNodes[ 0 ].tagName.toLowerCase() ).to.equal( 'b' );
  699. expect( domP.childNodes[ 1 ].data ).to.equal( 'foo' );
  700. const domB = domP.childNodes[ 0 ];
  701. const viewB = viewP.getChild( 0 );
  702. expect( domB.childNodes.length ).to.equal( 1 );
  703. expect( domB.childNodes[ 0 ].data ).to.equal( INLINE_FILLER );
  704. expect( domSelection.rangeCount ).to.equal( 1 );
  705. expect( domSelection.getRangeAt( 0 ).startContainer ).to.equal( domB.childNodes[ 0 ] );
  706. expect( domSelection.getRangeAt( 0 ).startOffset ).to.equal( INLINE_FILLER_LENGTH );
  707. expect( domSelection.getRangeAt( 0 ).collapsed ).to.be.true;
  708. // 3. Add text node only to the view: <p><b>x{}</b>foo</p>.
  709. const viewText = new ViewText( 'x' );
  710. viewB.appendChildren( viewText );
  711. selection.removeAllRanges();
  712. selection.addRange( ViewRange.createFromParentsAndOffsets( viewText, 1, viewText, 1 ) );
  713. renderer.markToSync( 'children', viewB );
  714. renderer.render();
  715. expect( domB.childNodes.length ).to.equal( 1 );
  716. expect( domB.childNodes[ 0 ].data ).to.equal( INLINE_FILLER + 'x' );
  717. expect( domSelection.rangeCount ).to.equal( 1 );
  718. expect( domSelection.getRangeAt( 0 ).startContainer ).to.equal( domB.childNodes[ 0 ] );
  719. expect( domSelection.getRangeAt( 0 ).startOffset ).to.equal( INLINE_FILLER_LENGTH + 1 );
  720. expect( domSelection.getRangeAt( 0 ).collapsed ).to.be.true;
  721. } );
  722. it( 'should handle typing in empty attribute as a text change, render if needed', () => {
  723. const domSelection = document.getSelection();
  724. // 1. Render <p><b>FILLER{}</b>foo</p>.
  725. const { view: viewP, selection: newSelection } = parse(
  726. '<container:p><attribute:b>[]</attribute:b>foo</container:p>' );
  727. viewRoot.appendChildren( viewP );
  728. selection.setTo( newSelection );
  729. renderer.markToSync( 'children', viewRoot );
  730. renderer.render();
  731. // 2. Check the DOM.
  732. const domP = domRoot.childNodes[ 0 ];
  733. expect( domP.childNodes.length ).to.equal( 2 );
  734. expect( domP.childNodes[ 0 ].tagName.toLowerCase() ).to.equal( 'b' );
  735. expect( domP.childNodes[ 1 ].data ).to.equal( 'foo' );
  736. const domB = domP.childNodes[ 0 ];
  737. const viewB = viewP.getChild( 0 );
  738. expect( domB.childNodes.length ).to.equal( 1 );
  739. expect( domB.childNodes[ 0 ].data ).to.equal( INLINE_FILLER );
  740. expect( domSelection.rangeCount ).to.equal( 1 );
  741. expect( domSelection.getRangeAt( 0 ).startContainer ).to.equal( domB.childNodes[ 0 ] );
  742. expect( domSelection.getRangeAt( 0 ).startOffset ).to.equal( INLINE_FILLER_LENGTH );
  743. expect( domSelection.getRangeAt( 0 ).collapsed ).to.be.true;
  744. // 3. Add text node only to the view: <p><b>x{}</b>foo</p>.
  745. const viewText = new ViewText( 'x' );
  746. viewB.appendChildren( viewText );
  747. selection.removeAllRanges();
  748. selection.addRange( ViewRange.createFromParentsAndOffsets( viewText, 1, viewText, 1 ) );
  749. renderer.markToSync( 'text', viewText );
  750. renderer.render();
  751. // 4. Check the DOM.
  752. expect( domB.childNodes.length ).to.equal( 1 );
  753. expect( domB.childNodes[ 0 ].data ).to.equal( INLINE_FILLER + 'x' );
  754. expect( domSelection.rangeCount ).to.equal( 1 );
  755. expect( domSelection.getRangeAt( 0 ).startContainer ).to.equal( domB.childNodes[ 0 ] );
  756. expect( domSelection.getRangeAt( 0 ).startOffset ).to.equal( INLINE_FILLER_LENGTH + 1 );
  757. expect( domSelection.getRangeAt( 0 ).collapsed ).to.be.true;
  758. } );
  759. it( 'should handle not collapsed range', () => {
  760. const domSelection = document.getSelection();
  761. const { view: viewP, selection: newSelection } = parse(
  762. '<container:p>fo{o<attribute:b>b}ar</attribute:b></container:p>' );
  763. viewRoot.appendChildren( viewP );
  764. selection.setTo( newSelection );
  765. renderer.markToSync( 'children', viewRoot );
  766. renderer.render();
  767. const domP = domRoot.childNodes[ 0 ];
  768. expect( domP.childNodes.length ).to.equal( 2 );
  769. expect( domP.childNodes[ 0 ].data ).to.equal( 'foo' );
  770. expect( domP.childNodes[ 1 ].tagName.toLowerCase() ).to.equal( 'b' );
  771. expect( domP.childNodes[ 1 ].childNodes.length ).to.equal( 1 );
  772. expect( domP.childNodes[ 1 ].childNodes[ 0 ].data ).to.equal( 'bar' );
  773. expect( domSelection.rangeCount ).to.equal( 1 );
  774. expect( domSelection.getRangeAt( 0 ).startContainer ).to.equal( domP.childNodes[ 0 ] );
  775. expect( domSelection.getRangeAt( 0 ).startOffset ).to.equal( 2 );
  776. expect( domSelection.getRangeAt( 0 ).endContainer ).to.equal( domP.childNodes[ 1 ].childNodes[ 0 ] );
  777. expect( domSelection.getRangeAt( 0 ).endOffset ).to.equal( 1 );
  778. renderer.markToSync( 'children', viewP );
  779. renderAndExpectNoChanges( renderer, domRoot );
  780. } );
  781. it( 'should not change selection if there is no editable with selection', () => {
  782. const domDiv = createElement( document, 'div', null, 'not editable' );
  783. document.body.appendChild( domDiv );
  784. const domSelection = document.getSelection();
  785. domSelection.removeAllRanges();
  786. const domRange = new Range();
  787. domRange.setStart( domDiv, 0 );
  788. domRange.collapse( true );
  789. domSelection.addRange( domRange );
  790. selectionEditable = null;
  791. const { view: viewP, selection: newSelection } = parse( '<container:p>fo{o}</container:p>' );
  792. viewRoot.appendChildren( viewP );
  793. selection.setTo( newSelection );
  794. renderer.render();
  795. expect( domSelection.rangeCount ).to.equal( 1 );
  796. expect( domSelection.getRangeAt( 0 ).startContainer ).to.equal( domDiv );
  797. expect( domSelection.getRangeAt( 0 ).startOffset ).to.equal( 0 );
  798. expect( domSelection.getRangeAt( 0 ).collapsed ).to.equal( true );
  799. } );
  800. it( 'should not change selection if there is no focus', () => {
  801. const domDiv = createElement( document, 'div', null, 'not editable' );
  802. document.body.appendChild( domDiv );
  803. const domSelection = document.getSelection();
  804. domSelection.removeAllRanges();
  805. const domRange = new Range();
  806. domRange.setStart( domDiv, 0 );
  807. domRange.collapse( true );
  808. domSelection.addRange( domRange );
  809. renderer.isFocused = false;
  810. const { view: viewP, selection: newSelection } = parse( '<container:p>fo{o}</container:p>' );
  811. viewRoot.appendChildren( viewP );
  812. selection.setTo( newSelection );
  813. renderer.render();
  814. expect( domSelection.rangeCount ).to.equal( 1 );
  815. expect( domSelection.getRangeAt( 0 ).startContainer ).to.equal( domDiv );
  816. expect( domSelection.getRangeAt( 0 ).startOffset ).to.equal( 0 );
  817. expect( domSelection.getRangeAt( 0 ).collapsed ).to.equal( true );
  818. } );
  819. it( 'should not add inline filler after text node', () => {
  820. const { view: viewP, selection: newSelection } = parse( '<container:p>foo[]</container:p>' );
  821. viewRoot.appendChildren( viewP );
  822. selection.setTo( newSelection );
  823. renderer.markToSync( 'children', viewRoot );
  824. renderer.render();
  825. const domP = domRoot.childNodes[ 0 ];
  826. expect( domP.innerHTML.indexOf( INLINE_FILLER ) ).to.equal( -1 );
  827. } );
  828. it( 'should throw if there is no filler in expected position', () => {
  829. const { view: viewP, selection: newSelection } = parse(
  830. '<container:p>foo<attribute:b>[]</attribute:b>bar</container:p>' );
  831. viewRoot.appendChildren( viewP );
  832. selection.setTo( newSelection );
  833. renderer.markToSync( 'children', viewRoot );
  834. renderer.render();
  835. const domB = domRoot.childNodes[ 0 ].childNodes[ 1 ];
  836. const viewB = viewP.getChild( 1 );
  837. expect( domB.childNodes[ 0 ].data ).to.equal( INLINE_FILLER );
  838. // Remove filler.
  839. domB.childNodes[ 0 ].data = '';
  840. selection.removeAllRanges();
  841. renderer.markToSync( 'children', viewB );
  842. expect( () => {
  843. renderer.render();
  844. } ).to.throw( CKEditorError, /^view-renderer-filler-was-lost/ );
  845. } );
  846. it( 'should handle focusing element', () => {
  847. const domFocusSpy = testUtils.sinon.spy( domRoot, 'focus' );
  848. const editable = selection.editableElement;
  849. renderer.render();
  850. expect( editable ).to.equal( viewRoot );
  851. expect( domFocusSpy.calledOnce ).to.be.true;
  852. } );
  853. it( 'should not focus editable if isFocues is set to false', () => {
  854. const domFocusSpy = testUtils.sinon.spy( domRoot, 'focus' );
  855. renderer.isFocused = false;
  856. renderer.render();
  857. expect( domFocusSpy.calledOnce ).to.be.false;
  858. } );
  859. it( 'should not focus already focused DOM element', () => {
  860. domRoot.setAttribute( 'contentEditable', true );
  861. domRoot.focus();
  862. const domFocusSpy = testUtils.sinon.spy( domRoot, 'focus' );
  863. renderer.render();
  864. expect( domFocusSpy.called ).to.be.false;
  865. } );
  866. describe( 'fake selection', () => {
  867. beforeEach( () => {
  868. const { view: viewP, selection: newSelection } = parse(
  869. '<container:p>[foo bar]</container:p>'
  870. );
  871. viewRoot.appendChildren( viewP );
  872. selection.setTo( newSelection );
  873. renderer.markToSync( 'children', viewRoot );
  874. renderer.render();
  875. } );
  876. it( 'should render fake selection', () => {
  877. const label = 'fake selection label';
  878. selection.setFake( true, { label } );
  879. renderer.render();
  880. expect( domRoot.childNodes.length ).to.equal( 2 );
  881. const container = domRoot.childNodes[ 1 ];
  882. expect( domConverter.getCorrespondingViewElement( container ) ).to.be.undefined;
  883. expect( container.childNodes.length ).to.equal( 1 );
  884. const textNode = container.childNodes[ 0 ];
  885. expect( textNode.textContent ).to.equal( label );
  886. const domSelection = domRoot.ownerDocument.getSelection();
  887. expect( domSelection.anchorNode ).to.equal( textNode );
  888. expect( domSelection.anchorOffset ).to.equal( 0 );
  889. expect( domSelection.focusNode ).to.equal( textNode );
  890. expect( domSelection.focusOffset ).to.equal( label.length );
  891. } );
  892. it( 'should render &nbsp; if no selection label is provided', () => {
  893. selection.setFake( true );
  894. renderer.render();
  895. expect( domRoot.childNodes.length ).to.equal( 2 );
  896. const container = domRoot.childNodes[ 1 ];
  897. expect( container.childNodes.length ).to.equal( 1 );
  898. const textNode = container.childNodes[ 0 ];
  899. expect( textNode.textContent ).to.equal( '\u00A0' );
  900. const domSelection = domRoot.ownerDocument.getSelection();
  901. expect( domSelection.anchorNode ).to.equal( textNode );
  902. expect( domSelection.anchorOffset ).to.equal( 0 );
  903. expect( domSelection.focusNode ).to.equal( textNode );
  904. expect( domSelection.focusOffset ).to.equal( 1 );
  905. } );
  906. it( 'should remove fake selection container when selection is no longer fake', () => {
  907. selection.setFake( true );
  908. renderer.render();
  909. selection.setFake( false );
  910. renderer.render();
  911. expect( domRoot.childNodes.length ).to.equal( 1 );
  912. const domParagraph = domRoot.childNodes[ 0 ];
  913. expect( domParagraph.childNodes.length ).to.equal( 1 );
  914. const textNode = domParagraph.childNodes[ 0 ];
  915. expect( domParagraph.tagName.toLowerCase() ).to.equal( 'p' );
  916. const domSelection = domRoot.ownerDocument.getSelection();
  917. expect( domSelection.anchorNode ).to.equal( textNode );
  918. expect( domSelection.anchorOffset ).to.equal( 0 );
  919. expect( domSelection.focusNode ).to.equal( textNode );
  920. expect( domSelection.focusOffset ).to.equal( 7 );
  921. } );
  922. it( 'should reuse fake selection container #1', () => {
  923. const label = 'fake selection label';
  924. selection.setFake( true, { label } );
  925. renderer.render();
  926. expect( domRoot.childNodes.length ).to.equal( 2 );
  927. const container = domRoot.childNodes[ 1 ];
  928. selection.setFake( true, { label } );
  929. renderer.render();
  930. expect( domRoot.childNodes.length ).to.equal( 2 );
  931. const newContainer = domRoot.childNodes[ 1 ];
  932. expect( newContainer ).equals( container );
  933. expect( newContainer.childNodes.length ).to.equal( 1 );
  934. const textNode = newContainer.childNodes[ 0 ];
  935. expect( textNode.textContent ).to.equal( label );
  936. } );
  937. it( 'should reuse fake selection container #2', () => {
  938. selection.setFake( true, { label: 'label 1' } );
  939. renderer.render();
  940. expect( domRoot.childNodes.length ).to.equal( 2 );
  941. const container = domRoot.childNodes[ 1 ];
  942. selection.setFake( false );
  943. renderer.render();
  944. expect( domRoot.childNodes.length ).to.equal( 1 );
  945. selection.setFake( true, { label: 'label 2' } );
  946. renderer.render();
  947. expect( domRoot.childNodes.length ).to.equal( 2 );
  948. const newContainer = domRoot.childNodes[ 1 ];
  949. expect( newContainer ).equals( container );
  950. expect( newContainer.childNodes.length ).to.equal( 1 );
  951. const textNode = newContainer.childNodes[ 0 ];
  952. expect( textNode.textContent ).to.equal( 'label 2' );
  953. } );
  954. it( 'should reuse fake selection container #3', () => {
  955. selection.setFake( true, { label: 'label 1' } );
  956. renderer.render();
  957. expect( domRoot.childNodes.length ).to.equal( 2 );
  958. const container = domRoot.childNodes[ 1 ];
  959. selection.setFake( true, { label: 'label 2' } );
  960. renderer.render();
  961. expect( domRoot.childNodes.length ).to.equal( 2 );
  962. const newContainer = domRoot.childNodes[ 1 ];
  963. expect( newContainer ).equals( container );
  964. expect( newContainer.childNodes.length ).to.equal( 1 );
  965. const textNode = newContainer.childNodes[ 0 ];
  966. expect( textNode.textContent ).to.equal( 'label 2' );
  967. } );
  968. it( 'should style fake selection container properly', () => {
  969. selection.setFake( true, { label: 'fake selection' } );
  970. renderer.render();
  971. expect( domRoot.childNodes.length ).to.equal( 2 );
  972. const container = domRoot.childNodes[ 1 ];
  973. expect( container.style.position ).to.equal( 'fixed' );
  974. expect( container.style.top ).to.equal( '0px' );
  975. expect( container.style.left ).to.equal( '-9999px' );
  976. } );
  977. it( 'should bind fake selection container to view selection', () => {
  978. selection.setFake( true, { label: 'fake selection' } );
  979. renderer.render();
  980. expect( domRoot.childNodes.length ).to.equal( 2 );
  981. const container = domRoot.childNodes[ 1 ];
  982. const bindSelection = renderer.domConverter.fakeSelectionToView( container );
  983. expect( bindSelection ).to.be.defined;
  984. expect( bindSelection.isEqual( selection ) ).to.be.true;
  985. } );
  986. } );
  987. } );
  988. } );
  989. function renderAndExpectNoChanges( renderer, domRoot ) {
  990. const config = {
  991. childList: true,
  992. characterData: true,
  993. characterDataOldValue: true,
  994. subtree: true
  995. };
  996. const mutationObserver = new window.MutationObserver( () => {
  997. throw 'There should be not mutations';
  998. } );
  999. mutationObserver.observe( domRoot, config );
  1000. renderer.render();
  1001. const records = mutationObserver.takeRecords();
  1002. mutationObserver.disconnect();
  1003. expect( records.length ).to.equal( 0 );
  1004. }