|
|
@@ -0,0 +1,414 @@
|
|
|
+/**
|
|
|
+ * @license Copyright (c) 2003-2017, CKSource - Frederico Knabben. All rights reserved.
|
|
|
+ * For licensing, see LICENSE.md.
|
|
|
+ */
|
|
|
+
|
|
|
+/* global document, Text */
|
|
|
+
|
|
|
+import global from '../../src/dom/global';
|
|
|
+import testUtils from '@ckeditor/ckeditor5-core/tests/_utils/utils';
|
|
|
+import isRange from '../../src/dom/isrange';
|
|
|
+import {
|
|
|
+ scrollViewportToShowTarget,
|
|
|
+ scrollAncestorsToShowTarget
|
|
|
+} from '../../src/dom/scroll';
|
|
|
+
|
|
|
+testUtils.createSinonSandbox();
|
|
|
+
|
|
|
+describe( 'scrollAncestorsToShowTarget()', () => {
|
|
|
+ let target, element, firstAncestor, secondAncestor, body;
|
|
|
+
|
|
|
+ beforeEach( () => {
|
|
|
+ element = document.createElement( 'p' );
|
|
|
+ firstAncestor = document.createElement( 'blockquote' );
|
|
|
+ secondAncestor = document.createElement( 'div' );
|
|
|
+ body = document.createElement( 'div' );
|
|
|
+
|
|
|
+ testUtils.sinon.stub( global, 'document', { body } );
|
|
|
+
|
|
|
+ document.body.appendChild( body );
|
|
|
+ body.appendChild( secondAncestor );
|
|
|
+ secondAncestor.appendChild( firstAncestor );
|
|
|
+ firstAncestor.appendChild( element );
|
|
|
+
|
|
|
+ stubRect( firstAncestor, {
|
|
|
+ top: 0, right: 100, bottom: 100, left: 0, width: 100, height: 100
|
|
|
+ }, {
|
|
|
+ scrollLeft: 100, scrollTop: 100
|
|
|
+ } );
|
|
|
+
|
|
|
+ stubRect( secondAncestor, {
|
|
|
+ top: -100, right: 0, bottom: 0, left: -100, width: 100, height: 100
|
|
|
+ }, {
|
|
|
+ scrollLeft: 100, scrollTop: 100
|
|
|
+ } );
|
|
|
+
|
|
|
+ stubRect( body, {
|
|
|
+ top: 1000, right: 2000, bottom: 1000, left: 1000, width: 1000, height: 1000
|
|
|
+ }, {
|
|
|
+ scrollLeft: 1000, scrollTop: 1000
|
|
|
+ } );
|
|
|
+ } );
|
|
|
+
|
|
|
+ afterEach( () => {
|
|
|
+ body.remove();
|
|
|
+ } );
|
|
|
+
|
|
|
+ describe( 'for an HTMLElement', () => {
|
|
|
+ beforeEach( () => {
|
|
|
+ target = element;
|
|
|
+ } );
|
|
|
+
|
|
|
+ test();
|
|
|
+ } );
|
|
|
+
|
|
|
+ describe( 'for a DOM Range', () => {
|
|
|
+ beforeEach( () => {
|
|
|
+ target = document.createRange();
|
|
|
+ target.setStart( firstAncestor, 0 );
|
|
|
+ target.setEnd( firstAncestor, 0 );
|
|
|
+ } );
|
|
|
+
|
|
|
+ test();
|
|
|
+
|
|
|
+ it( 'should set #scrollTop and #scrollLeft of the ancestor to show the target (above, attached to the Text)', () => {
|
|
|
+ const text = new Text( 'foo' );
|
|
|
+ firstAncestor.appendChild( text );
|
|
|
+ target.setStart( text, 1 );
|
|
|
+ target.setEnd( text, 2 );
|
|
|
+
|
|
|
+ stubRect( target, { top: -100, right: 75, bottom: 0, left: 25, width: 50, height: 100 } );
|
|
|
+
|
|
|
+ scrollAncestorsToShowTarget( target );
|
|
|
+ assertScrollPosition( firstAncestor, { scrollTop: 0, scrollLeft: 100 } );
|
|
|
+ } );
|
|
|
+ } );
|
|
|
+
|
|
|
+ function test() {
|
|
|
+ it( 'should not touch the #scrollTop #scrollLeft of the ancestor if target is visible', () => {
|
|
|
+ stubRect( target, { top: 25, right: 75, bottom: 75, left: 25, width: 50, height: 50 } );
|
|
|
+
|
|
|
+ scrollAncestorsToShowTarget( target );
|
|
|
+ assertScrollPosition( firstAncestor, { scrollLeft: 100, scrollTop: 100 } );
|
|
|
+ } );
|
|
|
+
|
|
|
+ it( 'should not touch the #scrollTop #scrollLeft of the document.body', () => {
|
|
|
+ stubRect( target, { top: 25, right: 75, bottom: 75, left: 25, width: 50, height: 50 } );
|
|
|
+
|
|
|
+ scrollAncestorsToShowTarget( target );
|
|
|
+ assertScrollPosition( body, { scrollLeft: 1000, scrollTop: 1000 } );
|
|
|
+ } );
|
|
|
+
|
|
|
+ it( 'should set #scrollTop and #scrollLeft of the ancestor to show the target (above)', () => {
|
|
|
+ stubRect( target, { top: -100, right: 75, bottom: 0, left: 25, width: 50, height: 100 } );
|
|
|
+
|
|
|
+ scrollAncestorsToShowTarget( target );
|
|
|
+ assertScrollPosition( firstAncestor, { scrollTop: 0, scrollLeft: 100 } );
|
|
|
+ } );
|
|
|
+
|
|
|
+ it( 'should set #scrollTop and #scrollLeft of the ancestor to show the target (below)', () => {
|
|
|
+ stubRect( target, { top: 200, right: 75, bottom: 300, left: 25, width: 50, height: 100 } );
|
|
|
+
|
|
|
+ scrollAncestorsToShowTarget( target );
|
|
|
+ assertScrollPosition( firstAncestor, { scrollTop: 300, scrollLeft: 100 } );
|
|
|
+ } );
|
|
|
+
|
|
|
+ it( 'should set #scrollTop and #scrollLeft of the ancestor to show the target (left of)', () => {
|
|
|
+ stubRect( target, { top: 0, right: 0, bottom: 100, left: -100, width: 100, height: 100 } );
|
|
|
+
|
|
|
+ scrollAncestorsToShowTarget( target );
|
|
|
+ assertScrollPosition( firstAncestor, { scrollTop: 100, scrollLeft: 0 } );
|
|
|
+ } );
|
|
|
+
|
|
|
+ it( 'should set #scrollTop and #scrollLeft of the ancestor to show the target (right of)', () => {
|
|
|
+ stubRect( target, { top: 0, right: 200, bottom: 100, left: 100, width: 100, height: 100 } );
|
|
|
+
|
|
|
+ scrollAncestorsToShowTarget( target );
|
|
|
+ assertScrollPosition( firstAncestor, { scrollTop: 100, scrollLeft: 200 } );
|
|
|
+ } );
|
|
|
+
|
|
|
+ it( 'should set #scrollTop and #scrollLeft of all the ancestors', () => {
|
|
|
+ stubRect( target, { top: 0, right: 200, bottom: 100, left: 100, width: 100, height: 100 } );
|
|
|
+
|
|
|
+ scrollAncestorsToShowTarget( target );
|
|
|
+ assertScrollPosition( firstAncestor, { scrollTop: 100, scrollLeft: 200 } );
|
|
|
+ // Note: Because everything is a mock, scrolling the firstAncestor doesn't really change
|
|
|
+ // the getBoundingClientRect geometry of the target. That's why scrolling secondAncestor
|
|
|
+ // works like the target remained in the original position and hence scrollLeft is 300 instead
|
|
|
+ // of 200.
|
|
|
+ assertScrollPosition( secondAncestor, { scrollTop: 200, scrollLeft: 300 } );
|
|
|
+ } );
|
|
|
+ }
|
|
|
+} );
|
|
|
+
|
|
|
+describe( 'scrollViewportToShowTarget()', () => {
|
|
|
+ let target, firstAncestor, element;
|
|
|
+ const viewportOffset = 30;
|
|
|
+
|
|
|
+ beforeEach( () => {
|
|
|
+ element = document.createElement( 'p' );
|
|
|
+ firstAncestor = document.createElement( 'blockquote' );
|
|
|
+
|
|
|
+ document.body.appendChild( firstAncestor );
|
|
|
+ firstAncestor.appendChild( element );
|
|
|
+
|
|
|
+ stubRect( firstAncestor, {
|
|
|
+ top: 0, right: 100, bottom: 100, left: 0, width: 100, height: 100
|
|
|
+ }, {
|
|
|
+ scrollLeft: 100, scrollTop: 100
|
|
|
+ } );
|
|
|
+
|
|
|
+ testUtils.sinon.stub( global, 'window', {
|
|
|
+ innerWidth: 1000,
|
|
|
+ innerHeight: 500,
|
|
|
+ scrollX: 100,
|
|
|
+ scrollY: 100,
|
|
|
+ scrollTo: sinon.spy(),
|
|
|
+ getComputedStyle: () => ( {
|
|
|
+ borderTopWidth: '0px',
|
|
|
+ borderRightWidth: '0px',
|
|
|
+ borderBottomWidth: '0px',
|
|
|
+ borderLeftWidth: '0px'
|
|
|
+ } )
|
|
|
+ } );
|
|
|
+
|
|
|
+ // Assuming 20px v- and h-scrollbars here.
|
|
|
+ testUtils.sinon.stub( global, 'document', {
|
|
|
+ body: document.body,
|
|
|
+ documentElement: {
|
|
|
+ clientWidth: 980,
|
|
|
+ clientHeight: 480
|
|
|
+ }
|
|
|
+ } );
|
|
|
+ } );
|
|
|
+
|
|
|
+ afterEach( () => {
|
|
|
+ firstAncestor.remove();
|
|
|
+ } );
|
|
|
+
|
|
|
+ describe( 'for an HTMLElement', () => {
|
|
|
+ beforeEach( () => {
|
|
|
+ target = element;
|
|
|
+ } );
|
|
|
+
|
|
|
+ testNoOffset();
|
|
|
+
|
|
|
+ describe( 'with a viewportOffset', () => {
|
|
|
+ testWithOffset();
|
|
|
+ } );
|
|
|
+ } );
|
|
|
+
|
|
|
+ describe( 'for a DOM Range', () => {
|
|
|
+ beforeEach( () => {
|
|
|
+ target = document.createRange();
|
|
|
+ target.setStart( firstAncestor, 0 );
|
|
|
+ target.setEnd( firstAncestor, 0 );
|
|
|
+ } );
|
|
|
+
|
|
|
+ testNoOffset();
|
|
|
+
|
|
|
+ describe( 'with a viewportOffset', () => {
|
|
|
+ testWithOffset();
|
|
|
+ } );
|
|
|
+ } );
|
|
|
+
|
|
|
+ // Note: Because everything is a mock, scrolling the firstAncestor doesn't really change
|
|
|
+ // the getBoundingClientRect geometry of the target. That's why scrolling the viewport
|
|
|
+ // works like the target remained in the original position. It's tricky but much faster
|
|
|
+ // and still shows that the whole thing works as expected.
|
|
|
+ //
|
|
|
+ // Note: Negative scrollTo arguments make no sense in reality, but in mocks with arbitrary
|
|
|
+ // initial geometry and scroll position they give the right, relative picture of what's going on.
|
|
|
+ function testNoOffset() {
|
|
|
+ it( 'does not scroll the viewport when the target is fully visible', () => {
|
|
|
+ stubRect( target, { top: 0, right: 200, bottom: 100, left: 100, width: 100, height: 100 } );
|
|
|
+
|
|
|
+ scrollViewportToShowTarget( { target } );
|
|
|
+ assertScrollPosition( firstAncestor, { scrollTop: 100, scrollLeft: 200 } );
|
|
|
+ sinon.assert.notCalled( global.window.scrollTo );
|
|
|
+ } );
|
|
|
+
|
|
|
+ it( 'scrolls the viewport to show the target (above)', () => {
|
|
|
+ stubRect( target, { top: -200, right: 200, bottom: -100, left: 100, width: 100, height: 100 } );
|
|
|
+
|
|
|
+ scrollViewportToShowTarget( { target } );
|
|
|
+ assertScrollPosition( firstAncestor, { scrollTop: -100, scrollLeft: 200 } );
|
|
|
+ sinon.assert.calledWithExactly( global.window.scrollTo, 100, -100 );
|
|
|
+ } );
|
|
|
+
|
|
|
+ it( 'scrolls the viewport to show the target (partially above)', () => {
|
|
|
+ stubRect( target, { top: -50, right: 200, bottom: 50, left: 100, width: 100, height: 100 } );
|
|
|
+
|
|
|
+ scrollViewportToShowTarget( { target } );
|
|
|
+ assertScrollPosition( firstAncestor, { scrollTop: 50, scrollLeft: 200 } );
|
|
|
+ sinon.assert.calledWithExactly( global.window.scrollTo, 100, 50 );
|
|
|
+ } );
|
|
|
+
|
|
|
+ it( 'scrolls the viewport to show the target (below)', () => {
|
|
|
+ stubRect( target, { top: 600, right: 200, bottom: 700, left: 100, width: 100, height: 100 } );
|
|
|
+
|
|
|
+ scrollViewportToShowTarget( { target } );
|
|
|
+ assertScrollPosition( firstAncestor, { scrollTop: 700, scrollLeft: 200 } );
|
|
|
+ sinon.assert.calledWithExactly( global.window.scrollTo, 100, 320 );
|
|
|
+ } );
|
|
|
+
|
|
|
+ it( 'scrolls the viewport to show the target (partially below)', () => {
|
|
|
+ stubRect( target, { top: 450, right: 200, bottom: 550, left: 100, width: 100, height: 100 } );
|
|
|
+
|
|
|
+ scrollViewportToShowTarget( { target } );
|
|
|
+ assertScrollPosition( firstAncestor, { scrollTop: 550, scrollLeft: 200 } );
|
|
|
+ sinon.assert.calledWithExactly( global.window.scrollTo, 100, 170 );
|
|
|
+ } );
|
|
|
+
|
|
|
+ it( 'scrolls the viewport to show the target (to the left)', () => {
|
|
|
+ stubRect( target, { top: 0, right: -100, bottom: 100, left: -200, width: 100, height: 100 } );
|
|
|
+
|
|
|
+ scrollViewportToShowTarget( { target } );
|
|
|
+ assertScrollPosition( firstAncestor, { scrollTop: 100, scrollLeft: -100 } );
|
|
|
+ sinon.assert.calledWithExactly( global.window.scrollTo, -100, 100 );
|
|
|
+ } );
|
|
|
+
|
|
|
+ it( 'scrolls the viewport to show the target (partially to the left)', () => {
|
|
|
+ stubRect( target, { top: 0, right: 50, bottom: 100, left: -50, width: 100, height: 100 } );
|
|
|
+
|
|
|
+ scrollViewportToShowTarget( { target } );
|
|
|
+ assertScrollPosition( firstAncestor, { scrollTop: 100, scrollLeft: 50 } );
|
|
|
+ sinon.assert.calledWithExactly( global.window.scrollTo, 50, 100 );
|
|
|
+ } );
|
|
|
+
|
|
|
+ it( 'scrolls the viewport to show the target (to the right)', () => {
|
|
|
+ stubRect( target, { top: 0, right: 1200, bottom: 100, left: 1100, width: 100, height: 100 } );
|
|
|
+
|
|
|
+ scrollViewportToShowTarget( { target } );
|
|
|
+ assertScrollPosition( firstAncestor, { scrollTop: 100, scrollLeft: 1200 } );
|
|
|
+ sinon.assert.calledWithExactly( global.window.scrollTo, 320, 100 );
|
|
|
+ } );
|
|
|
+
|
|
|
+ it( 'scrolls the viewport to show the target (partially to the right)', () => {
|
|
|
+ stubRect( target, { top: 0, right: 1050, bottom: 100, left: 950, width: 100, height: 100 } );
|
|
|
+
|
|
|
+ scrollViewportToShowTarget( { target } );
|
|
|
+ assertScrollPosition( firstAncestor, { scrollTop: 100, scrollLeft: 1050 } );
|
|
|
+ sinon.assert.calledWithExactly( global.window.scrollTo, 170, 100 );
|
|
|
+ } );
|
|
|
+ }
|
|
|
+
|
|
|
+ // Note: Because everything is a mock, scrolling the firstAncestor doesn't really change
|
|
|
+ // the getBoundingClientRect geometry of the target. That's why scrolling the viewport
|
|
|
+ // works like the target remained in the original position. It's tricky but much faster
|
|
|
+ // and still shows that the whole thing works as expected.
|
|
|
+ //
|
|
|
+ // Note: Negative scrollTo arguments make no sense in reality, but in mocks with arbitrary
|
|
|
+ // initial geometry and scroll position they give the right, relative picture of what's going on.
|
|
|
+ function testWithOffset() {
|
|
|
+ it( 'does not scroll the viewport when the target is fully visible', () => {
|
|
|
+ stubRect( target, { top: 50, right: 200, bottom: 150, left: 100, width: 100, height: 100 } );
|
|
|
+
|
|
|
+ scrollViewportToShowTarget( { target, viewportOffset } );
|
|
|
+ assertScrollPosition( firstAncestor, { scrollTop: 150, scrollLeft: 200 } );
|
|
|
+ sinon.assert.notCalled( global.window.scrollTo );
|
|
|
+ } );
|
|
|
+
|
|
|
+ it( 'scrolls the viewport to show the target (above)', () => {
|
|
|
+ stubRect( target, { top: -200, right: 200, bottom: -100, left: 100, width: 100, height: 100 } );
|
|
|
+
|
|
|
+ scrollViewportToShowTarget( { target, viewportOffset } );
|
|
|
+ assertScrollPosition( firstAncestor, { scrollTop: -100, scrollLeft: 200 } );
|
|
|
+ sinon.assert.calledWithExactly( global.window.scrollTo, 100, -130 );
|
|
|
+ } );
|
|
|
+
|
|
|
+ it( 'scrolls the viewport to show the target (partially above)', () => {
|
|
|
+ stubRect( target, { top: -50, right: 200, bottom: 50, left: 100, width: 100, height: 100 } );
|
|
|
+
|
|
|
+ scrollViewportToShowTarget( { target, viewportOffset } );
|
|
|
+ assertScrollPosition( firstAncestor, { scrollTop: 50, scrollLeft: 200 } );
|
|
|
+ sinon.assert.calledWithExactly( global.window.scrollTo, 100, 20 );
|
|
|
+ } );
|
|
|
+
|
|
|
+ it( 'scrolls the viewport to show the target (below)', () => {
|
|
|
+ stubRect( target, { top: 600, right: 200, bottom: 700, left: 100, width: 100, height: 100 } );
|
|
|
+
|
|
|
+ scrollViewportToShowTarget( { target, viewportOffset } );
|
|
|
+ assertScrollPosition( firstAncestor, { scrollTop: 700, scrollLeft: 200 } );
|
|
|
+ sinon.assert.calledWithExactly( global.window.scrollTo, 100, 350 );
|
|
|
+ } );
|
|
|
+
|
|
|
+ it( 'scrolls the viewport to show the target (partially below)', () => {
|
|
|
+ stubRect( target, { top: 450, right: 200, bottom: 550, left: 100, width: 100, height: 100 } );
|
|
|
+
|
|
|
+ scrollViewportToShowTarget( { target, viewportOffset } );
|
|
|
+ assertScrollPosition( firstAncestor, { scrollTop: 550, scrollLeft: 200 } );
|
|
|
+ sinon.assert.calledWithExactly( global.window.scrollTo, 100, 200 );
|
|
|
+ } );
|
|
|
+
|
|
|
+ it( 'scrolls the viewport to show the target (to the left)', () => {
|
|
|
+ stubRect( target, { top: 0, right: -100, bottom: 100, left: -200, width: 100, height: 100 } );
|
|
|
+
|
|
|
+ scrollViewportToShowTarget( { target, viewportOffset } );
|
|
|
+ assertScrollPosition( firstAncestor, { scrollTop: 100, scrollLeft: -100 } );
|
|
|
+ sinon.assert.calledWithExactly( global.window.scrollTo, -130, 70 );
|
|
|
+ } );
|
|
|
+
|
|
|
+ it( 'scrolls the viewport to show the target (partially to the left)', () => {
|
|
|
+ stubRect( target, { top: 0, right: 50, bottom: 100, left: -50, width: 100, height: 100 } );
|
|
|
+
|
|
|
+ scrollViewportToShowTarget( { target, viewportOffset } );
|
|
|
+ assertScrollPosition( firstAncestor, { scrollTop: 100, scrollLeft: 50 } );
|
|
|
+ sinon.assert.calledWithExactly( global.window.scrollTo, 20, 70 );
|
|
|
+ } );
|
|
|
+
|
|
|
+ it( 'scrolls the viewport to show the target (to the right)', () => {
|
|
|
+ stubRect( target, { top: 0, right: 1200, bottom: 100, left: 1100, width: 100, height: 100 } );
|
|
|
+
|
|
|
+ scrollViewportToShowTarget( { target, viewportOffset } );
|
|
|
+ assertScrollPosition( firstAncestor, { scrollTop: 100, scrollLeft: 1200 } );
|
|
|
+ sinon.assert.calledWithExactly( global.window.scrollTo, 350, 70 );
|
|
|
+ } );
|
|
|
+
|
|
|
+ it( 'scrolls the viewport to show the target (partially to the right)', () => {
|
|
|
+ stubRect( target, { top: 0, right: 1050, bottom: 100, left: 950, width: 100, height: 100 } );
|
|
|
+
|
|
|
+ scrollViewportToShowTarget( { target, viewportOffset } );
|
|
|
+ assertScrollPosition( firstAncestor, { scrollTop: 100, scrollLeft: 1050 } );
|
|
|
+ sinon.assert.calledWithExactly( global.window.scrollTo, 200, 70 );
|
|
|
+ } );
|
|
|
+ }
|
|
|
+} );
|
|
|
+
|
|
|
+function stubRect( target, geometryStub, scrollStub ) {
|
|
|
+ if ( isRange( target ) ) {
|
|
|
+ testUtils.sinon.stub( target, 'getClientRects' ).returns( [ geometryStub ] );
|
|
|
+ } else {
|
|
|
+ testUtils.sinon.stub( target, 'getBoundingClientRect' ).returns( geometryStub );
|
|
|
+ }
|
|
|
+
|
|
|
+ if ( scrollStub ) {
|
|
|
+ let { scrollLeft, scrollTop } = scrollStub;
|
|
|
+
|
|
|
+ // There's no way to stub scrollLeft|Top with Sinon. defineProperties
|
|
|
+ // must be used instead.
|
|
|
+ Object.defineProperties( target, {
|
|
|
+ scrollLeft: {
|
|
|
+ get() {
|
|
|
+ return scrollLeft;
|
|
|
+ },
|
|
|
+ set( value ) {
|
|
|
+ scrollLeft = value;
|
|
|
+ }
|
|
|
+ },
|
|
|
+ scrollTop: {
|
|
|
+ get() {
|
|
|
+ return scrollTop;
|
|
|
+ },
|
|
|
+ set( value ) {
|
|
|
+ scrollTop = value;
|
|
|
+ }
|
|
|
+ }
|
|
|
+ } );
|
|
|
+ }
|
|
|
+}
|
|
|
+
|
|
|
+function assertScrollPosition( element, expected ) {
|
|
|
+ expect( element.scrollTop ).to.equal( expected.scrollTop, 'scrollTop' );
|
|
|
+ expect( element.scrollLeft ).to.equal( expected.scrollLeft, 'scrollLeft' );
|
|
|
+}
|