dom-to-view.js 18 KB

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