vue使用keep-alive保持滚动条位置的实现

前言

下班前，20分钟，发一篇。。。
简单介绍，使用keep-alive的时候，返回前一页，没有保持滚动条位置。
事实上，就算不使用keep-alive，位置也没有被记录。
但是，在不使用keep-alive的时候，页面内容会刷新，所以就随他去了……就是这么任性……

思路

官方有推荐一个scrollBehavior，链接，但是上面标注，只在history.pushState的浏览器生效，不知道是不是只能开启history.pushState才可以使用，看了下实现，挺不友好的，还是自己搞一个吧。。。

实现思路是这样的，首先给路由增加一个对象meta：

meta: {
    keepAlive: true,
    scrollTop: 0,
}

keepAlive是否需要保持页面，scrollTop记录页面的滚动位置。
然后在app.vue增加如下入口：

<keep-alive>
    <router-view v-if="$route.meta.keepAlive"></router-view>
</keep-alive>
<router-view v-if="!$route.meta.keepAlive"></router-view>

这样就启用keep-alive了。
然后在全局main.ts增加一个全局路由控制：

router.beforeEach((to: Route, from: Route, next: () => void) => {    
    if (from.meta.keepAlive) {
    const $content = document.querySelector('#content');
    const scrollTop = $content ? $content.scrollTop : 0;
    from.meta.scrollTop = scrollTop;
  }
  next();
});

很简单，离开的时候判断当前页是否需要保持页面，如果需要，记录页面主容器content的滚动位置，写入路由。
然后，每次进入保持好的页面，读取滚动条位置scrollTop，修改主容器的scrollTop，就搞定了：

public activated() {
    const scrollTop = this.$route.meta.scrollTop;
    const $content = document.querySelector('#content');
    if (scrollTop && $content) {
      $content.scrollTop = scrollTop;
    }
}

看起来很简单哦。

遗留问题

1、是不是每个页面都可以记录滚动条位置呢？

其实不是的，有的页面，内部有js交互，比如tab交互，不同的tab，页面可滚动的高度不一致，如果不保持页面状态而统一记录滚动位置，有可能导致滚动条的位置错位。

2、能不能把activated这一步写到全局的main.ts或者state去呢？

有想过这点，但是目前来说，没找到实现的方法。
首先，如果通过router来控制，做不到，全局路由控制只能在页面加载前监听，取不到载入页的元素。
如果写在一个通用的全局函数去控制，比如定义一个state，当页面加载完的时候设置，那需要定义一个mixins来处理，但是对这个mixins不太熟悉，暂时还不知道该怎么做，可能有时间找个方法搞定它。

没有啦……

后记

今天抽时间看了下官方的scrollBehavior，其实还是很简单的，但是我用不上，，，
原因是官方使用的滚动条，针对的是元素是#app，但是很遗憾，我的页面布局决定了，我的滚动条应该给#content元素。

<div id="app">
  <div class="wrap">
    <div id="header">
    <div id="content">
    <div id="footer">
    ...

所以scrollBehavior只能否决了。
回到mixins，今天也尝试了一下，但是VSC提示我，在mixin中的activated方法找不到this.$route这个属性：

类型“VueConstructor<Vue> | ComponentOptions<Vue, DefaultData<Vue>, DefaultMethods<Vue>, DefaultComputed, PropsDefinition<Record<string, any>>, Record<string, any>>”上不存在属性“$route”。
  类型“VueConstructor<Vue>”上不存在属性“$route”。

当然，就算提示找不到$route，实际上还是找到了的。
但是这里又有一个问题，mixin会在当前页每一个组件中都执行一次，在N个组件中会对滚动条操作N次，感觉有点冗赘，不太喜欢。
暂时找不到更好的实现方式了，只能在需要记录的页面单独实现activated...

搞定

下班前，总算搞定了。不废话，上代码：
自定义一个mixins：

//mixin.ts
import Vue from 'vue';
import Component from 'vue-class-component';

@Component
export default class MyMixin extends Vue {
  public activated() {
    const scrollTop = this.$route.meta.scrollTop;
    const $content = document.querySelector('#content');
    if (scrollTop && $content) {
      $content.scrollTop = scrollTop;
    }
  }
}

在需要记录scrollTop的页面引入这个mixins：

// home.vue
import { Component, Mixins } from 'vue-property-decorator';
import MyMixin from '@/global/mixin';

@Component
export default class Home extends Mixins(MyMixin) {
  // todo ...
}

关键在于Mixins，在没有使用Mixins之前，我们引入的是Vue，组件继承的也是Vue，现在引入Mixins，组件直接继承Mixins，然后把我们自定义的mixins传递进去，就可以在本页挂载自定义的Mixins了。
这么处理，基本完成了记录滚动条的功能，OK～