What is Chaperone?
Chaperone is a simple jQuery plugin for doing guided tours through a website. Inspired by Joyride, Chaperone takes a list of items and uses them as a guide to show messages on targetted elements.
Getting Started
Download the production version or the development version.
Also, if you don’t want to make your own styles, you’ll also want the stylesheet.
In your web page:
<link rel="stylesheet" type="text/css" media="screen" href="chaperone.css">
<script src="jquery.min.js"></script>
<script src="chaperone.min.js"></script>
<script>
jQuery(function($) {
$('#my-tour').chaperone(); // Set up a default tour for #my-tour
$('#my-tour').chaperone('start'); // Start the tour
});
</script>
Documentation
Check out the documention page
Examples
Check out the examples page
Release History
1.0.3 - Now used in production
0.3.0 - First release
License
Copyright (c) 2012 Andrew Montgomery-Hurrell
Licensed under the MIT, GPL licenses.
Contributing
In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using grunt.
Important notes
Please don’t edit files in the dist
subdirectory as they are generated via grunt. You’ll find source code in the src
subdirectory!
While grunt can run the included unit tests via PhantomJS, this shouldn’t be considered a substitute for the real thing. Please be sure to test the test/*.html
unit test file(s) in actual browsers.
Installing grunt
This assumes you have node.js and npm installed already.
- Test that grunt is installed globally by running
grunt --version
at the command-line. - If grunt isn’t installed globally, run
npm install -g grunt
to install the latest version. You may need to runsudo npm install -g grunt
. - From the root directory of this project, run
npm install
to install the project’s dependencies.
Installing PhantomJS
In order for the qunit task to work properly, PhantomJS must be installed and in the system PATH (if you can run “phantomjs” at the command line, this task should work).
Unfortunately, PhantomJS cannot be installed automatically via npm or grunt, so you need to install it yourself. There are a number of ways to install PhantomJS.
- PhantomJS and Mac OS X
- PhantomJS Installation (PhantomJS wiki)
Note that the phantomjs
executable needs to be in the system PATH
for grunt to see it.