Vue scrollBehavior 滚动行为

野性酷女 2022-03-08 06:12 223阅读 0赞

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

注意: 这个功能只在 HTML5 history 模式下可用。

当创建一个 Router 实例，你可以提供一个 `scrollBehavior` 方法：

![复制代码][copycode.gif]

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

![复制代码][copycode.gif]

`scrollBehavior` 方法接收 `to` 和 `from` 路由对象。第三个参数 `savedPosition` 当且仅当 `popstate` 导航 (通过浏览器的 前进/后退 按钮触发) 时才可用。

这个方法返回滚动位置的对象信息，长这样：

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

如果返回一个 falsy (译者注：falsy 不是 `false`，[参考这里][Link 1])的值，或者是一个空对象，那么不会发生滚动。

举例：

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

对于所有路由导航，简单地让页面滚动到顶部。

返回 `savedPosition`，在按下 后退/前进 按钮时，就会像浏览器的原生表现那样：

![复制代码][copycode.gif]

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

![复制代码][copycode.gif]

如果你要模拟『滚动到锚点』的行为：

![复制代码][copycode.gif]

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

![复制代码][copycode.gif]

我们还可以利用[路由元信息][Link 2]更细颗粒度地控制滚动。查看完整例子：

![复制代码][copycode.gif]

const scrollBehavior = (to, from, savedPosition) => {
      if (savedPosition) {
        // savedPosition is only available for popstate navigations.
        return savedPosition
      } else {
        const position = {}
        // new navigation.
        // scroll to anchor by returning the selector
        if (to.hash) {
          position.selector = to.hash
        }
        // 如果meta中有scrollTop
        if (to.matched.some(m => m.meta.scrollToTop)) {
          // cords will be used if no selector is provided,
          // or if the selector didn't match any element.
          position.x = 0
          position.y = 0
        }
        // if the returned position is falsy or an empty object,
        // will retain current scroll position.
        return position
      }
    }

![复制代码][copycode.gif]

与keepAlive结合，如果keepAlive的话，保存停留的位置：

![复制代码][copycode.gif]

scrollBehavior (to, from, savedPosition) {
         if (savedPosition) {
                return savedPosition
        } else {
            if (from.meta.keepAlive) {
            　　from.meta.savedPosition = document.body.scrollTop;
            }
            return { x: 0, y: to.meta.savedPosition ||0}
        }
    }

转载：[https://www.cnblogs.com/sophie\_wang/p/7880261.html][https_www.cnblogs.com_sophie_wang_p_7880261.html]

[copycode.gif]: /images/20220308/b981d11b46c84c5a95113f1345a1079d.png
[Link 1]: https://developer.mozilla.org/zh-CN/docs/Glossary/Falsy
[Link 2]: https://router.vuejs.org/zh-cn/advanced/meta.html
[https_www.cnblogs.com_sophie_wang_p_7880261.html]: https://www.cnblogs.com/sophie_wang/p/7880261.html