intro.js

User Onboarding and Product Walkthrough Library

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
intro.js
22,571807.2.08 months ago10 years agoMinified + gzip package size for intro.js in KB

Readme

Intro.js
Build Status npm
User Onboarding and Product Walkthrough Library

<img src="https://raw.githubusercontent.com/usablica/intro.js/gh-pages/img/introjs-demo.png">

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 yarn ``yarn add intro.js``
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:
```html ````
See all attributes here.
3) Call this JavaScript function: ```javascript 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:
npm run build

Contributors ✨

<td align="center"><a href="http://afshinm.name"><img src="https://avatars3.githubusercontent.com/u/314326?v=4" width="100px;" alt=""/><br /><sub><b>Afshin Mehrabani</b></sub></a><br /><a href="https://github.com/usablica/intro.js/commits?author=afshinm" title="Code">💻</a> <a href="https://github.com/usablica/intro.js/commits?author=afshinm" title="Documentation">📖</a></td>
<td align="center"><a href="https://bozdoz.com"><img src="https://avatars0.githubusercontent.com/u/1410985?v=4" width="100px;" alt=""/><br /><sub><b>bozdoz</b></sub></a><br /><a href="https://github.com/usablica/intro.js/commits?author=bozdoz" title="Code">💻</a> <a href="https://github.com/usablica/intro.js/commits?author=bozdoz" title="Documentation">📖</a></td>

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