Giter VIP home page Giter VIP logo

bootstrap-tour's Introduction

Bootstrap Tour

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

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

Documentation

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

Add Bootstrap Tour to your page

/* Boostrap Tooltip and Popup javascripts needs to be attached */
<script src="bootstrap-tooltip.js" type="text/javascript"></script>
<script src="bootstrap-popup.js" type="text/javascript"></script>

/* Then attach the Bootstrap Tour plugin */
<script src="bootstrap-tour.js" type="text/javascript"></script>

Define the attach points

/* Bootstrap Tour can be attached to any element with a unique ID, in any order */
<h3 id="yourHeaderID"></h3>
<p id="yourParagraphID">

<a id="yourAnchorID" href="#url">

Create Your Tour Outline

/* Each tip is set within this <ol>. */
/* This creates the order the tips are displayed */
<ol id="chooseID">
  /* data-id needs to be the same as the parent it will attach to */
  <li data-target="#newHeader">Tip content...</li>
  /* using 'data-title' lets you have custom title */
  <li data-target="#parentElementID" data-title="Second Feature">Content...</li>
  /* you can use 'data-placement' to define where the popup will appear */
  <li data-target="#parentElementID" data-placement="bottom">Content...</li>
</ol>

Activate the tour

/* Launching the tour when to page is loaded */
<script type="text/javascript">
  $(window).load(function() {
    $(this).featureTour({
      /* Options will go here */
    });
  });
</script>

Options

/* Setting your options to override the defaults */
$(this).featureTour({
  'cookieMonster': true,           // true/false for whether cookies are used
  'cookieName': 'myHomepageTour',  // choose your own cookie name
  'cookieDomain': false,           // set to false or yoursite.com
  'tipContent': '#tourContent'     // The ID of the <ol> used for content
});

GILD

Bootstrap Tour was made by GILD.

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.

bootstrap-tour's People

Stargazers

 avatar  avatar

Watchers

 avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.