Bootstrap Joyride - DEPRICATED

Bootstrap Joyride is an easy to configure site tour wizard based on Twitter Boostrap and inspired by Joyride.

Bootstrap Joyride is MIT-licensed and absolutely free to use.

Documentation

Bootstrap Joyride is inspired by Joyride and relies on a similar structure for the tour markup.

BUGS

Not really, but still yes :-) Some stuff hardcoded that should be changed. Started to rewrite and narrow down the bugs and add more settings. Please feel free to contribute.

Add Bootstrap Joyride to your page

• Boostrap Tooltip and Popup javascripts needs to be attached

  <script src="bootstrap-tooltip.js" type="text/javascript"></script> <script src="bootstrap-popover.js" type="text/javascript"></script>

• Then attach the Bootstrap Joyride plugin

  <script src="bootstrap-joyride.js" type="text/javascript"></script>

Define the attach points

	- Bootstrap Joyride can be attached to any element with a unique ID, in any order.
	<h3 id="JoyrideStop1">This is neat</h3>

	<p id="JoyrideStop2">Bla bla bla</p>

	<a id="JoyrideStop3" href="#url">Click me</a>

	<div id="JoyrideStop4">This is my content</div>

Create Your Joyride Outline

• Each joyride tour is made in a ol.
• The joyride is in the order of the li's

	<ol id="JoyrideCourseID">
	  <li data-target="#JoyrideStop1" data-placement="bottom" data-title="First Stop">Joyride content...</li>
	  <li data-target="#JoyrideStop2" data-placement="top" data-title="Second Stop">Joyride content...</li>
	  <li data-target="#JoyrideStop3" data-placement="left" data-title="Third Stop">Joyride content...</li>
	  <li data-target="#JoyrideStop4" data-placement="right" data-title="Fourth Stop">Joyride content...</li>
	</ol>

Activate the Joyride

Launch the Joyride on pageload

	<script type="text/javascript">
	  $(window).load(function() {
	    $(this).BootJoyride({
	      /* Settings will go here */
	    });
	  });
	</script>

Launch the Joyride on a button click.

<a href="#joyride" id="startride" class="btn btn-large btn-danger"><span class="icon-bullhorn"></span>Start Joyride</a>

	$('#startride').click(function (e) {
    e.preventDefault();
	    $(this).BootJoyride({
	      'cookieMonster': false,           	// true/false for whether cookies are used
	      'cookieName': 'myHomepageJoyride',  	// choose your own cookie name
	      'cookieDomain': false,           		// set to false or yoursite.com
	      'tipContent': '#JoyrideCourseID',    	// The ID of the <ol> used for content
	      'postRideCallback': $.noop,      		// A method to call once the tour closes
	      'postStepCallback': $.noop,      		// A method to call after each step
	      'nextOnClose': false,            		// If cookies are enabled, increment the current step on close
	      'debug': false
	    });
    });

Launch the Joyride on a button click with modal.

Create an overlay div

    <div id='overlay'></div>
    <a href="#joyride" id="startride" class="btn btn-large btn-danger"><span class="icon-bullhorn"></span>Start Joyride</a>

Use this css overlay

	<style>
   	    #overlay {
	    	position: fixed; 
		    top: 0;
		    left: 0;
		    width: 100%;
		    height: 100%;
		    background: #000;
		    opacity: 0.4;
		    filter: alpha(opacity=40);
		    z-index: 10;
		    display: none;
		}
   	</style>

	$('#startride').click(function (e) {
    	e.preventDefault();
	    $('#overlay').show();
		    $(this).BootJoyride({
		      'cookieMonster': false,           	// true/false for whether cookies are used
		      'cookieName': 'myHomepageJoyride',  	// choose your own cookie name
		      'cookieDomain': false,           		// set to false or yoursite.com
		      'tipContent': '#JoyrideCourseID',    	// The ID of the <ol> used for content
		      'postRideCallback': endride,      	// A method to call once the tour closes
		      'postStepCallback': $.noop,      		// A method to call after each step
		      'nextOnClose': false,            		// If cookies are enabled, increment the current step on close
		      'debug': false
		    });
    });

    function endride() 
    {
    	$('#overlay').hide();
    }

Options / Settings

	- Set your settings to override the defaults

	$(this).BootJoyride({
	  'cookieMonster': true,           		// true/false for whether cookies are used
	  'cookieName': 'myHomepageJoyride',  	// choose your own cookie name
	  'cookieDomain': false,           		// set to false or yoursite.com
	  'tipContent': '#JoyrideCourseID',		// The ID of the <ol> used for content
	  'postRideCallback': $.noop,      		// A method to call once the tour closes
      'postStepCallback': $.noop,      		// A method to call after each step
      'nextOnClose': false,            		// If cookies are enabled, increment the current step on close
      'debug': false
	});

Credits

Orignial Idea and code is from: Bootstrap-Tour by GILD. Since no active dev i decided to fix the bugs and improve and rebrand it.

MIT Open Source License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.