A better way for new feature introduction and step-by-step users guide for your website and project.
Clone or download
bozdoz
Latest commit b46bbcd Apr 25, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github moved GITHUB files to .github; added npm minify and simplified build … Feb 23, 2018
docs chore(docs): adding bozdoz Dec 2, 2017
example Merge pull request #801 from usablica/fix-scroll-elements Feb 23, 2018
minified v2.9.3 - fix to skip and done, exiting intro; resolves #832 and resolves Apr 25, 2018
themes Fix position of left arrow arrow in modern theme Mar 13, 2018
.gitignore removing _site from docs, updating gitignore Jul 29, 2017
.jshintrc Merge branch 'master' into js-hint Oct 8, 2017
.spmignore Add spm support May 19, 2014
.travis.yml chore(travis): removing extra parts Oct 31, 2017
Makefile chore(makefile): adding test target Oct 31, 2017
README.md v2.9.3 - fix to skip and done, exiting intro; resolves #832 and resolves Apr 25, 2018
bower.json v2.3.0 🚀 Sep 1, 2016
changelog.md v2.9.3 - fix to skip and done, exiting intro; resolves #832 and resolves Apr 25, 2018
component.json v2.9.3 - fix to skip and done, exiting intro; resolves #832 and resolves Apr 25, 2018
intro.js v2.9.3 - fix to skip and done, exiting intro; resolves #832 and resolves Apr 25, 2018
introjs-rtl.css Update introjs-rtl.css May 28, 2017
introjs.css [FIX] Replaced old syntax with new one for radial-gradient Jan 2, 2018
license.md v2.6.0 Jul 29, 2017
package-lock.json v2.9.3 - fix to skip and done, exiting intro; resolves #832 and resolves Apr 25, 2018
package.json v2.9.3 - fix to skip and done, exiting intro; resolves #832 and resolves Apr 25, 2018
release.sh v2.9.1 - resolves #846 Apr 24, 2018
yarn.lock Added yarn lock Dec 21, 2016

README.md

Intro.js v2.9.3

Build Status

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

Where to get

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)

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. 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'.

Documentation

Please visit Documentation.

Using with:

Intro.js has many wrappers for different purposes. Please visit Documentation for more info.

Build

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

Instant IntroJs

Want to learn faster and easier? Here we have Instant IntroJs, Packt Publishing.

Buy and Download

Release History

Authors

Afshin Mehrabani

Benjamin J DeLong

Other contributors

Contributing

View contribution guidlines

Support/Discussion

License

Commercial license

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

Open-source license

GNU AGPLv3