vue-router滚动行为

滚动行为

使用前端路由, 当切换到新路由时, 想要页面滚到顶部, 或者是保持原先的滚动位置, 就像重新加载页面那样. 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}}

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

1
2
3

scrollBehavior(to, from, savePosition) {
  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
    }
  }
}

异步滚动

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

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

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