renderer.js 36 KB

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