dom-to-view.js 35 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 { StylesProcessor } from '../../../src/view/stylesmap';
  13. import { parse, stringify } from '../../../src/dev-utils/view';
  14. import count from '@ckeditor/ckeditor5-utils/src/count';
  15. import createElement from '@ckeditor/ckeditor5-utils/src/dom/createelement';
  16. describe( 'DomConverter', () => {
  17. let converter, viewDocument;
  18. before( () => {
  19. viewDocument = new ViewDocument( new StylesProcessor() );
  20. converter = new DomConverter( viewDocument );
  21. } );
  22. describe( 'domToView()', () => {
  23. it( 'should create tree of view elements from DOM elements', () => {
  24. const domImg = createElement( document, 'img' );
  25. const domText = document.createTextNode( 'foo' );
  26. const domP = createElement( document, 'p', { 'class': 'foo' }, [ domImg, domText ] );
  27. const viewImg = new ViewElement( viewDocument, 'img' );
  28. converter.bindElements( domImg, viewImg );
  29. const viewP = converter.domToView( domP );
  30. expect( viewP ).to.be.an.instanceof( ViewElement );
  31. expect( viewP.name ).to.equal( 'p' );
  32. expect( viewP.getAttribute( 'class' ) ).to.equal( 'foo' );
  33. expect( count( viewP.getAttributeKeys() ) ).to.equal( 1 );
  34. expect( viewP.childCount ).to.equal( 2 );
  35. expect( viewP.getChild( 0 ).name ).to.equal( 'img' );
  36. expect( viewP.getChild( 1 ).data ).to.equal( 'foo' );
  37. expect( converter.mapViewToDom( viewP ) ).to.not.equal( domP );
  38. expect( converter.mapViewToDom( viewP.getChild( 0 ) ) ).to.equal( domImg );
  39. } );
  40. it( 'should create tree of view elements from DOM elements and bind elements', () => {
  41. const domImg = createElement( document, 'img' );
  42. const domText = document.createTextNode( 'foo' );
  43. const domP = createElement( document, 'p', { 'class': 'foo' }, [ domImg, domText ] );
  44. const viewP = converter.domToView( domP, { bind: true } );
  45. expect( viewP ).to.be.an.instanceof( ViewElement );
  46. expect( viewP.name ).to.equal( 'p' );
  47. expect( viewP.getAttribute( 'class' ) ).to.equal( 'foo' );
  48. expect( count( viewP.getAttributeKeys() ) ).to.equal( 1 );
  49. expect( viewP.childCount ).to.equal( 2 );
  50. expect( viewP.getChild( 0 ).name ).to.equal( 'img' );
  51. expect( viewP.getChild( 1 ).data ).to.equal( 'foo' );
  52. expect( converter.mapViewToDom( viewP ) ).to.equal( domP );
  53. expect( converter.mapViewToDom( viewP.getChild( 0 ) ) ).to.equal( domP.childNodes[ 0 ] );
  54. } );
  55. it( 'should support unicode', () => {
  56. const domText = document.createTextNode( 'நிலைக்கு' );
  57. const domP = createElement( document, 'p', { 'class': 'foo' }, [ domText ] );
  58. const viewP = converter.domToView( domP, { bind: true } );
  59. expect( viewP.childCount ).to.equal( 1 );
  60. const viewText = viewP.getChild( 0 );
  61. expect( viewText.data ).to.equal( 'நிலைக்கு' );
  62. expect( converter.mapViewToDom( viewP ) ).to.equal( domP );
  63. expect( converter.findCorrespondingDomText( viewP.getChild( 0 ) ) ).to.equal( domP.childNodes[ 0 ] );
  64. } );
  65. it( 'should create tree of view elements from DOM element without children', () => {
  66. const domImg = createElement( document, 'img' );
  67. const domText = document.createTextNode( 'foo' );
  68. const domP = createElement( document, 'p', { 'class': 'foo' }, [ domImg, domText ] );
  69. const viewImg = new ViewElement( viewDocument, 'img' );
  70. converter.bindElements( domImg, viewImg );
  71. const viewP = converter.domToView( domP, { withChildren: false } );
  72. expect( viewP ).to.be.an.instanceof( ViewElement );
  73. expect( viewP.name ).to.equal( 'p' );
  74. expect( viewP.getAttribute( 'class' ) ).to.equal( 'foo' );
  75. expect( count( viewP.getAttributeKeys() ) ).to.equal( 1 );
  76. expect( viewP.childCount ).to.equal( 0 );
  77. expect( converter.mapViewToDom( viewP ) ).to.not.equal( domP );
  78. } );
  79. it( 'should create view document fragment from DOM document fragment', () => {
  80. const domImg = createElement( document, 'img' );
  81. const domText = document.createTextNode( 'foo' );
  82. const domFragment = document.createDocumentFragment();
  83. domFragment.appendChild( domImg );
  84. domFragment.appendChild( domText );
  85. const viewFragment = converter.domToView( domFragment, { bind: true } );
  86. expect( viewFragment ).to.be.an.instanceof( ViewDocumentFragment );
  87. expect( viewFragment.childCount ).to.equal( 2 );
  88. expect( viewFragment.getChild( 0 ).name ).to.equal( 'img' );
  89. expect( viewFragment.getChild( 1 ).data ).to.equal( 'foo' );
  90. expect( converter.mapViewToDom( viewFragment ) ).to.equal( domFragment );
  91. expect( converter.mapViewToDom( viewFragment.getChild( 0 ) ) ).to.equal( domFragment.childNodes[ 0 ] );
  92. } );
  93. it( 'should create view document fragment from DOM document fragment without children', () => {
  94. const domImg = createElement( document, 'img' );
  95. const domText = document.createTextNode( 'foo' );
  96. const domFragment = document.createDocumentFragment();
  97. domFragment.appendChild( domImg );
  98. domFragment.appendChild( domText );
  99. const viewImg = new ViewElement( viewDocument, 'img' );
  100. converter.bindElements( domImg, viewImg );
  101. const viewFragment = converter.domToView( domFragment, { withChildren: false } );
  102. expect( viewFragment ).to.be.an.instanceof( ViewDocumentFragment );
  103. expect( viewFragment.childCount ).to.equal( 0 );
  104. expect( converter.mapViewToDom( viewFragment ) ).to.not.equal( domFragment );
  105. } );
  106. it( 'should return already bind document fragment', () => {
  107. const domFragment = document.createDocumentFragment();
  108. const viewFragment = new ViewDocumentFragment();
  109. converter.bindDocumentFragments( domFragment, viewFragment );
  110. const viewFragment2 = converter.domToView( domFragment );
  111. expect( viewFragment2 ).to.equal( viewFragment );
  112. } );
  113. it( 'should return null for block filler', () => {
  114. // eslint-disable-next-line new-cap
  115. const domFiller = BR_FILLER( document );
  116. expect( converter.domToView( domFiller ) ).to.be.null;
  117. } );
  118. it( 'should return null for empty text node', () => {
  119. const textNode = document.createTextNode( '' );
  120. expect( converter.domToView( textNode ) ).to.be.null;
  121. } );
  122. it( 'should return null for a comment', () => {
  123. const comment = document.createComment( 'abc' );
  124. expect( converter.domToView( comment ) ).to.be.null;
  125. } );
  126. describe( 'it should clear whitespaces', () => {
  127. it( 'at the beginning of block element', () => {
  128. const domDiv = createElement( document, 'div', {}, [
  129. document.createTextNode( ' ' ),
  130. createElement( document, 'p', {}, [
  131. document.createTextNode( ' foo' )
  132. ] ),
  133. createElement( document, 'p', {}, [
  134. document.createTextNode( ' foo' )
  135. ] )
  136. ] );
  137. const viewDiv = converter.domToView( domDiv );
  138. expect( viewDiv.childCount ).to.equal( 2 );
  139. expect( viewDiv.getChild( 0 ).getChild( 0 ).data ).to.equal( 'foo' );
  140. expect( viewDiv.getChild( 1 ).getChild( 0 ).data ).to.equal( 'foo' );
  141. } );
  142. it( 'at the end of block element', () => {
  143. const domDiv = createElement( document, 'div', {}, [
  144. createElement( document, 'p', {}, [
  145. document.createTextNode( 'foo ' )
  146. ] ),
  147. createElement( document, 'p', {}, [
  148. document.createTextNode( 'foo ' )
  149. ] ),
  150. document.createTextNode( ' ' )
  151. ] );
  152. const viewDiv = converter.domToView( domDiv );
  153. expect( viewDiv.childCount ).to.equal( 2 );
  154. expect( viewDiv.getChild( 0 ).getChild( 0 ).data ).to.equal( 'foo' );
  155. expect( viewDiv.getChild( 1 ).getChild( 0 ).data ).to.equal( 'foo' );
  156. } );
  157. it( 'after a block element', () => {
  158. const domDiv = createElement( document, 'div', {}, [
  159. createElement( document, 'p', {}, [
  160. document.createTextNode( 'foo' )
  161. ] ),
  162. document.createTextNode( ' ' )
  163. ] );
  164. const viewDiv = converter.domToView( domDiv );
  165. expect( viewDiv.childCount ).to.equal( 1 );
  166. expect( viewDiv.getChild( 0 ).getChild( 0 ).data ).to.equal( 'foo' );
  167. } );
  168. it( 'after a block element (new line)', () => {
  169. const domDiv = createElement( document, 'div', {}, [
  170. createElement( document, 'p', {}, [
  171. document.createTextNode( 'foo' )
  172. ] ),
  173. document.createTextNode( '\n' )
  174. ] );
  175. const viewDiv = converter.domToView( domDiv );
  176. expect( viewDiv.childCount ).to.equal( 1 );
  177. expect( viewDiv.getChild( 0 ).getChild( 0 ).data ).to.equal( 'foo' );
  178. } );
  179. it( 'after a block element (carriage return)', () => {
  180. const domDiv = createElement( document, 'div', {}, [
  181. createElement( document, 'p', {}, [
  182. document.createTextNode( 'foo' )
  183. ] ),
  184. document.createTextNode( '\r' )
  185. ] );
  186. const viewDiv = converter.domToView( domDiv );
  187. expect( viewDiv.childCount ).to.equal( 1 );
  188. expect( viewDiv.getChild( 0 ).getChild( 0 ).data ).to.equal( 'foo' );
  189. } );
  190. it( 'after a block element (tab)', () => {
  191. const domDiv = createElement( document, 'div', {}, [
  192. createElement( document, 'p', {}, [
  193. document.createTextNode( 'foo' )
  194. ] ),
  195. document.createTextNode( '\t' )
  196. ] );
  197. const viewDiv = converter.domToView( domDiv );
  198. expect( viewDiv.childCount ).to.equal( 1 );
  199. expect( viewDiv.getChild( 0 ).getChild( 0 ).data ).to.equal( 'foo' );
  200. } );
  201. // See https://github.com/ckeditor/ckeditor5-engine/issues/822#issuecomment-311670249
  202. it( 'but preserve all except " \\n\\r\\t"', () => {
  203. const domDiv = createElement( document, 'div', {}, [
  204. createElement( document, 'p', {}, [
  205. document.createTextNode( 'x\fx\vx\u00a0x\u1680x\u2000x\u200ax\u2028x\u2029x\u202fx\u205fx\u3000x\ufeffx' )
  206. ] ),
  207. createElement( document, 'p', {}, [
  208. // x<two spaces>x because it behaved differently than "x<space>x" when I've been fixing this
  209. document.createTextNode( 'x\f\vx\u00a0\u1680x\u2000\u200ax\u2028\u2029x\u202f\u205fx\u3000\ufeffx' )
  210. ] )
  211. ] );
  212. const viewDiv = converter.domToView( domDiv );
  213. expect( viewDiv.childCount ).to.equal( 2 );
  214. expect( viewDiv.getChild( 0 ).getChild( 0 ).data )
  215. .to.equal( 'x\fx\vx\u00a0x\u1680x\u2000x\u200ax\u2028x\u2029x\u202fx\u205fx\u3000x\ufeffx' );
  216. expect( viewDiv.getChild( 1 ).getChild( 0 ).data )
  217. .to.equal( 'x\f\vx\u00a0\u1680x\u2000\u200ax\u2028\u2029x\u202f\u205fx\u3000\ufeffx' );
  218. } );
  219. it( 'before a block element', () => {
  220. const domDiv = createElement( document, 'div', {}, [
  221. document.createTextNode( ' ' ),
  222. createElement( document, 'p', {}, [
  223. document.createTextNode( ' foo' )
  224. ] )
  225. ] );
  226. const viewDiv = converter.domToView( domDiv );
  227. expect( viewDiv.childCount ).to.equal( 1 );
  228. expect( viewDiv.getChild( 0 ).getChild( 0 ).data ).to.equal( 'foo' );
  229. } );
  230. it( 'before a block element (new line)', () => {
  231. const domDiv = createElement( document, 'div', {}, [
  232. document.createTextNode( '\n' ),
  233. createElement( document, 'p', {}, [
  234. document.createTextNode( 'foo' )
  235. ] )
  236. ] );
  237. const viewDiv = converter.domToView( domDiv );
  238. expect( viewDiv.childCount ).to.equal( 1 );
  239. expect( viewDiv.getChild( 0 ).getChild( 0 ).data ).to.equal( 'foo' );
  240. } );
  241. it( 'after a <br>', () => {
  242. const domP = createElement( document, 'p', {}, [
  243. document.createTextNode( 'foo' ),
  244. createElement( document, 'br' ),
  245. document.createTextNode( ' bar' )
  246. ] );
  247. const viewP = converter.domToView( domP );
  248. expect( viewP.childCount ).to.equal( 3 );
  249. expect( viewP.getChild( 2 ).data ).to.equal( 'bar' );
  250. } );
  251. it( 'after a <br> – two spaces', () => {
  252. const domP = createElement( document, 'p', {}, [
  253. document.createTextNode( 'foo' ),
  254. createElement( document, 'br' ),
  255. document.createTextNode( ' \u00a0bar' )
  256. ] );
  257. const viewP = converter.domToView( domP );
  258. expect( viewP.childCount ).to.equal( 3 );
  259. expect( viewP.getChild( 2 ).data ).to.equal( ' bar' );
  260. } );
  261. // This TC ensures that the algorithm stops on <br>.
  262. // If not, situations like https://github.com/ckeditor/ckeditor5/issues/1024#issuecomment-393109558 might occur.
  263. it( 'after a <br> – when <br> is preceeded with a nbsp', () => {
  264. const domP = createElement( document, 'p', {}, [
  265. document.createTextNode( 'foo\u00a0' ),
  266. createElement( document, 'br' ),
  267. document.createTextNode( ' bar' )
  268. ] );
  269. const viewP = converter.domToView( domP );
  270. expect( viewP.childCount ).to.equal( 3 );
  271. expect( viewP.getChild( 2 ).data ).to.equal( 'bar' );
  272. } );
  273. it( 'after a <br> – when text after that <br> is nested', () => {
  274. const domP = createElement( document, 'p', {}, [
  275. document.createTextNode( 'foo' ),
  276. createElement( document, 'br' ),
  277. createElement( document, 'b', {}, [
  278. document.createTextNode( ' bar' )
  279. ] )
  280. ] );
  281. const viewP = converter.domToView( domP );
  282. expect( viewP.childCount ).to.equal( 3 );
  283. expect( viewP.getChild( 2 ).getChild( 0 ).data ).to.equal( 'bar' );
  284. } );
  285. it( 'between <br>s - trim only the left boundary', () => {
  286. const domP = createElement( document, 'p', {}, [
  287. document.createTextNode( 'x' ),
  288. createElement( document, 'br' ),
  289. document.createTextNode( ' foo ' ),
  290. createElement( document, 'br' ),
  291. document.createTextNode( 'x' )
  292. ] );
  293. const viewP = converter.domToView( domP );
  294. expect( viewP.childCount ).to.equal( 5 );
  295. expect( viewP.getChild( 2 ).data ).to.equal( 'foo ' );
  296. } );
  297. it( 'multiple consecutive whitespaces changed to one', () => {
  298. const domDiv = createElement( document, 'div', {}, [
  299. createElement( document, 'p', {}, [
  300. document.createTextNode( ' f o o' )
  301. ] ),
  302. createElement( document, 'p', {}, [
  303. document.createTextNode( 'fo o ' )
  304. ] )
  305. ] );
  306. const viewDiv = converter.domToView( domDiv );
  307. expect( viewDiv.getChild( 0 ).getChild( 0 ).data ).to.equal( 'f o o' );
  308. expect( viewDiv.getChild( 1 ).getChild( 0 ).data ).to.equal( 'fo o' );
  309. } );
  310. it( 'multiple consecutive whitespaces changed to one (tab, new line, carriage return)', () => {
  311. const domDiv = createElement( document, 'div', {}, [
  312. document.createTextNode( '\n\n \t\r\n' ),
  313. createElement( document, 'p', {}, [
  314. document.createTextNode( 'f\n\t\r\n\to\n\n\no' )
  315. ] ),
  316. document.createTextNode( '\n\n \t\r\n' )
  317. ] );
  318. const viewDiv = converter.domToView( domDiv );
  319. expect( viewDiv.childCount ).to.equal( 1 );
  320. expect( viewDiv.getChild( 0 ).getChild( 0 ).data ).to.equal( 'f o o' );
  321. } );
  322. function testTexts( inputTexts, output ) {
  323. if ( typeof inputTexts == 'string' ) {
  324. inputTexts = [ inputTexts ];
  325. }
  326. it( 'spaces in a text node: ' + inputTexts.join( '|' ) + ' -> ' + output, () => {
  327. const domElement = createElement( document, 'div', {}, [] );
  328. for ( const text of inputTexts ) {
  329. domElement.appendChild( document.createTextNode( text.replace( /_/g, '\u00A0' ) ) );
  330. }
  331. const viewElement = converter.domToView( domElement );
  332. let data = '';
  333. for ( const child of viewElement.getChildren() ) {
  334. data += child.data.replace( /\u00A0/g, '_' );
  335. }
  336. expect( data ).to.equal( output );
  337. } );
  338. }
  339. // At the beginning.
  340. testTexts( '_x', ' x' );
  341. testTexts( '_ x', ' x' );
  342. testTexts( '_ _x', ' x' );
  343. testTexts( '_ _ x', ' x' );
  344. // At the end.
  345. testTexts( 'x_', 'x ' );
  346. testTexts( 'x _', 'x ' );
  347. testTexts( 'x __', 'x ' );
  348. testTexts( 'x _ _', 'x ' );
  349. // In the middle.
  350. testTexts( 'x x', 'x x' );
  351. testTexts( 'x _x', 'x x' );
  352. testTexts( 'x _ x', 'x x' );
  353. testTexts( 'x _ _x', 'x x' );
  354. // Complex.
  355. testTexts( '_x_', ' x ' );
  356. testTexts( '_ x _x _', ' x x ' );
  357. testTexts( '_ _x x _', ' x x ' );
  358. testTexts( '_ _x x __', ' x x ' );
  359. testTexts( '_ _x _ _x_', ' x x ' );
  360. testTexts( '_', ' ' );
  361. // With hard &nbsp;
  362. testTexts( '_x', ' x' );
  363. testTexts( '__x', ' _x' );
  364. testTexts( '___x', ' __x' );
  365. testTexts( '__ x', ' _ x' );
  366. testTexts( 'x_', 'x ' );
  367. testTexts( 'x__', 'x_ ' );
  368. testTexts( 'x___', 'x__ ' );
  369. testTexts( 'x_x', 'x_x' );
  370. testTexts( 'x___x', 'x___x' );
  371. testTexts( 'x____x', 'x____x' );
  372. testTexts( 'x__ x', 'x__ x' );
  373. testTexts( 'x___ x', 'x___ x' );
  374. testTexts( 'x_ _x', 'x_ x' );
  375. testTexts( 'x __x', 'x _x' );
  376. testTexts( 'x _ x', 'x x' );
  377. testTexts( 'x __ _x', 'x _ x' );
  378. // Two text nodes.
  379. testTexts( [ 'x', 'y' ], 'xy' );
  380. testTexts( [ 'x ', 'y' ], 'x y' );
  381. testTexts( [ 'x _', 'y' ], 'x y' );
  382. testTexts( [ 'x __', 'y' ], 'x y' );
  383. testTexts( [ 'x _ _', 'y' ], 'x y' );
  384. testTexts( [ 'x', ' y' ], 'x y' );
  385. testTexts( [ 'x_', ' y' ], 'x y' );
  386. testTexts( [ 'x _', ' y' ], 'x y' );
  387. testTexts( [ 'x __', ' y' ], 'x y' );
  388. testTexts( [ 'x _ _', ' y' ], 'x y' );
  389. testTexts( [ 'x', ' _y' ], 'x y' );
  390. testTexts( [ 'x_', ' _y' ], 'x y' );
  391. testTexts( [ 'x _', ' _y' ], 'x y' );
  392. testTexts( [ 'x __', ' _y' ], 'x y' );
  393. testTexts( [ 'x _ _', ' _y' ], 'x y' );
  394. // Some tests with hard &nbsp;
  395. testTexts( [ 'x', '_y' ], 'x_y' );
  396. testTexts( [ 'x_', 'y' ], 'x_y' );
  397. testTexts( [ 'x__', ' y' ], 'x_ y' );
  398. testTexts( [ 'x_ _', ' y' ], 'x_ y' );
  399. it( 'not in preformatted blocks', () => {
  400. const domDiv = createElement( document, 'div', {}, [
  401. createElement( document, 'pre', {}, [
  402. document.createTextNode( ' foo\n foo ' )
  403. ] )
  404. ] );
  405. const viewDiv = converter.domToView( domDiv );
  406. expect( viewDiv.getChild( 0 ).getChild( 0 ).data ).to.equal( ' foo\n foo ' );
  407. } );
  408. // https://github.com/ckeditor/ckeditor5-clipboard/issues/2#issuecomment-310417731
  409. it( 'not in span between two words (space)', () => {
  410. const domDiv = createElement( document, 'div', {}, [
  411. document.createTextNode( 'word' ),
  412. createElement( document, 'span', {}, [
  413. document.createTextNode( ' ' )
  414. ] ),
  415. document.createTextNode( 'word' )
  416. ] );
  417. const viewDiv = converter.domToView( domDiv );
  418. expect( viewDiv.getChild( 1 ).name ).to.equal( 'span' );
  419. expect( viewDiv.getChild( 1 ).childCount ).to.equal( 1 );
  420. expect( viewDiv.getChild( 1 ).getChild( 0 ).data ).to.equal( ' ' );
  421. } );
  422. // https://github.com/ckeditor/ckeditor5-clipboard/issues/2#issuecomment-310417731
  423. it( 'not in span between two words (nbsp)', () => {
  424. const domDiv = createElement( document, 'div', {}, [
  425. document.createTextNode( 'word' ),
  426. createElement( document, 'span', {}, [
  427. document.createTextNode( '\u00a0' )
  428. ] ),
  429. document.createTextNode( 'word' )
  430. ] );
  431. const viewDiv = converter.domToView( domDiv );
  432. expect( viewDiv.getChild( 1 ).name ).to.equal( 'span' );
  433. expect( viewDiv.getChild( 1 ).childCount ).to.equal( 1 );
  434. expect( viewDiv.getChild( 1 ).getChild( 0 ).data ).to.equal( '\u00a0' );
  435. } );
  436. // https://github.com/ckeditor/ckeditor5-clipboard/issues/2#issuecomment-310417731
  437. it( 'not in a Chrome\'s paste-like content', () => {
  438. // Like:
  439. // <span style="color: rgb(0, 0, 0); font-family: Times;">This is the<span>\u00a0</span></span>
  440. // <a href="url" style="font-family: Times; font-size: medium;">third developer preview</a>
  441. const domDiv = createElement( document, 'div', {}, [
  442. createElement( document, 'span', {}, [
  443. document.createTextNode( 'word' ),
  444. createElement( document, 'span', {}, [
  445. document.createTextNode( '\u00a0' )
  446. ] )
  447. ] ),
  448. createElement( document, 'a', {}, [
  449. document.createTextNode( 'word' )
  450. ] )
  451. ] );
  452. const viewDiv = converter.domToView( domDiv );
  453. expect( viewDiv.getChild( 0 ).name ).to.equal( 'span' );
  454. expect( viewDiv.getChild( 0 ).childCount ).to.equal( 2 );
  455. expect( viewDiv.getChild( 0 ).getChild( 1 ).name ).to.equal( 'span' );
  456. expect( viewDiv.getChild( 0 ).getChild( 1 ).childCount ).to.equal( 1 );
  457. expect( viewDiv.getChild( 0 ).getChild( 1 ).getChild( 0 ).data ).to.equal( '\u00a0' );
  458. } );
  459. // While we render `X&nbsp;<br>X`, `X <br>X` is ok too – the space needs to be preserved.
  460. it( 'not before a <br>', () => {
  461. const domP = createElement( document, 'p', {}, [
  462. document.createTextNode( 'foo ' ),
  463. createElement( document, 'br' )
  464. ] );
  465. const viewP = converter.domToView( domP );
  466. expect( viewP.childCount ).to.equal( 2 );
  467. expect( viewP.getChild( 0 ).data ).to.equal( 'foo ' );
  468. } );
  469. it( 'not before a <br> (space+nbsp)', () => {
  470. const domP = createElement( document, 'p', {}, [
  471. document.createTextNode( 'foo \u00a0' ),
  472. createElement( document, 'br' )
  473. ] );
  474. const viewP = converter.domToView( domP );
  475. expect( viewP.childCount ).to.equal( 2 );
  476. expect( viewP.getChild( 0 ).data ).to.equal( 'foo ' );
  477. } );
  478. it( 'before a <br> (space+space=>space)', () => {
  479. const domP = createElement( document, 'p', {}, [
  480. document.createTextNode( 'foo ' ),
  481. createElement( document, 'br' )
  482. ] );
  483. const viewP = converter.domToView( domP );
  484. expect( viewP.childCount ).to.equal( 2 );
  485. expect( viewP.getChild( 0 ).data ).to.equal( 'foo ' );
  486. } );
  487. it( 'not before a <br> – when text before that <br> is nested', () => {
  488. const domP = createElement( document, 'p', {}, [
  489. createElement( document, 'b', {}, [
  490. document.createTextNode( 'foo ' )
  491. ] ),
  492. createElement( document, 'br' )
  493. ] );
  494. const viewP = converter.domToView( domP );
  495. expect( viewP.childCount ).to.equal( 2 );
  496. expect( viewP.getChild( 0 ).getChild( 0 ).data ).to.equal( 'foo ' );
  497. } );
  498. //
  499. // See also whitespace-handling-integration.js.
  500. //
  501. } );
  502. describe( 'clearing auto filler', () => {
  503. it( 'should remove inline filler when converting dom to view', () => {
  504. const text = document.createTextNode( INLINE_FILLER + 'foo' );
  505. const view = converter.domToView( text );
  506. expect( view.data ).to.equal( 'foo' );
  507. } );
  508. // See https://github.com/ckeditor/ckeditor5/issues/692.
  509. it( 'should not remove space after inline filler if previous node nor next node does not exist', () => {
  510. const text = document.createTextNode( INLINE_FILLER + ' ' );
  511. const view = converter.domToView( text );
  512. expect( view.data ).to.equal( ' ' );
  513. } );
  514. it( 'should convert non breaking space to normal space after inline filler', () => {
  515. const text = document.createTextNode( INLINE_FILLER + '\u00A0' );
  516. const view = converter.domToView( text );
  517. expect( view.data ).to.equal( ' ' );
  518. } );
  519. } );
  520. } );
  521. describe( 'domChildrenToView', () => {
  522. it( 'should convert children', () => {
  523. const domImg = createElement( document, 'img' );
  524. const domText = document.createTextNode( 'foo' );
  525. const domP = createElement( document, 'p', null, [ domImg, domText ] );
  526. const viewChildren = Array.from( converter.domChildrenToView( domP ) );
  527. expect( viewChildren.length ).to.equal( 2 );
  528. expect( stringify( viewChildren[ 0 ] ) ).to.equal( '<img></img>' );
  529. expect( stringify( viewChildren[ 1 ] ) ).to.equal( 'foo' );
  530. } );
  531. it( 'should skip filler', () => {
  532. // eslint-disable-next-line new-cap
  533. const domFiller = BR_FILLER( 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( viewDocument, { blockFillerMode: 'nbsp' } );
  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( viewDocument ), '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( viewDocument ), '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. } );