README_CN.md

Stack-Keep-Alive

Stack-Keep-Alive 是Vue.js(Vue 3.x)项目中页面缓存自动管理工具。

Vue2.x 版本

在线Demo, 打开Vue-devtools查看页面缓存

为什么需要本插件：

在使用Vue.js搭配vue-router开发单页面应用时，经常使用keep-alive组件缓存浏览过的页面来提升用户体验，目前提供了如下配置方式来动态管理缓存

include - 只有名称匹配的组件会被缓存。
exclude - 任何名称匹配的组件都不会被缓存。
max - 最多可以缓存多少组件实例。

但是这只能处理简单状况，无法应对复杂状况，比如：

1. 如何在返回上一页面时，销毁当前页面缓存
2. 如何缓存多个使用相同组件的页面，并且有针对性的销毁

功能

1. 自动侦测前进或后退
2. 后退时自动销毁当前页面缓存
3. 前进时自动创建新的缓存实例，不管该组件是否被缓存过
4. 刷新页面后，仍能够准确识别前进或后退
5. replaceStay白名单帮助在tab切换时缓存页面

使用方式

1. npm i -s stack-keep-alive
2. 使用stack-keep-alive替换keep-alive组件 (无需引入，已注册全局组件)

<!-- 注意绑定key -->  
<router-view v-slot="{ Component }">
  <stack-keep-alive v-slot='{ key }'> 
      <component :is="Component" :key='key'/>
  </stack-keep-alive>
</router-view>

3. 在app初始化时，使用StackKeepAlive插件

import StackKeepAlive from 'stack-keep-alive'
const app = Vue.createApp({})
app.use(StackKeepAlive)
...

配置

1. replace白名单

在tab栏切换时，需要留存某些tab页面，可以在replaceStay中配置这些路径

<stack-keep-alive v-slot='{ key }' :replaceStay='["/foo"]'> 
    <component :is="Component" :key='key'/>
</stack-keep-alive>

2. 配合transition使用，需要使用内置sk-transition组件替换transition组件. 使用name和 back_name 实现两种不同动画效果

    <router-view v-slot="{ Component }">
      <sk-transition name='slide-left' back_name='slide-right'>
        <stack-keep-alive v-slot="{ key }">
          <component :is="Component" :key='key'/>
        </stack-keep-alive>
      </sk-transition>
    </router-view>

3. 单例组件 有时期望一个组件在整个应用生命周期只创建一次，比如常见的购物车页面，此时使用 singleton配置单例组件

<stack-keep-alive v-slot='{ key }' :singleton='["/foo"]'> 
    <component :is="Component" :key='key'/>
</stack-keep-alive>

更新日志

v1.0.0

1. 修复配合transition组件无效的问题

v1.0.0-beta.0

1. 支持Vue3
2. 单元测试

Sample code

1. 静态文件引入
2. 工程化+完整动画

欢迎添加微信 **OmniBug **探讨交流，Email: [email protected]