1️⃣ 滚动行为

使用前端路由,当切换到新路由时,想要页面滚到顶部,或者是保持原先的滚动位置,就像重新加载页面那样。vue-router 可以自定义路由切换时页面如何滚动。

注意: 这个功能只在支持 history.pushState 的浏览器中可用。

当创建一个 Router 实例,你可以提供一个 scrollBehavior 方法:

  1. const router = new VueRouter({
  2. routes: [...],
  3. scrollBehavior (to, from, savedPosition) {
  4. // return 期望滚动到哪个的位置
  5. }
  6. })

scrollBehavior 方法接收 to 和 from 路由对象。第三个参数 savedPosition 当且仅当 popstate 导航 (通过浏览器的 前进/后退 按钮触发) 时才可用。
这个方法返回滚动位置的对象信息,长这样:

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

如果返回一个 falsy 的值,或者是一个空对象,那么不会发生滚动。

  1. 1. falsy (虚值) 是在 Boolean 上下文中认定为 false 的值。
  2. 2. JavaScript 中只有 8 falsy 值。
  3. 1. false
  4. 2. 0
  5. 3. -0
  6. 4. 0n
  7. 5. "", '', ``
  8. 6. null
  9. 7. undefined
  10. 8. NaN

image.png
23.gif

2️⃣ 举例

  1. scrollBehavior (to, from, savedPosition) {
  2. return { x: 0, y: 0 }
  3. }

对于所有路由导航,简单地让页面滚动到顶部。
返回 savedPosition,在按下 后退/前进 按钮时,就会像浏览器的原生表现那样:

  1. scrollBehavior (to, from, savedPosition) {
  2. if (savedPosition) {
  3. return savedPosition
  4. } else {
  5. return { x: 0, y: 0 }
  6. }
  7. }

如果你要模拟“滚动到锚点”的行为:

  1. scrollBehavior (to, from, savedPosition) {
  2. if (to.hash) {
  3. return {
  4. selector: to.hash
  5. }
  6. }
  7. }

1️⃣ 异步滚动

2.8.0 新增

你也可以返回一个 Promise 来得出预期的位置描述:

  1. scrollBehavior (to, from, savedPosition) {
  2. return new Promise((resolve, reject) => {
  3. setTimeout(() => {
  4. resolve({ x: 0, y: 0 })
  5. }, 500)
  6. })
  7. }

将其挂载到从页面级别的过渡组件的事件上,令其滚动行为和页面过渡一起良好运行是可能的。但是考虑到用例的多样性和复杂性,我们仅提供这个原始的接口,以支持不同用户场景的具体实现。

1️⃣ 平滑滚动

只需将 behavior 选项添加到 scrollBehavior 内部返回的对象中,就可以为支持它的浏览器启用原生平滑滚动:

  1. scrollBehavior (to, from, savedPosition) {
  2. if (to.hash) {
  3. return {
  4. selector: to.hash,
  5. behavior: 'smooth',
  6. }
  7. }
  8. }