Add example for gatsby-browser.js API shouldUpdateScroll #3857
Conversation
|
Deploy preview for gatsbygram ready! Built with commit 3154a9d |
| @@ -35,6 +35,11 @@ exports.onRouteUpdate = true | |||
| * @param {object} $0 | |||
| * @param {object} $0.prevRouterProps The previous state of the router before the route change. | |||
| * @param {object} $0.pathname The new pathname | |||
| * @example | |||
| * exports.shouldUpdateScroll = (prevRouterProps, pathname) => { | |||
| * window.scrollTo(0, 0) // upon navigation, scroll to top of page | |||
There was a problem hiding this comment.
I'm curious what the use case for doing this would be?
There was a problem hiding this comment.
For my particular use-case, I wanted it so when navlinks clicked always start at the top of the page. By default, they start off at the last scrolled position of the page. This example overrides that behavior.
There was a problem hiding this comment.
Could you try upgrading to the latest Gatsby? There was a bug that was causing problems with scrolling that I fixed in #3775
It sounds like you were just running into that bug.
I'd love an example for this API but it should be a realistic one — not one that works around a bug :-)
There was a problem hiding this comment.
Understood! I'll remove my workaround, and then test. If I come up with a better example, I will absolutely submit. Thanks for the update, Kyle.
There was a problem hiding this comment.
Just confirming you fixed the issue I was having with your patch.
| @@ -152,6 +152,7 @@ Websites built with Gatsby: | |||
| * [ERC dEX](https://ercdex.com) | |||
| * [iContract Blog](https://blog.icontract.co.uk) | |||
| * [Dona Rita](https://donarita.co.uk) ([source](https://github.com/peduarte/dona-rita-website)) | |||
| * [Andy Slezak](https://www.aslezak.com) ([source](https://github.com/amslezak)) | |||
There was a problem hiding this comment.
Could you do this in a separate PR? Thanks!
|
closing this issue, and opening separate PRs. |
No description provided.