vue-page-stack
English | 简体中文
A Vue SPA navigation manager,cache the UI in the SPA like a native application, rather than destroy it.
Example
Features
-
🐉 expanded on vue-router, the original navigation logic remains unchanged -
⚽ When a page is re-rendered as apushorforward, the newly rendered page will be added to the Stack. -
🏆 Whenbackorgo(negative number), the previous pages are not re-rendered, but instead are read from the Stack, and these pages retain the previous content state, such as the form content, the position of the scroll bar -
🏈 backorgo (negative)will remove unused pages from the Stack -
🎓 replacewill update the current page in the stack -
🎉 activated hook function triggers when rolling back to the previous page -
🚀 Browser back and forward events are supporded -
🍕 Responding to changes in routes with Parameters is supporded, such as navigating from/user/footo/user/bar, component instances are reused -
🐰 provides routing direction changes, and you can add different animations when forward or backward
Installation and use
Installation
npm install vue-page-stack
# OR
yarn add vue-page-stack
use
import Vue from 'vue'
import VuePageStack from 'vue-page-stack';
// vue-router is necessary
Vue.use(VuePageStack, { router });
// App.vue
<template>
<div id="app">
<vue-page-stack>
<router-view ></router-view>
</vue-page-stack>
</div>
</template>
CDN
<script src="https://unpkg.com/vue-page-stack/dist/vue-page-stack.umd.min.js"></script>
Vue.use(VuePageStack, { router });
API
install
use Vue.use to install vue-page-stack
Vue.use(VuePageStack, options);
// example
Vue.use(VuePageStack, { router });
Options description：
| Attribute | Description | Type | Accepted Values | Default |
|---|---|---|---|---|
| router | vue-router instance | Object | vue-router instance | - |
| name | VuePageStack name | String | 'VuePageStack' | 'VuePageStack' |
| keyName | stack-key name | String | 'stack-key' | 'stack-key' |
you can customize VuePageStack's name and keyName
Vue.use(VuePageStack, { router, name: 'VuePageStack', keyName: 'stack-key' });
forward or backward
If you want to make some animate entering or leaving, vue-page-stack offers stack-key-dir to judge forward or backward.
// App.vue
$route(to, from) {
if (to.params['stack-key-dir'] === 'forward') {
this.transitionName = 'forward';
} else {
this.transitionName = 'back';
}
}
get current UI stack
let UIStack = this.$pageStack.getStack();
Notes
keyName
Why is the parameter keyName added to the route? To support the browser's backward and forward events，this is important in webApp or wechat.
Changelog
Details changes for each release are documented in the release notes.
Principle
Getting the current page instance refers to the keep-alive section of Vue.
Thanks
The plug-in draws on both vue-navigation and vue-nav，Thank you very much for their inspiration.
Contributors
✨
Thanks goes to these wonderful people (emoji key):
 hezf |
 李娜 |
 余小磊 |
 yellowbeee |
2 Jun 3, 2021
36 Jun 14, 2022
42 Jul 10, 2022
63 Sep 12, 2022
63 Jan 8, 2023
21 Jul 29, 2022
72 Dec 6, 2022
11 Jan 9, 2022
149 Nov 25, 2022
96 Dec 14, 2022
26 Apr 14, 2022
1k Dec 7, 2022
78 Sep 23, 2022
9 Apr 23, 2022
257 Oct 18, 2022
1 Jan 8, 2022
25 Dec 19, 2022
0 Mar 29, 2022
57 Nov 12, 2022