vue-stacked-ui
Description
vue-stacked-ui provides "Stacked UI" at the top of vue-router(v4).
It is possible to realize a UI that allows users to drill down through data, sometimes seen in dashboards.
Following features,
- Allows infinite number of pages to be stacked.
- URL-first design. (URL representing stack state)
- Browser history support.
- Route params passed to page by vue-router.
- Provides callback to block when "pop" Stack.
Requirement
- Vue 3
- vue-router 4
Install
npm install vue-stacked-ui
Usage
(Preparation) Load plugin in main.ts
import router from './router'
import { stackedUI } from 'vue-stacked-ui'
import 'vue-stacked-ui/dist/vue-stacked-ui.css'
// Then use it as Vue plugin.
app.use(stackedUI, {router: router});
TypeScript
(Preparation) Allow slug parameter in router/index.ts
{
path: '/about/:v1?/:v2?/:v3?/\/:slug(.*)?', // add "/\/:slug(.*)?"
props: true,
meta: { stackable: true } // Mark page can use as stack.
}
TypeScript
(Use) Control stack
<StackPush to="/about">stack push component</StackPush> <StackPop>stack push component</StackPop>
HTML
(Use) Programatically control stack
import { useStack } from "vue-stacked-ui"
const stack = useStack();
stack.push("/about/hoge")
stack.pop()
TypeScript
(Use) Register onBeforePop callback if you need.
props.currentStack?.onBeforePop(() => {
return confirm("Realy close stack?")
});
TypeScript
