README.md

Vue route timeline

Build a timeline clicking throug your application, using vue-router and vuex.

For detailed explanation on how things work, checkout the docs.

Instalation

npm install vue-route-timeline

Getting started

import Vue from 'vue'; // Load vue
import VueRouteTimeline from 'vue-route-timeline'; // Import timeline
import App from './App'; // Load your app
import router from './router'; // Add your router
import store from './store'; // Build your vuex store

Vue.use(VueRouteTimeline, {store, router}); // Connect timeline to vue, store and router

new Vue({
  el: '#app',
  router,
  store,
  render: h => h(App),
});

Usage

Add an item whenever you like, it will store the current route:

this.$routeTimeline.set('Title', 'Subtitle');

Contributors

Thanks goes to these wonderful people (emoji key):

disjfa 💬 💻 🎨 📖 💡

This project follows the all-contributors specification. Contributions of any kind welcome!