Commit5692607

authored and

committed

fix(common): Prefer to use pageXOffset / pageYOffset instance of scrollX / scrollY (#28262)

This fix ensures a better cross-browser compatibility.This fix has been used for angular.io.PRClose#28262

1 parent2506c02 commit5692607Copy full SHA for 5692607

File tree

+13

-15

lines changed

+13

-15

lines changed

Lines changed: 1 addition & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -24,7 +24,7 @@ export class ScrollService implements OnDestroy {`
`24`	`24`	`poppedStateScrollPosition:ScrollPosition\|null=null;`
`25`	`25`	`// Whether the browser supports the necessary features for manual scroll restoration.`
`26`	`26`	`supportManualScrollRestoration:boolean=!!window&&('scrollTo'inwindow)&&`
`27`		`-('scrollX'inwindow)&&('scrollY'inwindow)&&isScrollRestorationWritable();`
	`27`	`+('pageXOffset'inwindow)&&isScrollRestorationWritable();`
`28`	`28`
`29`	`29`	`// Offset from the top of the document to bottom of any static elements`
`30`	`30`	`// at the top (e.g. toolbar) + some margin`

Lines changed: 3 additions & 3 deletions

Original file line number	Diff line number	Diff line change
`@@ -89,7 +89,7 @@ export class BrowserViewportScroller implements ViewportScroller {`
`89`	`89`	`*/`
`90`	`90`	`getScrollPosition():[number,number]{`
`91`	`91`	`if(this.supportsScrolling()){`
`92`		`-return[this.window.scrollX,this.window.scrollY];`
	`92`	`+return[this.window.pageXOffset,this.window.pageYOffset];`
`93`	`93`	`}else{`
`94`	`94`	`return[0,0];`
`95`	`95`	`}`
`@@ -149,7 +149,7 @@ export class BrowserViewportScroller implements ViewportScroller {`
`149`	`149`	`*/`
`150`	`150`	`privatesupportScrollRestoration():boolean{`
`151`	`151`	`try{`
`152`		`-if(!this.window\|\|!this.window.scrollTo){`
	`152`	`+if(!this.supportsScrolling()){`
`153`	`153`	`returnfalse;`
`154`	`154`	`}`
`155`	`155`	// The `scrollRestoration` property could be on the `history` instance or its prototype.
`@@ -166,7 +166,7 @@ export class BrowserViewportScroller implements ViewportScroller {`
`166`	`166`
`167`	`167`	`privatesupportsScrolling():boolean{`
`168`	`168`	`try{`
`169`		`-return!!this.window.scrollTo;`
	`169`	`+return!!this.window&&!!this.window.scrollTo&&'pageXOffset'inthis.window;`
`170`	`170`	`}catch{`
`171`	`171`	`returnfalse;`
`172`	`172`	`}`

Lines changed: 2 additions & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -15,7 +15,8 @@ describe('BrowserViewportScroller', () => {`
`15`	`15`	`letwindowSpy:any;`
`16`	`16`
`17`	`17`	`beforeEach(()=>{`
`18`		`-windowSpy=jasmine.createSpyObj('window',['history','scrollTo']);`
	`18`	`+windowSpy=`
	`19`	`+jasmine.createSpyObj('window',['history','scrollTo','pageXOffset','pageYOffset']);`
`19`	`20`	`windowSpy.history.scrollRestoration='auto';`
`20`	`21`	`documentSpy=jasmine.createSpyObj('document',['getElementById','getElementsByName']);`
`21`	`22`	`scroller=newBrowserViewportScroller(documentSpy,windowSpy,null!);`

Lines changed: 7 additions & 10 deletions

Original file line number	Diff line number	Diff line change
`@@ -348,27 +348,24 @@ describe('bootstrap', () => {`
`348`	`348`	`awaitrouter.navigateByUrl('/aa');`
`349`	`349`	`window.scrollTo(0,5000);`
`350`	`350`
`351`		`-// IE 11 uses non-standard pageYOffset instead of scrollY`
`352`		`-constgetScrollY=()=>window.scrollY!==undefined ?window.scrollY :window.pageYOffset;`
`353`		`-`
`354`	`351`	`awaitrouter.navigateByUrl('/fail');`
`355`		`-expect(getScrollY()).toEqual(5000);`
	`352`	`+expect(window.pageYOffset).toEqual(5000);`
`356`	`353`
`357`	`354`	`awaitrouter.navigateByUrl('/bb');`
`358`	`355`	`window.scrollTo(0,3000);`
`359`	`356`
`360`		`-expect(getScrollY()).toEqual(3000);`
	`357`	`+expect(window.pageYOffset).toEqual(3000);`
`361`	`358`
`362`	`359`	`awaitrouter.navigateByUrl('/cc');`
`363`		`-expect(getScrollY()).toEqual(0);`
	`360`	`+expect(window.pageYOffset).toEqual(0);`
`364`	`361`
`365`	`362`	`awaitrouter.navigateByUrl('/aa#marker2');`
`366`		`-expect(getScrollY()).toBeGreaterThanOrEqual(5900);`
`367`		`-expect(getScrollY()).toBeLessThan(6000);// offset`
	`363`	`+expect(window.pageYOffset).toBeGreaterThanOrEqual(5900);`
	`364`	`+expect(window.pageYOffset).toBeLessThan(6000);// offset`
`368`	`365`
`369`	`366`	`awaitrouter.navigateByUrl('/aa#marker3');`
`370`		`-expect(getScrollY()).toBeGreaterThanOrEqual(8900);`
`371`		`-expect(getScrollY()).toBeLessThan(9000);`
	`367`	`+expect(window.pageYOffset).toBeGreaterThanOrEqual(8900);`
	`368`	`+expect(window.pageYOffset).toBeLessThan(9000);`
`372`	`369`	`done();`
`373`	`370`	`});`
`374`	`371`

Comments

(0)