8
0

renderer.js 72 KB

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