8
0

renderer.js 32 KB

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