renderer.js 71 KB

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