Angular Tour - AngularJS directive for giving a tour of your website.

Demo

See it in action

Showcase features of your website

Give an interactive tour to showcase the features of your website.

• Uses cookies to remember your last step, or if you've complete the tour
• Easy to use, takes minutes to get up and running
• Customizable, use your own stylesheet or html markup
• Fully tested against all major browsers

Supported browsers

Has been tested in

• Chrome
• Firefox
• Safari
• Internet Explorer 10+

Installation

To install run

bower install angular-tour

Angular Tour has dependencies on jQuery and jQuery cookie, which bower will install.

Setup

Once bower has downloaded those dependencies for you, you'll need to make sure you add the required libraries to your index file. Your script includes should look something like this:

<script src="bower_components/jquery/jquery.js"></script>
<script src="bower_components/angular/angular.js"></script>
<script src="bower_components/jquery-cookie/jquery.cookie.js"></script>
<script src="bower_components/angular-tour/angular-tour-tpls.min.js"></script>

You'll also probably want to include the default stylesheet for angular tour. (You can replace this with your own stylesheet.)

<link rel="bower_components/angular-tour/angular-tour.css"/>

Lastly, you'll need to include the module in your angular app

angular.module('myApp', ['angular-tour'])

How to use

To begin your tour you'll need a <tour> element to contain all of your tour tips.

Surround the elements you want to highlight with a <tour-tip> element.

Example markup:

<tour>
  <span tourtip="tip 1"> Highlighted </span>
  <span tourtip="tip 2"> Elements </span>
  <span tourtip="tip 3"> Go </span>
  <span tourtip="tip 4"> Here </span>
  <input tourtip="or add it as an attribute to your element" />
</tour>

There are additional attributes that allow you to customize each tour-tip.

tourtip-step (Default: "null"): tour tip play from step 0 onwards, you can specify a specific order, e.g.

<span tourtip="tip 2" tourtip-step="1"></span>
<span tourtip="tip 1" tourtip-step="0"></span>
<span tourtip="tip 3" tourtip-step="2"></span>

next-label (Default: "Next"): The text for the next button. placement (Default: "top"): Placement of the tour tip relative to the target element. can be top, right, left, bottom

Inside your tour, you also have access to two scope methods for ending and starting the tour.

<a ng-click="openTour()">Open Tour</a>
<a ng-click="closeTour()">Close Tour</a>

Further Customization

Defaults

If you'd like to edit the defaults for all your tour, you can inject tourConfig somewhere into your app and modify the following defaults.

{
  placement        : 'top',                  // default placement relative to target. 'top', 'right', 'left', 'bottom'
  animation        : true,                   // if tips fade in
  nextLabel        : 'Next',                 // default text in the next tip button
  scrollSpeed      : 200,                    // page scrolling speed in milliseconds
  offset           : 28,                     // how many pixels offset the tip is from the target
  cookies          : true,                   // if cookies are used, may help to disable during development
  cookieName       : 'ngTour',               // choose your own cookie name
  postTourCallback : function (stepIndex){}, // a method to call once the tour closes (canceled or complete)
  postStepCallback : function (stepIndex){}  // a method to call after each step
}

Customizing Templates

As was already mentioned, you can use your own CSS for styling the tour tips. You can also use your own markup.

If you would like to replace the html template, instead of using the angular-tour-tpls.min.js script, use angular-tour.min.js which doesn't include a template.

The easiest way to add your own template is to use the script directive:

<script id="tour/tour.tpl.html" type="text/ng-template">
  <div class="tour-tip">
      <span class="tour-arrow tt-{{ placement }}"></span>
      <div class="tour-content-wrapper">
          <p ng-bind="content"></p>
          <a ng-click="nextAction()" ng-bind="nextLabel" class="small button tour-next-tip"></a>
          <a ng-click="closeAction()" class="tour-close-tip">×</a>
      </div>
  </div>  
</script>

License

This project is licensed under the MIT license.