Skip to content

Latest commit

 

History

History
72 lines (49 loc) · 2.75 KB

README.md

File metadata and controls

72 lines (49 loc) · 2.75 KB

Intro.js

Better introductions for websites and features with a step-by-step guide for your projects.

##How to use Intro.js can be added to your site in three simple steps:

1) Include intro.js and introjs.css (or the minified version for production) in your page.

2) Add data-intro and data-step to your HTML elements.
For example:

<a href='http://google.com/' data-intro='Hello step one!' data-step='1'></a>

3) Call this JavaScript function:

introJs().start();

Optionally, pass one parameter to introJs function to limit the presentation section, for example introJs(".introduction-farm").start(); runs the introduction only for elements with class='introduction-farm'.

##Using with:

###Rails

If you are using the rails asset pipeline you can use the introjs-rails gem.

###Yii framework You can simply use this project for Yii framework: https://github.com/moein7tl/Yii-IntroJS

##Roadmap

  • More browser compatibility
  • Adding ability to define tooltip position in each step, top, left, right and bottom
  • Fix overlay layer bug while using it in wide monitors and document object
  • Change Next and Skip buttons
  • Add complete introduction callback

##History

###v0.1.0 - March 16, 2013 First version

##Main Contributors

other contributors: https://github.com/usablica/intro.js/contributors

##Support/Discussion

##License

Copyright (C) 2012 Afshin Mehrabani ([email protected])

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.