dom-to-view.js 35 KB

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