Package Exports

product-tour

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (product-tour) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

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

##Requirement

Jquery

##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
        nextText: '', //optional defaults: 'next'
        prevText: '', //optional defaults: 'prev'
        html:// optional (true || false) defaults: false
    });
    //can only be called once
    productTour.addNewTourSteps([//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
        class: ''//top, bottom, right, left
    ]); 
    productTour.startTour();//initialize the tour

Development

To clone and run project with a view of developing framework

    npm install

NPM would help in getting our environment ready

    bower install

would bring our jquery dependency.

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

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

    gulp serve

which listens to updates of our product-tour.js and product-tour.css and call our

    gulp build

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

gulp build-js

Build Just the JS

    gulp build-css

Build Just the 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