scroll.js 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447
  1. /**
  2. * @license Copyright (c) 2003-2017, CKSource - Frederico Knabben. All rights reserved.
  3. * For licensing, see LICENSE.md.
  4. */
  5. /* global window, document, Text */
  6. import testUtils from '@ckeditor/ckeditor5-core/tests/_utils/utils';
  7. import isRange from '../../src/dom/isrange';
  8. import { scrollViewportToShowTarget, scrollAncestorsToShowTarget, _test } from '../../src/dom/scroll';
  9. testUtils.createSinonSandbox();
  10. describe( 'scrollAncestorsToShowTarget()', () => {
  11. let target, element, firstAncestor, secondAncestor;
  12. beforeEach( () => {
  13. element = document.createElement( 'p' );
  14. firstAncestor = document.createElement( 'blockquote' );
  15. secondAncestor = document.createElement( 'div' );
  16. document.body.appendChild( secondAncestor );
  17. secondAncestor.appendChild( firstAncestor );
  18. firstAncestor.appendChild( element );
  19. // Make the element immune to the border-width-* styles in the test environment.
  20. testUtils.sinon.stub( window, 'getComputedStyle' ).returns( {
  21. borderTopWidth: '0px',
  22. borderRightWidth: '0px',
  23. borderBottomWidth: '0px',
  24. borderLeftWidth: '0px'
  25. } );
  26. stubRect( firstAncestor, {
  27. top: 0, right: 100, bottom: 100, left: 0, width: 100, height: 100
  28. }, {
  29. scrollLeft: 100, scrollTop: 100
  30. } );
  31. stubRect( secondAncestor, {
  32. top: -100, right: 0, bottom: 0, left: -100, width: 100, height: 100
  33. }, {
  34. scrollLeft: 100, scrollTop: 100
  35. } );
  36. stubRect( document.body, {
  37. top: 1000, right: 2000, bottom: 1000, left: 1000, width: 1000, height: 1000
  38. }, {
  39. scrollLeft: 1000, scrollTop: 1000
  40. } );
  41. } );
  42. afterEach( () => {
  43. secondAncestor.remove();
  44. } );
  45. describe( 'for an HTMLElement', () => {
  46. beforeEach( () => {
  47. target = element;
  48. } );
  49. test();
  50. } );
  51. describe( 'for a DOM Range', () => {
  52. beforeEach( () => {
  53. target = document.createRange();
  54. target.setStart( firstAncestor, 0 );
  55. target.setEnd( firstAncestor, 0 );
  56. } );
  57. test();
  58. it( 'should set #scrollTop and #scrollLeft of the ancestor to show the target (above, attached to the Text)', () => {
  59. const text = new Text( 'foo' );
  60. firstAncestor.appendChild( text );
  61. target.setStart( text, 1 );
  62. target.setEnd( text, 2 );
  63. stubRect( target, { top: -100, right: 75, bottom: 0, left: 25, width: 50, height: 100 } );
  64. scrollAncestorsToShowTarget( target );
  65. assertScrollPosition( firstAncestor, { scrollTop: 0, scrollLeft: 100 } );
  66. } );
  67. } );
  68. function test() {
  69. it( 'should not touch the #scrollTop #scrollLeft of the ancestor if target is visible', () => {
  70. stubRect( target, { top: 25, right: 75, bottom: 75, left: 25, width: 50, height: 50 } );
  71. scrollAncestorsToShowTarget( target );
  72. assertScrollPosition( firstAncestor, { scrollLeft: 100, scrollTop: 100 } );
  73. } );
  74. it( 'should not touch the #scrollTop #scrollLeft of the document.body', () => {
  75. stubRect( target, { top: 25, right: 75, bottom: 75, left: 25, width: 50, height: 50 } );
  76. scrollAncestorsToShowTarget( target );
  77. assertScrollPosition( document.body, { scrollLeft: 1000, scrollTop: 1000 } );
  78. } );
  79. it( 'should set #scrollTop and #scrollLeft of the ancestor to show the target (above)', () => {
  80. stubRect( target, { top: -100, right: 75, bottom: 0, left: 25, width: 50, height: 100 } );
  81. scrollAncestorsToShowTarget( target );
  82. assertScrollPosition( firstAncestor, { scrollTop: 0, scrollLeft: 100 } );
  83. } );
  84. it( 'should set #scrollTop and #scrollLeft of the ancestor to show the target (below)', () => {
  85. stubRect( target, { top: 200, right: 75, bottom: 300, left: 25, width: 50, height: 100 } );
  86. scrollAncestorsToShowTarget( target );
  87. assertScrollPosition( firstAncestor, { scrollTop: 300, scrollLeft: 100 } );
  88. } );
  89. it( 'should set #scrollTop and #scrollLeft of the ancestor to show the target (left of)', () => {
  90. stubRect( target, { top: 0, right: 0, bottom: 100, left: -100, width: 100, height: 100 } );
  91. scrollAncestorsToShowTarget( target );
  92. assertScrollPosition( firstAncestor, { scrollTop: 100, scrollLeft: 0 } );
  93. } );
  94. it( 'should set #scrollTop and #scrollLeft of the ancestor to show the target (right of)', () => {
  95. stubRect( target, { top: 0, right: 200, bottom: 100, left: 100, width: 100, height: 100 } );
  96. scrollAncestorsToShowTarget( target );
  97. assertScrollPosition( firstAncestor, { scrollTop: 100, scrollLeft: 200 } );
  98. } );
  99. it( 'should set #scrollTop and #scrollLeft of all the ancestors', () => {
  100. stubRect( target, { top: 0, right: 200, bottom: 100, left: 100, width: 100, height: 100 } );
  101. scrollAncestorsToShowTarget( target );
  102. assertScrollPosition( firstAncestor, { scrollTop: 100, scrollLeft: 200 } );
  103. // Note: Because everything is a mock, scrolling the firstAncestor doesn't really change
  104. // the getBoundingClientRect geometry of the target. That's why scrolling secondAncestor
  105. // works like the target remained in the original position and hence scrollLeft is 300 instead
  106. // of 200.
  107. assertScrollPosition( secondAncestor, { scrollTop: 200, scrollLeft: 300 } );
  108. } );
  109. }
  110. } );
  111. describe( 'scrollViewportToShowTarget()', () => {
  112. let target, firstAncestor, element;
  113. const viewportOffset = 30;
  114. beforeEach( () => {
  115. element = document.createElement( 'p' );
  116. firstAncestor = document.createElement( 'blockquote' );
  117. document.body.appendChild( firstAncestor );
  118. firstAncestor.appendChild( element );
  119. stubRect( firstAncestor, {
  120. top: 0, right: 100, bottom: 100, left: 0, width: 100, height: 100
  121. }, {
  122. scrollLeft: 100, scrollTop: 100
  123. } );
  124. testUtils.sinon.stub( window, 'innerWidth' ).value( 1000 );
  125. testUtils.sinon.stub( window, 'innerHeight' ).value( 500 );
  126. testUtils.sinon.stub( window, 'scrollX' ).value( 100 );
  127. testUtils.sinon.stub( window, 'scrollY' ).value( 100 );
  128. testUtils.sinon.stub( window, 'scrollTo' );
  129. testUtils.sinon.stub( window, 'getComputedStyle' ).returns( {
  130. borderTopWidth: '0px',
  131. borderRightWidth: '0px',
  132. borderBottomWidth: '0px',
  133. borderLeftWidth: '0px'
  134. } );
  135. // Assuming 20px v- and h-scrollbars here.
  136. testUtils.sinon.stub( window.document, 'documentElement' ).value( {
  137. clientWidth: 980,
  138. clientHeight: 480
  139. } );
  140. } );
  141. afterEach( () => {
  142. firstAncestor.remove();
  143. } );
  144. describe( 'for an HTMLElement', () => {
  145. beforeEach( () => {
  146. target = element;
  147. } );
  148. testNoOffset();
  149. describe( 'with a viewportOffset', () => {
  150. testWithOffset();
  151. } );
  152. } );
  153. describe( 'for a DOM Range', () => {
  154. beforeEach( () => {
  155. target = document.createRange();
  156. target.setStart( firstAncestor, 0 );
  157. target.setEnd( firstAncestor, 0 );
  158. } );
  159. testNoOffset();
  160. describe( 'with a viewportOffset', () => {
  161. testWithOffset();
  162. } );
  163. } );
  164. // Note: Because everything is a mock, scrolling the firstAncestor doesn't really change
  165. // the getBoundingClientRect geometry of the target. That's why scrolling the viewport
  166. // works like the target remained in the original position. It's tricky but much faster
  167. // and still shows that the whole thing works as expected.
  168. //
  169. // Note: Negative scrollTo arguments make no sense in reality, but in mocks with arbitrary
  170. // initial geometry and scroll position they give the right, relative picture of what's going on.
  171. function testNoOffset() {
  172. it( 'calls scrollAncestorsToShowTarget first', () => {
  173. const spy = testUtils.sinon.stub( _test, 'scrollAncestorsToShowTarget' );
  174. stubRect( target, { top: -200, right: 200, bottom: -100, left: 100, width: 100, height: 100 } );
  175. scrollViewportToShowTarget( { target } );
  176. sinon.assert.calledOnce( spy );
  177. sinon.assert.calledWithExactly( spy, target );
  178. } );
  179. it( 'does not scroll the viewport when the target is fully visible', () => {
  180. stubRect( target, { top: 0, right: 200, bottom: 100, left: 100, width: 100, height: 100 } );
  181. scrollViewportToShowTarget( { target } );
  182. assertScrollPosition( firstAncestor, { scrollTop: 100, scrollLeft: 200 } );
  183. sinon.assert.notCalled( window.scrollTo );
  184. } );
  185. it( 'scrolls the viewport to show the target (above)', () => {
  186. stubRect( target, { top: -200, right: 200, bottom: -100, left: 100, width: 100, height: 100 } );
  187. scrollViewportToShowTarget( { target } );
  188. assertScrollPosition( firstAncestor, { scrollTop: -100, scrollLeft: 200 } );
  189. sinon.assert.calledWithExactly( window.scrollTo, 100, -100 );
  190. } );
  191. it( 'scrolls the viewport to show the target (partially above)', () => {
  192. stubRect( target, { top: -50, right: 200, bottom: 50, left: 100, width: 100, height: 100 } );
  193. scrollViewportToShowTarget( { target } );
  194. assertScrollPosition( firstAncestor, { scrollTop: 50, scrollLeft: 200 } );
  195. sinon.assert.calledWithExactly( window.scrollTo, 100, 50 );
  196. } );
  197. it( 'scrolls the viewport to show the target (below)', () => {
  198. stubRect( target, { top: 600, right: 200, bottom: 700, left: 100, width: 100, height: 100 } );
  199. scrollViewportToShowTarget( { target } );
  200. assertScrollPosition( firstAncestor, { scrollTop: 700, scrollLeft: 200 } );
  201. sinon.assert.calledWithExactly( window.scrollTo, 100, 320 );
  202. } );
  203. it( 'scrolls the viewport to show the target (partially below)', () => {
  204. stubRect( target, { top: 450, right: 200, bottom: 550, left: 100, width: 100, height: 100 } );
  205. scrollViewportToShowTarget( { target } );
  206. assertScrollPosition( firstAncestor, { scrollTop: 550, scrollLeft: 200 } );
  207. sinon.assert.calledWithExactly( window.scrollTo, 100, 170 );
  208. } );
  209. it( 'scrolls the viewport to show the target (to the left)', () => {
  210. stubRect( target, { top: 0, right: -100, bottom: 100, left: -200, width: 100, height: 100 } );
  211. scrollViewportToShowTarget( { target } );
  212. assertScrollPosition( firstAncestor, { scrollTop: 100, scrollLeft: -100 } );
  213. sinon.assert.calledWithExactly( window.scrollTo, -100, 100 );
  214. } );
  215. it( 'scrolls the viewport to show the target (partially to the left)', () => {
  216. stubRect( target, { top: 0, right: 50, bottom: 100, left: -50, width: 100, height: 100 } );
  217. scrollViewportToShowTarget( { target } );
  218. assertScrollPosition( firstAncestor, { scrollTop: 100, scrollLeft: 50 } );
  219. sinon.assert.calledWithExactly( window.scrollTo, 50, 100 );
  220. } );
  221. it( 'scrolls the viewport to show the target (to the right)', () => {
  222. stubRect( target, { top: 0, right: 1200, bottom: 100, left: 1100, width: 100, height: 100 } );
  223. scrollViewportToShowTarget( { target } );
  224. assertScrollPosition( firstAncestor, { scrollTop: 100, scrollLeft: 1200 } );
  225. sinon.assert.calledWithExactly( window.scrollTo, 320, 100 );
  226. } );
  227. it( 'scrolls the viewport to show the target (partially to the right)', () => {
  228. stubRect( target, { top: 0, right: 1050, bottom: 100, left: 950, width: 100, height: 100 } );
  229. scrollViewportToShowTarget( { target } );
  230. assertScrollPosition( firstAncestor, { scrollTop: 100, scrollLeft: 1050 } );
  231. sinon.assert.calledWithExactly( window.scrollTo, 170, 100 );
  232. } );
  233. }
  234. // Note: Because everything is a mock, scrolling the firstAncestor doesn't really change
  235. // the getBoundingClientRect geometry of the target. That's why scrolling the viewport
  236. // works like the target remained in the original position. It's tricky but much faster
  237. // and still shows that the whole thing works as expected.
  238. //
  239. // Note: Negative scrollTo arguments make no sense in reality, but in mocks with arbitrary
  240. // initial geometry and scroll position they give the right, relative picture of what's going on.
  241. function testWithOffset() {
  242. it( 'calls scrollAncestorsToShowTarget first', () => {
  243. const spy = testUtils.sinon.stub( _test, 'scrollAncestorsToShowTarget' );
  244. stubRect( target, { top: -200, right: 200, bottom: -100, left: 100, width: 100, height: 100 } );
  245. scrollViewportToShowTarget( { target, viewportOffset } );
  246. sinon.assert.calledOnce( spy );
  247. sinon.assert.calledWithExactly( spy, target );
  248. } );
  249. it( 'does not scroll the viewport when the target is fully visible', () => {
  250. stubRect( target, { top: 50, right: 200, bottom: 150, left: 100, width: 100, height: 100 } );
  251. scrollViewportToShowTarget( { target, viewportOffset } );
  252. assertScrollPosition( firstAncestor, { scrollTop: 150, scrollLeft: 200 } );
  253. sinon.assert.notCalled( window.scrollTo );
  254. } );
  255. it( 'scrolls the viewport to show the target (above)', () => {
  256. stubRect( target, { top: -200, right: 200, bottom: -100, left: 100, width: 100, height: 100 } );
  257. scrollViewportToShowTarget( { target, viewportOffset } );
  258. assertScrollPosition( firstAncestor, { scrollTop: -100, scrollLeft: 200 } );
  259. sinon.assert.calledWithExactly( window.scrollTo, 100, -130 );
  260. } );
  261. it( 'scrolls the viewport to show the target (partially above)', () => {
  262. stubRect( target, { top: -50, right: 200, bottom: 50, left: 100, width: 100, height: 100 } );
  263. scrollViewportToShowTarget( { target, viewportOffset } );
  264. assertScrollPosition( firstAncestor, { scrollTop: 50, scrollLeft: 200 } );
  265. sinon.assert.calledWithExactly( window.scrollTo, 100, 20 );
  266. } );
  267. it( 'scrolls the viewport to show the target (below)', () => {
  268. stubRect( target, { top: 600, right: 200, bottom: 700, left: 100, width: 100, height: 100 } );
  269. scrollViewportToShowTarget( { target, viewportOffset } );
  270. assertScrollPosition( firstAncestor, { scrollTop: 700, scrollLeft: 200 } );
  271. sinon.assert.calledWithExactly( window.scrollTo, 100, 350 );
  272. } );
  273. it( 'scrolls the viewport to show the target (partially below)', () => {
  274. stubRect( target, { top: 450, right: 200, bottom: 550, left: 100, width: 100, height: 100 } );
  275. scrollViewportToShowTarget( { target, viewportOffset } );
  276. assertScrollPosition( firstAncestor, { scrollTop: 550, scrollLeft: 200 } );
  277. sinon.assert.calledWithExactly( window.scrollTo, 100, 200 );
  278. } );
  279. it( 'scrolls the viewport to show the target (to the left)', () => {
  280. stubRect( target, { top: 0, right: -100, bottom: 100, left: -200, width: 100, height: 100 } );
  281. scrollViewportToShowTarget( { target, viewportOffset } );
  282. assertScrollPosition( firstAncestor, { scrollTop: 100, scrollLeft: -100 } );
  283. sinon.assert.calledWithExactly( window.scrollTo, -130, 70 );
  284. } );
  285. it( 'scrolls the viewport to show the target (partially to the left)', () => {
  286. stubRect( target, { top: 0, right: 50, bottom: 100, left: -50, width: 100, height: 100 } );
  287. scrollViewportToShowTarget( { target, viewportOffset } );
  288. assertScrollPosition( firstAncestor, { scrollTop: 100, scrollLeft: 50 } );
  289. sinon.assert.calledWithExactly( window.scrollTo, 20, 70 );
  290. } );
  291. it( 'scrolls the viewport to show the target (to the right)', () => {
  292. stubRect( target, { top: 0, right: 1200, bottom: 100, left: 1100, width: 100, height: 100 } );
  293. scrollViewportToShowTarget( { target, viewportOffset } );
  294. assertScrollPosition( firstAncestor, { scrollTop: 100, scrollLeft: 1200 } );
  295. sinon.assert.calledWithExactly( window.scrollTo, 350, 70 );
  296. } );
  297. it( 'scrolls the viewport to show the target (partially to the right)', () => {
  298. stubRect( target, { top: 0, right: 1050, bottom: 100, left: 950, width: 100, height: 100 } );
  299. scrollViewportToShowTarget( { target, viewportOffset } );
  300. assertScrollPosition( firstAncestor, { scrollTop: 100, scrollLeft: 1050 } );
  301. sinon.assert.calledWithExactly( window.scrollTo, 200, 70 );
  302. } );
  303. }
  304. } );
  305. function stubRect( target, geometryStub, scrollStub ) {
  306. if ( isRange( target ) ) {
  307. testUtils.sinon.stub( target, 'getClientRects' ).returns( [ geometryStub ] );
  308. } else {
  309. testUtils.sinon.stub( target, 'getBoundingClientRect' ).returns( geometryStub );
  310. // Make the element immune to the border-width-* styles in the test environment.
  311. Object.defineProperties( target, {
  312. offsetWidth: {
  313. value: geometryStub.width
  314. },
  315. clientWidth: {
  316. value: geometryStub.width
  317. },
  318. offsetHeight: {
  319. value: geometryStub.height
  320. },
  321. clientHeight: {
  322. value: geometryStub.height
  323. }
  324. } );
  325. }
  326. if ( scrollStub ) {
  327. let { scrollLeft, scrollTop } = scrollStub;
  328. // There's no way to stub scrollLeft|Top with Sinon. defineProperties
  329. // must be used instead.
  330. Object.defineProperties( target, {
  331. scrollLeft: {
  332. get() {
  333. return scrollLeft;
  334. },
  335. set( value ) {
  336. scrollLeft = value;
  337. },
  338. configurable: true
  339. },
  340. scrollTop: {
  341. get() {
  342. return scrollTop;
  343. },
  344. set( value ) {
  345. scrollTop = value;
  346. },
  347. configurable: true
  348. }
  349. } );
  350. }
  351. }
  352. function assertScrollPosition( element, expected ) {
  353. expect( element.scrollTop ).to.equal( expected.scrollTop, 'scrollTop' );
  354. expect( element.scrollLeft ).to.equal( expected.scrollLeft, 'scrollLeft' );
  355. }