Skip to content

Latest commit

 

History

History
92 lines (78 loc) · 2.68 KB

README.md

File metadata and controls

92 lines (78 loc) · 2.68 KB
Raw

Product-Tour

A responsive tour snippet, with a step-by-step guide(onboarding) to help users understand how to use your website.

npm install product-tour@latest

Requirements

Example

See index.html

Usage

Simply include the following to get started

<script src="<link to jquery.js>"></script>
<script src="product-tour.min.js" type="text/javascript"></script>
<link href="product-tour.min.css" rel="stylesheet" type="text/css"/>
// initialize constructor
var productTour = new ProductTour({
	overlay:true, // optional (true || false) defaults: true
	onStart: function () {}, // called when tour starts || optional
	onChanged:function (e) {}, // called when tour changes || optional
	onClosed:function (e) {}, // called when the tour has been closed || optional
	next: '', // optional defaults: 'Next'
	prev: '', // optional defaults: 'Previous'
	of: '', // optional defaults: 'of'
	html: // optional (true || false) defaults: false
});
// can only be called once
productTour.steps([ // pass an array of tour steps
	{
		element: '', // specify the target selector by id or class #search or .header (defaults: body)
		title: '', // title of the tour step
		content: '', // content. Could be text or html. (if html set html attribute above to be true)
		image: '', // specify image to be shown on mobile view
		position: '' // top, bottom, right, left
	},
	{
		element: '', // specify the target selector by id or class #search or .header (defaults: body)
		title: '', // title of the tour step
		content: '', // content. Could be text or html. (if html set html attribute above to be true)
		image: '', // specify image to be shown on mobile view
		position: '' // top, bottom, right, left
	}
]);
productTour.startTour(); // initialize the tour

Development

To clone and run project with a view of developing framework

NPM would help in getting our environment ready:

npm install

We used gulp in handling our building and test running of frame work.

Use the index.html to do your design and testing of the framework with the browser. Simply use the command below:

gulp serve

This will listen to updates of our product-tour.js and product-tour.css and call:

gulp build

to help compile and build our minified version which is automatically or already called in our index.html file so the browser is opened.

Build Just the JS

gulp build-js

Build Just the CSS

gulp build-css

Credits

https://codyhouse.co/gem/product-tour/

Demo

https://codyhouse.co/demo/product-tour/

Contributions

Send a pull request or create an issue... thanks