Scroll Position Logic Improvements

[ryanwiemer]

Come up with a better solution for when to remember or not remember the scroll position.

• Reset Scroll Position after page is loaded gatsbyjs/gatsby#3249
• correct key behavior gatsbyjs/gatsby#3483

Remember Scroll Position

• When a user clicks the back button
• When a user manually refreshes the page

Start At The Top Of The Page

• When a user clicks on a link

[dsbrianwebster]

How about this Ryan? Seems to satisfy all the above criteria for me when I include in in my gatsby-browser.js file?

exports.onRouteUpdate = args => {
  if (typeof window !== 'undefined' && args.action == "PUSH") {
    window.scrollTo(0, 0)
  }
}

exports.shouldUpdateScroll = args => {
  //  scroll on < back, forward >, refresh, but not link clicks
  return (
    args.prevRouterProps == null ||
    (args.prevRouterProps && args.prevRouterProps.history.action == "POP")
  ) ? true : false;
};

[ryanwiemer]

@dsbrianwebster thanks for the suggestion! After an initial test that appears to accomplish what I was after. I will have to do a little more testing to be sure but the logic looks good to me.

[ziyafenn]

Didn't really work for me. I see it working in a console but no effect on scrolling position.

[ryanwiemer]

@ziyafenn,

Sorry for the double post if you get notified again. Not sure what your issue might be. For good measure I would clear your cache and make sure your are using the latest version of Gatsby. I used Gatsby version 1.9.172 when testing this solution and it seemed to work fine for me. I can't vouch for future or past versions though.

I thought for a moment I was able to replicate your issue but after checking my dependencies and clearing my cache it was working. 🤷

Sorry if that isn't too helpful.