dom-to-view.js 19 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530
  1. /**
  2. * @license Copyright (c) 2003-2015, CKSource - Frederico Knabben. All rights reserved.
  3. * For licensing, see LICENSE.md.
  4. */
  5. /* globals Range, document */
  6. /* bender-tags: view, domconverter, browser-only */
  7. import ViewElement from '/ckeditor5/engine/view/element.js';
  8. import DomConverter from '/ckeditor5/engine/view/domconverter.js';
  9. import ViewDocumentFragment from '/ckeditor5/engine/view/documentfragment.js';
  10. import { INLINE_FILLER, INLINE_FILLER_LENGTH, NBSP_FILLER } from '/ckeditor5/engine/view/filler.js';
  11. import { parse, stringify } from '/ckeditor5/engine/dev-utils/view.js';
  12. import count from '/ckeditor5/utils/count.js';
  13. import createElement from '/ckeditor5/utils/dom/createelement.js';
  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.getCorrespondingDom( viewP ) ).to.not.equal( domP );
  35. expect( converter.getCorrespondingDom( 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.getCorrespondingDom( viewP ) ).to.equal( domP );
  50. expect( converter.getCorrespondingDom( 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.getCorrespondingDom( viewP ) ).to.equal( domP );
  60. expect( converter.getCorrespondingDom( 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.getCorrespondingDom( 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.getCorrespondingDom( viewFragment ) ).to.equal( domFragment );
  88. expect( converter.getCorrespondingDom( 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.getCorrespondingDom( viewFragment ) ).to.not.equal( domFragment );
  102. } );
  103. it( 'should return already bind document fragment', () => {
  104. const domFragment = document.createDocumentFragment();
  105. const viewFragment = new ViewDocumentFragment();
  106. converter.bindDocumentFragments( domFragment, viewFragment );
  107. const viewFragment2 = converter.domToView( domFragment );
  108. expect( viewFragment2 ).to.equal( viewFragment );
  109. } );
  110. it( 'should return null for block filler', () => {
  111. const domFiller = converter.blockFiller( document );
  112. expect( converter.domToView( domFiller ) ).to.be.null;
  113. } );
  114. it( 'should return null for empty text node', () => {
  115. const textNode = document.createTextNode( '' );
  116. expect( converter.domToView( textNode ) ).to.be.null;
  117. } );
  118. describe( 'it should clear whitespaces', () => {
  119. it( 'at the beginning of block element', () => {
  120. const domDiv = createElement( document, 'div', {}, [
  121. document.createTextNode( ' ' ),
  122. createElement( document, 'p', {}, [
  123. document.createTextNode( ' foo' )
  124. ] ),
  125. createElement( document, 'p', {}, [
  126. document.createTextNode( ' foo' )
  127. ] )
  128. ] );
  129. const viewDiv = converter.domToView( domDiv );
  130. expect( viewDiv.childCount ).to.equal( 2 );
  131. expect( viewDiv.getChild( 0 ).getChild( 0 ).data ).to.equal( 'foo' );
  132. expect( viewDiv.getChild( 1 ).getChild( 0 ).data ).to.equal( 'foo' );
  133. } );
  134. it( 'at the end of block element', () => {
  135. const domDiv = createElement( document, 'div', {}, [
  136. createElement( document, 'p', {}, [
  137. document.createTextNode( 'foo ' )
  138. ] ),
  139. createElement( document, 'p', {}, [
  140. document.createTextNode( 'foo ' )
  141. ] ),
  142. document.createTextNode( ' ' )
  143. ] );
  144. const viewDiv = converter.domToView( domDiv );
  145. expect( viewDiv.childCount ).to.equal( 2 );
  146. expect( viewDiv.getChild( 0 ).getChild( 0 ).data ).to.equal( 'foo' );
  147. expect( viewDiv.getChild( 1 ).getChild( 0 ).data ).to.equal( 'foo' );
  148. } );
  149. it( 'multiple consecutive whitespaces changed to one', () => {
  150. const domDiv = createElement( document, 'div', {}, [
  151. createElement( document, 'p', {}, [
  152. document.createTextNode( ' f o o' )
  153. ] ),
  154. createElement( document, 'p', {}, [
  155. document.createTextNode( 'fo o ' )
  156. ] )
  157. ] );
  158. const viewDiv = converter.domToView( domDiv );
  159. expect( viewDiv.getChild( 0 ).getChild( 0 ).data ).to.equal( 'f o o' );
  160. expect( viewDiv.getChild( 1 ).getChild( 0 ).data ).to.equal( 'fo o' );
  161. } );
  162. it( 'not in preformatted blocks', () => {
  163. const domDiv = createElement( document, 'div', {}, [
  164. createElement( document, 'pre', {}, [
  165. document.createTextNode( ' foo\n foo ' )
  166. ] )
  167. ] );
  168. const viewDiv = converter.domToView( domDiv );
  169. expect( viewDiv.getChild( 0 ).getChild( 0 ).data ).to.equal( ' foo\n foo ' );
  170. } );
  171. } );
  172. } );
  173. describe( 'domChildrenToView', () => {
  174. it( 'should convert children', () => {
  175. const domImg = createElement( document, 'img' );
  176. const domText = document.createTextNode( 'foo' );
  177. const domP = createElement( document, 'p', null, [ domImg, domText ] );
  178. const viewChildren = Array.from( converter.domChildrenToView( domP ) );
  179. expect( viewChildren.length ).to.equal( 2 );
  180. expect( stringify( viewChildren[ 0 ] ) ).to.equal( '<img></img>' );
  181. expect( stringify( viewChildren[ 1 ] ) ).to.equal( 'foo' );
  182. } );
  183. it( 'should skip filler', () => {
  184. const domFiller = converter.blockFiller( document );
  185. const domP = createElement( document, 'p', null, domFiller );
  186. const viewChildren = Array.from( converter.domChildrenToView( domP ) );
  187. expect( viewChildren.length ).to.equal( 0 );
  188. } );
  189. it( 'should pass options', () => {
  190. const domText = document.createTextNode( 'foo' );
  191. const domB = createElement( document, 'b', null, 'bar' );
  192. const domP = createElement( document, 'p', null, [ domB, domText ] );
  193. const viewChildren = Array.from( converter.domChildrenToView( domP, { withChildren: false } ) );
  194. expect( viewChildren.length ).to.equal( 2 );
  195. expect( stringify( viewChildren[ 0 ] ) ).to.equal( '<b></b>' );
  196. expect( stringify( viewChildren[ 1 ] ) ).to.equal( 'foo' );
  197. } );
  198. } );
  199. describe( 'domPositionToView', () => {
  200. it( 'should converter position in text', () => {
  201. const domText = document.createTextNode( 'foo' );
  202. const domB = createElement( document, 'b', null, 'bar' );
  203. const domP = createElement( document, 'p', null, [ domText, domB ] );
  204. const viewP = parse( '<p>foo<b>bar</b></p>' );
  205. converter.bindElements( domP, viewP );
  206. converter.bindElements( domB, viewP.getChild( 0 ) );
  207. const viewPosition = converter.domPositionToView( domText, 2 );
  208. expect( stringify( viewP, viewPosition ) ).to.equal( '<p>fo{}o<b>bar</b></p>' );
  209. } );
  210. it( 'should support unicode', () => {
  211. const domText = document.createTextNode( 'நிலைக்கு' );
  212. const domP = createElement( document, 'p', null, [ domText ] );
  213. const viewP = parse( '<p>நிலைக்கு</p>' );
  214. converter.bindElements( domP, viewP );
  215. const viewPosition = converter.domPositionToView( domText, 4 );
  216. expect( stringify( viewP, viewPosition ) ).to.equal( '<p>நிலை{}க்கு</p>' );
  217. } );
  218. it( 'should converter position in element', () => {
  219. const domText = document.createTextNode( 'foo' );
  220. const domB = createElement( document, 'b', null, 'bar' );
  221. const domP = createElement( document, 'p', null, [ domText, domB ] );
  222. const viewP = parse( '<p>foo<b>bar</b></p>' );
  223. converter.bindElements( domP, viewP );
  224. converter.bindElements( domB, viewP.getChild( 0 ) );
  225. const viewPosition = converter.domPositionToView( domP, 1 );
  226. expect( stringify( viewP, viewPosition ) ).to.equal( '<p>foo[]<b>bar</b></p>' );
  227. } );
  228. it( 'should converter position at the beginning', () => {
  229. const domText = document.createTextNode( 'foo' );
  230. const domP = createElement( document, 'p', null, domText );
  231. const viewP = parse( '<p>foo</p>' );
  232. converter.bindElements( domP, viewP );
  233. const viewPosition = converter.domPositionToView( domP, 0 );
  234. expect( stringify( viewP, viewPosition ) ).to.equal( '<p>[]foo</p>' );
  235. } );
  236. it( 'should converter position inside block filler', () => {
  237. const converter = new DomConverter( { blockFiller: NBSP_FILLER } );
  238. const domFiller = NBSP_FILLER( document );
  239. const domP = createElement( document, 'p', null, domFiller );
  240. const viewP = parse( '<p></p>' );
  241. converter.bindElements( domP, viewP );
  242. const viewPosition = converter.domPositionToView( domFiller, 0 );
  243. expect( stringify( viewP, viewPosition ) ).to.equal( '<p>[]</p>' );
  244. } );
  245. it( 'should converter position inside inline filler', () => {
  246. const domFiller = document.createTextNode( INLINE_FILLER );
  247. const domText = document.createTextNode( 'foo' );
  248. const domB = createElement( document, 'b', null, domFiller );
  249. const domP = createElement( document, 'p', null, [ domText, domB ] );
  250. const viewP = parse( '<p>foo<b></b></p>' );
  251. converter.bindElements( domP, viewP );
  252. converter.bindElements( domB, viewP.getChild( 1 ) );
  253. const viewPosition = converter.domPositionToView( domFiller, INLINE_FILLER_LENGTH );
  254. expect( stringify( viewP, viewPosition ) ).to.equal( '<p>foo<b>[]</b></p>' );
  255. } );
  256. it( 'should converter position inside inline filler with text', () => {
  257. const domFiller = document.createTextNode( INLINE_FILLER + 'bar' );
  258. const domText = document.createTextNode( 'foo' );
  259. const domB = createElement( document, 'b', null, domFiller );
  260. const domP = createElement( document, 'p', null, [ domText, domB ] );
  261. const viewP = parse( '<p>foo<b>bar</b></p>' );
  262. converter.bindElements( domP, viewP );
  263. converter.bindElements( domB, viewP.getChild( 1 ) );
  264. const viewPosition = converter.domPositionToView( domFiller, INLINE_FILLER_LENGTH + 2 );
  265. expect( viewPosition.offset ).to.equal( 2 );
  266. expect( stringify( viewP, viewPosition ) ).to.equal( '<p>foo<b>ba{}r</b></p>' );
  267. } );
  268. it( 'should converter position inside inline filler with text at the beginning', () => {
  269. const domFiller = document.createTextNode( INLINE_FILLER + 'bar' );
  270. const domText = document.createTextNode( 'foo' );
  271. const domB = createElement( document, 'b', null, domFiller );
  272. const domP = createElement( document, 'p', null, [ domText, domB ] );
  273. const viewP = parse( '<p>foo<b>bar</b></p>' );
  274. converter.bindElements( domP, viewP );
  275. converter.bindElements( domB, viewP.getChild( 1 ) );
  276. const viewPosition = converter.domPositionToView( domFiller, INLINE_FILLER_LENGTH - 1 );
  277. expect( viewPosition.offset ).to.equal( 0 );
  278. expect( stringify( viewP, viewPosition ) ).to.equal( '<p>foo<b>{}bar</b></p>' );
  279. } );
  280. it( 'should converter position at the end', () => {
  281. const domText = document.createTextNode( 'foo' );
  282. const domP = createElement( document, 'p', null, domText );
  283. const viewP = parse( '<p>foo</p>' );
  284. converter.bindElements( domP, viewP );
  285. const viewPosition = converter.domPositionToView( domP, 1 );
  286. expect( stringify( viewP, viewPosition ) ).to.equal( '<p>foo[]</p>' );
  287. } );
  288. it( 'should return null if there is no corresponding parent node', () => {
  289. const domText = document.createTextNode( 'foo' );
  290. const domP = createElement( document, 'p', null, domText );
  291. const viewPosition = converter.domPositionToView( domP, 0 );
  292. expect( viewPosition ).to.be.null;
  293. } );
  294. it( 'should return null if there is no corresponding sibling node', () => {
  295. const domB = createElement( document, 'b', null, 'bar' );
  296. const domText = document.createTextNode( 'foo' );
  297. const domP = createElement( document, 'p', null, [ domB, domText ] );
  298. const viewPosition = converter.domPositionToView( domP, 1 );
  299. expect( viewPosition ).to.be.null;
  300. } );
  301. it( 'should return null if there is no corresponding text node', () => {
  302. const domText = document.createTextNode( 'foo' );
  303. const viewPosition = converter.domPositionToView( domText, 1 );
  304. expect( viewPosition ).to.be.null;
  305. } );
  306. } );
  307. describe( 'domRangeToView', () => {
  308. it( 'should converter DOM range', () => {
  309. const domFoo = document.createTextNode( 'foo' );
  310. const domBar = document.createTextNode( 'bar' );
  311. const domB = createElement( document, 'b', null, domBar );
  312. const domP = createElement( document, 'p', null, [ domFoo, domB ] );
  313. const viewP = parse( '<p>foo<b>bar</b></p>' );
  314. converter.bindElements( domP, viewP );
  315. converter.bindElements( domB, viewP.getChild( 1 ) );
  316. const domRange = new Range();
  317. domRange.setStart( domFoo, 1 );
  318. domRange.setEnd( domBar, 2 );
  319. const viewRange = converter.domRangeToView( domRange );
  320. expect( stringify( viewP, viewRange ) ).to.equal( '<p>f{oo<b>ba}r</b></p>' );
  321. } );
  322. it( 'should return null if start or end is null', () => {
  323. const domFoo = document.createTextNode( 'foo' );
  324. const domBar = document.createTextNode( 'bar' );
  325. const domB = createElement( document, 'b', null, domBar );
  326. createElement( document, 'p', null, [ domFoo, domB ] );
  327. const domRange = new Range();
  328. domRange.setStart( domFoo, 1 );
  329. domRange.setEnd( domBar, 2 );
  330. const viewRange = converter.domRangeToView( domRange );
  331. expect( viewRange ).to.be.null;
  332. } );
  333. } );
  334. describe( 'domSelectionToView', () => {
  335. it( 'should converter selection', () => {
  336. const domFoo = document.createTextNode( 'foo' );
  337. const domBar = document.createTextNode( 'bar' );
  338. const domB = createElement( document, 'b', null, domBar );
  339. const domP = createElement( document, 'p', null, [ domFoo, domB ] );
  340. const viewP = parse( '<p>foo<b>bar</b></p>' );
  341. converter.bindElements( domP, viewP );
  342. converter.bindElements( domB, viewP.getChild( 1 ) );
  343. document.body.appendChild( domP );
  344. const domRange = new Range();
  345. domRange.setStart( domFoo, 1 );
  346. domRange.setEnd( domBar, 2 );
  347. const domSelection = document.getSelection();
  348. domSelection.removeAllRanges();
  349. domSelection.addRange( domRange );
  350. const viewSelection = converter.domSelectionToView( domSelection );
  351. expect( viewSelection.rangeCount ).to.equal( 1 );
  352. expect( stringify( viewP, viewSelection.getFirstRange() ) ).to.equal( '<p>f{oo<b>ba}r</b></p>' );
  353. } );
  354. it( 'should converter empty selection to empty selection', () => {
  355. const domSelection = document.getSelection();
  356. domSelection.removeAllRanges();
  357. const viewSelection = converter.domSelectionToView( domSelection );
  358. expect( viewSelection.rangeCount ).to.equal( 0 );
  359. } );
  360. it( 'should not add null ranges', () => {
  361. const domFoo = document.createTextNode( 'foo' );
  362. const domBar = document.createTextNode( 'bar' );
  363. const domB = createElement( document, 'b', null, domBar );
  364. const domP = createElement( document, 'p', null, [ domFoo, domB ] );
  365. document.body.appendChild( domP );
  366. const domRange = new Range();
  367. domRange.setStart( domFoo, 1 );
  368. domRange.setEnd( domBar, 2 );
  369. const domSelection = document.getSelection();
  370. domSelection.removeAllRanges();
  371. domSelection.addRange( domRange );
  372. const viewSelection = converter.domSelectionToView( domSelection );
  373. expect( viewSelection.rangeCount ).to.equal( 0 );
  374. } );
  375. } );
  376. } );