dom-to-view.js 35 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043
  1. /**
  2. * @license Copyright (c) 2003-2018, CKSource - Frederico Knabben. All rights reserved.
  3. * For licensing, see LICENSE.md.
  4. */
  5. /* globals document */
  6. import ViewElement from '../../../src/view/element';
  7. import ViewDocumentSelection from '../../../src/view/documentselection';
  8. import DomConverter from '../../../src/view/domconverter';
  9. import ViewDocumentFragment from '../../../src/view/documentfragment';
  10. import { INLINE_FILLER, INLINE_FILLER_LENGTH, NBSP_FILLER } from '../../../src/view/filler';
  11. import { parse, stringify } from '../../../src/dev-utils/view';
  12. import count from '@ckeditor/ckeditor5-utils/src/count';
  13. import createElement from '@ckeditor/ckeditor5-utils/src/dom/createelement';
  14. describe( 'DomConverter', () => {
  15. let converter;
  16. before( () => {
  17. converter = new DomConverter();
  18. } );
  19. describe( 'domToView()', () => {
  20. it( 'should create tree of view elements from DOM elements', () => {
  21. const domImg = createElement( document, 'img' );
  22. const domText = document.createTextNode( 'foo' );
  23. const domP = createElement( document, 'p', { 'class': 'foo' }, [ domImg, domText ] );
  24. const viewImg = new ViewElement( 'img' );
  25. converter.bindElements( domImg, viewImg );
  26. const viewP = converter.domToView( domP );
  27. expect( viewP ).to.be.an.instanceof( ViewElement );
  28. expect( viewP.name ).to.equal( 'p' );
  29. expect( viewP.getAttribute( 'class' ) ).to.equal( 'foo' );
  30. expect( count( viewP.getAttributeKeys() ) ).to.equal( 1 );
  31. expect( viewP.childCount ).to.equal( 2 );
  32. expect( viewP.getChild( 0 ).name ).to.equal( 'img' );
  33. expect( viewP.getChild( 1 ).data ).to.equal( 'foo' );
  34. expect( converter.mapViewToDom( viewP ) ).to.not.equal( domP );
  35. expect( converter.mapViewToDom( viewP.getChild( 0 ) ) ).to.equal( domImg );
  36. } );
  37. it( 'should create tree of view elements from DOM elements and bind elements', () => {
  38. const domImg = createElement( document, 'img' );
  39. const domText = document.createTextNode( 'foo' );
  40. const domP = createElement( document, 'p', { 'class': 'foo' }, [ domImg, domText ] );
  41. const viewP = converter.domToView( domP, { bind: true } );
  42. expect( viewP ).to.be.an.instanceof( ViewElement );
  43. expect( viewP.name ).to.equal( 'p' );
  44. expect( viewP.getAttribute( 'class' ) ).to.equal( 'foo' );
  45. expect( count( viewP.getAttributeKeys() ) ).to.equal( 1 );
  46. expect( viewP.childCount ).to.equal( 2 );
  47. expect( viewP.getChild( 0 ).name ).to.equal( 'img' );
  48. expect( viewP.getChild( 1 ).data ).to.equal( 'foo' );
  49. expect( converter.mapViewToDom( viewP ) ).to.equal( domP );
  50. expect( converter.mapViewToDom( viewP.getChild( 0 ) ) ).to.equal( domP.childNodes[ 0 ] );
  51. } );
  52. it( 'should support unicode', () => {
  53. const domText = document.createTextNode( 'நிலைக்கு' );
  54. const domP = createElement( document, 'p', { 'class': 'foo' }, [ domText ] );
  55. const viewP = converter.domToView( domP, { bind: true } );
  56. expect( viewP.childCount ).to.equal( 1 );
  57. const viewText = viewP.getChild( 0 );
  58. expect( viewText.data ).to.equal( 'நிலைக்கு' );
  59. expect( converter.mapViewToDom( viewP ) ).to.equal( domP );
  60. expect( converter.findCorrespondingDomText( viewP.getChild( 0 ) ) ).to.equal( domP.childNodes[ 0 ] );
  61. } );
  62. it( 'should create tree of view elements from DOM element without children', () => {
  63. const domImg = createElement( document, 'img' );
  64. const domText = document.createTextNode( 'foo' );
  65. const domP = createElement( document, 'p', { 'class': 'foo' }, [ domImg, domText ] );
  66. const viewImg = new ViewElement( 'img' );
  67. converter.bindElements( domImg, viewImg );
  68. const viewP = converter.domToView( domP, { withChildren: false } );
  69. expect( viewP ).to.be.an.instanceof( ViewElement );
  70. expect( viewP.name ).to.equal( 'p' );
  71. expect( viewP.getAttribute( 'class' ) ).to.equal( 'foo' );
  72. expect( count( viewP.getAttributeKeys() ) ).to.equal( 1 );
  73. expect( viewP.childCount ).to.equal( 0 );
  74. expect( converter.mapViewToDom( viewP ) ).to.not.equal( domP );
  75. } );
  76. it( 'should create view document fragment from DOM document fragment', () => {
  77. const domImg = createElement( document, 'img' );
  78. const domText = document.createTextNode( 'foo' );
  79. const domFragment = document.createDocumentFragment();
  80. domFragment.appendChild( domImg );
  81. domFragment.appendChild( domText );
  82. const viewFragment = converter.domToView( domFragment, { bind: true } );
  83. expect( viewFragment ).to.be.an.instanceof( ViewDocumentFragment );
  84. expect( viewFragment.childCount ).to.equal( 2 );
  85. expect( viewFragment.getChild( 0 ).name ).to.equal( 'img' );
  86. expect( viewFragment.getChild( 1 ).data ).to.equal( 'foo' );
  87. expect( converter.mapViewToDom( viewFragment ) ).to.equal( domFragment );
  88. expect( converter.mapViewToDom( viewFragment.getChild( 0 ) ) ).to.equal( domFragment.childNodes[ 0 ] );
  89. } );
  90. it( 'should create view document fragment from DOM document fragment without children', () => {
  91. const domImg = createElement( document, 'img' );
  92. const domText = document.createTextNode( 'foo' );
  93. const domFragment = document.createDocumentFragment();
  94. domFragment.appendChild( domImg );
  95. domFragment.appendChild( domText );
  96. const viewImg = new ViewElement( 'img' );
  97. converter.bindElements( domImg, viewImg );
  98. const viewFragment = converter.domToView( domFragment, { withChildren: false } );
  99. expect( viewFragment ).to.be.an.instanceof( ViewDocumentFragment );
  100. expect( viewFragment.childCount ).to.equal( 0 );
  101. expect( converter.mapViewToDom( viewFragment ) ).to.not.equal( domFragment );
  102. } );
  103. it( 'should return already bind document fragment', () => {
  104. const domFragment = document.createDocumentFragment();
  105. const viewFragment = new ViewDocumentFragment();
  106. converter.bindDocumentFragments( domFragment, viewFragment );
  107. const viewFragment2 = converter.domToView( domFragment );
  108. expect( viewFragment2 ).to.equal( viewFragment );
  109. } );
  110. it( 'should return null for block filler', () => {
  111. const domFiller = converter.blockFiller( document );
  112. expect( converter.domToView( domFiller ) ).to.be.null;
  113. } );
  114. it( 'should return null for empty text node', () => {
  115. const textNode = document.createTextNode( '' );
  116. expect( converter.domToView( textNode ) ).to.be.null;
  117. } );
  118. it( 'should return null for a comment', () => {
  119. const comment = document.createComment( 'abc' );
  120. expect( converter.domToView( comment ) ).to.be.null;
  121. } );
  122. describe( 'it should clear whitespaces', () => {
  123. it( 'at the beginning of block element', () => {
  124. const domDiv = createElement( document, 'div', {}, [
  125. document.createTextNode( ' ' ),
  126. createElement( document, 'p', {}, [
  127. document.createTextNode( ' foo' )
  128. ] ),
  129. createElement( document, 'p', {}, [
  130. document.createTextNode( ' foo' )
  131. ] )
  132. ] );
  133. const viewDiv = converter.domToView( domDiv );
  134. expect( viewDiv.childCount ).to.equal( 2 );
  135. expect( viewDiv.getChild( 0 ).getChild( 0 ).data ).to.equal( 'foo' );
  136. expect( viewDiv.getChild( 1 ).getChild( 0 ).data ).to.equal( 'foo' );
  137. } );
  138. it( 'at the end of block element', () => {
  139. const domDiv = createElement( document, 'div', {}, [
  140. createElement( document, 'p', {}, [
  141. document.createTextNode( 'foo ' )
  142. ] ),
  143. createElement( document, 'p', {}, [
  144. document.createTextNode( 'foo ' )
  145. ] ),
  146. document.createTextNode( ' ' )
  147. ] );
  148. const viewDiv = converter.domToView( domDiv );
  149. expect( viewDiv.childCount ).to.equal( 2 );
  150. expect( viewDiv.getChild( 0 ).getChild( 0 ).data ).to.equal( 'foo' );
  151. expect( viewDiv.getChild( 1 ).getChild( 0 ).data ).to.equal( 'foo' );
  152. } );
  153. it( 'after a block element', () => {
  154. const domDiv = createElement( document, 'div', {}, [
  155. createElement( document, 'p', {}, [
  156. document.createTextNode( 'foo' )
  157. ] ),
  158. document.createTextNode( ' ' )
  159. ] );
  160. const viewDiv = converter.domToView( domDiv );
  161. expect( viewDiv.childCount ).to.equal( 1 );
  162. expect( viewDiv.getChild( 0 ).getChild( 0 ).data ).to.equal( 'foo' );
  163. } );
  164. it( 'after a block element (new line)', () => {
  165. const domDiv = createElement( document, 'div', {}, [
  166. createElement( document, 'p', {}, [
  167. document.createTextNode( 'foo' )
  168. ] ),
  169. document.createTextNode( '\n' )
  170. ] );
  171. const viewDiv = converter.domToView( domDiv );
  172. expect( viewDiv.childCount ).to.equal( 1 );
  173. expect( viewDiv.getChild( 0 ).getChild( 0 ).data ).to.equal( 'foo' );
  174. } );
  175. it( 'after a block element (carriage return)', () => {
  176. const domDiv = createElement( document, 'div', {}, [
  177. createElement( document, 'p', {}, [
  178. document.createTextNode( 'foo' )
  179. ] ),
  180. document.createTextNode( '\r' )
  181. ] );
  182. const viewDiv = converter.domToView( domDiv );
  183. expect( viewDiv.childCount ).to.equal( 1 );
  184. expect( viewDiv.getChild( 0 ).getChild( 0 ).data ).to.equal( 'foo' );
  185. } );
  186. it( 'after a block element (tab)', () => {
  187. const domDiv = createElement( document, 'div', {}, [
  188. createElement( document, 'p', {}, [
  189. document.createTextNode( 'foo' )
  190. ] ),
  191. document.createTextNode( '\t' )
  192. ] );
  193. const viewDiv = converter.domToView( domDiv );
  194. expect( viewDiv.childCount ).to.equal( 1 );
  195. expect( viewDiv.getChild( 0 ).getChild( 0 ).data ).to.equal( 'foo' );
  196. } );
  197. // See https://github.com/ckeditor/ckeditor5-engine/issues/822#issuecomment-311670249
  198. it( 'but preserve all except " \\n\\r\\t"', () => {
  199. const domDiv = createElement( document, 'div', {}, [
  200. createElement( document, 'p', {}, [
  201. document.createTextNode( 'x\fx\vx\u00a0x\u1680x\u2000x\u200ax\u2028x\u2029x\u202fx\u205fx\u3000x\ufeffx' )
  202. ] ),
  203. createElement( document, 'p', {}, [
  204. // x<two spaces>x because it behaved differently than "x<space>x" when I've been fixing this
  205. document.createTextNode( 'x\f\vx\u00a0\u1680x\u2000\u200ax\u2028\u2029x\u202f\u205fx\u3000\ufeffx' )
  206. ] )
  207. ] );
  208. const viewDiv = converter.domToView( domDiv );
  209. expect( viewDiv.childCount ).to.equal( 2 );
  210. expect( viewDiv.getChild( 0 ).getChild( 0 ).data )
  211. .to.equal( 'x\fx\vx\u00a0x\u1680x\u2000x\u200ax\u2028x\u2029x\u202fx\u205fx\u3000x\ufeffx' );
  212. expect( viewDiv.getChild( 1 ).getChild( 0 ).data )
  213. .to.equal( 'x\f\vx\u00a0\u1680x\u2000\u200ax\u2028\u2029x\u202f\u205fx\u3000\ufeffx' );
  214. } );
  215. it( 'before a block element', () => {
  216. const domDiv = createElement( document, 'div', {}, [
  217. document.createTextNode( ' ' ),
  218. createElement( document, 'p', {}, [
  219. document.createTextNode( ' foo' )
  220. ] )
  221. ] );
  222. const viewDiv = converter.domToView( domDiv );
  223. expect( viewDiv.childCount ).to.equal( 1 );
  224. expect( viewDiv.getChild( 0 ).getChild( 0 ).data ).to.equal( 'foo' );
  225. } );
  226. it( 'before a block element (new line)', () => {
  227. const domDiv = createElement( document, 'div', {}, [
  228. document.createTextNode( '\n' ),
  229. createElement( document, 'p', {}, [
  230. document.createTextNode( 'foo' )
  231. ] )
  232. ] );
  233. const viewDiv = converter.domToView( domDiv );
  234. expect( viewDiv.childCount ).to.equal( 1 );
  235. expect( viewDiv.getChild( 0 ).getChild( 0 ).data ).to.equal( 'foo' );
  236. } );
  237. it( 'after a <br>', () => {
  238. const domP = createElement( document, 'p', {}, [
  239. document.createTextNode( 'foo' ),
  240. createElement( document, 'br' ),
  241. document.createTextNode( ' bar' )
  242. ] );
  243. const viewP = converter.domToView( domP );
  244. expect( viewP.childCount ).to.equal( 3 );
  245. expect( viewP.getChild( 2 ).data ).to.equal( 'bar' );
  246. } );
  247. it( 'after a <br> – two spaces', () => {
  248. const domP = createElement( document, 'p', {}, [
  249. document.createTextNode( 'foo' ),
  250. createElement( document, 'br' ),
  251. document.createTextNode( ' \u00a0bar' )
  252. ] );
  253. const viewP = converter.domToView( domP );
  254. expect( viewP.childCount ).to.equal( 3 );
  255. expect( viewP.getChild( 2 ).data ).to.equal( ' bar' );
  256. } );
  257. // This TC ensures that the algorithm stops on <br>.
  258. // If not, situations like https://github.com/ckeditor/ckeditor5/issues/1024#issuecomment-393109558 might occur.
  259. it( 'after a <br> – when <br> is preceeded with a nbsp', () => {
  260. const domP = createElement( document, 'p', {}, [
  261. document.createTextNode( 'foo\u00a0' ),
  262. createElement( document, 'br' ),
  263. document.createTextNode( ' bar' )
  264. ] );
  265. const viewP = converter.domToView( domP );
  266. expect( viewP.childCount ).to.equal( 3 );
  267. expect( viewP.getChild( 2 ).data ).to.equal( 'bar' );
  268. } );
  269. it( 'after a <br> – when text after that <br> is nested', () => {
  270. const domP = createElement( document, 'p', {}, [
  271. document.createTextNode( 'foo' ),
  272. createElement( document, 'br' ),
  273. createElement( document, 'b', {}, [
  274. document.createTextNode( ' bar' )
  275. ] )
  276. ] );
  277. const viewP = converter.domToView( domP );
  278. expect( viewP.childCount ).to.equal( 3 );
  279. expect( viewP.getChild( 2 ).getChild( 0 ).data ).to.equal( 'bar' );
  280. } );
  281. it( 'between <br>s - trim only the left boundary', () => {
  282. const domP = createElement( document, 'p', {}, [
  283. document.createTextNode( 'x' ),
  284. createElement( document, 'br' ),
  285. document.createTextNode( ' foo ' ),
  286. createElement( document, 'br' ),
  287. document.createTextNode( 'x' )
  288. ] );
  289. const viewP = converter.domToView( domP );
  290. expect( viewP.childCount ).to.equal( 5 );
  291. expect( viewP.getChild( 2 ).data ).to.equal( 'foo ' );
  292. } );
  293. it( 'multiple consecutive whitespaces changed to one', () => {
  294. const domDiv = createElement( document, 'div', {}, [
  295. createElement( document, 'p', {}, [
  296. document.createTextNode( ' f o o' )
  297. ] ),
  298. createElement( document, 'p', {}, [
  299. document.createTextNode( 'fo o ' )
  300. ] )
  301. ] );
  302. const viewDiv = converter.domToView( domDiv );
  303. expect( viewDiv.getChild( 0 ).getChild( 0 ).data ).to.equal( 'f o o' );
  304. expect( viewDiv.getChild( 1 ).getChild( 0 ).data ).to.equal( 'fo o' );
  305. } );
  306. it( 'multiple consecutive whitespaces changed to one (tab, new line, carriage return)', () => {
  307. const domDiv = createElement( document, 'div', {}, [
  308. document.createTextNode( '\n\n \t\r\n' ),
  309. createElement( document, 'p', {}, [
  310. document.createTextNode( 'f\n\t\r\n\to\n\n\no' )
  311. ] ),
  312. document.createTextNode( '\n\n \t\r\n' )
  313. ] );
  314. const viewDiv = converter.domToView( domDiv );
  315. expect( viewDiv.childCount ).to.equal( 1 );
  316. expect( viewDiv.getChild( 0 ).getChild( 0 ).data ).to.equal( 'f o o' );
  317. } );
  318. function test( inputTexts, output ) {
  319. if ( typeof inputTexts == 'string' ) {
  320. inputTexts = [ inputTexts ];
  321. }
  322. it( 'spaces in a text node: ' + inputTexts.join( '|' ) + ' -> ' + output, () => {
  323. const domElement = createElement( document, 'div', {}, [] );
  324. for ( const text of inputTexts ) {
  325. domElement.appendChild( document.createTextNode( text.replace( /_/g, '\u00A0' ) ) );
  326. }
  327. const viewElement = converter.domToView( domElement );
  328. let data = '';
  329. for ( const child of viewElement.getChildren() ) {
  330. data += child.data.replace( /\u00A0/g, '_' );
  331. }
  332. expect( data ).to.equal( output );
  333. } );
  334. }
  335. // At the beginning.
  336. test( '_x', ' x' );
  337. test( '_ x', ' x' );
  338. test( '_ _x', ' x' );
  339. test( '_ _ x', ' x' );
  340. // At the end.
  341. test( 'x_', 'x ' );
  342. test( 'x _', 'x ' );
  343. test( 'x_ _', 'x ' );
  344. test( 'x _ _', 'x ' );
  345. // In the middle.
  346. test( 'x x', 'x x' );
  347. test( 'x _x', 'x x' );
  348. test( 'x _ x', 'x x' );
  349. test( 'x _ _x', 'x x' );
  350. // Complex.
  351. test( '_x_', ' x ' );
  352. test( '_ x _x _', ' x x ' );
  353. test( '_ _x x _', ' x x ' );
  354. test( '_ _x x_ _', ' x x ' );
  355. test( '_ _x _ _x_', ' x x ' );
  356. test( '_', ' ' );
  357. // With hard &nbsp;
  358. test( '_x', ' x' );
  359. test( '__x', ' _x' );
  360. test( '___x', ' __x' );
  361. test( '__ x', ' _ x' );
  362. test( 'x_', 'x ' );
  363. test( 'x__', 'x_ ' );
  364. test( 'x___', 'x__ ' );
  365. // This is an edge case, but it's impossible to write elegant and compact algorithm that is also
  366. // 100% correct. We might assume that expected result is `x _` but it will be converted to `x `
  367. // by the algorithm. This is acceptable, though.
  368. test( 'x __', 'x ' );
  369. test( 'x_x', 'x_x' );
  370. test( 'x___x', 'x___x' );
  371. test( 'x____x', 'x____x' );
  372. test( 'x__ x', 'x__ x' );
  373. test( 'x___ x', 'x___ x' );
  374. test( 'x_ _x', 'x_ x' );
  375. test( 'x __x', 'x _x' );
  376. test( 'x _ x', 'x x' );
  377. test( 'x __ _x', 'x _ x' );
  378. // Two text nodes.
  379. test( [ 'x', 'y' ], 'xy' );
  380. test( [ 'x ', 'y' ], 'x y' );
  381. test( [ 'x _', 'y' ], 'x y' );
  382. test( [ 'x _ ', 'y' ], 'x y' );
  383. test( [ 'x _ _', 'y' ], 'x y' );
  384. test( [ 'x', ' y' ], 'x y' );
  385. test( [ 'x ', '_y' ], 'x y' );
  386. test( [ 'x_ ', '_y' ], 'x y' );
  387. test( [ 'x _ ', '_y' ], 'x y' );
  388. test( [ 'x_ _ ', '_y' ], 'x y' );
  389. test( [ 'x', ' _y' ], 'x y' );
  390. test( [ 'x ', '_ y' ], 'x y' );
  391. test( [ 'x_ ', '_ y' ], 'x y' );
  392. test( [ 'x _ ', '_ y' ], 'x y' );
  393. test( [ 'x_ _ ', '_ y' ], 'x y' );
  394. // Some tests with hard &nbsp;
  395. test( [ 'x', '_y' ], 'x_y' );
  396. test( [ 'x_', 'y' ], 'x_y' );
  397. test( [ 'x_', ' y' ], 'x_ y' );
  398. test( [ 'x__', ' y' ], 'x__ y' );
  399. test( [ 'x_ _', ' y' ], 'x_ y' );
  400. it( 'not in preformatted blocks', () => {
  401. const domDiv = createElement( document, 'div', {}, [
  402. createElement( document, 'pre', {}, [
  403. document.createTextNode( ' foo\n foo ' )
  404. ] )
  405. ] );
  406. const viewDiv = converter.domToView( domDiv );
  407. expect( viewDiv.getChild( 0 ).getChild( 0 ).data ).to.equal( ' foo\n foo ' );
  408. } );
  409. // https://github.com/ckeditor/ckeditor5-clipboard/issues/2#issuecomment-310417731
  410. it( 'not in span between two words (space)', () => {
  411. const domDiv = createElement( document, 'div', {}, [
  412. document.createTextNode( 'word' ),
  413. createElement( document, 'span', {}, [
  414. document.createTextNode( ' ' )
  415. ] ),
  416. document.createTextNode( 'word' )
  417. ] );
  418. const viewDiv = converter.domToView( domDiv );
  419. expect( viewDiv.getChild( 1 ).name ).to.equal( 'span' );
  420. expect( viewDiv.getChild( 1 ).childCount ).to.equal( 1 );
  421. expect( viewDiv.getChild( 1 ).getChild( 0 ).data ).to.equal( ' ' );
  422. } );
  423. // https://github.com/ckeditor/ckeditor5-clipboard/issues/2#issuecomment-310417731
  424. it( 'not in span between two words (nbsp)', () => {
  425. const domDiv = createElement( document, 'div', {}, [
  426. document.createTextNode( 'word' ),
  427. createElement( document, 'span', {}, [
  428. document.createTextNode( '\u00a0' )
  429. ] ),
  430. document.createTextNode( 'word' )
  431. ] );
  432. const viewDiv = converter.domToView( domDiv );
  433. expect( viewDiv.getChild( 1 ).name ).to.equal( 'span' );
  434. expect( viewDiv.getChild( 1 ).childCount ).to.equal( 1 );
  435. expect( viewDiv.getChild( 1 ).getChild( 0 ).data ).to.equal( '\u00a0' );
  436. } );
  437. // https://github.com/ckeditor/ckeditor5-clipboard/issues/2#issuecomment-310417731
  438. it( 'not in a Chrome\'s paste-like content', () => {
  439. // Like:
  440. // <span style="color: rgb(0, 0, 0); font-family: Times;">This is the<span>\u00a0</span></span>
  441. // <a href="url" style="font-family: Times; font-size: medium;">third developer preview</a>
  442. const domDiv = createElement( document, 'div', {}, [
  443. createElement( document, 'span', {}, [
  444. document.createTextNode( 'word' ),
  445. createElement( document, 'span', {}, [
  446. document.createTextNode( '\u00a0' )
  447. ] )
  448. ] ),
  449. createElement( document, 'a', {}, [
  450. document.createTextNode( 'word' )
  451. ] )
  452. ] );
  453. const viewDiv = converter.domToView( domDiv );
  454. expect( viewDiv.getChild( 0 ).name ).to.equal( 'span' );
  455. expect( viewDiv.getChild( 0 ).childCount ).to.equal( 2 );
  456. expect( viewDiv.getChild( 0 ).getChild( 1 ).name ).to.equal( 'span' );
  457. expect( viewDiv.getChild( 0 ).getChild( 1 ).childCount ).to.equal( 1 );
  458. expect( viewDiv.getChild( 0 ).getChild( 1 ).getChild( 0 ).data ).to.equal( '\u00a0' );
  459. } );
  460. // While we render `X&nbsp;<br>X`, `X <br>X` is ok too – the space needs to be preserved.
  461. it( 'not before a <br>', () => {
  462. const domP = createElement( document, 'p', {}, [
  463. document.createTextNode( 'foo ' ),
  464. createElement( document, 'br' )
  465. ] );
  466. const viewP = converter.domToView( domP );
  467. expect( viewP.childCount ).to.equal( 2 );
  468. expect( viewP.getChild( 0 ).data ).to.equal( 'foo ' );
  469. } );
  470. it( 'not before a <br> (nbsp+space)', () => {
  471. const domP = createElement( document, 'p', {}, [
  472. document.createTextNode( 'foo\u00a0 ' ),
  473. createElement( document, 'br' )
  474. ] );
  475. const viewP = converter.domToView( domP );
  476. expect( viewP.childCount ).to.equal( 2 );
  477. expect( viewP.getChild( 0 ).data ).to.equal( 'foo ' );
  478. } );
  479. it( 'before a <br> (space+space=>space)', () => {
  480. const domP = createElement( document, 'p', {}, [
  481. document.createTextNode( 'foo ' ),
  482. createElement( document, 'br' )
  483. ] );
  484. const viewP = converter.domToView( domP );
  485. expect( viewP.childCount ).to.equal( 2 );
  486. expect( viewP.getChild( 0 ).data ).to.equal( 'foo ' );
  487. } );
  488. it( 'not before a <br> – when text before that <br> is nested', () => {
  489. const domP = createElement( document, 'p', {}, [
  490. createElement( document, 'b', {}, [
  491. document.createTextNode( 'foo ' )
  492. ] ),
  493. createElement( document, 'br' )
  494. ] );
  495. const viewP = converter.domToView( domP );
  496. expect( viewP.childCount ).to.equal( 2 );
  497. expect( viewP.getChild( 0 ).getChild( 0 ).data ).to.equal( 'foo ' );
  498. } );
  499. //
  500. // See also whitespace-handling-integration.js.
  501. //
  502. } );
  503. describe( 'clearing auto filler', () => {
  504. it( 'should remove inline filler when converting dom to view', () => {
  505. const text = document.createTextNode( INLINE_FILLER + 'foo' );
  506. const view = converter.domToView( text );
  507. expect( view.data ).to.equal( 'foo' );
  508. } );
  509. // See https://github.com/ckeditor/ckeditor5/issues/692.
  510. it( 'should not remove space after inline filler if previous node nor next node does not exist', () => {
  511. const text = document.createTextNode( INLINE_FILLER + ' ' );
  512. const view = converter.domToView( text );
  513. expect( view.data ).to.equal( ' ' );
  514. } );
  515. it( 'should convert non breaking space to normal space after inline filler', () => {
  516. const text = document.createTextNode( INLINE_FILLER + '\u00A0' );
  517. const view = converter.domToView( text );
  518. expect( view.data ).to.equal( ' ' );
  519. } );
  520. } );
  521. } );
  522. describe( 'domChildrenToView', () => {
  523. it( 'should convert children', () => {
  524. const domImg = createElement( document, 'img' );
  525. const domText = document.createTextNode( 'foo' );
  526. const domP = createElement( document, 'p', null, [ domImg, domText ] );
  527. const viewChildren = Array.from( converter.domChildrenToView( domP ) );
  528. expect( viewChildren.length ).to.equal( 2 );
  529. expect( stringify( viewChildren[ 0 ] ) ).to.equal( '<img></img>' );
  530. expect( stringify( viewChildren[ 1 ] ) ).to.equal( 'foo' );
  531. } );
  532. it( 'should skip filler', () => {
  533. const domFiller = converter.blockFiller( document );
  534. const domP = createElement( document, 'p', null, domFiller );
  535. const viewChildren = Array.from( converter.domChildrenToView( domP ) );
  536. expect( viewChildren.length ).to.equal( 0 );
  537. } );
  538. it( 'should pass options', () => {
  539. const domText = document.createTextNode( 'foo' );
  540. const domB = createElement( document, 'b', null, 'bar' );
  541. const domP = createElement( document, 'p', null, [ domB, domText ] );
  542. const viewChildren = Array.from( converter.domChildrenToView( domP, { withChildren: false } ) );
  543. expect( viewChildren.length ).to.equal( 2 );
  544. expect( stringify( viewChildren[ 0 ] ) ).to.equal( '<b></b>' );
  545. expect( stringify( viewChildren[ 1 ] ) ).to.equal( 'foo' );
  546. } );
  547. } );
  548. describe( 'domPositionToView()', () => {
  549. it( 'should converter position in text', () => {
  550. const domText = document.createTextNode( 'foo' );
  551. const domB = createElement( document, 'b', null, 'bar' );
  552. const domP = createElement( document, 'p', null, [ domText, domB ] );
  553. const viewP = parse( '<p>foo<b>bar</b></p>' );
  554. converter.bindElements( domP, viewP );
  555. converter.bindElements( domB, viewP.getChild( 0 ) );
  556. const viewPosition = converter.domPositionToView( domText, 2 );
  557. expect( stringify( viewP, viewPosition ) ).to.equal( '<p>fo{}o<b>bar</b></p>' );
  558. } );
  559. it( 'should support unicode', () => {
  560. const domText = document.createTextNode( 'நிலைக்கு' );
  561. const domP = createElement( document, 'p', null, [ domText ] );
  562. const viewP = parse( '<p>நிலைக்கு</p>' );
  563. converter.bindElements( domP, viewP );
  564. const viewPosition = converter.domPositionToView( domText, 4 );
  565. expect( stringify( viewP, viewPosition ) ).to.equal( '<p>நிலை{}க்கு</p>' );
  566. } );
  567. it( 'should converter position in element', () => {
  568. const domText = document.createTextNode( 'foo' );
  569. const domB = createElement( document, 'b', null, 'bar' );
  570. const domP = createElement( document, 'p', null, [ domText, domB ] );
  571. const viewP = parse( '<p>foo<b>bar</b></p>' );
  572. converter.bindElements( domP, viewP );
  573. converter.bindElements( domB, viewP.getChild( 0 ) );
  574. const viewPosition = converter.domPositionToView( domP, 1 );
  575. expect( stringify( viewP, viewPosition ) ).to.equal( '<p>foo[]<b>bar</b></p>' );
  576. } );
  577. it( 'should converter position at the beginning', () => {
  578. const domText = document.createTextNode( 'foo' );
  579. const domP = createElement( document, 'p', null, domText );
  580. const viewP = parse( '<p>foo</p>' );
  581. converter.bindElements( domP, viewP );
  582. const viewPosition = converter.domPositionToView( domP, 0 );
  583. expect( stringify( viewP, viewPosition ) ).to.equal( '<p>[]foo</p>' );
  584. } );
  585. it( 'should converter position inside block filler', () => {
  586. const converter = new DomConverter( { blockFiller: NBSP_FILLER } );
  587. const domFiller = NBSP_FILLER( document ); // eslint-disable-line new-cap
  588. const domP = createElement( document, 'p', null, domFiller );
  589. const viewP = parse( '<p></p>' );
  590. converter.bindElements( domP, viewP );
  591. const viewPosition = converter.domPositionToView( domFiller, 0 );
  592. expect( stringify( viewP, viewPosition ) ).to.equal( '<p>[]</p>' );
  593. } );
  594. it( 'should converter position inside inline filler', () => {
  595. const domFiller = document.createTextNode( INLINE_FILLER );
  596. const domText = document.createTextNode( 'foo' );
  597. const domB = createElement( document, 'b', null, domFiller );
  598. const domP = createElement( document, 'p', null, [ domText, domB ] );
  599. const viewP = parse( '<p>foo<b></b></p>' );
  600. converter.bindElements( domP, viewP );
  601. converter.bindElements( domB, viewP.getChild( 1 ) );
  602. const viewPosition = converter.domPositionToView( domFiller, INLINE_FILLER_LENGTH );
  603. expect( stringify( viewP, viewPosition ) ).to.equal( '<p>foo<b>[]</b></p>' );
  604. } );
  605. it( 'should converter position inside inline filler with text', () => {
  606. const domFiller = document.createTextNode( INLINE_FILLER + 'bar' );
  607. const domText = document.createTextNode( 'foo' );
  608. const domB = createElement( document, 'b', null, domFiller );
  609. const domP = createElement( document, 'p', null, [ domText, domB ] );
  610. const viewP = parse( '<p>foo<b>bar</b></p>' );
  611. converter.bindElements( domP, viewP );
  612. converter.bindElements( domB, viewP.getChild( 1 ) );
  613. const viewPosition = converter.domPositionToView( domFiller, INLINE_FILLER_LENGTH + 2 );
  614. expect( viewPosition.offset ).to.equal( 2 );
  615. expect( stringify( viewP, viewPosition ) ).to.equal( '<p>foo<b>ba{}r</b></p>' );
  616. } );
  617. it( 'should converter position inside inline filler with text at the beginning', () => {
  618. const domFiller = document.createTextNode( INLINE_FILLER + 'bar' );
  619. const domText = document.createTextNode( 'foo' );
  620. const domB = createElement( document, 'b', null, domFiller );
  621. const domP = createElement( document, 'p', null, [ domText, domB ] );
  622. const viewP = parse( '<p>foo<b>bar</b></p>' );
  623. converter.bindElements( domP, viewP );
  624. converter.bindElements( domB, viewP.getChild( 1 ) );
  625. const viewPosition = converter.domPositionToView( domFiller, INLINE_FILLER_LENGTH - 1 );
  626. expect( viewPosition.offset ).to.equal( 0 );
  627. expect( stringify( viewP, viewPosition ) ).to.equal( '<p>foo<b>{}bar</b></p>' );
  628. } );
  629. it( 'should converter position at the end', () => {
  630. const domText = document.createTextNode( 'foo' );
  631. const domP = createElement( document, 'p', null, domText );
  632. const viewP = parse( '<p>foo</p>' );
  633. converter.bindElements( domP, viewP );
  634. const viewPosition = converter.domPositionToView( domP, 1 );
  635. expect( stringify( viewP, viewPosition ) ).to.equal( '<p>foo[]</p>' );
  636. } );
  637. it( 'should return null if there is no corresponding parent node', () => {
  638. const domText = document.createTextNode( 'foo' );
  639. const domP = createElement( document, 'p', null, domText );
  640. const viewPosition = converter.domPositionToView( domP, 0 );
  641. expect( viewPosition ).to.be.null;
  642. } );
  643. it( 'should return null if there is no corresponding sibling node', () => {
  644. const domB = createElement( document, 'b', null, 'bar' );
  645. const domText = document.createTextNode( 'foo' );
  646. const domP = createElement( document, 'p', null, [ domB, domText ] );
  647. const viewPosition = converter.domPositionToView( domP, 1 );
  648. expect( viewPosition ).to.be.null;
  649. } );
  650. it( 'should return null if there is no corresponding text node', () => {
  651. const domText = document.createTextNode( 'foo' );
  652. const viewPosition = converter.domPositionToView( domText, 1 );
  653. expect( viewPosition ).to.be.null;
  654. } );
  655. } );
  656. describe( 'domRangeToView()', () => {
  657. it( 'should convert DOM range', () => {
  658. const domFoo = document.createTextNode( 'foo' );
  659. const domBar = document.createTextNode( 'bar' );
  660. const domB = createElement( document, 'b', null, domBar );
  661. const domP = createElement( document, 'p', null, [ domFoo, domB ] );
  662. const viewP = parse( '<p>foo<b>bar</b></p>' );
  663. converter.bindElements( domP, viewP );
  664. converter.bindElements( domB, viewP.getChild( 1 ) );
  665. const domRange = document.createRange();
  666. domRange.setStart( domFoo, 1 );
  667. domRange.setEnd( domBar, 2 );
  668. const viewRange = converter.domRangeToView( domRange );
  669. expect( stringify( viewP, viewRange ) ).to.equal( '<p>f{oo<b>ba}r</b></p>' );
  670. } );
  671. it( 'should return null if start or end is null', () => {
  672. const domFoo = document.createTextNode( 'foo' );
  673. const domBar = document.createTextNode( 'bar' );
  674. const domB = createElement( document, 'b', null, domBar );
  675. createElement( document, 'p', null, [ domFoo, domB ] );
  676. const domRange = document.createRange();
  677. domRange.setStart( domFoo, 1 );
  678. domRange.setEnd( domBar, 2 );
  679. const viewRange = converter.domRangeToView( domRange );
  680. expect( viewRange ).to.be.null;
  681. } );
  682. } );
  683. describe( 'domSelectionToView()', () => {
  684. it( 'should convert selection', () => {
  685. const domFoo = document.createTextNode( 'foo' );
  686. const domBar = document.createTextNode( 'bar' );
  687. const domB = createElement( document, 'b', null, domBar );
  688. const domP = createElement( document, 'p', null, [ domFoo, domB ] );
  689. const viewP = parse( '<p>foo<b>bar</b></p>' );
  690. converter.bindElements( domP, viewP );
  691. converter.bindElements( domB, viewP.getChild( 1 ) );
  692. document.body.appendChild( domP );
  693. const domRange = document.createRange();
  694. domRange.setStart( domFoo, 1 );
  695. domRange.setEnd( domBar, 2 );
  696. const domSelection = document.getSelection();
  697. domSelection.removeAllRanges();
  698. domSelection.addRange( domRange );
  699. const viewSelection = converter.domSelectionToView( domSelection );
  700. expect( viewSelection.rangeCount ).to.equal( 1 );
  701. expect( stringify( viewP, viewSelection.getFirstRange() ) ).to.equal( '<p>f{oo<b>ba}r</b></p>' );
  702. domP.remove();
  703. } );
  704. it( 'should convert empty selection to empty selection', () => {
  705. const domSelection = document.getSelection();
  706. domSelection.removeAllRanges();
  707. const viewSelection = converter.domSelectionToView( domSelection );
  708. expect( viewSelection.rangeCount ).to.equal( 0 );
  709. } );
  710. it( 'should handle selection direction', () => {
  711. const domFoo = document.createTextNode( 'foo' );
  712. const domP = createElement( document, 'p', null, [ domFoo ] );
  713. const viewP = parse( '<p>foo</p>' );
  714. converter.bindElements( domP, viewP );
  715. document.body.appendChild( domP );
  716. const domRange = document.createRange();
  717. domRange.setStart( domFoo, 2 );
  718. domRange.collapse( true );
  719. const domSelection = document.getSelection();
  720. domSelection.removeAllRanges();
  721. domSelection.addRange( domRange );
  722. domSelection.extend( domFoo, 1 );
  723. const viewSelection = converter.domSelectionToView( domSelection );
  724. expect( viewSelection.rangeCount ).to.equal( 1 );
  725. expect( viewSelection.anchor.offset ).to.equal( 2 );
  726. expect( viewSelection.focus.offset ).to.equal( 1 );
  727. expect( viewSelection.isBackward ).to.be.true;
  728. domP.remove();
  729. } );
  730. it( 'should not add null ranges', () => {
  731. const domFoo = document.createTextNode( 'foo' );
  732. const domBar = document.createTextNode( 'bar' );
  733. const domB = createElement( document, 'b', null, domBar );
  734. const domP = createElement( document, 'p', null, [ domFoo, domB ] );
  735. document.body.appendChild( domP );
  736. const domRange = document.createRange();
  737. domRange.setStart( domFoo, 1 );
  738. domRange.setEnd( domBar, 2 );
  739. const domSelection = document.getSelection();
  740. domSelection.removeAllRanges();
  741. domSelection.addRange( domRange );
  742. const viewSelection = converter.domSelectionToView( domSelection );
  743. expect( viewSelection.rangeCount ).to.equal( 0 );
  744. domP.remove();
  745. } );
  746. it( 'should return fake selection', () => {
  747. const domContainer = document.createElement( 'div' );
  748. const domSelection = document.getSelection();
  749. domContainer.innerHTML = 'fake selection container';
  750. document.body.appendChild( domContainer );
  751. const viewSelection = new ViewDocumentSelection( new ViewElement(), 'in' );
  752. converter.bindFakeSelection( domContainer, viewSelection );
  753. const domRange = document.createRange();
  754. domRange.selectNodeContents( domContainer );
  755. domSelection.removeAllRanges();
  756. domSelection.addRange( domRange );
  757. const bindViewSelection = converter.domSelectionToView( domSelection );
  758. expect( bindViewSelection.isEqual( viewSelection ) ).to.be.true;
  759. domContainer.remove();
  760. } );
  761. it( 'should return fake selection if selection is placed inside text node', () => {
  762. const domContainer = document.createElement( 'div' );
  763. const domSelection = document.getSelection();
  764. domContainer.innerHTML = 'fake selection container';
  765. document.body.appendChild( domContainer );
  766. const viewSelection = new ViewDocumentSelection( new ViewElement(), 'in' );
  767. converter.bindFakeSelection( domContainer, viewSelection );
  768. const domRange = document.createRange();
  769. domRange.selectNodeContents( domContainer.firstChild );
  770. domSelection.removeAllRanges();
  771. domSelection.addRange( domRange );
  772. const bindViewSelection = converter.domSelectionToView( domSelection );
  773. expect( bindViewSelection.isEqual( viewSelection ) ).to.be.true;
  774. domContainer.remove();
  775. } );
  776. } );
  777. } );