8
0

renderer.js 36 KB

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