renderer.js 72 KB

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