renderer.js 46 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316
  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 'ckeditor5-engine/src/view/element';
  7. import ViewText from 'ckeditor5-engine/src/view/text';
  8. import ViewRange from 'ckeditor5-engine/src/view/range';
  9. import Selection from 'ckeditor5-engine/src/view/selection';
  10. import DomConverter from 'ckeditor5-engine/src/view/domconverter';
  11. import Renderer from 'ckeditor5-engine/src/view/renderer';
  12. import CKEditorError from 'ckeditor5-utils/src/ckeditorerror';
  13. import { parse } from 'ckeditor5-engine/src/dev-utils/view';
  14. import { INLINE_FILLER, INLINE_FILLER_LENGTH, isBlockFiller, BR_FILLER } from 'ckeditor5-engine/src/view/filler';
  15. import testUtils from 'ckeditor5-core/tests/_utils/utils';
  16. import createElement from '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 not care about filler if there is no DOM', () => {
  209. selectionEditable = null;
  210. const { view: viewP, selection: newSelection } = parse(
  211. '<container:p>foo<attribute:b>[]</attribute:b>bar</container:p>' );
  212. const viewRoot = new ViewElement( 'p' );
  213. viewRoot.appendChildren( viewP );
  214. selection.setTo( newSelection );
  215. renderer.markToSync( 'children', viewRoot );
  216. renderer.render();
  217. // Expect no error on render.
  218. expect( viewRoot ).to.be.ok;
  219. } );
  220. it( 'should add and remove inline filler in case <p>foo<b>[]</b>bar</p>', () => {
  221. const domSelection = document.getSelection();
  222. // Step 1: <p>foo<b>"FILLER{}"</b></p>
  223. const { view: viewP, selection: newSelection } = parse(
  224. '<container:p>foo<attribute:b>[]</attribute:b>bar</container:p>' );
  225. viewRoot.appendChildren( viewP );
  226. selection.setTo( newSelection );
  227. renderer.markToSync( 'children', viewRoot );
  228. renderer.render();
  229. expect( domRoot.childNodes.length ).to.equal( 1 );
  230. expect( domRoot.childNodes[ 0 ].tagName.toLowerCase() ).to.equal( 'p' );
  231. const domP = domRoot.childNodes[ 0 ];
  232. expect( domP.childNodes.length ).to.equal( 3 );
  233. expect( domP.childNodes[ 0 ].data ).to.equal( 'foo' );
  234. expect( domP.childNodes[ 2 ].data ).to.equal( 'bar' );
  235. expect( domP.childNodes[ 1 ].tagName.toLowerCase() ).to.equal( 'b' );
  236. expect( domP.childNodes[ 1 ].childNodes.length ).to.equal( 1 );
  237. expect( domP.childNodes[ 1 ].childNodes[ 0 ].data ).to.equal( INLINE_FILLER );
  238. expect( domSelection.rangeCount ).to.equal( 1 );
  239. expect( domSelection.getRangeAt( 0 ).startContainer ).to.equal( domP.childNodes[ 1 ].childNodes[ 0 ] );
  240. expect( domSelection.getRangeAt( 0 ).startOffset ).to.equal( INLINE_FILLER_LENGTH );
  241. expect( domSelection.getRangeAt( 0 ).collapsed ).to.be.true;
  242. // Step 2: No mutation on second render
  243. renderer.markToSync( 'children', viewRoot );
  244. renderer.markToSync( 'children', viewP );
  245. renderAndExpectNoChanges( renderer, domRoot );
  246. // Step 3: <p>foo{}<b></b></p>
  247. selection.removeAllRanges();
  248. selection.addRange( ViewRange.createFromParentsAndOffsets( viewP.getChild( 0 ), 3, viewP.getChild( 0 ), 3 ) );
  249. renderer.render();
  250. expect( domP.childNodes.length ).to.equal( 3 );
  251. expect( domP.childNodes[ 0 ].data ).to.equal( 'foo' );
  252. expect( domP.childNodes[ 2 ].data ).to.equal( 'bar' );
  253. expect( domP.childNodes[ 1 ].tagName.toLowerCase() ).to.equal( 'b' );
  254. expect( domP.childNodes[ 1 ].childNodes.length ).to.equal( 0 );
  255. expect( domSelection.rangeCount ).to.equal( 1 );
  256. expect( domSelection.getRangeAt( 0 ).startContainer ).to.equal( domP.childNodes[ 0 ] );
  257. expect( domSelection.getRangeAt( 0 ).startOffset ).to.equal( 3 );
  258. expect( domSelection.getRangeAt( 0 ).collapsed ).to.be.true;
  259. // Step 4: No mutation on second render
  260. renderer.markToSync( 'children', viewRoot );
  261. renderer.markToSync( 'children', viewP );
  262. renderAndExpectNoChanges( renderer, domRoot );
  263. } );
  264. it( 'should add and remove inline filler in case <p>[]<b>foo</b></p>', () => {
  265. const domSelection = document.getSelection();
  266. // Step 1: <p>"FILLER{}"<b>foo</b></p>
  267. const { view: viewP, selection: newSelection } = parse(
  268. '<container:p>[]<attribute:b>foo</attribute:b></container:p>' );
  269. viewRoot.appendChildren( viewP );
  270. selection.setTo( newSelection );
  271. renderer.markToSync( 'children', viewRoot );
  272. renderer.render();
  273. const domP = domRoot.childNodes[ 0 ];
  274. expect( domP.childNodes.length ).to.equal( 2 );
  275. expect( domP.childNodes[ 0 ].data ).to.equal( INLINE_FILLER );
  276. expect( domP.childNodes[ 1 ].tagName.toLowerCase() ).to.equal( 'b' );
  277. expect( domP.childNodes[ 1 ].childNodes.length ).to.equal( 1 );
  278. expect( domP.childNodes[ 1 ].childNodes[ 0 ].data ).to.equal( 'foo' );
  279. expect( domSelection.rangeCount ).to.equal( 1 );
  280. expect( domSelection.getRangeAt( 0 ).startContainer ).to.equal( domP.childNodes[ 0 ] );
  281. expect( domSelection.getRangeAt( 0 ).startOffset ).to.equal( INLINE_FILLER_LENGTH );
  282. expect( domSelection.getRangeAt( 0 ).collapsed ).to.be.true;
  283. // Step 2: No mutation on second render
  284. renderer.markToSync( 'children', viewP );
  285. renderAndExpectNoChanges( renderer, domRoot );
  286. // Step 3: <p><b>{}foo</b></p>
  287. selection.removeAllRanges();
  288. selection.addRange( ViewRange.createFromParentsAndOffsets(
  289. viewP.getChild( 0 ).getChild( 0 ), 0, viewP.getChild( 0 ).getChild( 0 ), 0 ) );
  290. renderer.render();
  291. expect( domP.childNodes.length ).to.equal( 1 );
  292. expect( domP.childNodes[ 0 ].tagName.toLowerCase() ).to.equal( 'b' );
  293. expect( domP.childNodes[ 0 ].childNodes.length ).to.equal( 1 );
  294. expect( domP.childNodes[ 0 ].childNodes[ 0 ].data ).to.equal( 'foo' );
  295. expect( domSelection.rangeCount ).to.equal( 1 );
  296. expect( domSelection.getRangeAt( 0 ).startContainer ).to.equal( domP.childNodes[ 0 ] .childNodes[ 0 ] );
  297. expect( domSelection.getRangeAt( 0 ).startOffset ).to.equal( 0 );
  298. expect( domSelection.getRangeAt( 0 ).collapsed ).to.be.true;
  299. // Step 4: No mutation on second render
  300. renderer.markToSync( 'children', viewP );
  301. renderAndExpectNoChanges( renderer, domRoot );
  302. } );
  303. it( 'should add and remove inline filler in case <p><b>foo</b>[]</p>', () => {
  304. const domSelection = document.getSelection();
  305. // Step 1: <p>"FILLER{}"<b>foo</b></p>
  306. const { view: viewP, selection: newSelection } = parse(
  307. '<container:p><attribute:b>foo</attribute:b>[]</container:p>' );
  308. viewRoot.appendChildren( viewP );
  309. selection.setTo( newSelection );
  310. renderer.markToSync( 'children', viewRoot );
  311. renderer.render();
  312. const domP = domRoot.childNodes[ 0 ];
  313. expect( domP.childNodes.length ).to.equal( 2 );
  314. expect( domP.childNodes[ 0 ].tagName.toLowerCase() ).to.equal( 'b' );
  315. expect( domP.childNodes[ 0 ].childNodes.length ).to.equal( 1 );
  316. expect( domP.childNodes[ 0 ].childNodes[ 0 ].data ).to.equal( 'foo' );
  317. expect( domP.childNodes[ 1 ].data ).to.equal( INLINE_FILLER );
  318. expect( domSelection.rangeCount ).to.equal( 1 );
  319. expect( domSelection.getRangeAt( 0 ).startContainer ).to.equal( domP.childNodes[ 1 ] );
  320. expect( domSelection.getRangeAt( 0 ).startOffset ).to.equal( INLINE_FILLER_LENGTH );
  321. expect( domSelection.getRangeAt( 0 ).collapsed ).to.be.true;
  322. // Step 2: No mutation on second render
  323. renderer.markToSync( 'children', viewP );
  324. renderAndExpectNoChanges( renderer, domRoot );
  325. // Step 3: <p><b>foo{}</b></p>
  326. selection.removeAllRanges();
  327. selection.addRange( ViewRange.createFromParentsAndOffsets(
  328. viewP.getChild( 0 ).getChild( 0 ), 3, viewP.getChild( 0 ).getChild( 0 ), 3 ) );
  329. renderer.render();
  330. expect( domP.childNodes.length ).to.equal( 1 );
  331. expect( domP.childNodes[ 0 ].tagName.toLowerCase() ).to.equal( 'b' );
  332. expect( domP.childNodes[ 0 ].childNodes.length ).to.equal( 1 );
  333. expect( domP.childNodes[ 0 ].childNodes[ 0 ].data ).to.equal( 'foo' );
  334. expect( domSelection.rangeCount ).to.equal( 1 );
  335. expect( domSelection.getRangeAt( 0 ).startContainer ).to.equal( domP.childNodes[ 0 ] .childNodes[ 0 ] );
  336. expect( domSelection.getRangeAt( 0 ).startOffset ).to.equal( 3 );
  337. expect( domSelection.getRangeAt( 0 ).collapsed ).to.be.true;
  338. // Step 4: No mutation on second render
  339. renderer.markToSync( 'children', viewP );
  340. renderAndExpectNoChanges( renderer, domRoot );
  341. } );
  342. it( 'should add and remove inline filler in case <p><b>foo</b>[]<b>bar</b></p>', () => {
  343. const domSelection = document.getSelection();
  344. const { view: viewP, selection: newSelection } = parse(
  345. '<container:p><attribute:b>foo</attribute:b>[]<attribute:b>bar</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( 3 );
  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( domP.childNodes[ 2 ].tagName.toLowerCase() ).to.equal( 'b' );
  357. expect( domP.childNodes[ 2 ].childNodes.length ).to.equal( 1 );
  358. expect( domP.childNodes[ 2 ].childNodes[ 0 ].data ).to.equal( 'bar' );
  359. expect( domSelection.rangeCount ).to.equal( 1 );
  360. expect( domSelection.getRangeAt( 0 ).startContainer ).to.equal( domP.childNodes[ 1 ] );
  361. expect( domSelection.getRangeAt( 0 ).startOffset ).to.equal( INLINE_FILLER_LENGTH );
  362. expect( domSelection.getRangeAt( 0 ).collapsed ).to.be.true;
  363. } );
  364. it( 'should move filler when selection is moved', () => {
  365. // Step 1: <p>foo<b>"FILLER{}"</b></p>
  366. const { view: viewP, selection: newSelection } = parse(
  367. '<container:p>foo<attribute:b>[]</attribute:b><attribute:i></attribute:i></container:p>' );
  368. viewRoot.appendChildren( viewP );
  369. selection.setTo( newSelection );
  370. renderer.markToSync( 'children', viewRoot );
  371. renderer.render();
  372. const domP = domRoot.childNodes[ 0 ];
  373. expect( domP.childNodes.length ).to.equal( 3 );
  374. expect( domP.childNodes[ 0 ].data ).to.equal( 'foo' );
  375. expect( domP.childNodes[ 1 ].tagName.toLowerCase() ).to.equal( 'b' );
  376. expect( domP.childNodes[ 1 ].childNodes.length ).to.equal( 1 );
  377. expect( domP.childNodes[ 1 ].childNodes[ 0 ].data ).to.equal( INLINE_FILLER );
  378. expect( domP.childNodes[ 2 ].tagName.toLowerCase() ).to.equal( 'i' );
  379. expect( domP.childNodes[ 2 ].childNodes.length ).to.equal( 0 );
  380. // Step 2: <p>foo<b></b><i>"FILLER{}"</i></p>
  381. selection.removeAllRanges();
  382. const viewI = viewP.getChild( 2 );
  383. selection.addRange( ViewRange.createFromParentsAndOffsets( viewI, 0, viewI, 0 ) );
  384. renderer.render();
  385. expect( domP.childNodes.length ).to.equal( 3 );
  386. expect( domP.childNodes[ 0 ].data ).to.equal( 'foo' );
  387. expect( domP.childNodes[ 1 ].tagName.toLowerCase() ).to.equal( 'b' );
  388. expect( domP.childNodes[ 1 ].childNodes.length ).to.equal( 0 );
  389. expect( domP.childNodes[ 2 ].tagName.toLowerCase() ).to.equal( 'i' );
  390. expect( domP.childNodes[ 2 ].childNodes.length ).to.equal( 1 );
  391. expect( domP.childNodes[ 2 ].childNodes[ 0 ].data ).to.equal( INLINE_FILLER );
  392. } );
  393. it( 'should remove filler when text is added and selection removed', () => {
  394. // Step 1: <p>foo<b>"FILLER{}"</b></p>
  395. const { view: viewP, selection: newSelection } = parse( '<container:p>foo<attribute:b>[]</attribute:b></container:p>' );
  396. const viewB = viewP.getChild( 1 );
  397. viewRoot.appendChildren( viewP );
  398. selection.setTo( newSelection );
  399. renderer.markToSync( 'children', viewRoot );
  400. renderer.render();
  401. const domP = domRoot.childNodes[ 0 ];
  402. expect( domP.childNodes.length ).to.equal( 2 );
  403. expect( domP.childNodes[ 0 ].data ).to.equal( 'foo' );
  404. expect( domP.childNodes[ 1 ].tagName.toLowerCase() ).to.equal( 'b' );
  405. expect( domP.childNodes[ 1 ].childNodes.length ).to.equal( 1 );
  406. expect( domP.childNodes[ 1 ].childNodes[ 0 ].data ).to.equal( INLINE_FILLER );
  407. // Step 2: Add text node.
  408. const viewText = new ViewText( 'x' );
  409. viewB.appendChildren( viewText );
  410. selection.removeAllRanges();
  411. selection.addRange( ViewRange.createFromParentsAndOffsets( viewText, 1, viewText, 1 ) );
  412. renderer.markToSync( 'children', viewB );
  413. renderer.render();
  414. // Step 3: Remove selection from the view.
  415. selection.removeAllRanges();
  416. renderer.render();
  417. expect( domP.childNodes.length ).to.equal( 2 );
  418. expect( domP.childNodes[ 0 ].data ).to.equal( 'foo' );
  419. expect( domP.childNodes[ 1 ].tagName.toLowerCase() ).to.equal( 'b' );
  420. expect( domP.childNodes[ 1 ].childNodes.length ).to.equal( 1 );
  421. expect( domP.childNodes[ 1 ].childNodes[ 0 ].data ).to.equal( 'x' );
  422. } );
  423. // #659
  424. // The element before the filler is removed so the position of the filler
  425. // cannot be remembered as parent+offset.
  426. it( 'should remove filler from a modified DOM in case <p>bar<b>foo</b>[]</p>', () => {
  427. // Step 1: <p>bar<b>foo</b>"FILLER{}"</p>
  428. const { view: viewP, selection: newSelection } = parse( '<container:p>bar<attribute:b>foo</attribute:b>[]</container:p>' );
  429. viewRoot.appendChildren( viewP );
  430. selection.setTo( newSelection );
  431. renderer.markToSync( 'children', viewRoot );
  432. renderer.render();
  433. const domP = domRoot.childNodes[ 0 ];
  434. expect( domP.childNodes.length ).to.equal( 3 );
  435. expect( domP.childNodes[ 2 ].data ).to.equal( INLINE_FILLER );
  436. // Step 2: Remove the <b> and update the selection (<p>bar[]</p>).
  437. viewP.removeChildren( 1 );
  438. selection.removeAllRanges();
  439. selection.addRange( ViewRange.createFromParentsAndOffsets( viewP, 1, viewP, 1 ) );
  440. renderer.markToSync( 'children', viewP );
  441. renderer.render();
  442. // Step 3: Check whether there's no filler in the DOM.
  443. expect( domP.childNodes.length ).to.equal( 1 );
  444. expect( domP.childNodes[ 0 ].data ).to.equal( 'bar' );
  445. } );
  446. // #659
  447. it( 'should remove filler from a modified DOM when children moved', () => {
  448. // Step 1: <p><b>foo</b>"FILLER{}"<b>bar</b></p><p></p>
  449. const { view: viewFragment, selection: newSelection }
  450. = parse( '<container:p><attribute:b>foo</attribute:b>[]<attribute:b>bar</attribute:b></container:p><container:p></container:p>' );
  451. viewRoot.appendChildren( viewFragment );
  452. selection.setTo( newSelection );
  453. renderer.markToSync( 'children', viewRoot );
  454. renderer.render();
  455. expect( domRoot.childNodes.length ).to.equal( 2 );
  456. const domP = domRoot.childNodes[ 0 ];
  457. const domP2 = domRoot.childNodes[ 1 ];
  458. expect( domP.childNodes.length ).to.equal( 3 );
  459. expect( domP.childNodes[ 1 ].data ).to.equal( INLINE_FILLER );
  460. // Step 2: Move <b>foo</b><b>bar</b> to the second paragraph and leave collapsed selection in the first one.
  461. // <p>[]</p><p><b>foo</b><b>bar</b></p>
  462. const viewP = viewRoot.getChild( 0 );
  463. const viewP2 = viewRoot.getChild( 1 );
  464. const removedChildren = viewP.removeChildren( 0, 2 );
  465. viewP2.appendChildren( removedChildren );
  466. selection.removeAllRanges();
  467. selection.addRange( ViewRange.createFromParentsAndOffsets( viewP, 0, viewP, 0 ) );
  468. renderer.markToSync( 'children', viewP );
  469. renderer.markToSync( 'children', viewP2 );
  470. renderer.render();
  471. // Step 3: Check whether in the first paragraph there's a <br> filler and that
  472. // in the second one there are two <b> tags.
  473. expect( domP.childNodes.length ).to.equal( 1 );
  474. expect( isBlockFiller( domP.childNodes[ 0 ], BR_FILLER ) ).to.be.true;
  475. expect( domP2.childNodes.length ).to.equal( 2 );
  476. expect( domP2.childNodes[ 0 ].tagName.toLowerCase() ).to.equal( 'b' );
  477. expect( domP2.childNodes[ 1 ].tagName.toLowerCase() ).to.equal( 'b' );
  478. } );
  479. // Test for an edge case in the _isSelectionInInlineFiller which can be triggered like
  480. // in one of ckeditor/ckeditor5-typing#59 automated tests.
  481. it( 'should not break when selection is moved to a new element, when filler exists', () => {
  482. // Step 1: <p>bar<b>"FILLER{}"</b></p>
  483. const { view: viewP, selection: newSelection } = parse( '<container:p>bar<attribute:b>[]</attribute:b></container:p>' );
  484. viewRoot.appendChildren( viewP );
  485. selection.setTo( newSelection );
  486. renderer.markToSync( 'children', viewRoot );
  487. renderer.render();
  488. const domP = domRoot.childNodes[ 0 ];
  489. expect( domP.childNodes.length ).to.equal( 2 );
  490. expect( domP.childNodes[ 1 ].childNodes[ 0 ].data ).to.equal( INLINE_FILLER );
  491. // Step 2: Move selection to a new attribute element and remove the previous one
  492. viewP.removeChildren( 1 ); // Remove <b>.
  493. const viewI = parse( '<attribute:i></attribute:i>' );
  494. viewP.appendChildren( viewI );
  495. selection.removeAllRanges();
  496. selection.addRange( ViewRange.createFromParentsAndOffsets( viewI, 0, viewI, 0 ) );
  497. renderer.markToSync( 'children', viewP );
  498. renderer.render();
  499. // Step 3: Check whether new filler was created in the <i> element.
  500. expect( domP.childNodes.length ).to.equal( 2 );
  501. expect( domP.childNodes[ 1 ].tagName.toLowerCase() ).to.equal( 'i' );
  502. expect( domP.childNodes[ 1 ].childNodes[ 0 ].data ).to.equal( INLINE_FILLER );
  503. } );
  504. // Test for an edge case in the _isSelectionInInlineFiller, when selection is before a view element
  505. // that has not been yet rendered/bound to DOM.
  506. it( 'should remove inline filler if selection is before a view element not bound to dom', () => {
  507. // Step 1: <p>bar<b>abc</b>"FILLER"{}</p>
  508. const { view: viewP, selection: newSelection } = parse( '<container:p>bar<attribute:b>abc</attribute:b>[]</container:p>' );
  509. viewRoot.appendChildren( viewP );
  510. selection.setTo( newSelection );
  511. renderer.markToSync( 'children', viewRoot );
  512. renderer.render();
  513. const domP = domRoot.childNodes[ 0 ];
  514. expect( domP.childNodes.length ).to.equal( 3 );
  515. expect( domP.childNodes[ 2 ].data ).to.equal( INLINE_FILLER );
  516. // Step 2: Move selection to a new attribute element.
  517. const viewAbc = parse( 'abc' );
  518. viewP.appendChildren( viewAbc );
  519. selection.removeAllRanges();
  520. selection.addRange( ViewRange.createFromParentsAndOffsets( viewP, 3, viewP, 3 ) );
  521. renderer.markToSync( 'children', viewP );
  522. renderer.render();
  523. // Step 3: Check whether old filler was removed.
  524. expect( domP.childNodes.length ).to.equal( 3 );
  525. expect( domP.textContent.indexOf( INLINE_FILLER ) ).to.equal( -1 );
  526. } );
  527. it( 'should handle typing in empty block, do nothing if changes are already applied', () => {
  528. const domSelection = document.getSelection();
  529. const { view: viewP, selection: newSelection } = parse( '<container:p>[]</container:p>' );
  530. viewRoot.appendChildren( viewP );
  531. selection.setTo( newSelection );
  532. renderer.markToSync( 'children', viewRoot );
  533. renderer.render();
  534. const domP = domRoot.childNodes[ 0 ];
  535. expect( domP.childNodes.length ).to.equal( 1 );
  536. expect( isBlockFiller( domP.childNodes[ 0 ], BR_FILLER ) ).to.be.true;
  537. expect( domSelection.rangeCount ).to.equal( 1 );
  538. expect( domSelection.getRangeAt( 0 ).startContainer ).to.equal( domP );
  539. expect( domSelection.getRangeAt( 0 ).startOffset ).to.equal( 0 );
  540. expect( domSelection.getRangeAt( 0 ).collapsed ).to.be.true;
  541. // Remove filler and add text node to both DOM and View <p>x{}</p>
  542. domP.removeChild( domP.childNodes[ 0 ] );
  543. domP.appendChild( document.createTextNode( 'x' ) );
  544. domSelection.removeAllRanges();
  545. const domRange = new Range();
  546. domRange.setStart( domP.childNodes[ 0 ], 1 );
  547. domRange.collapse( true );
  548. domSelection.addRange( domRange );
  549. const viewText = new ViewText( 'x' );
  550. viewP.appendChildren( viewText );
  551. selection.removeAllRanges();
  552. selection.addRange( ViewRange.createFromParentsAndOffsets( viewText, 1, viewText, 1 ) );
  553. renderer.markToSync( 'children', viewP );
  554. renderAndExpectNoChanges( renderer, domRoot );
  555. } );
  556. it( 'should handle typing in empty block, render if needed', () => {
  557. const domSelection = document.getSelection();
  558. const { view: viewP, selection: newSelection } = parse( '<container:p>[]</container:p>' );
  559. viewRoot.appendChildren( viewP );
  560. selection.setTo( newSelection );
  561. renderer.markToSync( 'children', viewRoot );
  562. renderer.render();
  563. const domP = domRoot.childNodes[ 0 ];
  564. expect( domP.childNodes.length ).to.equal( 1 );
  565. expect( isBlockFiller( domP.childNodes[ 0 ], BR_FILLER ) ).to.be.true;
  566. expect( domSelection.rangeCount ).to.equal( 1 );
  567. expect( domSelection.getRangeAt( 0 ).startContainer ).to.equal( domP );
  568. expect( domSelection.getRangeAt( 0 ).startOffset ).to.equal( 0 );
  569. expect( domSelection.getRangeAt( 0 ).collapsed ).to.be.true;
  570. // Add text node only in View <p>x{}</p>
  571. const viewText = new ViewText( 'x' );
  572. viewP.appendChildren( viewText );
  573. selection.removeAllRanges();
  574. selection.addRange( ViewRange.createFromParentsAndOffsets( viewText, 1, viewText, 1 ) );
  575. renderer.markToSync( 'children', viewP );
  576. renderer.render();
  577. expect( domP.childNodes.length ).to.equal( 1 );
  578. expect( domP.childNodes[ 0 ].data ).to.equal( 'x' );
  579. expect( domSelection.rangeCount ).to.equal( 1 );
  580. expect( domSelection.getRangeAt( 0 ).startContainer ).to.equal( domP.childNodes[ 0 ] );
  581. expect( domSelection.getRangeAt( 0 ).startOffset ).to.equal( 1 );
  582. expect( domSelection.getRangeAt( 0 ).collapsed ).to.be.true;
  583. } );
  584. it( 'should handle removing last character', () => {
  585. const domSelection = document.getSelection();
  586. const { view: viewP, selection: newSelection } = parse( '<container:p>x{}</container:p>' );
  587. viewRoot.appendChildren( viewP );
  588. selection.setTo( newSelection );
  589. renderer.markToSync( 'children', viewRoot );
  590. renderer.render();
  591. const domP = domRoot.childNodes[ 0 ];
  592. expect( domP.childNodes.length ).to.equal( 1 );
  593. expect( domP.childNodes[ 0 ].data ).to.equal( 'x' );
  594. expect( domSelection.rangeCount ).to.equal( 1 );
  595. expect( domSelection.getRangeAt( 0 ).startContainer ).to.equal( domP.childNodes[ 0 ] );
  596. expect( domSelection.getRangeAt( 0 ).startOffset ).to.equal( 1 );
  597. expect( domSelection.getRangeAt( 0 ).collapsed ).to.be.true;
  598. // Remove text and add filler to both DOM and View <p>{}</p>
  599. domP.removeChild( domP.childNodes[ 0 ] );
  600. domP.appendChild( BR_FILLER( document ) );
  601. domSelection.removeAllRanges();
  602. const domRange = new Range();
  603. domRange.setStart( domP.childNodes[ 0 ], 0 );
  604. domRange.collapse( true );
  605. domSelection.addRange( domRange );
  606. viewP.removeChildren( 0 );
  607. selection.removeAllRanges();
  608. selection.addRange( ViewRange.createFromParentsAndOffsets( viewP, 0, viewP, 0 ) );
  609. renderer.markToSync( 'children', viewP );
  610. renderAndExpectNoChanges( renderer, domRoot );
  611. } );
  612. it( 'should handle typing in empty attribute, do nothing if changes are already applied', () => {
  613. const domSelection = document.getSelection();
  614. // 1. Render <p><b>FILLER{}</b>foo</p>.
  615. const { view: viewP, selection: newSelection } = parse(
  616. '<container:p><attribute:b>[]</attribute:b>foo</container:p>' );
  617. viewRoot.appendChildren( viewP );
  618. selection.setTo( newSelection );
  619. renderer.markToSync( 'children', viewRoot );
  620. renderer.render();
  621. // 2. Check the DOM.
  622. const domP = domRoot.childNodes[ 0 ];
  623. expect( domP.childNodes.length ).to.equal( 2 );
  624. expect( domP.childNodes[ 0 ].tagName.toLowerCase() ).to.equal( 'b' );
  625. expect( domP.childNodes[ 1 ].data ).to.equal( 'foo' );
  626. const domB = domP.childNodes[ 0 ];
  627. const viewB = viewP.getChild( 0 );
  628. expect( domB.childNodes.length ).to.equal( 1 );
  629. expect( domB.childNodes[ 0 ].data ).to.equal( INLINE_FILLER );
  630. expect( domSelection.rangeCount ).to.equal( 1 );
  631. expect( domSelection.getRangeAt( 0 ).startContainer ).to.equal( domB.childNodes[ 0 ] );
  632. expect( domSelection.getRangeAt( 0 ).startOffset ).to.equal( INLINE_FILLER_LENGTH );
  633. expect( domSelection.getRangeAt( 0 ).collapsed ).to.be.true;
  634. // 3. Add text node to both the DOM and the view: <p><b>FILLERx</b>foo</p>.
  635. domB.childNodes[ 0 ].data += 'x';
  636. domSelection.removeAllRanges();
  637. const domRange = new Range();
  638. domRange.setStart( domB.childNodes[ 0 ], INLINE_FILLER_LENGTH + 1 );
  639. domRange.collapse( true );
  640. domSelection.addRange( domRange );
  641. const viewText = new ViewText( 'x' );
  642. viewB.appendChildren( viewText );
  643. selection.removeAllRanges();
  644. selection.addRange( ViewRange.createFromParentsAndOffsets( viewText, 1, viewText, 1 ) );
  645. renderer.markToSync( 'children', viewP );
  646. renderAndExpectNoChanges( renderer, domRoot );
  647. } );
  648. it( 'should handle typing in empty attribute as a children change, render if needed', () => {
  649. const domSelection = document.getSelection();
  650. // 1. Render <p><b>FILLER{}</b>foo</p>.
  651. const { view: viewP, selection: newSelection } = parse(
  652. '<container:p><attribute:b>[]</attribute:b>foo</container:p>' );
  653. viewRoot.appendChildren( viewP );
  654. selection.setTo( newSelection );
  655. renderer.markToSync( 'children', viewRoot );
  656. renderer.render();
  657. // 2. Check the DOM.
  658. const domP = domRoot.childNodes[ 0 ];
  659. expect( domP.childNodes.length ).to.equal( 2 );
  660. expect( domP.childNodes[ 0 ].tagName.toLowerCase() ).to.equal( 'b' );
  661. expect( domP.childNodes[ 1 ].data ).to.equal( 'foo' );
  662. const domB = domP.childNodes[ 0 ];
  663. const viewB = viewP.getChild( 0 );
  664. expect( domB.childNodes.length ).to.equal( 1 );
  665. expect( domB.childNodes[ 0 ].data ).to.equal( INLINE_FILLER );
  666. expect( domSelection.rangeCount ).to.equal( 1 );
  667. expect( domSelection.getRangeAt( 0 ).startContainer ).to.equal( domB.childNodes[ 0 ] );
  668. expect( domSelection.getRangeAt( 0 ).startOffset ).to.equal( INLINE_FILLER_LENGTH );
  669. expect( domSelection.getRangeAt( 0 ).collapsed ).to.be.true;
  670. // 3. Add text node only to the view: <p><b>x{}</b>foo</p>.
  671. const viewText = new ViewText( 'x' );
  672. viewB.appendChildren( viewText );
  673. selection.removeAllRanges();
  674. selection.addRange( ViewRange.createFromParentsAndOffsets( viewText, 1, viewText, 1 ) );
  675. renderer.markToSync( 'children', viewB );
  676. renderer.render();
  677. expect( domB.childNodes.length ).to.equal( 1 );
  678. expect( domB.childNodes[ 0 ].data ).to.equal( INLINE_FILLER + 'x' );
  679. expect( domSelection.rangeCount ).to.equal( 1 );
  680. expect( domSelection.getRangeAt( 0 ).startContainer ).to.equal( domB.childNodes[ 0 ] );
  681. expect( domSelection.getRangeAt( 0 ).startOffset ).to.equal( INLINE_FILLER_LENGTH + 1 );
  682. expect( domSelection.getRangeAt( 0 ).collapsed ).to.be.true;
  683. } );
  684. it( 'should handle typing in empty attribute as a text change, render if needed', () => {
  685. const domSelection = document.getSelection();
  686. // 1. Render <p><b>FILLER{}</b>foo</p>.
  687. const { view: viewP, selection: newSelection } = parse(
  688. '<container:p><attribute:b>[]</attribute:b>foo</container:p>' );
  689. viewRoot.appendChildren( viewP );
  690. selection.setTo( newSelection );
  691. renderer.markToSync( 'children', viewRoot );
  692. renderer.render();
  693. // 2. Check the DOM.
  694. const domP = domRoot.childNodes[ 0 ];
  695. expect( domP.childNodes.length ).to.equal( 2 );
  696. expect( domP.childNodes[ 0 ].tagName.toLowerCase() ).to.equal( 'b' );
  697. expect( domP.childNodes[ 1 ].data ).to.equal( 'foo' );
  698. const domB = domP.childNodes[ 0 ];
  699. const viewB = viewP.getChild( 0 );
  700. expect( domB.childNodes.length ).to.equal( 1 );
  701. expect( domB.childNodes[ 0 ].data ).to.equal( INLINE_FILLER );
  702. expect( domSelection.rangeCount ).to.equal( 1 );
  703. expect( domSelection.getRangeAt( 0 ).startContainer ).to.equal( domB.childNodes[ 0 ] );
  704. expect( domSelection.getRangeAt( 0 ).startOffset ).to.equal( INLINE_FILLER_LENGTH );
  705. expect( domSelection.getRangeAt( 0 ).collapsed ).to.be.true;
  706. // 3. Add text node only to the view: <p><b>x{}</b>foo</p>.
  707. const viewText = new ViewText( 'x' );
  708. viewB.appendChildren( viewText );
  709. selection.removeAllRanges();
  710. selection.addRange( ViewRange.createFromParentsAndOffsets( viewText, 1, viewText, 1 ) );
  711. renderer.markToSync( 'text', viewText );
  712. renderer.render();
  713. // 4. Check the DOM.
  714. expect( domB.childNodes.length ).to.equal( 1 );
  715. expect( domB.childNodes[ 0 ].data ).to.equal( INLINE_FILLER + 'x' );
  716. expect( domSelection.rangeCount ).to.equal( 1 );
  717. expect( domSelection.getRangeAt( 0 ).startContainer ).to.equal( domB.childNodes[ 0 ] );
  718. expect( domSelection.getRangeAt( 0 ).startOffset ).to.equal( INLINE_FILLER_LENGTH + 1 );
  719. expect( domSelection.getRangeAt( 0 ).collapsed ).to.be.true;
  720. } );
  721. it( 'should handle not collapsed range', () => {
  722. const domSelection = document.getSelection();
  723. const { view: viewP, selection: newSelection } = parse(
  724. '<container:p>fo{o<attribute:b>b}ar</attribute:b></container:p>' );
  725. viewRoot.appendChildren( viewP );
  726. selection.setTo( newSelection );
  727. renderer.markToSync( 'children', viewRoot );
  728. renderer.render();
  729. const domP = domRoot.childNodes[ 0 ];
  730. expect( domP.childNodes.length ).to.equal( 2 );
  731. expect( domP.childNodes[ 0 ].data ).to.equal( 'foo' );
  732. expect( domP.childNodes[ 1 ].tagName.toLowerCase() ).to.equal( 'b' );
  733. expect( domP.childNodes[ 1 ].childNodes.length ).to.equal( 1 );
  734. expect( domP.childNodes[ 1 ].childNodes[ 0 ].data ).to.equal( 'bar' );
  735. expect( domSelection.rangeCount ).to.equal( 1 );
  736. expect( domSelection.getRangeAt( 0 ).startContainer ).to.equal( domP.childNodes[ 0 ] );
  737. expect( domSelection.getRangeAt( 0 ).startOffset ).to.equal( 2 );
  738. expect( domSelection.getRangeAt( 0 ).endContainer ).to.equal( domP.childNodes[ 1 ].childNodes[ 0 ] );
  739. expect( domSelection.getRangeAt( 0 ).endOffset ).to.equal( 1 );
  740. renderer.markToSync( 'children', viewP );
  741. renderAndExpectNoChanges( renderer, domRoot );
  742. } );
  743. it( 'should not change selection if there is no editable with selection', () => {
  744. const domDiv = createElement( document, 'div', null, 'not editable' );
  745. document.body.appendChild( domDiv );
  746. const domSelection = document.getSelection();
  747. domSelection.removeAllRanges();
  748. const domRange = new Range();
  749. domRange.setStart( domDiv, 0 );
  750. domRange.collapse( true );
  751. domSelection.addRange( domRange );
  752. selectionEditable = null;
  753. const { view: viewP, selection: newSelection } = parse( '<container:p>fo{o}</container:p>' );
  754. viewRoot.appendChildren( viewP );
  755. selection.setTo( newSelection );
  756. renderer.render();
  757. expect( domSelection.rangeCount ).to.equal( 1 );
  758. expect( domSelection.getRangeAt( 0 ).startContainer ).to.equal( domDiv );
  759. expect( domSelection.getRangeAt( 0 ).startOffset ).to.equal( 0 );
  760. expect( domSelection.getRangeAt( 0 ).collapsed ).to.equal( true );
  761. } );
  762. it( 'should not change selection if there is no focus', () => {
  763. const domDiv = createElement( document, 'div', null, 'not editable' );
  764. document.body.appendChild( domDiv );
  765. const domSelection = document.getSelection();
  766. domSelection.removeAllRanges();
  767. const domRange = new Range();
  768. domRange.setStart( domDiv, 0 );
  769. domRange.collapse( true );
  770. domSelection.addRange( domRange );
  771. renderer.isFocused = false;
  772. const { view: viewP, selection: newSelection } = parse( '<container:p>fo{o}</container:p>' );
  773. viewRoot.appendChildren( viewP );
  774. selection.setTo( newSelection );
  775. renderer.render();
  776. expect( domSelection.rangeCount ).to.equal( 1 );
  777. expect( domSelection.getRangeAt( 0 ).startContainer ).to.equal( domDiv );
  778. expect( domSelection.getRangeAt( 0 ).startOffset ).to.equal( 0 );
  779. expect( domSelection.getRangeAt( 0 ).collapsed ).to.equal( true );
  780. } );
  781. it( 'should not add inline filler after text node', () => {
  782. const { view: viewP, selection: newSelection } = parse( '<container:p>foo[]</container:p>' );
  783. viewRoot.appendChildren( viewP );
  784. selection.setTo( newSelection );
  785. renderer.markToSync( 'children', viewRoot );
  786. renderer.render();
  787. const domP = domRoot.childNodes[ 0 ];
  788. expect( domP.innerHTML.indexOf( INLINE_FILLER ) ).to.equal( -1 );
  789. } );
  790. it( 'should throw if there is no filler in expected position', () => {
  791. const { view: viewP, selection: newSelection } = parse(
  792. '<container:p>foo<attribute:b>[]</attribute:b>bar</container:p>' );
  793. viewRoot.appendChildren( viewP );
  794. selection.setTo( newSelection );
  795. renderer.markToSync( 'children', viewRoot );
  796. renderer.render();
  797. const domB = domRoot.childNodes[ 0 ].childNodes[ 1 ];
  798. const viewB = viewP.getChild( 1 );
  799. expect( domB.childNodes[ 0 ].data ).to.equal( INLINE_FILLER );
  800. // Remove filler.
  801. domB.childNodes[ 0 ].data = '';
  802. selection.removeAllRanges();
  803. renderer.markToSync( 'children', viewB );
  804. expect( () => {
  805. renderer.render();
  806. } ).to.throw( CKEditorError, /^view-renderer-filler-was-lost/ );
  807. } );
  808. it( 'should handle focusing element', () => {
  809. const domFocusSpy = testUtils.sinon.spy( domRoot, 'focus' );
  810. const editable = selection.editableElement;
  811. renderer.render();
  812. expect( editable ).to.equal( viewRoot );
  813. expect( domFocusSpy.calledOnce ).to.be.true;
  814. } );
  815. it( 'should not focus editable if isFocues is set to false', () => {
  816. const domFocusSpy = testUtils.sinon.spy( domRoot, 'focus' );
  817. renderer.isFocused = false;
  818. renderer.render();
  819. expect( domFocusSpy.calledOnce ).to.be.false;
  820. } );
  821. it( 'should not focus already focused DOM element', () => {
  822. domRoot.setAttribute( 'contentEditable', true );
  823. domRoot.focus();
  824. const domFocusSpy = testUtils.sinon.spy( domRoot, 'focus' );
  825. renderer.render();
  826. expect( domFocusSpy.called ).to.be.false;
  827. } );
  828. describe( 'fake selection', () => {
  829. beforeEach( () => {
  830. const { view: viewP, selection: newSelection } = parse(
  831. '<container:p>[foo bar]</container:p>'
  832. );
  833. viewRoot.appendChildren( viewP );
  834. selection.setTo( newSelection );
  835. renderer.markToSync( 'children', viewRoot );
  836. renderer.render();
  837. } );
  838. it( 'should render fake selection', () => {
  839. const label = 'fake selection label';
  840. selection.setFake( true, { label } );
  841. renderer.render();
  842. expect( domRoot.childNodes.length ).to.equal( 2 );
  843. const container = domRoot.childNodes[ 1 ];
  844. expect( domConverter.getCorrespondingViewElement( container ) ).to.be.undefined;
  845. expect( container.childNodes.length ).to.equal( 1 );
  846. const textNode = container.childNodes[ 0 ];
  847. expect( textNode.textContent ).to.equal( label );
  848. const domSelection = domRoot.ownerDocument.getSelection();
  849. expect( domSelection.anchorNode ).to.equal( textNode );
  850. expect( domSelection.anchorOffset ).to.equal( 0 );
  851. expect( domSelection.focusNode ).to.equal( textNode );
  852. expect( domSelection.focusOffset ).to.equal( label.length );
  853. } );
  854. it( 'should render &nbsp; if no selection label is provided', () => {
  855. selection.setFake( true );
  856. renderer.render();
  857. expect( domRoot.childNodes.length ).to.equal( 2 );
  858. const container = domRoot.childNodes[ 1 ];
  859. expect( container.childNodes.length ).to.equal( 1 );
  860. const textNode = container.childNodes[ 0 ];
  861. expect( textNode.textContent ).to.equal( '\u00A0' );
  862. const domSelection = domRoot.ownerDocument.getSelection();
  863. expect( domSelection.anchorNode ).to.equal( textNode );
  864. expect( domSelection.anchorOffset ).to.equal( 0 );
  865. expect( domSelection.focusNode ).to.equal( textNode );
  866. expect( domSelection.focusOffset ).to.equal( 1 );
  867. } );
  868. it( 'should remove fake selection container when selection is no longer fake', () => {
  869. selection.setFake( true );
  870. renderer.render();
  871. selection.setFake( false );
  872. renderer.render();
  873. expect( domRoot.childNodes.length ).to.equal( 1 );
  874. const domParagraph = domRoot.childNodes[ 0 ];
  875. expect( domParagraph.childNodes.length ).to.equal( 1 );
  876. const textNode = domParagraph.childNodes[ 0 ];
  877. expect( domParagraph.tagName.toLowerCase() ).to.equal( 'p' );
  878. const domSelection = domRoot.ownerDocument.getSelection();
  879. expect( domSelection.anchorNode ).to.equal( textNode );
  880. expect( domSelection.anchorOffset ).to.equal( 0 );
  881. expect( domSelection.focusNode ).to.equal( textNode );
  882. expect( domSelection.focusOffset ).to.equal( 7 );
  883. } );
  884. it( 'should reuse fake selection container #1', () => {
  885. const label = 'fake selection label';
  886. selection.setFake( true, { label } );
  887. renderer.render();
  888. expect( domRoot.childNodes.length ).to.equal( 2 );
  889. const container = domRoot.childNodes[ 1 ];
  890. selection.setFake( true, { label } );
  891. renderer.render();
  892. expect( domRoot.childNodes.length ).to.equal( 2 );
  893. const newContainer = domRoot.childNodes[ 1 ];
  894. expect( newContainer ).equals( container );
  895. expect( newContainer.childNodes.length ).to.equal( 1 );
  896. const textNode = newContainer.childNodes[ 0 ];
  897. expect( textNode.textContent ).to.equal( label );
  898. } );
  899. it( 'should reuse fake selection container #2', () => {
  900. selection.setFake( true, { label: 'label 1' } );
  901. renderer.render();
  902. expect( domRoot.childNodes.length ).to.equal( 2 );
  903. const container = domRoot.childNodes[ 1 ];
  904. selection.setFake( false );
  905. renderer.render();
  906. expect( domRoot.childNodes.length ).to.equal( 1 );
  907. selection.setFake( true, { label: 'label 2' } );
  908. renderer.render();
  909. expect( domRoot.childNodes.length ).to.equal( 2 );
  910. const newContainer = domRoot.childNodes[ 1 ];
  911. expect( newContainer ).equals( container );
  912. expect( newContainer.childNodes.length ).to.equal( 1 );
  913. const textNode = newContainer.childNodes[ 0 ];
  914. expect( textNode.textContent ).to.equal( 'label 2' );
  915. } );
  916. it( 'should reuse fake selection container #3', () => {
  917. selection.setFake( true, { label: 'label 1' } );
  918. renderer.render();
  919. expect( domRoot.childNodes.length ).to.equal( 2 );
  920. const container = domRoot.childNodes[ 1 ];
  921. selection.setFake( true, { label: 'label 2' } );
  922. renderer.render();
  923. expect( domRoot.childNodes.length ).to.equal( 2 );
  924. const newContainer = domRoot.childNodes[ 1 ];
  925. expect( newContainer ).equals( container );
  926. expect( newContainer.childNodes.length ).to.equal( 1 );
  927. const textNode = newContainer.childNodes[ 0 ];
  928. expect( textNode.textContent ).to.equal( 'label 2' );
  929. } );
  930. it( 'should style fake selection container properly', () => {
  931. selection.setFake( true, { label: 'fake selection' } );
  932. renderer.render();
  933. expect( domRoot.childNodes.length ).to.equal( 2 );
  934. const container = domRoot.childNodes[ 1 ];
  935. expect( container.style.position ).to.equal( 'fixed' );
  936. expect( container.style.top ).to.equal( '0px' );
  937. expect( container.style.left ).to.equal( '-9999px' );
  938. } );
  939. it( 'should bind fake selection container to view selection', () => {
  940. selection.setFake( true, { label: 'fake selection' } );
  941. renderer.render();
  942. expect( domRoot.childNodes.length ).to.equal( 2 );
  943. const container = domRoot.childNodes[ 1 ];
  944. const bindSelection = renderer.domConverter.fakeSelectionToView( container );
  945. expect( bindSelection ).to.be.defined;
  946. expect( bindSelection.isEqual( selection ) ).to.be.true;
  947. } );
  948. } );
  949. } );
  950. } );
  951. function renderAndExpectNoChanges( renderer, domRoot ) {
  952. const config = {
  953. childList: true,
  954. characterData: true,
  955. characterDataOldValue: true,
  956. subtree: true
  957. };
  958. const mutationObserver = new window.MutationObserver( () => {
  959. throw 'There should be not mutations';
  960. } );
  961. mutationObserver.observe( domRoot, config );
  962. renderer.render();
  963. const records = mutationObserver.takeRecords();
  964. mutationObserver.disconnect();
  965. expect( records.length ).to.equal( 0 );
  966. }