Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pulsardev/vue-tour
Vue Tour is a lightweight, simple and customizable guided tour plugin for use with Vue.js. It provides a quick and easy way to guide your users through your application.
https://github.com/pulsardev/vue-tour
javascript tour vue
Last synced: about 1 month ago
JSON representation
Vue Tour is a lightweight, simple and customizable guided tour plugin for use with Vue.js. It provides a quick and easy way to guide your users through your application.
- Host: GitHub
- URL: https://github.com/pulsardev/vue-tour
- Owner: pulsardev
- License: mit
- Created: 2018-02-20T00:07:39.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2023-01-07T03:58:36.000Z (almost 2 years ago)
- Last Synced: 2024-04-14T11:51:50.236Z (8 months ago)
- Topics: javascript, tour, vue
- Language: Vue
- Homepage: https://pulsardev.github.io/vue-tour
- Size: 8.36 MB
- Stars: 2,350
- Watchers: 26
- Forks: 276
- Open Issues: 72
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
Awesome Lists containing this project
- awesome-github-star - vue-tour
- awesome - pulsardev/vue-tour - Vue Tour is a lightweight, simple and customizable guided tour plugin for use with Vue.js. It provides a quick and easy way to guide your users through your application. (Vue)
- awesome - pulsardev/vue-tour - Vue Tour is a lightweight, simple and customizable guided tour plugin for use with Vue.js. It provides a quick and easy way to guide your users through your application. (Vue)
README
# Vue Tour
[](https://circleci.com/gh/pulsardev/vue-tour/tree/master)
> 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.
[](https://pulsardev.github.io/vue-tour/)
## Table of Contents
- [Getting Started](#getting-started)
- [Something Missing?](#something-missing)
## 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.
```javascript
import Vue from 'vue'
import App from './App.vue'
import VueTour from 'vue-tour'
require('vue-tour/dist/vue-tour.css')
Vue.use(VueTour)
new Vue({
render: h => h(App)
}).$mount('#app')
```
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).
```html
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'.
export default {
name: 'my-tour',
data () {
return {
steps: [
{
target: '#v-step-0', // We're using document.querySelector() under the hood
header: {
title: 'Get Started',
},
content: `Discover <strong>Vue Tour</strong>!`
},
{
target: '.v-step-1',
content: 'An awesome plugin made with Vue.js!'
},
{
target: '[data-v-step="2"]',
content: 'Try it, you\'ll love it!<br>You can put HTML in the steps and completely customize the DOM to suit your needs.',
params: {
placement: 'top' // Any valid Popper.js placement. See https://popper.js.org/popper-documentation.html#Popper.placements
}
}
]
}
},
mounted: function () {
this.$tours['myTour'].start()
}
}
```
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.
```javascript
this.$tours['myTour'].start()
```
For a more detailed documentation, checkout the [docs for vue-tour](https://github.com/pulsardev/vue-tour/wiki).
## `before()` UI step functions
If you need to do UI setup work before a step, there's a `before` function you may include in any/each of
your steps. This function will get invoked before the start/next/previous step is rendered. The function must return a promise. The function is invoked when `start`, `nextStep`, and `previousStep` are triggered. When the promise is rejected, it will not move to the next or previous step. If the promise is resolved then it will move in the direction specified.
It's used when you need to change what's shown on the screen between steps. For example, you may want to hide
one set of menus and open a screen or you want to perform an async operation. This is especially useful in single-page applications.
```javascript
steps: [
{
target: '#v-step-0', // We're using document.querySelector() under the hood
content: `Discover Vue Tour!`,
before: type => new Promise((resolve, reject) => {
// Time-consuming UI/async operation here
resolve('foo')
})
}
]
```
## Something Missing?
If you have a feature request or found a bug, [let us know](https://github.com/pulsardev/vue-tour/issues) by submitting an issue.