• Stars
    star
    22,527
  • Rank 978 (Top 0.02 %)
  • Language
    TypeScript
  • License
    Other
  • Created about 11 years ago
  • Updated about 2 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Lightweight, user-friendly onboarding tour library

Intro.js

Build Status npm

User Onboarding and Product Walkthrough Library

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:

<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:

npm run build

Contributors โœจ


Afshin Mehrabani

๐Ÿ’ป ๐Ÿ“–

bozdoz

๐Ÿ’ป ๐Ÿ“–

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

More Repositories

1

front-end-frameworks

A collection of best front-end frameworks for faster and easier web development.
2,778
star
2

progress.js

ProgressJs is a JavaScript and CSS3 library which help developers to create and manage progress bar for every objects on the page.
JavaScript
2,372
star
3

kissui.scrollanim

CSS3 scroll animation library
CSS
1,429
star
4

widearea

Create expandable textarea and write large amount of text easily.
JavaScript
1,135
star
5

label.css

Just a simply easy way to label each element you want!
Ruby
766
star
6

persian.js

A simple library for Persian language localization.
JavaScript
355
star
7

liaar

Create fake REST API in a minute
Python
201
star
8

motion.js

Motion.js is a easy to use, cross-browser CSS3 library for creating animations in web.
JavaScript
80
star
9

_s

_s: Pythonic array slicing in JavaScript
JavaScript
72
star
10

density

NodeJs module for calculating keyword density in a text/html
JavaScript
45
star
11

lup

Easy to use CSS3 transition manager
JavaScript
40
star
12

doc42

Jekyll-Kissui bundle to create awesome documentations
24
star
13

kissui.position

Track element(s) on the page like a boss.
JavaScript
23
star
14

kissui

๐Ÿ’ซ Simple, easy to use, modern web development framework
CSS
17
star
15

dummychat

A NodeJS-Socket.IO dummy chat, every client has a dummy and can play with it!
JavaScript
14
star
16

otobox.js

Simple and fast JavaScript/HTML5 library to create autocomplete inputs
JavaScript
14
star
17

semver.ir

Semantic Versioning Specification (Persian)
JavaScript
13
star
18

sourcedoc

Document your code, continuously.
CSS
12
star
19

kissui.sticky

Simple and lightweight sticky position that works everywhere
CSS
11
star
20

introjs-website

Intro.js website and documentation
JavaScript
10
star
21

hello-backbonejs-fa

Tutorial of increasing complexity for Backbone.js, translated to Persian
JavaScript
8
star
22

parserjs

Javascript AST parser
JavaScript
7
star
23

algorithms

Implementation of common algorithms
Rust
4
star
24

localr

Map localhost ports to localr.io
JavaScript
4
star
25

datatube

Javascript library to import, process and export data
JavaScript
2
star
26

readr

News API client in React Native + ES6 version of AYLIEN News API SDK
JavaScript
2
star