renderer.js 46 KB

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