renderer.js 73 KB

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