support scrollToTop page meta

nuxt · Oct 19, 2022 · 023936f · 023936f
1 parent 3ec9051
commit 023936f
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 1 deletion.
diff --git a/packages/nuxt/src/pages/runtime/composables.ts b/packages/nuxt/src/pages/runtime/composables.ts
@@ -29,6 +29,8 @@ export interface PageMeta {
   layoutTransition?: boolean | TransitionProps
   key?: false | string | ((route: RouteLocationNormalizedLoaded) => string)
   keepalive?: boolean | KeepAliveProps
+  /** Set to `false` to avoid scrolling to top on page navigations */
+  scrollToTop?: boolean
 }
 
 declare module 'vue-router' {

diff --git a/packages/nuxt/src/pages/runtime/router.options.ts b/packages/nuxt/src/pages/runtime/router.options.ts
@@ -16,7 +16,11 @@ export default <RouterConfig> {
     let position: ScrollPosition = savedPosition || undefined
 
     // Scroll to top if route is changed by default
-    if (!position && from.matched[0] !== to.matched[0]) {
+    if (
+      !position &&
+      (from && to && from.matched[0] !== to.matched[0]) &&
+      to.meta.scrollToTop !== false
+    ) {
       position = { left: 0, top: 0 }
     }