8
0

renderer.js 71 KB

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