renderer.js 70 KB

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