renderer.js 35 KB

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