Better introductions for websites and features with a step-by-step guide for your projects.
You can obtain your local copy of Intro.js from:
1) This github repository, using git clone https://github.com/usablica/intro.js.git
2) Using bower bower install intro.js --save
3) Using npm npm install intro.js --save
4) Download it from CDN (1, 2)
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. Use introjs-rtl.min.css for Right-to-Left language support.
CDN hosted files are available at jsDelivr (click Show More) & cdnjs.
2) Add data-intro and data-step to your HTML elements. To add hints you should use data-hint attribute.
For example:
<a href='http://google.com/' data-intro='Hello step one!'></a>See all attributes here.
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'.
IntroJS provides awesome templates and we are trying to update and add more templates for next versions. You can browse all templates here: https://github.com/usablica/intro.js/wiki/templates
In order to use templates, all you need to do is appending the template stylesheet to your page, after IntroJS CSS file:
<!-- Add IntroJs styles -->
<link href="../../introjs.css" rel="stylesheet">
<!-- Add Nazanin template -->
<link href="../../themes/introjs-nazanin.css" rel="stylesheet">Please visit Documentation page on the Wiki.
If you are using the rails asset pipeline you can use the introjs-rails gem.
You can simply use this project for Yii framework: https://github.com/moein7tl/Yii-IntroJS
Here you can find an IntroJs integration for Drupal: https://drupal.org/sandbox/alexanderfb/2061829
For AngularJS, you can use the directives in angular-intro.js.
Ember IntroJS wraps introjs in an Ember Component to guide users through your app.
https://github.com/thefrontside/ember-introjs
You can use IntroJS inside your Wordpress, here is a good article by SitePoint: http://www.sitepoint.com/creating-intro-js-powered-tours-wordpress/
Here is a under construction plugin for Wordpress: https://github.com/newoldmedia/intro.js-wordpress
GWT wrapper on top of Intro.js
Github: https://github.com/Agnie-Software/gwt-introjs
First you should install nodejs and npm, then first run this command: npm install to install all dependencies.
Now you can run this command to minify all static resources:
make build
Want to learn faster and easier? Here we have Instant IntroJs, Packt Publishing.
Afshin Mehrabani
If you want to use Intro.js for a commercial application, theme or plugin the commercial license is the appropriate license. With this option, your source code is kept proprietary. Purchase a commercial license at introjs.com
GNU AGPLv3