Vue Tour
Vue Tour is a lightweight, simple and customizable tour plugin for use with Vue.js. It provides a quick and easy way to guide your users through your application.
Table of Contents
Getting Started
You can install vue-tour
using npm or by downloading the minified build on GitHub.
npm install vue-tour
Then import the plugin in your application entry point (typically main.js if you used vue-cli to scaffold your project) and tell Vue to use it. Also don't forget to include the styles. You can add the styles provided by default or customize them to your own liking.
Vue
Finally put a v-tour
component in your template anywhere in your app (usually in App.vue) and pass it an array of steps.
The target
property of each step can target a DOM element in any component of your app (as long as it exists in the DOM when the concerned step pops up).
A DOM element on your page. The first step will pop on this element because its ID is 'v-step-0'. A DOM element on your page. The second step will pop on this element because its ID is 'v-step-1'. A DOM element on your page. The third and final step will pop on this element because its ID is 'v-step-2'.
For all individual elements you want to add a step on, make sure it can be retrieved with document.querySelector()
. You can use any selector, an ID, a CSS class, data attributes, etc.
Once this is done and your steps correctly target some DOM elements of your application, you can start the tour by calling the following method.
this$tours'myTour'start
For a more detailed documentation, checkout the docs for vue-tour.
Something Missing?
If you have a feature request or found a bug, let us know by submitting an issue.