8
0

renderer.js 73 KB

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