8
0

renderer.js 36 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033
  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. import ViewElement from '/ckeditor5/engine/view/element.js';
  7. import ViewText from '/ckeditor5/engine/view/text.js';
  8. import ViewRange from '/ckeditor5/engine/view/range.js';
  9. import Selection from '/ckeditor5/engine/view/selection.js';
  10. import DomConverter from '/ckeditor5/engine/view/domconverter.js';
  11. import Renderer from '/ckeditor5/engine/view/renderer.js';
  12. import CKEditorError from '/ckeditor5/utils/ckeditorerror.js';
  13. import { parse } from '/tests/engine/_utils/view.js';
  14. import { INLINE_FILLER, INLINE_FILLER_LENGTH, isBlockFiller, BR_FILLER } from '/ckeditor5/engine/view/filler.js';
  15. import testUtils from '/tests/ckeditor5/_utils/utils.js';
  16. import createElement from '/ckeditor5/utils/dom/createelement.js';
  17. testUtils.createSinonSandbox();
  18. describe( 'Renderer', () => {
  19. let selection, domConverter, renderer;
  20. beforeEach( () => {
  21. selection = new Selection();
  22. domConverter = new DomConverter();
  23. renderer = new Renderer( domConverter, selection );
  24. renderer.domDocuments.add( document );
  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 move filler when selection is moved', () => {
  359. // Step 1: <p>foo<b>"FILLER{}"</b></p>
  360. const { view: viewP, selection: newSelection } = parse(
  361. '<container:p>foo<attribute:b>[]</attribute:b><attribute:i></attribute:i></container:p>' );
  362. viewRoot.appendChildren( viewP );
  363. selection.setTo( newSelection );
  364. renderer.markToSync( 'children', viewRoot );
  365. renderer.render();
  366. const domP = domRoot.childNodes[ 0 ];
  367. expect( domP.childNodes.length ).to.equal( 3 );
  368. expect( domP.childNodes[ 0 ].data ).to.equal( 'foo' );
  369. expect( domP.childNodes[ 1 ].tagName.toLowerCase() ).to.equal( 'b' );
  370. expect( domP.childNodes[ 1 ].childNodes.length ).to.equal( 1 );
  371. expect( domP.childNodes[ 1 ].childNodes[ 0 ].data ).to.equal( INLINE_FILLER );
  372. expect( domP.childNodes[ 2 ].tagName.toLowerCase() ).to.equal( 'i' );
  373. expect( domP.childNodes[ 2 ].childNodes.length ).to.equal( 0 );
  374. // Step 2: <p>foo<b></b><i>"FILLER{}"</i></p>
  375. selection.removeAllRanges();
  376. const viewI = viewP.getChild( 2 );
  377. selection.addRange( ViewRange.createFromParentsAndOffsets( viewI, 0, viewI, 0 ) );
  378. renderer.render();
  379. expect( domP.childNodes.length ).to.equal( 3 );
  380. expect( domP.childNodes[ 0 ].data ).to.equal( 'foo' );
  381. expect( domP.childNodes[ 1 ].tagName.toLowerCase() ).to.equal( 'b' );
  382. expect( domP.childNodes[ 1 ].childNodes.length ).to.equal( 0 );
  383. expect( domP.childNodes[ 2 ].tagName.toLowerCase() ).to.equal( 'i' );
  384. expect( domP.childNodes[ 2 ].childNodes.length ).to.equal( 1 );
  385. expect( domP.childNodes[ 2 ].childNodes[ 0 ].data ).to.equal( INLINE_FILLER );
  386. } );
  387. it( 'should remove filler when text is added and selection removed', () => {
  388. // Step 1: <p>foo<b>"FILLER{}"</b></p>
  389. const { view: viewP, selection: newSelection } = parse( '<container:p>foo<attribute:b>[]</attribute:b></container:p>' );
  390. const viewB = viewP.getChild( 1 );
  391. viewRoot.appendChildren( viewP );
  392. selection.setTo( newSelection );
  393. renderer.markToSync( 'children', viewRoot );
  394. renderer.render();
  395. const domP = domRoot.childNodes[ 0 ];
  396. expect( domP.childNodes.length ).to.equal( 2 );
  397. expect( domP.childNodes[ 0 ].data ).to.equal( 'foo' );
  398. expect( domP.childNodes[ 1 ].tagName.toLowerCase() ).to.equal( 'b' );
  399. expect( domP.childNodes[ 1 ].childNodes.length ).to.equal( 1 );
  400. expect( domP.childNodes[ 1 ].childNodes[ 0 ].data ).to.equal( INLINE_FILLER );
  401. // Step 2: Add text node.
  402. const viewText = new ViewText( 'x' );
  403. viewB.appendChildren( viewText );
  404. selection.removeAllRanges();
  405. selection.addRange( ViewRange.createFromParentsAndOffsets( viewText, 1, viewText, 1 ) );
  406. renderer.markToSync( 'children', viewB );
  407. renderer.render();
  408. // Step 3: Remove selection from the view.
  409. selection.removeAllRanges();
  410. renderer.render();
  411. expect( domP.childNodes.length ).to.equal( 2 );
  412. expect( domP.childNodes[ 0 ].data ).to.equal( 'foo' );
  413. expect( domP.childNodes[ 1 ].tagName.toLowerCase() ).to.equal( 'b' );
  414. expect( domP.childNodes[ 1 ].childNodes.length ).to.equal( 1 );
  415. expect( domP.childNodes[ 1 ].childNodes[ 0 ].data ).to.equal( 'x' );
  416. } );
  417. it( 'should handle typing in empty block, do nothing if changes are already applied', () => {
  418. const domSelection = document.getSelection();
  419. const { view: viewP, selection: newSelection } = parse( '<container:p>[]</container:p>' );
  420. viewRoot.appendChildren( viewP );
  421. selection.setTo( newSelection );
  422. renderer.markToSync( 'children', viewRoot );
  423. renderer.render();
  424. const domP = domRoot.childNodes[ 0 ];
  425. expect( domP.childNodes.length ).to.equal( 1 );
  426. expect( isBlockFiller( domP.childNodes[ 0 ], BR_FILLER ) ).to.be.true;
  427. expect( domSelection.rangeCount ).to.equal( 1 );
  428. expect( domSelection.getRangeAt( 0 ).startContainer ).to.equal( domP );
  429. expect( domSelection.getRangeAt( 0 ).startOffset ).to.equal( 0 );
  430. expect( domSelection.getRangeAt( 0 ).collapsed ).to.be.true;
  431. // Remove filler and add text node to both DOM and View <p>x{}</p>
  432. domP.removeChild( domP.childNodes[ 0 ] );
  433. domP.appendChild( document.createTextNode( 'x' ) );
  434. domSelection.removeAllRanges();
  435. const domRange = new Range();
  436. domRange.setStart( domP.childNodes[ 0 ], 1 );
  437. domRange.collapse( true );
  438. domSelection.addRange( domRange );
  439. const viewText = new ViewText( 'x' );
  440. viewP.appendChildren( viewText );
  441. selection.removeAllRanges();
  442. selection.addRange( ViewRange.createFromParentsAndOffsets( viewText, 1, viewText, 1 ) );
  443. renderer.markToSync( 'children', viewP );
  444. renderAndExpectNoChanges( renderer, domRoot );
  445. } );
  446. it( 'should handle typing in empty block, render if needed', () => {
  447. const domSelection = document.getSelection();
  448. const { view: viewP, selection: newSelection } = parse( '<container:p>[]</container:p>' );
  449. viewRoot.appendChildren( viewP );
  450. selection.setTo( newSelection );
  451. renderer.markToSync( 'children', viewRoot );
  452. renderer.render();
  453. const domP = domRoot.childNodes[ 0 ];
  454. expect( domP.childNodes.length ).to.equal( 1 );
  455. expect( isBlockFiller( domP.childNodes[ 0 ], BR_FILLER ) ).to.be.true;
  456. expect( domSelection.rangeCount ).to.equal( 1 );
  457. expect( domSelection.getRangeAt( 0 ).startContainer ).to.equal( domP );
  458. expect( domSelection.getRangeAt( 0 ).startOffset ).to.equal( 0 );
  459. expect( domSelection.getRangeAt( 0 ).collapsed ).to.be.true;
  460. // Add text node only in View <p>x{}</p>
  461. const viewText = new ViewText( 'x' );
  462. viewP.appendChildren( viewText );
  463. selection.removeAllRanges();
  464. selection.addRange( ViewRange.createFromParentsAndOffsets( viewText, 1, viewText, 1 ) );
  465. renderer.markToSync( 'children', viewP );
  466. renderer.render();
  467. expect( domP.childNodes.length ).to.equal( 1 );
  468. expect( domP.childNodes[ 0 ].data ).to.equal( 'x' );
  469. expect( domSelection.rangeCount ).to.equal( 1 );
  470. expect( domSelection.getRangeAt( 0 ).startContainer ).to.equal( domP.childNodes[ 0 ] );
  471. expect( domSelection.getRangeAt( 0 ).startOffset ).to.equal( 1 );
  472. expect( domSelection.getRangeAt( 0 ).collapsed ).to.be.true;
  473. } );
  474. it( 'should handle removing last character', () => {
  475. const domSelection = document.getSelection();
  476. const { view: viewP, selection: newSelection } = parse( '<container:p>x{}</container:p>' );
  477. viewRoot.appendChildren( viewP );
  478. selection.setTo( newSelection );
  479. renderer.markToSync( 'children', viewRoot );
  480. renderer.render();
  481. const domP = domRoot.childNodes[ 0 ];
  482. expect( domP.childNodes.length ).to.equal( 1 );
  483. expect( domP.childNodes[ 0 ].data ).to.equal( 'x' );
  484. expect( domSelection.rangeCount ).to.equal( 1 );
  485. expect( domSelection.getRangeAt( 0 ).startContainer ).to.equal( domP.childNodes[ 0 ] );
  486. expect( domSelection.getRangeAt( 0 ).startOffset ).to.equal( 1 );
  487. expect( domSelection.getRangeAt( 0 ).collapsed ).to.be.true;
  488. // Remove text and add filler to both DOM and View <p>{}</p>
  489. domP.removeChild( domP.childNodes[ 0 ] );
  490. domP.appendChild( BR_FILLER( document ) );
  491. domSelection.removeAllRanges();
  492. const domRange = new Range();
  493. domRange.setStart( domP.childNodes[ 0 ], 0 );
  494. domRange.collapse( true );
  495. domSelection.addRange( domRange );
  496. viewP.removeChildren( 0 );
  497. selection.removeAllRanges();
  498. selection.addRange( ViewRange.createFromParentsAndOffsets( viewP, 0, viewP, 0 ) );
  499. renderer.markToSync( 'children', viewP );
  500. renderAndExpectNoChanges( renderer, domRoot );
  501. } );
  502. it( 'should handle typing in empty attribute, do nothing if changes are already applied', () => {
  503. const domSelection = document.getSelection();
  504. const { view: viewP, selection: newSelection } = parse(
  505. '<container:p><attribute:b>[]</attribute:b>foo</container:p>' );
  506. viewRoot.appendChildren( viewP );
  507. selection.setTo( newSelection );
  508. renderer.markToSync( 'children', viewRoot );
  509. renderer.render();
  510. const domP = domRoot.childNodes[ 0 ];
  511. expect( domP.childNodes.length ).to.equal( 2 );
  512. expect( domP.childNodes[ 0 ].tagName.toLowerCase() ).to.equal( 'b' );
  513. expect( domP.childNodes[ 1 ].data ).to.equal( 'foo' );
  514. const domB = domP.childNodes[ 0 ];
  515. const viewB = viewP.getChild( 0 );
  516. expect( domB.childNodes.length ).to.equal( 1 );
  517. expect( domB.childNodes[ 0 ].data ).to.equal( INLINE_FILLER );
  518. expect( domSelection.rangeCount ).to.equal( 1 );
  519. expect( domSelection.getRangeAt( 0 ).startContainer ).to.equal( domB.childNodes[ 0 ] );
  520. expect( domSelection.getRangeAt( 0 ).startOffset ).to.equal( INLINE_FILLER_LENGTH );
  521. expect( domSelection.getRangeAt( 0 ).collapsed ).to.be.true;
  522. // Add text node to both DOM and View <p><b>x</b>foo</p>
  523. domB.childNodes[ 0 ].data += 'x';
  524. domSelection.removeAllRanges();
  525. const domRange = new Range();
  526. domRange.setStart( domB.childNodes[ 0 ], INLINE_FILLER_LENGTH + 1 );
  527. domRange.collapse( true );
  528. domSelection.addRange( domRange );
  529. const viewText = new ViewText( 'x' );
  530. viewB.appendChildren( viewText );
  531. selection.removeAllRanges();
  532. selection.addRange( ViewRange.createFromParentsAndOffsets( viewText, 1, viewText, 1 ) );
  533. renderer.markToSync( 'children', viewP );
  534. renderAndExpectNoChanges( renderer, domRoot );
  535. } );
  536. it( 'should handle typing in empty attribute as a children change, render if needed', () => {
  537. const domSelection = document.getSelection();
  538. const { view: viewP, selection: newSelection } = parse(
  539. '<container:p><attribute:b>[]</attribute:b>foo</container:p>' );
  540. viewRoot.appendChildren( viewP );
  541. selection.setTo( newSelection );
  542. renderer.markToSync( 'children', viewRoot );
  543. renderer.render();
  544. const domP = domRoot.childNodes[ 0 ];
  545. expect( domP.childNodes.length ).to.equal( 2 );
  546. expect( domP.childNodes[ 0 ].tagName.toLowerCase() ).to.equal( 'b' );
  547. expect( domP.childNodes[ 1 ].data ).to.equal( 'foo' );
  548. const domB = domP.childNodes[ 0 ];
  549. const viewB = viewP.getChild( 0 );
  550. expect( domB.childNodes.length ).to.equal( 1 );
  551. expect( domB.childNodes[ 0 ].data ).to.equal( INLINE_FILLER );
  552. expect( domSelection.rangeCount ).to.equal( 1 );
  553. expect( domSelection.getRangeAt( 0 ).startContainer ).to.equal( domB.childNodes[ 0 ] );
  554. expect( domSelection.getRangeAt( 0 ).startOffset ).to.equal( INLINE_FILLER_LENGTH );
  555. expect( domSelection.getRangeAt( 0 ).collapsed ).to.be.true;
  556. // Add text node only to View <p><b>x</b>foo</p>
  557. const viewText = new ViewText( 'x' );
  558. viewB.appendChildren( viewText );
  559. selection.removeAllRanges();
  560. selection.addRange( ViewRange.createFromParentsAndOffsets( viewText, 1, viewText, 1 ) );
  561. renderer.markToSync( 'children', viewB );
  562. renderer.render();
  563. expect( domB.childNodes.length ).to.equal( 1 );
  564. expect( domB.childNodes[ 0 ].data ).to.equal( INLINE_FILLER + 'x' );
  565. expect( domSelection.rangeCount ).to.equal( 1 );
  566. expect( domSelection.getRangeAt( 0 ).startContainer ).to.equal( domB.childNodes[ 0 ] );
  567. expect( domSelection.getRangeAt( 0 ).startOffset ).to.equal( INLINE_FILLER_LENGTH + 1 );
  568. expect( domSelection.getRangeAt( 0 ).collapsed ).to.be.true;
  569. } );
  570. it( 'should handle typing in empty attribute as a text change, render if needed', () => {
  571. const domSelection = document.getSelection();
  572. const { view: viewP, selection: newSelection } = parse(
  573. '<container:p><attribute:b>[]</attribute:b>foo</container:p>' );
  574. viewRoot.appendChildren( viewP );
  575. selection.setTo( newSelection );
  576. renderer.markToSync( 'children', viewRoot );
  577. renderer.render();
  578. const domP = domRoot.childNodes[ 0 ];
  579. expect( domP.childNodes.length ).to.equal( 2 );
  580. expect( domP.childNodes[ 0 ].tagName.toLowerCase() ).to.equal( 'b' );
  581. expect( domP.childNodes[ 1 ].data ).to.equal( 'foo' );
  582. const domB = domP.childNodes[ 0 ];
  583. const viewB = viewP.getChild( 0 );
  584. expect( domB.childNodes.length ).to.equal( 1 );
  585. expect( domB.childNodes[ 0 ].data ).to.equal( INLINE_FILLER );
  586. expect( domSelection.rangeCount ).to.equal( 1 );
  587. expect( domSelection.getRangeAt( 0 ).startContainer ).to.equal( domB.childNodes[ 0 ] );
  588. expect( domSelection.getRangeAt( 0 ).startOffset ).to.equal( INLINE_FILLER_LENGTH );
  589. expect( domSelection.getRangeAt( 0 ).collapsed ).to.be.true;
  590. // Add text node only to View <p><b>x</b>foo</p>
  591. const viewText = new ViewText( 'x' );
  592. viewB.appendChildren( viewText );
  593. selection.removeAllRanges();
  594. selection.addRange( ViewRange.createFromParentsAndOffsets( viewText, 1, viewText, 1 ) );
  595. renderer.markToSync( 'text', viewText );
  596. renderer.render();
  597. expect( domB.childNodes.length ).to.equal( 1 );
  598. expect( domB.childNodes[ 0 ].data ).to.equal( INLINE_FILLER + 'x' );
  599. expect( domSelection.rangeCount ).to.equal( 1 );
  600. expect( domSelection.getRangeAt( 0 ).startContainer ).to.equal( domB.childNodes[ 0 ] );
  601. expect( domSelection.getRangeAt( 0 ).startOffset ).to.equal( INLINE_FILLER_LENGTH + 1 );
  602. expect( domSelection.getRangeAt( 0 ).collapsed ).to.be.true;
  603. } );
  604. it( 'should handle not collapsed range', () => {
  605. const domSelection = document.getSelection();
  606. const { view: viewP, selection: newSelection } = parse(
  607. '<container:p>fo{o<attribute:b>b}ar</attribute:b></container:p>' );
  608. viewRoot.appendChildren( viewP );
  609. selection.setTo( newSelection );
  610. renderer.markToSync( 'children', viewRoot );
  611. renderer.render();
  612. const domP = domRoot.childNodes[ 0 ];
  613. expect( domP.childNodes.length ).to.equal( 2 );
  614. expect( domP.childNodes[ 0 ].data ).to.equal( 'foo' );
  615. expect( domP.childNodes[ 1 ].tagName.toLowerCase() ).to.equal( 'b' );
  616. expect( domP.childNodes[ 1 ].childNodes.length ).to.equal( 1 );
  617. expect( domP.childNodes[ 1 ].childNodes[ 0 ].data ).to.equal( 'bar' );
  618. expect( domSelection.rangeCount ).to.equal( 1 );
  619. expect( domSelection.getRangeAt( 0 ).startContainer ).to.equal( domP.childNodes[ 0 ] );
  620. expect( domSelection.getRangeAt( 0 ).startOffset ).to.equal( 2 );
  621. expect( domSelection.getRangeAt( 0 ).endContainer ).to.equal( domP.childNodes[ 1 ].childNodes[ 0 ] );
  622. expect( domSelection.getRangeAt( 0 ).endOffset ).to.equal( 1 );
  623. renderer.markToSync( 'children', viewP );
  624. renderAndExpectNoChanges( renderer, domRoot );
  625. } );
  626. it( 'should not change selection if there is no editable with selection', () => {
  627. const domDiv = createElement( document, 'div', null, 'not editable' );
  628. document.body.appendChild( domDiv );
  629. const domSelection = document.getSelection();
  630. domSelection.removeAllRanges();
  631. const domRange = new Range();
  632. domRange.setStart( domDiv, 0 );
  633. domRange.collapse( true );
  634. domSelection.addRange( domRange );
  635. selectionEditable = null;
  636. const { view: viewP, selection: newSelection } = parse( '<container:p>fo{o}</container:p>' );
  637. viewRoot.appendChildren( viewP );
  638. selection.setTo( newSelection );
  639. renderer.render();
  640. expect( domSelection.rangeCount ).to.equal( 1 );
  641. expect( domSelection.getRangeAt( 0 ).startContainer ).to.equal( domDiv );
  642. expect( domSelection.getRangeAt( 0 ).startOffset ).to.equal( 0 );
  643. expect( domSelection.getRangeAt( 0 ).collapsed ).to.equal( true );
  644. } );
  645. it( 'should not change selection if there is no focus', () => {
  646. const domDiv = createElement( document, 'div', null, 'not editable' );
  647. document.body.appendChild( domDiv );
  648. const domSelection = document.getSelection();
  649. domSelection.removeAllRanges();
  650. const domRange = new Range();
  651. domRange.setStart( domDiv, 0 );
  652. domRange.collapse( true );
  653. domSelection.addRange( domRange );
  654. renderer.isFocused = false;
  655. const { view: viewP, selection: newSelection } = parse( '<container:p>fo{o}</container:p>' );
  656. viewRoot.appendChildren( viewP );
  657. selection.setTo( newSelection );
  658. renderer.render();
  659. expect( domSelection.rangeCount ).to.equal( 1 );
  660. expect( domSelection.getRangeAt( 0 ).startContainer ).to.equal( domDiv );
  661. expect( domSelection.getRangeAt( 0 ).startOffset ).to.equal( 0 );
  662. expect( domSelection.getRangeAt( 0 ).collapsed ).to.equal( true );
  663. } );
  664. it( 'should not add ranges if different editable is selected', () => {
  665. const domHeader = document.createElement( 'h1' );
  666. const viewHeader = new ViewElement( 'h1' );
  667. document.body.appendChild( domHeader );
  668. domConverter.bindElements( domHeader, viewHeader );
  669. selectionEditable = viewHeader;
  670. const { view: viewP, selection: newSelection } = parse( '<container:p>fo{o}</container:p>' );
  671. viewRoot.appendChildren( viewP );
  672. selection.setTo( newSelection );
  673. renderer.render();
  674. const domSelection = document.getSelection();
  675. expect( domSelection.rangeCount ).to.equal( 0 );
  676. } );
  677. it( 'should not add inline filler after text node', () => {
  678. const domSelection = document.getSelection();
  679. const { view: viewP, selection: newSelection } = parse( '<container:p>foo[]</container:p>' );
  680. viewRoot.appendChildren( viewP );
  681. selection.setTo( newSelection );
  682. renderer.markToSync( 'children', viewRoot );
  683. renderer.render();
  684. const domP = domRoot.childNodes[ 0 ];
  685. expect( domP.childNodes.length ).to.equal( 1 );
  686. expect( domP.childNodes[ 0 ].data ).to.equal( 'foo' );
  687. expect( domSelection.rangeCount ).to.equal( 1 );
  688. expect( domSelection.getRangeAt( 0 ).startContainer ).to.equal( domP );
  689. expect( domSelection.getRangeAt( 0 ).startOffset ).to.equal( 1 );
  690. expect( domSelection.getRangeAt( 0 ).collapsed ).to.be.true;
  691. } );
  692. it( 'should throw if there is no filler in expected position', () => {
  693. const { view: viewP, selection: newSelection } = parse(
  694. '<container:p>foo<attribute:b>[]</attribute:b>bar</container:p>' );
  695. viewRoot.appendChildren( viewP );
  696. selection.setTo( newSelection );
  697. renderer.markToSync( 'children', viewRoot );
  698. renderer.render();
  699. const domB = domRoot.childNodes[ 0 ].childNodes[ 1 ];
  700. const viewB = viewP.getChild( 1 );
  701. expect( domB.childNodes[ 0 ].data ).to.equal( INLINE_FILLER );
  702. // Remove filler.
  703. domB.childNodes[ 0 ].data = '';
  704. selection.removeAllRanges();
  705. renderer.markToSync( 'children', viewB );
  706. expect( () => {
  707. renderer.render();
  708. } ).to.throw();
  709. } );
  710. it( 'should handle focusing element', () => {
  711. const domFocusSpy = testUtils.sinon.spy( domRoot, 'focus' );
  712. const editable = selection.getEditableElement();
  713. renderer.render();
  714. expect( editable ).to.equal( viewRoot );
  715. expect( domFocusSpy.calledOnce ).to.be.true;
  716. } );
  717. it( 'should not focus editable if isFocues is set to false', () => {
  718. const domFocusSpy = testUtils.sinon.spy( domRoot, 'focus' );
  719. renderer.isFocused = false;
  720. renderer.render();
  721. expect( domFocusSpy.calledOnce ).to.be.false;
  722. } );
  723. it( 'should not focus already focused DOM element', () => {
  724. domRoot.setAttribute( 'contentEditable', true );
  725. domRoot.focus();
  726. const domFocusSpy = testUtils.sinon.spy( domRoot, 'focus' );
  727. renderer.render();
  728. expect( domFocusSpy.called ).to.be.false;
  729. } );
  730. } );
  731. } );
  732. function renderAndExpectNoChanges( renderer, domRoot ) {
  733. const config = {
  734. childList: true,
  735. characterData: true,
  736. characterDataOldValue: true,
  737. subtree: true
  738. };
  739. const mutationObserver = new window.MutationObserver( () => {
  740. throw 'There should be not mutations';
  741. } );
  742. mutationObserver.observe( domRoot, config );
  743. renderer.render();
  744. const records = mutationObserver.takeRecords();
  745. mutationObserver.disconnect();
  746. expect( records.length ).to.equal( 0 );
  747. }