renderer.js 29 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829
  1. /**
  2. * @license Copyright (c) 2003-2015, CKSource - Frederico Knabben. All rights reserved.
  3. * For licensing, see LICENSE.md.
  4. */
  5. /* bender-tags: treeview, browser-only */
  6. 'use strict';
  7. import ViewElement from '/ckeditor5/engine/treeview/element.js';
  8. import ViewText from '/ckeditor5/engine/treeview/text.js';
  9. import ViewRange from '/ckeditor5/engine/treeview/range.js';
  10. import Selection from '/ckeditor5/engine/treeview/selection.js';
  11. import DomConverter from '/ckeditor5/engine/treeview/domconverter.js';
  12. import Renderer from '/ckeditor5/engine/treeview/renderer.js';
  13. import CKEditorError from '/ckeditor5/utils/ckeditorerror.js';
  14. import { parse } from '/tests/engine/_utils/view.js';
  15. import { INLINE_FILLER, INLINE_FILLER_LENGTH, isBlockFiller, BR_FILLER } from '/ckeditor5/engine/treeview/filler.js';
  16. describe( 'Renderer', () => {
  17. let selection, domConverter, renderer;
  18. before( () => {
  19. selection = new Selection();
  20. domConverter = new DomConverter();
  21. renderer = new Renderer( domConverter, selection );
  22. } );
  23. describe( 'markToSync', () => {
  24. let viewRoot;
  25. beforeEach( () => {
  26. viewRoot = new ViewElement( 'p' );
  27. const domRoot = document.createElement( 'p' );
  28. domConverter.bindElements( domRoot, viewRoot );
  29. viewRoot.appendChildren( new ViewText( 'foo' ) );
  30. renderer.markedTexts.clear();
  31. renderer.markedAttributes.clear();
  32. renderer.markedChildren.clear();
  33. } );
  34. it( 'should mark attributes which need update', () => {
  35. viewRoot.setAttribute( 'class', 'foo' );
  36. renderer.markToSync( 'ATTRIBUTES', viewRoot );
  37. expect( renderer.markedAttributes.has( viewRoot ) ).to.be.true;
  38. } );
  39. it( 'should mark children which need update', () => {
  40. viewRoot.appendChildren( new ViewText( 'foo' ) );
  41. renderer.markToSync( 'CHILDREN', viewRoot );
  42. expect( renderer.markedChildren.has( viewRoot ) ).to.be.true;
  43. } );
  44. it( 'should not mark children if element has no corresponding node', () => {
  45. // Overwrite viewRoot with node without coresponding DOM node.
  46. viewRoot = new ViewElement( 'p' );
  47. viewRoot.appendChildren( new ViewText( 'foo' ) );
  48. renderer.markToSync( 'CHILDREN', viewRoot );
  49. expect( renderer.markedTexts.has( viewRoot ) ).to.be.false;
  50. } );
  51. it( 'should mark text which need update', () => {
  52. const viewText = new ViewText( 'foo' );
  53. viewRoot.appendChildren( viewText );
  54. viewText.data = 'bar';
  55. renderer.markToSync( 'TEXT', viewText );
  56. expect( renderer.markedTexts.has( viewText ) ).to.be.true;
  57. } );
  58. it( 'should not mark text if parent has no corresponding node', () => {
  59. const viewText = new ViewText( 'foo' );
  60. // Overwrite viewRoot with node without coresponding DOM node.
  61. viewRoot = new ViewElement( 'p' );
  62. viewRoot.appendChildren( viewText );
  63. viewText.data = 'bar';
  64. renderer.markToSync( 'TEXT', viewText );
  65. expect( renderer.markedTexts.has( viewText ) ).to.be.false;
  66. } );
  67. it( 'should throw if the type is unknown', () => {
  68. expect( () => {
  69. renderer.markToSync( 'UNKNOWN', viewRoot );
  70. } ).to.throw( CKEditorError, /^renderer-unknown-type/ );
  71. } );
  72. } );
  73. describe( 'render', () => {
  74. let viewRoot, domRoot;
  75. beforeEach( () => {
  76. viewRoot = new ViewElement( 'div' );
  77. domRoot = document.createElement( 'div' );
  78. document.body.appendChild( domRoot );
  79. domConverter.bindElements( domRoot, viewRoot );
  80. renderer.markedTexts.clear();
  81. renderer.markedAttributes.clear();
  82. renderer.markedChildren.clear();
  83. selection.removeAllRanges();
  84. } );
  85. it( 'should update attributes', () => {
  86. viewRoot.setAttribute( 'class', 'foo' );
  87. renderer.markToSync( 'ATTRIBUTES', viewRoot );
  88. renderer.render();
  89. expect( domRoot.getAttribute( 'class' ) ).to.equal( 'foo' );
  90. expect( renderer.markedAttributes.size ).to.equal( 0 );
  91. } );
  92. it( 'should remove attributes', () => {
  93. viewRoot.setAttribute( 'class', 'foo' );
  94. domRoot.setAttribute( 'id', 'bar' );
  95. domRoot.setAttribute( 'class', 'bar' );
  96. renderer.markToSync( 'ATTRIBUTES', viewRoot );
  97. renderer.render();
  98. expect( domRoot.getAttribute( 'class' ) ).to.equal( 'foo' );
  99. expect( domRoot.getAttribute( 'id' ) ).to.be.not.ok;
  100. expect( renderer.markedAttributes.size ).to.equal( 0 );
  101. } );
  102. it( 'should add children', () => {
  103. viewRoot.appendChildren( new ViewText( 'foo' ) );
  104. renderer.markToSync( 'CHILDREN', viewRoot );
  105. renderer.render();
  106. expect( domRoot.childNodes.length ).to.equal( 1 );
  107. expect( domRoot.childNodes[ 0 ].data ).to.equal( 'foo' );
  108. expect( renderer.markedChildren.size ).to.equal( 0 );
  109. } );
  110. it( 'should remove children', () => {
  111. viewRoot.appendChildren( new ViewText( 'foo' ) );
  112. renderer.markToSync( 'CHILDREN', viewRoot );
  113. renderer.render();
  114. expect( domRoot.childNodes.length ).to.equal( 1 );
  115. expect( domRoot.childNodes[ 0 ].data ).to.equal( 'foo' );
  116. viewRoot.removeChildren( 0, 1 );
  117. renderer.markToSync( 'CHILDREN', viewRoot );
  118. renderer.render();
  119. expect( domRoot.childNodes.length ).to.equal( 0 );
  120. expect( renderer.markedChildren.size ).to.equal( 0 );
  121. } );
  122. it( 'should update text', () => {
  123. const viewText = new ViewText( 'foo' );
  124. viewRoot.appendChildren( viewText );
  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. viewText.data = 'bar';
  130. renderer.markToSync( 'TEXT', viewText );
  131. renderer.render();
  132. expect( domRoot.childNodes.length ).to.equal( 1 );
  133. expect( domRoot.childNodes[ 0 ].data ).to.equal( 'bar' );
  134. expect( renderer.markedTexts.size ).to.equal( 0 );
  135. } );
  136. it( 'should not update text parent child list changed', () => {
  137. const viewImg = new ViewElement( 'img' );
  138. const viewText = new ViewText( 'foo' );
  139. viewRoot.appendChildren( [ viewImg, viewText ] );
  140. renderer.markToSync( 'CHILDREN', viewRoot );
  141. renderer.markToSync( 'TEXT', viewText );
  142. renderer.render();
  143. expect( domRoot.childNodes.length ).to.equal( 2 );
  144. expect( domRoot.childNodes[ 0 ].tagName ).to.equal( 'IMG' );
  145. expect( domRoot.childNodes[ 1 ].data ).to.equal( 'foo' );
  146. } );
  147. it( 'should not change text if it is the same during text rendering', () => {
  148. const viewText = new ViewText( 'foo' );
  149. viewRoot.appendChildren( viewText );
  150. renderer.markToSync( 'CHILDREN', viewRoot );
  151. renderer.render();
  152. // This should not be changed during the render.
  153. const domText = domRoot.childNodes[ 0 ];
  154. renderer.markToSync( 'TEXT', viewText );
  155. renderer.render();
  156. expect( domRoot.childNodes.length ).to.equal( 1 );
  157. expect( domRoot.childNodes[ 0 ] ).to.equal( domText );
  158. } );
  159. it( 'should not change text if it is the same during children rendering', () => {
  160. const viewText = new ViewText( 'foo' );
  161. viewRoot.appendChildren( viewText );
  162. renderer.markToSync( 'CHILDREN', viewRoot );
  163. renderer.render();
  164. // This should not be changed during the render.
  165. const domText = domRoot.childNodes[ 0 ];
  166. renderer.markToSync( 'CHILDREN', viewRoot );
  167. renderer.render();
  168. expect( domRoot.childNodes.length ).to.equal( 1 );
  169. expect( domRoot.childNodes[ 0 ] ).to.equal( domText );
  170. } );
  171. it( 'should not change element if it is the same', () => {
  172. const viewImg = new ViewElement( 'img' );
  173. viewRoot.appendChildren( viewImg );
  174. // This should not be changed during the render.
  175. const domImg = document.createElement( 'img' );
  176. domRoot.appendChild( domImg );
  177. domConverter.bindElements( domImg, viewImg );
  178. renderer.markToSync( 'CHILDREN', viewRoot );
  179. renderer.render();
  180. expect( domRoot.childNodes.length ).to.equal( 1 );
  181. expect( domRoot.childNodes[ 0 ] ).to.equal( domImg );
  182. } );
  183. it( 'should change element if it is different', () => {
  184. const viewImg = new ViewElement( 'img' );
  185. viewRoot.appendChildren( viewImg );
  186. renderer.markToSync( 'CHILDREN', viewRoot );
  187. renderer.render();
  188. const viewP = new ViewElement( 'p' );
  189. viewRoot.removeChildren( 0, 1 );
  190. viewRoot.appendChildren( viewP );
  191. renderer.markToSync( 'CHILDREN', viewRoot );
  192. renderer.render();
  193. expect( domRoot.childNodes.length ).to.equal( 1 );
  194. expect( domRoot.childNodes[ 0 ].tagName ).to.equal( 'P' );
  195. } );
  196. it( 'should add and remove inline filler in case <p>foo<b>[]</b>bar</p>', () => {
  197. const domSelection = document.getSelection();
  198. // Step 1: <p>foo<b>"FILLER{}"</b></p>
  199. const { view: viewP, selection: newSelection } = parse(
  200. '<container:p>foo<attribute:b>[]</attribute:b>bar</container:p>' );
  201. viewRoot.appendChildren( viewP );
  202. selection.setTo( newSelection );
  203. renderer.markToSync( 'CHILDREN', viewRoot );
  204. renderer.render();
  205. expect( domRoot.childNodes.length ).to.equal( 1 );
  206. expect( domRoot.childNodes[ 0 ].tagName.toLowerCase() ).to.equal( 'p' );
  207. const domP = domRoot.childNodes[ 0 ];
  208. expect( domP.childNodes.length ).to.equal( 3 );
  209. expect( domP.childNodes[ 0 ].data ).to.equal( 'foo' );
  210. expect( domP.childNodes[ 2 ].data ).to.equal( 'bar' );
  211. expect( domP.childNodes[ 1 ].tagName.toLowerCase() ).to.equal( 'b' );
  212. expect( domP.childNodes[ 1 ].childNodes.length ).to.equal( 1 );
  213. expect( domP.childNodes[ 1 ].childNodes[ 0 ].data ).to.equal( INLINE_FILLER );
  214. expect( domSelection.rangeCount ).to.equal( 1 );
  215. expect( domSelection.getRangeAt( 0 ).startContainer ).to.equal( domP.childNodes[ 1 ].childNodes[ 0 ] );
  216. expect( domSelection.getRangeAt( 0 ).startOffset ).to.equal( INLINE_FILLER_LENGTH );
  217. expect( domSelection.getRangeAt( 0 ).collapsed ).to.be.true;
  218. // Step 2: No mutation on second render
  219. renderer.markToSync( 'CHILDREN', viewRoot );
  220. renderer.markToSync( 'CHILDREN', viewP );
  221. renderAndExpectNoChanges( renderer, domRoot );
  222. // Step 3: <p>foo{}<b></b></p>
  223. selection.removeAllRanges();
  224. selection.addRange( ViewRange.createFromParentsAndOffsets( viewP.getChild( 0 ), 3, viewP.getChild( 0 ), 3 ) );
  225. renderer.render();
  226. expect( domP.childNodes.length ).to.equal( 3 );
  227. expect( domP.childNodes[ 0 ].data ).to.equal( 'foo' );
  228. expect( domP.childNodes[ 2 ].data ).to.equal( 'bar' );
  229. expect( domP.childNodes[ 1 ].tagName.toLowerCase() ).to.equal( 'b' );
  230. expect( domP.childNodes[ 1 ].childNodes.length ).to.equal( 0 );
  231. expect( domSelection.rangeCount ).to.equal( 1 );
  232. expect( domSelection.getRangeAt( 0 ).startContainer ).to.equal( domP.childNodes[ 0 ] );
  233. expect( domSelection.getRangeAt( 0 ).startOffset ).to.equal( 3 );
  234. expect( domSelection.getRangeAt( 0 ).collapsed ).to.be.true;
  235. // Step 4: No mutation on second render
  236. renderer.markToSync( 'CHILDREN', viewRoot );
  237. renderer.markToSync( 'CHILDREN', viewP );
  238. renderAndExpectNoChanges( renderer, domRoot );
  239. } );
  240. it( 'should add and remove inline filler in case <p>[]<b>foo</b></p>', () => {
  241. const domSelection = document.getSelection();
  242. // Step 1: <p>"FILLER{}"<b>foo</b></p>
  243. const { view: viewP, selection: newSelection } = parse(
  244. '<container:p>[]<attribute:b>foo</attribute:b></container:p>' );
  245. viewRoot.appendChildren( viewP );
  246. selection.setTo( newSelection );
  247. renderer.markToSync( 'CHILDREN', viewRoot );
  248. renderer.render();
  249. const domP = domRoot.childNodes[ 0 ];
  250. expect( domP.childNodes.length ).to.equal( 2 );
  251. expect( domP.childNodes[ 0 ].data ).to.equal( INLINE_FILLER );
  252. expect( domP.childNodes[ 1 ].tagName.toLowerCase() ).to.equal( 'b' );
  253. expect( domP.childNodes[ 1 ].childNodes.length ).to.equal( 1 );
  254. expect( domP.childNodes[ 1 ].childNodes[ 0 ].data ).to.equal( 'foo' );
  255. expect( domSelection.rangeCount ).to.equal( 1 );
  256. expect( domSelection.getRangeAt( 0 ).startContainer ).to.equal( domP.childNodes[ 0 ] );
  257. expect( domSelection.getRangeAt( 0 ).startOffset ).to.equal( INLINE_FILLER_LENGTH );
  258. expect( domSelection.getRangeAt( 0 ).collapsed ).to.be.true;
  259. // Step 2: No mutation on second render
  260. renderer.markToSync( 'CHILDREN', viewP );
  261. renderAndExpectNoChanges( renderer, domRoot );
  262. // Step 3: <p><b>{}foo</b></p>
  263. selection.removeAllRanges();
  264. selection.addRange( ViewRange.createFromParentsAndOffsets(
  265. viewP.getChild( 0 ).getChild( 0 ), 0, viewP.getChild( 0 ).getChild( 0 ), 0 ) );
  266. renderer.render();
  267. expect( domP.childNodes.length ).to.equal( 1 );
  268. expect( domP.childNodes[ 0 ].tagName.toLowerCase() ).to.equal( 'b' );
  269. expect( domP.childNodes[ 0 ].childNodes.length ).to.equal( 1 );
  270. expect( domP.childNodes[ 0 ].childNodes[ 0 ].data ).to.equal( 'foo' );
  271. expect( domSelection.rangeCount ).to.equal( 1 );
  272. expect( domSelection.getRangeAt( 0 ).startContainer ).to.equal( domP.childNodes[ 0 ] .childNodes[ 0 ] );
  273. expect( domSelection.getRangeAt( 0 ).startOffset ).to.equal( 0 );
  274. expect( domSelection.getRangeAt( 0 ).collapsed ).to.be.true;
  275. // Step 4: No mutation on second render
  276. renderer.markToSync( 'CHILDREN', viewP );
  277. renderAndExpectNoChanges( renderer, domRoot );
  278. } );
  279. it( 'should add and remove inline filler in case <p><b>foo</b>[]</p>', () => {
  280. const domSelection = document.getSelection();
  281. // Step 1: <p>"FILLER{}"<b>foo</b></p>
  282. const { view: viewP, selection: newSelection } = parse(
  283. '<container:p><attribute:b>foo</attribute:b>[]</container:p>' );
  284. viewRoot.appendChildren( viewP );
  285. selection.setTo( newSelection );
  286. renderer.markToSync( 'CHILDREN', viewRoot );
  287. renderer.render();
  288. const domP = domRoot.childNodes[ 0 ];
  289. expect( domP.childNodes.length ).to.equal( 2 );
  290. expect( domP.childNodes[ 0 ].tagName.toLowerCase() ).to.equal( 'b' );
  291. expect( domP.childNodes[ 0 ].childNodes.length ).to.equal( 1 );
  292. expect( domP.childNodes[ 0 ].childNodes[ 0 ].data ).to.equal( 'foo' );
  293. expect( domP.childNodes[ 1 ].data ).to.equal( INLINE_FILLER );
  294. expect( domSelection.rangeCount ).to.equal( 1 );
  295. expect( domSelection.getRangeAt( 0 ).startContainer ).to.equal( domP.childNodes[ 1 ] );
  296. expect( domSelection.getRangeAt( 0 ).startOffset ).to.equal( INLINE_FILLER_LENGTH );
  297. expect( domSelection.getRangeAt( 0 ).collapsed ).to.be.true;
  298. // Step 2: No mutation on second render
  299. renderer.markToSync( 'CHILDREN', viewP );
  300. renderAndExpectNoChanges( renderer, domRoot );
  301. // Step 3: <p><b>foo{}</b></p>
  302. selection.removeAllRanges();
  303. selection.addRange( ViewRange.createFromParentsAndOffsets(
  304. viewP.getChild( 0 ).getChild( 0 ), 3, viewP.getChild( 0 ).getChild( 0 ), 3 ) );
  305. renderer.render();
  306. expect( domP.childNodes.length ).to.equal( 1 );
  307. expect( domP.childNodes[ 0 ].tagName.toLowerCase() ).to.equal( 'b' );
  308. expect( domP.childNodes[ 0 ].childNodes.length ).to.equal( 1 );
  309. expect( domP.childNodes[ 0 ].childNodes[ 0 ].data ).to.equal( 'foo' );
  310. expect( domSelection.rangeCount ).to.equal( 1 );
  311. expect( domSelection.getRangeAt( 0 ).startContainer ).to.equal( domP.childNodes[ 0 ] .childNodes[ 0 ] );
  312. expect( domSelection.getRangeAt( 0 ).startOffset ).to.equal( 3 );
  313. expect( domSelection.getRangeAt( 0 ).collapsed ).to.be.true;
  314. // Step 4: No mutation on second render
  315. renderer.markToSync( 'CHILDREN', viewP );
  316. renderAndExpectNoChanges( renderer, domRoot );
  317. } );
  318. it( 'should add and remove inline filler in case <p><b>foo</b>[]<b>bar</b></p>', () => {
  319. const domSelection = document.getSelection();
  320. const { view: viewP, selection: newSelection } = parse(
  321. '<container:p><attribute:b>foo</attribute:b>[]<attribute:b>bar</attribute:b></container:p>' );
  322. viewRoot.appendChildren( viewP );
  323. selection.setTo( newSelection );
  324. renderer.markToSync( 'CHILDREN', viewRoot );
  325. renderer.render();
  326. const domP = domRoot.childNodes[ 0 ];
  327. expect( domP.childNodes.length ).to.equal( 3 );
  328. expect( domP.childNodes[ 0 ].tagName.toLowerCase() ).to.equal( 'b' );
  329. expect( domP.childNodes[ 0 ].childNodes.length ).to.equal( 1 );
  330. expect( domP.childNodes[ 0 ].childNodes[ 0 ].data ).to.equal( 'foo' );
  331. expect( domP.childNodes[ 1 ].data ).to.equal( INLINE_FILLER );
  332. expect( domP.childNodes[ 2 ].tagName.toLowerCase() ).to.equal( 'b' );
  333. expect( domP.childNodes[ 2 ].childNodes.length ).to.equal( 1 );
  334. expect( domP.childNodes[ 2 ].childNodes[ 0 ].data ).to.equal( 'bar' );
  335. expect( domSelection.rangeCount ).to.equal( 1 );
  336. expect( domSelection.getRangeAt( 0 ).startContainer ).to.equal( domP.childNodes[ 1 ] );
  337. expect( domSelection.getRangeAt( 0 ).startOffset ).to.equal( INLINE_FILLER_LENGTH );
  338. expect( domSelection.getRangeAt( 0 ).collapsed ).to.be.true;
  339. } );
  340. it( 'should handle typing in empty block, do nothing if changes are already applied', () => {
  341. const domSelection = document.getSelection();
  342. const { view: viewP, selection: newSelection } = parse( '<container:p>[]</container:p>' );
  343. viewRoot.appendChildren( viewP );
  344. selection.setTo( newSelection );
  345. renderer.markToSync( 'CHILDREN', viewRoot );
  346. renderer.render();
  347. const domP = domRoot.childNodes[ 0 ];
  348. expect( domP.childNodes.length ).to.equal( 1 );
  349. expect( isBlockFiller( domP.childNodes[ 0 ], BR_FILLER ) ).to.be.true;
  350. expect( domSelection.rangeCount ).to.equal( 1 );
  351. expect( domSelection.getRangeAt( 0 ).startContainer ).to.equal( domP );
  352. expect( domSelection.getRangeAt( 0 ).startOffset ).to.equal( 0 );
  353. expect( domSelection.getRangeAt( 0 ).collapsed ).to.be.true;
  354. // Remove filler and add text node to both DOM and View <p>x{}</p>
  355. domP.removeChild( domP.childNodes[ 0 ] );
  356. domP.appendChild( document.createTextNode( 'x' ) );
  357. domSelection.removeAllRanges();
  358. const domRange = new Range();
  359. domRange.setStart( domP.childNodes[ 0 ], 1 );
  360. domRange.collapse( true );
  361. domSelection.addRange( domRange );
  362. const viewText = new ViewText( 'x' );
  363. viewP.appendChildren( viewText );
  364. selection.removeAllRanges();
  365. selection.addRange( ViewRange.createFromParentsAndOffsets( viewText, 1, viewText, 1 ) );
  366. renderer.markToSync( 'CHILDREN', viewP );
  367. renderAndExpectNoChanges( renderer, domRoot );
  368. } );
  369. it( 'should handle typing in empty block, render if needed', () => {
  370. const domSelection = document.getSelection();
  371. const { view: viewP, selection: newSelection } = parse( '<container:p>[]</container:p>' );
  372. viewRoot.appendChildren( viewP );
  373. selection.setTo( newSelection );
  374. renderer.markToSync( 'CHILDREN', viewRoot );
  375. renderer.render();
  376. const domP = domRoot.childNodes[ 0 ];
  377. expect( domP.childNodes.length ).to.equal( 1 );
  378. expect( isBlockFiller( domP.childNodes[ 0 ], BR_FILLER ) ).to.be.true;
  379. expect( domSelection.rangeCount ).to.equal( 1 );
  380. expect( domSelection.getRangeAt( 0 ).startContainer ).to.equal( domP );
  381. expect( domSelection.getRangeAt( 0 ).startOffset ).to.equal( 0 );
  382. expect( domSelection.getRangeAt( 0 ).collapsed ).to.be.true;
  383. // Add text node only in View <p>x{}</p>
  384. const viewText = new ViewText( 'x' );
  385. viewP.appendChildren( viewText );
  386. selection.removeAllRanges();
  387. selection.addRange( ViewRange.createFromParentsAndOffsets( viewText, 1, viewText, 1 ) );
  388. renderer.markToSync( 'CHILDREN', viewP );
  389. renderer.render();
  390. expect( domP.childNodes.length ).to.equal( 1 );
  391. expect( domP.childNodes[ 0 ].data ).to.equal( 'x' );
  392. expect( domSelection.rangeCount ).to.equal( 1 );
  393. expect( domSelection.getRangeAt( 0 ).startContainer ).to.equal( domP.childNodes[ 0 ] );
  394. expect( domSelection.getRangeAt( 0 ).startOffset ).to.equal( 1 );
  395. expect( domSelection.getRangeAt( 0 ).collapsed ).to.be.true;
  396. } );
  397. it( 'should handle removing last character', () => {
  398. const domSelection = document.getSelection();
  399. const { view: viewP, selection: newSelection } = parse( '<container:p>x{}</container:p>' );
  400. viewRoot.appendChildren( viewP );
  401. selection.setTo( newSelection );
  402. renderer.markToSync( 'CHILDREN', viewRoot );
  403. renderer.render();
  404. const domP = domRoot.childNodes[ 0 ];
  405. expect( domP.childNodes.length ).to.equal( 1 );
  406. expect( domP.childNodes[ 0 ].data ).to.equal( 'x' );
  407. expect( domSelection.rangeCount ).to.equal( 1 );
  408. expect( domSelection.getRangeAt( 0 ).startContainer ).to.equal( domP.childNodes[ 0 ] );
  409. expect( domSelection.getRangeAt( 0 ).startOffset ).to.equal( 1 );
  410. expect( domSelection.getRangeAt( 0 ).collapsed ).to.be.true;
  411. // Remove text and add filler to both DOM and View <p>{}</p>
  412. domP.removeChild( domP.childNodes[ 0 ] );
  413. domP.appendChild( BR_FILLER( document ) );
  414. domSelection.removeAllRanges();
  415. const domRange = new Range();
  416. domRange.setStart( domP.childNodes[ 0 ], 0 );
  417. domRange.collapse( true );
  418. domSelection.addRange( domRange );
  419. viewP.removeChildren( 0 );
  420. selection.removeAllRanges();
  421. selection.addRange( ViewRange.createFromParentsAndOffsets( viewP, 0, viewP, 0 ) );
  422. renderer.markToSync( 'CHILDREN', viewP );
  423. renderAndExpectNoChanges( renderer, domRoot );
  424. } );
  425. it( 'should handle typing in empty attribute, do nothing if changes are already applied', () => {
  426. const domSelection = document.getSelection();
  427. const { view: viewP, selection: newSelection } = parse(
  428. '<container:p><attribute:b>[]</attribute:b>foo</container:p>' );
  429. viewRoot.appendChildren( viewP );
  430. selection.setTo( newSelection );
  431. renderer.markToSync( 'CHILDREN', viewRoot );
  432. renderer.render();
  433. const domP = domRoot.childNodes[ 0 ];
  434. expect( domP.childNodes.length ).to.equal( 2 );
  435. expect( domP.childNodes[ 0 ].tagName.toLowerCase() ).to.equal( 'b' );
  436. expect( domP.childNodes[ 1 ].data ).to.equal( 'foo' );
  437. const domB = domP.childNodes[ 0 ];
  438. const viewB = viewP.getChild( 0 );
  439. expect( domB.childNodes.length ).to.equal( 1 );
  440. expect( domB.childNodes[ 0 ].data ).to.equal( INLINE_FILLER );
  441. expect( domSelection.rangeCount ).to.equal( 1 );
  442. expect( domSelection.getRangeAt( 0 ).startContainer ).to.equal( domB.childNodes[ 0 ] );
  443. expect( domSelection.getRangeAt( 0 ).startOffset ).to.equal( INLINE_FILLER_LENGTH );
  444. expect( domSelection.getRangeAt( 0 ).collapsed ).to.be.true;
  445. // Add text node to both DOM and View <p><b>x</b>foo</p>
  446. domB.childNodes[ 0 ].data += 'x';
  447. domSelection.removeAllRanges();
  448. const domRange = new Range();
  449. domRange.setStart( domB.childNodes[ 0 ], INLINE_FILLER_LENGTH + 1 );
  450. domRange.collapse( true );
  451. domSelection.addRange( domRange );
  452. const viewText = new ViewText( 'x' );
  453. viewB.appendChildren( viewText );
  454. selection.removeAllRanges();
  455. selection.addRange( ViewRange.createFromParentsAndOffsets( viewText, 1, viewText, 1 ) );
  456. renderer.markToSync( 'CHILDREN', viewP );
  457. renderAndExpectNoChanges( renderer, domRoot );
  458. } );
  459. it( 'should handle typing in empty attribute as a CHILDREN change, render if needed', () => {
  460. const domSelection = document.getSelection();
  461. const { view: viewP, selection: newSelection } = parse(
  462. '<container:p><attribute:b>[]</attribute:b>foo</container:p>' );
  463. viewRoot.appendChildren( viewP );
  464. selection.setTo( newSelection );
  465. renderer.markToSync( 'CHILDREN', viewRoot );
  466. renderer.render();
  467. const domP = domRoot.childNodes[ 0 ];
  468. expect( domP.childNodes.length ).to.equal( 2 );
  469. expect( domP.childNodes[ 0 ].tagName.toLowerCase() ).to.equal( 'b' );
  470. expect( domP.childNodes[ 1 ].data ).to.equal( 'foo' );
  471. const domB = domP.childNodes[ 0 ];
  472. const viewB = viewP.getChild( 0 );
  473. expect( domB.childNodes.length ).to.equal( 1 );
  474. expect( domB.childNodes[ 0 ].data ).to.equal( INLINE_FILLER );
  475. expect( domSelection.rangeCount ).to.equal( 1 );
  476. expect( domSelection.getRangeAt( 0 ).startContainer ).to.equal( domB.childNodes[ 0 ] );
  477. expect( domSelection.getRangeAt( 0 ).startOffset ).to.equal( INLINE_FILLER_LENGTH );
  478. expect( domSelection.getRangeAt( 0 ).collapsed ).to.be.true;
  479. // Add text node only to View <p><b>x</b>foo</p>
  480. const viewText = new ViewText( 'x' );
  481. viewB.appendChildren( viewText );
  482. selection.removeAllRanges();
  483. selection.addRange( ViewRange.createFromParentsAndOffsets( viewText, 1, viewText, 1 ) );
  484. renderer.markToSync( 'CHILDREN', viewB );
  485. renderer.render();
  486. expect( domB.childNodes.length ).to.equal( 1 );
  487. expect( domB.childNodes[ 0 ].data ).to.equal( INLINE_FILLER + 'x' );
  488. expect( domSelection.rangeCount ).to.equal( 1 );
  489. expect( domSelection.getRangeAt( 0 ).startContainer ).to.equal( domB.childNodes[ 0 ] );
  490. expect( domSelection.getRangeAt( 0 ).startOffset ).to.equal( INLINE_FILLER_LENGTH + 1 );
  491. expect( domSelection.getRangeAt( 0 ).collapsed ).to.be.true;
  492. } );
  493. it( 'should handle typing in empty attribute as a TEXT change, render if needed', () => {
  494. const domSelection = document.getSelection();
  495. const { view: viewP, selection: newSelection } = parse(
  496. '<container:p><attribute:b>[]</attribute:b>foo</container:p>' );
  497. viewRoot.appendChildren( viewP );
  498. selection.setTo( newSelection );
  499. renderer.markToSync( 'CHILDREN', viewRoot );
  500. renderer.render();
  501. const domP = domRoot.childNodes[ 0 ];
  502. expect( domP.childNodes.length ).to.equal( 2 );
  503. expect( domP.childNodes[ 0 ].tagName.toLowerCase() ).to.equal( 'b' );
  504. expect( domP.childNodes[ 1 ].data ).to.equal( 'foo' );
  505. const domB = domP.childNodes[ 0 ];
  506. const viewB = viewP.getChild( 0 );
  507. expect( domB.childNodes.length ).to.equal( 1 );
  508. expect( domB.childNodes[ 0 ].data ).to.equal( INLINE_FILLER );
  509. expect( domSelection.rangeCount ).to.equal( 1 );
  510. expect( domSelection.getRangeAt( 0 ).startContainer ).to.equal( domB.childNodes[ 0 ] );
  511. expect( domSelection.getRangeAt( 0 ).startOffset ).to.equal( INLINE_FILLER_LENGTH );
  512. expect( domSelection.getRangeAt( 0 ).collapsed ).to.be.true;
  513. // Add text node only to View <p><b>x</b>foo</p>
  514. const viewText = new ViewText( 'x' );
  515. viewB.appendChildren( viewText );
  516. selection.removeAllRanges();
  517. selection.addRange( ViewRange.createFromParentsAndOffsets( viewText, 1, viewText, 1 ) );
  518. renderer.markToSync( 'TEXT', viewText );
  519. renderer.render();
  520. expect( domB.childNodes.length ).to.equal( 1 );
  521. expect( domB.childNodes[ 0 ].data ).to.equal( INLINE_FILLER + 'x' );
  522. expect( domSelection.rangeCount ).to.equal( 1 );
  523. expect( domSelection.getRangeAt( 0 ).startContainer ).to.equal( domB.childNodes[ 0 ] );
  524. expect( domSelection.getRangeAt( 0 ).startOffset ).to.equal( INLINE_FILLER_LENGTH + 1 );
  525. expect( domSelection.getRangeAt( 0 ).collapsed ).to.be.true;
  526. } );
  527. it( 'should handle not collapsed range', () => {
  528. const domSelection = document.getSelection();
  529. const { view: viewP, selection: newSelection } = parse(
  530. '<container:p>fo{o<attribute:b>b}ar</attribute:b></container:p>' );
  531. viewRoot.appendChildren( viewP );
  532. selection.setTo( newSelection );
  533. renderer.markToSync( 'CHILDREN', viewRoot );
  534. renderer.render();
  535. const domP = domRoot.childNodes[ 0 ];
  536. expect( domP.childNodes.length ).to.equal( 2 );
  537. expect( domP.childNodes[ 0 ].data ).to.equal( 'foo' );
  538. expect( domP.childNodes[ 1 ].tagName.toLowerCase() ).to.equal( 'b' );
  539. expect( domP.childNodes[ 1 ].childNodes.length ).to.equal( 1 );
  540. expect( domP.childNodes[ 1 ].childNodes[ 0 ].data ).to.equal( 'bar' );
  541. expect( domSelection.rangeCount ).to.equal( 1 );
  542. expect( domSelection.getRangeAt( 0 ).startContainer ).to.equal( domP.childNodes[ 0 ] );
  543. expect( domSelection.getRangeAt( 0 ).startOffset ).to.equal( 2 );
  544. expect( domSelection.getRangeAt( 0 ).endContainer ).to.equal( domP.childNodes[ 1 ].childNodes[ 0 ] );
  545. expect( domSelection.getRangeAt( 0 ).endOffset ).to.equal( 1 );
  546. renderer.markToSync( 'CHILDREN', viewP );
  547. renderAndExpectNoChanges( renderer, domRoot );
  548. } );
  549. it( 'should not add inline filler after text node', () => {
  550. const domSelection = document.getSelection();
  551. const { view: viewP, selection: newSelection } = parse( '<container:p>foo[]</container:p>' );
  552. viewRoot.appendChildren( viewP );
  553. selection.setTo( newSelection );
  554. renderer.markToSync( 'CHILDREN', viewRoot );
  555. renderer.render();
  556. const domP = domRoot.childNodes[ 0 ];
  557. expect( domP.childNodes.length ).to.equal( 1 );
  558. expect( domP.childNodes[ 0 ].data ).to.equal( 'foo' );
  559. expect( domSelection.rangeCount ).to.equal( 1 );
  560. expect( domSelection.getRangeAt( 0 ).startContainer ).to.equal( domP );
  561. expect( domSelection.getRangeAt( 0 ).startOffset ).to.equal( 1 );
  562. expect( domSelection.getRangeAt( 0 ).collapsed ).to.be.true;
  563. } );
  564. it( 'should throw if there is no filler in expected position', () => {
  565. const { view: viewP, selection: newSelection } = parse(
  566. '<container:p>foo<attribute:b>[]</attribute:b>bar</container:p>' );
  567. viewRoot.appendChildren( viewP );
  568. selection.setTo( newSelection );
  569. renderer.markToSync( 'CHILDREN', viewRoot );
  570. renderer.render();
  571. const domB = domRoot.childNodes[ 0 ].childNodes[ 1 ];
  572. const viewB = viewP.getChild( 1 );
  573. expect( domB.childNodes[ 0 ].data ).to.equal( INLINE_FILLER );
  574. // Remove filler.
  575. domB.childNodes[ 0 ].data = '';
  576. selection.removeAllRanges();
  577. renderer.markToSync( 'CHILDREN', viewB );
  578. expect( () => {
  579. renderer.render();
  580. } ).to.throw();
  581. } );
  582. } );
  583. } );
  584. function renderAndExpectNoChanges( renderer, domRoot ) {
  585. const config = {
  586. childList: true,
  587. characterData: true,
  588. characterDataOldValue: true,
  589. subtree: true
  590. };
  591. const mutationObserver = new window.MutationObserver( () => {
  592. throw 'There should be not mutations';
  593. } );
  594. mutationObserver.observe( domRoot, config );
  595. renderer.render();
  596. const records = mutationObserver.takeRecords();
  597. mutationObserver.disconnect();
  598. expect( records.length ).to.equal( 0 );
  599. }