renderer.js 30 KB

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