【VueRouter】切換路由后，新頁面滾動到頂部或保持原先的滾動位置——scrollBehavior

scrollBehavior (to, from, savedPosition) {
  if (savedPosition) {
    //保持原先的滾動位置
    return savedPosition
  } else {
    //滾動到頂部
    return { x: 0, y: 0 }
  }
}

使用前端路由，當切換到新路由時，想要頁面滾到頂部，或者是保持原先的滾動位置，就像重新加載頁面那樣。 vue-router 能做到，而且更好，它讓你可以自定義路由切換時頁面如何滾動。

注意: 這個功能只在支持 history.pushState 的瀏覽器中可用。

當創建一個 Router 實例，你可以提供一個 scrollBehavior 方法：

const router = new VueRouter({
  routes: [...],
  scrollBehavior (to, from, savedPosition) {
    // return 期望滾動到哪個的位置
  }
})

scrollBehavior 方法接收 to 和 from 路由對象。第三個參數 savedPosition 當且僅當 popstate 導航 (通過瀏覽器的 前進/后退 按鈕觸發) 時才可用。

這個方法返回滾動位置的對象信息，長這樣：

• { x: number, y: number }
• { selector: string, offset? : { x: number, y: number }} (offset 只在 2.6.0+ 支持)

如果返回一個 falsy (譯者注：falsy 不是 false，參考這里)的值，或者是一個空對象，那么不會發生滾動。

舉例：

scrollBehavior (to, from, savedPosition) {
  return { x: 0, y: 0 }
}

對於所有路由導航，簡單地讓頁面滾動到頂部。

返回 savedPosition，在按下 后退/前進 按鈕時，就會像瀏覽器的原生表現那樣：

scrollBehavior (to, from, savedPosition) {
  if (savedPosition) {
    return savedPosition
  } else {
    return { x: 0, y: 0 }
  }
}

如果你要模擬“滾動到錨點”的行為：

scrollBehavior (to, from, savedPosition) {
  if (to.hash) {
    return {
      selector: to.hash
    }
  }
}

我們還可以利用路由元信息更細顆粒度地控制滾動。查看完整例子請移步這里。

異步滾動

2.8.0 新增

你也可以返回一個 Promise 來得出預期的位置描述：

scrollBehavior (to, from, savedPosition) {
  return new Promise((resolve, reject) => {
    setTimeout(() => {
      resolve({ x: 0, y: 0 })
    }, 500)
  })
}

將其掛載到從頁面級別的過渡組件的事件上，令其滾動行為和頁面過渡一起良好運行是可能的。但是考慮到用例的多樣性和復雜性，我們僅提供這個原始的接口，以支持不同用戶場景的具體實現。

平滑滾動

只需將 behavior 選項添加到 scrollBehavior 內部返回的對象中，就可以為支持它的瀏覽器啟用原生平滑滾動：

scrollBehavior (to, from, savedPosition) {
  if (to.hash) {
    return {
      selector: to.hash,
      behavior: 'smooth',
    }
  }
}