renderer.js 70 KB

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