Add example for gatsby-browser.js API shouldUpdateScroll

gatsbyjs · Feb 4, 2018 · 7b5d72d · 7b5d72d
1 parent a83b7b8
commit 7b5d72d
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/packages/gatsby/src/utils/api-browser-docs.js b/packages/gatsby/src/utils/api-browser-docs.js
@@ -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
+ *   return false
+ * };
  */
 exports.shouldUpdateScroll = true