dom-to-view.js 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458
  1. /**
  2. * @license Copyright (c) 2003-2015, CKSource - Frederico Knabben. All rights reserved.
  3. * For licensing, see LICENSE.md.
  4. */
  5. /* bender-tags: view, domconverter, browser-only */
  6. import ViewElement from '/ckeditor5/engine/view/element.js';
  7. import DomConverter from '/ckeditor5/engine/view/domconverter.js';
  8. import ViewDocumentFragment from '/ckeditor5/engine/view/documentfragment.js';
  9. import { INLINE_FILLER, INLINE_FILLER_LENGTH, NBSP_FILLER } from '/ckeditor5/engine/view/filler.js';
  10. import { parse, stringify } from '/tests/engine/_utils/view.js';
  11. import count from '/ckeditor5/utils/count.js';
  12. import createElement from '/ckeditor5/utils/dom/createelement.js';
  13. describe( 'DomConverter', () => {
  14. let converter;
  15. before( () => {
  16. converter = new DomConverter();
  17. } );
  18. describe( 'domToView', () => {
  19. it( 'should create tree of view elements from DOM elements', () => {
  20. const domImg = createElement( document, 'img' );
  21. const domText = document.createTextNode( 'foo' );
  22. const domP = createElement( document, 'p', { 'class': 'foo' }, [ domImg, domText ] );
  23. const viewImg = new ViewElement( 'img' );
  24. converter.bindElements( domImg, viewImg );
  25. const viewP = converter.domToView( domP );
  26. expect( viewP ).to.be.an.instanceof( ViewElement );
  27. expect( viewP.name ).to.equal( 'p' );
  28. expect( viewP.getAttribute( 'class' ) ).to.equal( 'foo' );
  29. expect( count( viewP.getAttributeKeys() ) ).to.equal( 1 );
  30. expect( viewP.childCount ).to.equal( 2 );
  31. expect( viewP.getChild( 0 ).name ).to.equal( 'img' );
  32. expect( viewP.getChild( 1 ).data ).to.equal( 'foo' );
  33. expect( converter.getCorrespondingDom( viewP ) ).to.not.equal( domP );
  34. expect( converter.getCorrespondingDom( viewP.getChild( 0 ) ) ).to.equal( domImg );
  35. } );
  36. it( 'should create tree of view elements from DOM elements and bind elements', () => {
  37. const domImg = createElement( document, 'img' );
  38. const domText = document.createTextNode( 'foo' );
  39. const domP = createElement( document, 'p', { 'class': 'foo' }, [ domImg, domText ] );
  40. const viewP = converter.domToView( domP, { bind: true } );
  41. expect( viewP ).to.be.an.instanceof( ViewElement );
  42. expect( viewP.name ).to.equal( 'p' );
  43. expect( viewP.getAttribute( 'class' ) ).to.equal( 'foo' );
  44. expect( count( viewP.getAttributeKeys() ) ).to.equal( 1 );
  45. expect( viewP.childCount ).to.equal( 2 );
  46. expect( viewP.getChild( 0 ).name ).to.equal( 'img' );
  47. expect( viewP.getChild( 1 ).data ).to.equal( 'foo' );
  48. expect( converter.getCorrespondingDom( viewP ) ).to.equal( domP );
  49. expect( converter.getCorrespondingDom( viewP.getChild( 0 ) ) ).to.equal( domP.childNodes[ 0 ] );
  50. } );
  51. it( 'should support unicode', () => {
  52. const domText = document.createTextNode( 'நிலைக்கு' );
  53. const domP = createElement( document, 'p', { 'class': 'foo' }, [ domText ] );
  54. const viewP = converter.domToView( domP, { bind: true } );
  55. expect( viewP.childCount ).to.equal( 1 );
  56. const viewText = viewP.getChild( 0 );
  57. expect( viewText.data ).to.equal( 'நிலைக்கு' );
  58. expect( converter.getCorrespondingDom( viewP ) ).to.equal( domP );
  59. expect( converter.getCorrespondingDom( viewP.getChild( 0 ) ) ).to.equal( domP.childNodes[ 0 ] );
  60. } );
  61. it( 'should create tree of view elements from DOM element without children', () => {
  62. const domImg = createElement( document, 'img' );
  63. const domText = document.createTextNode( 'foo' );
  64. const domP = createElement( document, 'p', { 'class': 'foo' }, [ domImg, domText ] );
  65. const viewImg = new ViewElement( 'img' );
  66. converter.bindElements( domImg, viewImg );
  67. const viewP = converter.domToView( domP, { withChildren: false } );
  68. expect( viewP ).to.be.an.instanceof( ViewElement );
  69. expect( viewP.name ).to.equal( 'p' );
  70. expect( viewP.getAttribute( 'class' ) ).to.equal( 'foo' );
  71. expect( count( viewP.getAttributeKeys() ) ).to.equal( 1 );
  72. expect( viewP.childCount ).to.equal( 0 );
  73. expect( converter.getCorrespondingDom( viewP ) ).to.not.equal( domP );
  74. } );
  75. it( 'should create view document fragment from DOM document fragment', () => {
  76. const domImg = createElement( document, 'img' );
  77. const domText = document.createTextNode( 'foo' );
  78. const domFragment = document.createDocumentFragment();
  79. domFragment.appendChild( domImg );
  80. domFragment.appendChild( domText );
  81. const viewFragment = converter.domToView( domFragment, { bind: true } );
  82. expect( viewFragment ).to.be.an.instanceof( ViewDocumentFragment );
  83. expect( viewFragment.childCount ).to.equal( 2 );
  84. expect( viewFragment.getChild( 0 ).name ).to.equal( 'img' );
  85. expect( viewFragment.getChild( 1 ).data ).to.equal( 'foo' );
  86. expect( converter.getCorrespondingDom( viewFragment ) ).to.equal( domFragment );
  87. expect( converter.getCorrespondingDom( viewFragment.getChild( 0 ) ) ).to.equal( domFragment.childNodes[ 0 ] );
  88. } );
  89. it( 'should create view document fragment from DOM document fragment without children', () => {
  90. const domImg = createElement( document, 'img' );
  91. const domText = document.createTextNode( 'foo' );
  92. const domFragment = document.createDocumentFragment();
  93. domFragment.appendChild( domImg );
  94. domFragment.appendChild( domText );
  95. const viewImg = new ViewElement( 'img' );
  96. converter.bindElements( domImg, viewImg );
  97. const viewFragment = converter.domToView( domFragment, { withChildren: false } );
  98. expect( viewFragment ).to.be.an.instanceof( ViewDocumentFragment );
  99. expect( viewFragment.childCount ).to.equal( 0 );
  100. expect( converter.getCorrespondingDom( viewFragment ) ).to.not.equal( domFragment );
  101. } );
  102. it( 'should return already bind document fragment', () => {
  103. const domFragment = document.createDocumentFragment();
  104. const viewFragment = new ViewDocumentFragment();
  105. converter.bindDocumentFragments( domFragment, viewFragment );
  106. const viewFragment2 = converter.domToView( domFragment );
  107. expect( viewFragment2 ).to.equal( viewFragment );
  108. } );
  109. it( 'should return null for block filler', () => {
  110. const domFiller = converter.blockFiller( document );
  111. const viewFiller = converter.domToView( domFiller );
  112. expect( viewFiller ).to.be.null;
  113. } );
  114. } );
  115. describe( 'domChildrenToView', () => {
  116. it( 'should convert children', () => {
  117. const domImg = createElement( document, 'img' );
  118. const domText = document.createTextNode( 'foo' );
  119. const domP = createElement( document, 'p', null, [ domImg, domText ] );
  120. const viewChildren = Array.from( converter.domChildrenToView( domP ) );
  121. expect( viewChildren.length ).to.equal( 2 );
  122. expect( stringify( viewChildren[ 0 ] ) ).to.equal( '<img></img>' );
  123. expect( stringify( viewChildren[ 1 ] ) ).to.equal( 'foo' );
  124. } );
  125. it( 'should skip filler', () => {
  126. const domFiller = converter.blockFiller( document );
  127. const domP = createElement( document, 'p', null, domFiller );
  128. const viewChildren = Array.from( converter.domChildrenToView( domP ) );
  129. expect( viewChildren.length ).to.equal( 0 );
  130. } );
  131. it( 'should pass options', () => {
  132. const domText = document.createTextNode( 'foo' );
  133. const domB = createElement( document, 'b', null, 'bar' );
  134. const domP = createElement( document, 'p', null, [ domB, domText ] );
  135. const viewChildren = Array.from( converter.domChildrenToView( domP, { withChildren: false } ) );
  136. expect( viewChildren.length ).to.equal( 2 );
  137. expect( stringify( viewChildren[ 0 ] ) ).to.equal( '<b></b>' );
  138. expect( stringify( viewChildren[ 1 ] ) ).to.equal( 'foo' );
  139. } );
  140. } );
  141. describe( 'domPositionToView', () => {
  142. it( 'should converter position in text', () => {
  143. const domText = document.createTextNode( 'foo' );
  144. const domB = createElement( document, 'b', null, 'bar' );
  145. const domP = createElement( document, 'p', null, [ domText, domB ] );
  146. const viewP = parse( '<p>foo<b>bar</b></p>' );
  147. converter.bindElements( domP, viewP );
  148. converter.bindElements( domB, viewP.getChild( 0 ) );
  149. const viewPosition = converter.domPositionToView( domText, 2 );
  150. expect( stringify( viewP, viewPosition ) ).to.equal( '<p>fo{}o<b>bar</b></p>' );
  151. } );
  152. it( 'should support unicode', () => {
  153. const domText = document.createTextNode( 'நிலைக்கு' );
  154. const domP = createElement( document, 'p', null, [ domText ] );
  155. const viewP = parse( '<p>நிலைக்கு</p>' );
  156. converter.bindElements( domP, viewP );
  157. const viewPosition = converter.domPositionToView( domText, 4 );
  158. expect( stringify( viewP, viewPosition ) ).to.equal( '<p>நிலை{}க்கு</p>' );
  159. } );
  160. it( 'should converter position in element', () => {
  161. const domText = document.createTextNode( 'foo' );
  162. const domB = createElement( document, 'b', null, 'bar' );
  163. const domP = createElement( document, 'p', null, [ domText, domB ] );
  164. const viewP = parse( '<p>foo<b>bar</b></p>' );
  165. converter.bindElements( domP, viewP );
  166. converter.bindElements( domB, viewP.getChild( 0 ) );
  167. const viewPosition = converter.domPositionToView( domP, 1 );
  168. expect( stringify( viewP, viewPosition ) ).to.equal( '<p>foo[]<b>bar</b></p>' );
  169. } );
  170. it( 'should converter position at the beginning', () => {
  171. const domText = document.createTextNode( 'foo' );
  172. const domP = createElement( document, 'p', null, domText );
  173. const viewP = parse( '<p>foo</p>' );
  174. converter.bindElements( domP, viewP );
  175. const viewPosition = converter.domPositionToView( domP, 0 );
  176. expect( stringify( viewP, viewPosition ) ).to.equal( '<p>[]foo</p>' );
  177. } );
  178. it( 'should converter position inside block filler', () => {
  179. const converter = new DomConverter( { blockFiller: NBSP_FILLER } );
  180. const domFiller = NBSP_FILLER( document );
  181. const domP = createElement( document, 'p', null, domFiller );
  182. const viewP = parse( '<p></p>' );
  183. converter.bindElements( domP, viewP );
  184. const viewPosition = converter.domPositionToView( domFiller, 0 );
  185. expect( stringify( viewP, viewPosition ) ).to.equal( '<p>[]</p>' );
  186. } );
  187. it( 'should converter position inside inline filler', () => {
  188. const domFiller = document.createTextNode( INLINE_FILLER );
  189. const domText = document.createTextNode( 'foo' );
  190. const domB = createElement( document, 'b', null, domFiller );
  191. const domP = createElement( document, 'p', null, [ domText, domB ] );
  192. const viewP = parse( '<p>foo<b></b></p>' );
  193. converter.bindElements( domP, viewP );
  194. converter.bindElements( domB, viewP.getChild( 1 ) );
  195. const viewPosition = converter.domPositionToView( domFiller, INLINE_FILLER_LENGTH );
  196. expect( stringify( viewP, viewPosition ) ).to.equal( '<p>foo<b>[]</b></p>' );
  197. } );
  198. it( 'should converter position inside inline filler with text', () => {
  199. const domFiller = document.createTextNode( INLINE_FILLER + 'bar' );
  200. const domText = document.createTextNode( 'foo' );
  201. const domB = createElement( document, 'b', null, domFiller );
  202. const domP = createElement( document, 'p', null, [ domText, domB ] );
  203. const viewP = parse( '<p>foo<b>bar</b></p>' );
  204. converter.bindElements( domP, viewP );
  205. converter.bindElements( domB, viewP.getChild( 1 ) );
  206. const viewPosition = converter.domPositionToView( domFiller, INLINE_FILLER_LENGTH + 2 );
  207. expect( viewPosition.offset ).to.equal( 2 );
  208. expect( stringify( viewP, viewPosition ) ).to.equal( '<p>foo<b>ba{}r</b></p>' );
  209. } );
  210. it( 'should converter position inside inline filler with text at the beginning', () => {
  211. const domFiller = document.createTextNode( INLINE_FILLER + 'bar' );
  212. const domText = document.createTextNode( 'foo' );
  213. const domB = createElement( document, 'b', null, domFiller );
  214. const domP = createElement( document, 'p', null, [ domText, domB ] );
  215. const viewP = parse( '<p>foo<b>bar</b></p>' );
  216. converter.bindElements( domP, viewP );
  217. converter.bindElements( domB, viewP.getChild( 1 ) );
  218. const viewPosition = converter.domPositionToView( domFiller, INLINE_FILLER_LENGTH - 1 );
  219. expect( viewPosition.offset ).to.equal( 0 );
  220. expect( stringify( viewP, viewPosition ) ).to.equal( '<p>foo<b>{}bar</b></p>' );
  221. } );
  222. it( 'should converter position at the end', () => {
  223. const domText = document.createTextNode( 'foo' );
  224. const domP = createElement( document, 'p', null, domText );
  225. const viewP = parse( '<p>foo</p>' );
  226. converter.bindElements( domP, viewP );
  227. const viewPosition = converter.domPositionToView( domP, 1 );
  228. expect( stringify( viewP, viewPosition ) ).to.equal( '<p>foo[]</p>' );
  229. } );
  230. it( 'should return null if there is no corresponding parent node', () => {
  231. const domText = document.createTextNode( 'foo' );
  232. const domP = createElement( document, 'p', null, domText );
  233. const viewPosition = converter.domPositionToView( domP, 0 );
  234. expect( viewPosition ).to.be.null;
  235. } );
  236. it( 'should return null if there is no corresponding sibling node', () => {
  237. const domB = createElement( document, 'b', null, 'bar' );
  238. const domText = document.createTextNode( 'foo' );
  239. const domP = createElement( document, 'p', null, [ domB, domText ] );
  240. const viewPosition = converter.domPositionToView( domP, 1 );
  241. expect( viewPosition ).to.be.null;
  242. } );
  243. it( 'should return null if there is no corresponding text node', () => {
  244. const domText = document.createTextNode( 'foo' );
  245. const viewPosition = converter.domPositionToView( domText, 1 );
  246. expect( viewPosition ).to.be.null;
  247. } );
  248. } );
  249. describe( 'domRangeToView', () => {
  250. it( 'should converter DOM range', () => {
  251. const domFoo = document.createTextNode( 'foo' );
  252. const domBar = document.createTextNode( 'bar' );
  253. const domB = createElement( document, 'b', null, domBar );
  254. const domP = createElement( document, 'p', null, [ domFoo, domB ] );
  255. const viewP = parse( '<p>foo<b>bar</b></p>' );
  256. converter.bindElements( domP, viewP );
  257. converter.bindElements( domB, viewP.getChild( 1 ) );
  258. const domRange = new Range();
  259. domRange.setStart( domFoo, 1 );
  260. domRange.setEnd( domBar, 2 );
  261. const viewRange = converter.domRangeToView( domRange );
  262. expect( stringify( viewP, viewRange ) ).to.equal( '<p>f{oo<b>ba}r</b></p>' );
  263. } );
  264. it( 'should return null if start or end is null', () => {
  265. const domFoo = document.createTextNode( 'foo' );
  266. const domBar = document.createTextNode( 'bar' );
  267. const domB = createElement( document, 'b', null, domBar );
  268. createElement( document, 'p', null, [ domFoo, domB ] );
  269. const domRange = new Range();
  270. domRange.setStart( domFoo, 1 );
  271. domRange.setEnd( domBar, 2 );
  272. const viewRange = converter.domRangeToView( domRange );
  273. expect( viewRange ).to.be.null;
  274. } );
  275. } );
  276. describe( 'domSelectionToView', () => {
  277. it( 'should converter selection', () => {
  278. const domFoo = document.createTextNode( 'foo' );
  279. const domBar = document.createTextNode( 'bar' );
  280. const domB = createElement( document, 'b', null, domBar );
  281. const domP = createElement( document, 'p', null, [ domFoo, domB ] );
  282. const viewP = parse( '<p>foo<b>bar</b></p>' );
  283. converter.bindElements( domP, viewP );
  284. converter.bindElements( domB, viewP.getChild( 1 ) );
  285. document.body.appendChild( domP );
  286. const domRange = new Range();
  287. domRange.setStart( domFoo, 1 );
  288. domRange.setEnd( domBar, 2 );
  289. const domSelection = document.getSelection();
  290. domSelection.removeAllRanges();
  291. domSelection.addRange( domRange );
  292. const viewSelection = converter.domSelectionToView( domSelection );
  293. expect( viewSelection.rangeCount ).to.equal( 1 );
  294. expect( stringify( viewP, viewSelection.getFirstRange() ) ).to.equal( '<p>f{oo<b>ba}r</b></p>' );
  295. } );
  296. it( 'should converter empty selection to empty selection', () => {
  297. const domSelection = document.getSelection();
  298. domSelection.removeAllRanges();
  299. const viewSelection = converter.domSelectionToView( domSelection );
  300. expect( viewSelection.rangeCount ).to.equal( 0 );
  301. } );
  302. it( 'should not add null ranges', () => {
  303. const domFoo = document.createTextNode( 'foo' );
  304. const domBar = document.createTextNode( 'bar' );
  305. const domB = createElement( document, 'b', null, domBar );
  306. const domP = createElement( document, 'p', null, [ domFoo, domB ] );
  307. document.body.appendChild( domP );
  308. const domRange = new Range();
  309. domRange.setStart( domFoo, 1 );
  310. domRange.setEnd( domBar, 2 );
  311. const domSelection = document.getSelection();
  312. domSelection.removeAllRanges();
  313. domSelection.addRange( domRange );
  314. const viewSelection = converter.domSelectionToView( domSelection );
  315. expect( viewSelection.rangeCount ).to.equal( 0 );
  316. } );
  317. } );
  318. } );