8
0

dom-to-view.js 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430
  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.getChildCount() ).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.getChildCount() ).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 create tree of view elements from DOM element without children', () => {
  52. const domImg = createElement( document, 'img' );
  53. const domText = document.createTextNode( 'foo' );
  54. const domP = createElement( document, 'p', { 'class': 'foo' }, [ domImg, domText ] );
  55. const viewImg = new ViewElement( 'img' );
  56. converter.bindElements( domImg, viewImg );
  57. const viewP = converter.domToView( domP, { withChildren: false } );
  58. expect( viewP ).to.be.an.instanceof( ViewElement );
  59. expect( viewP.name ).to.equal( 'p' );
  60. expect( viewP.getAttribute( 'class' ) ).to.equal( 'foo' );
  61. expect( count( viewP.getAttributeKeys() ) ).to.equal( 1 );
  62. expect( viewP.getChildCount() ).to.equal( 0 );
  63. expect( converter.getCorrespondingDom( viewP ) ).to.not.equal( domP );
  64. } );
  65. it( 'should create view document fragment from DOM document fragment', () => {
  66. const domImg = createElement( document, 'img' );
  67. const domText = document.createTextNode( 'foo' );
  68. const domFragment = document.createDocumentFragment();
  69. domFragment.appendChild( domImg );
  70. domFragment.appendChild( domText );
  71. const viewFragment = converter.domToView( domFragment, { bind: true } );
  72. expect( viewFragment ).to.be.an.instanceof( ViewDocumentFragment );
  73. expect( viewFragment.getChildCount() ).to.equal( 2 );
  74. expect( viewFragment.getChild( 0 ).name ).to.equal( 'img' );
  75. expect( viewFragment.getChild( 1 ).data ).to.equal( 'foo' );
  76. expect( converter.getCorrespondingDom( viewFragment ) ).to.equal( domFragment );
  77. expect( converter.getCorrespondingDom( viewFragment.getChild( 0 ) ) ).to.equal( domFragment.childNodes[ 0 ] );
  78. } );
  79. it( 'should create view document fragment from DOM document fragment without children', () => {
  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 viewImg = new ViewElement( 'img' );
  86. converter.bindElements( domImg, viewImg );
  87. const viewFragment = converter.domToView( domFragment, { withChildren: false } );
  88. expect( viewFragment ).to.be.an.instanceof( ViewDocumentFragment );
  89. expect( viewFragment.getChildCount() ).to.equal( 0 );
  90. expect( converter.getCorrespondingDom( viewFragment ) ).to.not.equal( domFragment );
  91. } );
  92. it( 'should return already bind document fragment', () => {
  93. const domFragment = document.createDocumentFragment();
  94. const viewFragment = new ViewDocumentFragment();
  95. converter.bindDocumentFragments( domFragment, viewFragment );
  96. const viewFragment2 = converter.domToView( domFragment );
  97. expect( viewFragment2 ).to.equal( viewFragment );
  98. } );
  99. it( 'should return null for block filler', () => {
  100. const domFiller = converter.blockFiller( document );
  101. const viewFiller = converter.domToView( domFiller );
  102. expect( viewFiller ).to.be.null;
  103. } );
  104. } );
  105. describe( 'domChildrenToView', () => {
  106. it( 'should convert children', () => {
  107. const domImg = createElement( document, 'img' );
  108. const domText = document.createTextNode( 'foo' );
  109. const domP = createElement( document, 'p', null, [ domImg, domText ] );
  110. const viewChildren = Array.from( converter.domChildrenToView( domP ) );
  111. expect( viewChildren.length ).to.equal( 2 );
  112. expect( stringify( viewChildren[ 0 ] ) ).to.equal( '<img></img>' );
  113. expect( stringify( viewChildren[ 1 ] ) ).to.equal( 'foo' );
  114. } );
  115. it( 'should skip filler', () => {
  116. const domFiller = converter.blockFiller( document );
  117. const domP = createElement( document, 'p', null, domFiller );
  118. const viewChildren = Array.from( converter.domChildrenToView( domP ) );
  119. expect( viewChildren.length ).to.equal( 0 );
  120. } );
  121. it( 'should pass options', () => {
  122. const domText = document.createTextNode( 'foo' );
  123. const domB = createElement( document, 'b', null, 'bar' );
  124. const domP = createElement( document, 'p', null, [ domB, domText ] );
  125. const viewChildren = Array.from( converter.domChildrenToView( domP, { withChildren: false } ) );
  126. expect( viewChildren.length ).to.equal( 2 );
  127. expect( stringify( viewChildren[ 0 ] ) ).to.equal( '<b></b>' );
  128. expect( stringify( viewChildren[ 1 ] ) ).to.equal( 'foo' );
  129. } );
  130. } );
  131. describe( 'domPositionToView', () => {
  132. it( 'should converter position in text', () => {
  133. const domText = document.createTextNode( 'foo' );
  134. const domB = createElement( document, 'b', null, 'bar' );
  135. const domP = createElement( document, 'p', null, [ domText, domB ] );
  136. const viewP = parse( '<p>foo<b>bar</b></p>' );
  137. converter.bindElements( domP, viewP );
  138. converter.bindElements( domB, viewP.getChild( 0 ) );
  139. const viewPosition = converter.domPositionToView( domText, 2 );
  140. expect( stringify( viewP, viewPosition ) ).to.equal( '<p>fo{}o<b>bar</b></p>' );
  141. } );
  142. it( 'should converter position in element', () => {
  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( domP, 1 );
  150. expect( stringify( viewP, viewPosition ) ).to.equal( '<p>foo[]<b>bar</b></p>' );
  151. } );
  152. it( 'should converter position at the beginning', () => {
  153. const domText = document.createTextNode( 'foo' );
  154. const domP = createElement( document, 'p', null, domText );
  155. const viewP = parse( '<p>foo</p>' );
  156. converter.bindElements( domP, viewP );
  157. const viewPosition = converter.domPositionToView( domP, 0 );
  158. expect( stringify( viewP, viewPosition ) ).to.equal( '<p>[]foo</p>' );
  159. } );
  160. it( 'should converter position inside block filler', () => {
  161. const converter = new DomConverter( { blockFiller: NBSP_FILLER } );
  162. const domFiller = NBSP_FILLER( document );
  163. const domP = createElement( document, 'p', null, domFiller );
  164. const viewP = parse( '<p></p>' );
  165. converter.bindElements( domP, viewP );
  166. const viewPosition = converter.domPositionToView( domFiller, 0 );
  167. expect( stringify( viewP, viewPosition ) ).to.equal( '<p>[]</p>' );
  168. } );
  169. it( 'should converter position inside inline filler', () => {
  170. const domFiller = document.createTextNode( INLINE_FILLER );
  171. const domText = document.createTextNode( 'foo' );
  172. const domB = createElement( document, 'b', null, domFiller );
  173. const domP = createElement( document, 'p', null, [ domText, domB ] );
  174. const viewP = parse( '<p>foo<b></b></p>' );
  175. converter.bindElements( domP, viewP );
  176. converter.bindElements( domB, viewP.getChild( 1 ) );
  177. const viewPosition = converter.domPositionToView( domFiller, INLINE_FILLER_LENGTH );
  178. expect( stringify( viewP, viewPosition ) ).to.equal( '<p>foo<b>[]</b></p>' );
  179. } );
  180. it( 'should converter position inside inline filler with text', () => {
  181. const domFiller = document.createTextNode( INLINE_FILLER + 'bar' );
  182. const domText = document.createTextNode( 'foo' );
  183. const domB = createElement( document, 'b', null, domFiller );
  184. const domP = createElement( document, 'p', null, [ domText, domB ] );
  185. const viewP = parse( '<p>foo<b>bar</b></p>' );
  186. converter.bindElements( domP, viewP );
  187. converter.bindElements( domB, viewP.getChild( 1 ) );
  188. const viewPosition = converter.domPositionToView( domFiller, INLINE_FILLER_LENGTH + 2 );
  189. expect( viewPosition.offset ).to.equal( 2 );
  190. expect( stringify( viewP, viewPosition ) ).to.equal( '<p>foo<b>ba{}r</b></p>' );
  191. } );
  192. it( 'should converter position inside inline filler with text at the beginning', () => {
  193. const domFiller = document.createTextNode( INLINE_FILLER + 'bar' );
  194. const domText = document.createTextNode( 'foo' );
  195. const domB = createElement( document, 'b', null, domFiller );
  196. const domP = createElement( document, 'p', null, [ domText, domB ] );
  197. const viewP = parse( '<p>foo<b>bar</b></p>' );
  198. converter.bindElements( domP, viewP );
  199. converter.bindElements( domB, viewP.getChild( 1 ) );
  200. const viewPosition = converter.domPositionToView( domFiller, INLINE_FILLER_LENGTH - 1 );
  201. expect( viewPosition.offset ).to.equal( 0 );
  202. expect( stringify( viewP, viewPosition ) ).to.equal( '<p>foo<b>{}bar</b></p>' );
  203. } );
  204. it( 'should converter position at the end', () => {
  205. const domText = document.createTextNode( 'foo' );
  206. const domP = createElement( document, 'p', null, domText );
  207. const viewP = parse( '<p>foo</p>' );
  208. converter.bindElements( domP, viewP );
  209. const viewPosition = converter.domPositionToView( domP, 1 );
  210. expect( stringify( viewP, viewPosition ) ).to.equal( '<p>foo[]</p>' );
  211. } );
  212. it( 'should return null if there is no corresponding parent node', () => {
  213. const domText = document.createTextNode( 'foo' );
  214. const domP = createElement( document, 'p', null, domText );
  215. const viewPosition = converter.domPositionToView( domP, 0 );
  216. expect( viewPosition ).to.be.null;
  217. } );
  218. it( 'should return null if there is no corresponding sibling node', () => {
  219. const domB = createElement( document, 'b', null, 'bar' );
  220. const domText = document.createTextNode( 'foo' );
  221. const domP = createElement( document, 'p', null, [ domB, domText ] );
  222. const viewPosition = converter.domPositionToView( domP, 1 );
  223. expect( viewPosition ).to.be.null;
  224. } );
  225. it( 'should return null if there is no corresponding text node', () => {
  226. const domText = document.createTextNode( 'foo' );
  227. const viewPosition = converter.domPositionToView( domText, 1 );
  228. expect( viewPosition ).to.be.null;
  229. } );
  230. } );
  231. describe( 'domRangeToView', () => {
  232. it( 'should converter DOM range', () => {
  233. const domFoo = document.createTextNode( 'foo' );
  234. const domBar = document.createTextNode( 'bar' );
  235. const domB = createElement( document, 'b', null, domBar );
  236. const domP = createElement( document, 'p', null, [ domFoo, domB ] );
  237. const viewP = parse( '<p>foo<b>bar</b></p>' );
  238. converter.bindElements( domP, viewP );
  239. converter.bindElements( domB, viewP.getChild( 1 ) );
  240. const domRange = new Range();
  241. domRange.setStart( domFoo, 1 );
  242. domRange.setEnd( domBar, 2 );
  243. const viewRange = converter.domRangeToView( domRange );
  244. expect( stringify( viewP, viewRange ) ).to.equal( '<p>f{oo<b>ba}r</b></p>' );
  245. } );
  246. it( 'should return null if start or end is null', () => {
  247. const domFoo = document.createTextNode( 'foo' );
  248. const domBar = document.createTextNode( 'bar' );
  249. const domB = createElement( document, 'b', null, domBar );
  250. createElement( document, 'p', null, [ domFoo, domB ] );
  251. const domRange = new Range();
  252. domRange.setStart( domFoo, 1 );
  253. domRange.setEnd( domBar, 2 );
  254. const viewRange = converter.domRangeToView( domRange );
  255. expect( viewRange ).to.be.null;
  256. } );
  257. } );
  258. describe( 'domSelectionToView', () => {
  259. it( 'should converter selection', () => {
  260. const domFoo = document.createTextNode( 'foo' );
  261. const domBar = document.createTextNode( 'bar' );
  262. const domB = createElement( document, 'b', null, domBar );
  263. const domP = createElement( document, 'p', null, [ domFoo, domB ] );
  264. const viewP = parse( '<p>foo<b>bar</b></p>' );
  265. converter.bindElements( domP, viewP );
  266. converter.bindElements( domB, viewP.getChild( 1 ) );
  267. document.body.appendChild( domP );
  268. const domRange = new Range();
  269. domRange.setStart( domFoo, 1 );
  270. domRange.setEnd( domBar, 2 );
  271. const domSelection = document.getSelection();
  272. domSelection.removeAllRanges();
  273. domSelection.addRange( domRange );
  274. const viewSelection = converter.domSelectionToView( domSelection );
  275. expect( viewSelection.rangeCount ).to.equal( 1 );
  276. expect( stringify( viewP, viewSelection.getFirstRange() ) ).to.equal( '<p>f{oo<b>ba}r</b></p>' );
  277. } );
  278. it( 'should converter empty selection to empty selection', () => {
  279. const domSelection = document.getSelection();
  280. domSelection.removeAllRanges();
  281. const viewSelection = converter.domSelectionToView( domSelection );
  282. expect( viewSelection.rangeCount ).to.equal( 0 );
  283. } );
  284. it( 'should not add null ranges', () => {
  285. const domFoo = document.createTextNode( 'foo' );
  286. const domBar = document.createTextNode( 'bar' );
  287. const domB = createElement( document, 'b', null, domBar );
  288. const domP = createElement( document, 'p', null, [ domFoo, domB ] );
  289. document.body.appendChild( domP );
  290. const domRange = new Range();
  291. domRange.setStart( domFoo, 1 );
  292. domRange.setEnd( domBar, 2 );
  293. const domSelection = document.getSelection();
  294. domSelection.removeAllRanges();
  295. domSelection.addRange( domRange );
  296. const viewSelection = converter.domSelectionToView( domSelection );
  297. expect( viewSelection.rangeCount ).to.equal( 0 );
  298. } );
  299. } );
  300. } );