dom-to-view.js 36 KB

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