Library / SDK
usablica/intro.js avatar
usablica/intro.js

Intro.js puts the whole tour in HTML attributes, and routes commercial use to a paid license

Lightweight, user-friendly onboarding tour library

23,454 stars2,542 forksTypeScriptNOASSERTION

At a glance

What is it?
Intro.js is a user onboarding and product walkthrough library whose steps live in data-intro and data-step attributes, activated by one function call. It is small enough to read in an afternoon, and the details that decide whether it fits your product are the licence split, the two entry points, and a test suite that needs Docker.
Who is it for?
Intro.js fits teams that want a tour running in an afternoon and control their own markup, and that read the licence before shipping. It does not fit teams needing framework-specific setup without reading the hosted docs, nor anyone expecting a pinned CDN URL from the README, and commercial products are pointed at a purchased license.
Can I use it commercially?
Check first. The repository uses a licence we do not classify automatically, so read its LICENSE file before any commercial use.
Is it still maintained?
Yes. The repository last received commits 3 days ago.
What is it written in?
Mainly TypeScript, according to GitHub's language statistics.

Answers come from the project's GitHub data, last synced on November 15, 2026, and from our analysis. They are not legal advice.

From daily snapshots

Star history

  • usablica/intro.js23,454 ★ · -5
Star history
Repository2026-09-212026-11-15
usablica/intro.js23.5k23.5k

-5 Stars in the last 55 days, measured from the daily GitHub snapshot. Compare with other projects

Editorial analysis

The tour is markup, not configuration

Steps live in your HTML rather than in a config object. The pattern is one line: add data-intro and data-step to the elements you want covered, use data-hint for the smaller hint bubbles, then call the function.

html
<a href='http://google.com/' data-intro='Hello step one!'></a>
javascript
introJs().start();

The activation line can take one parameter, and the example given is a CSS selector:

`introJs(".introduction-farm").start();`

That selector scopes the tour to elements carrying class='introduction-farm', which is the only scoping mechanism described here. Two consequences follow. There is nothing to run if the attributes are missing, since the tour walks existing elements rather than generating them.

Three stylesheets, and the RTL one is easy to forget

Step one of the setup is including the library and its stylesheet in the page: intro.js and introjs.css, or the minified versions for production. A third file exists for right-to-left language support, introjs-rtl.min.css.

That third file is where a deployment quietly goes wrong. The README names it only inside step one, so a right-to-left product has to include it explicitly. The minified-versus-source choice has the same shape: the docs mention both without naming filenames for the minified pair beyond the rtl one, so check the dist output before wiring a build step. Files are served from jsDelivr and cdnjs if you would rather not host them.

AGPLv3 for open source, a purchase for anything commercial

The licence section splits into two paths, and the split is explicit. For a commercial application, theme or plugin, the commercial license is named as the appropriate one, it keeps your source code proprietary, and it is purchased at introjs.com. The open-source path is GNU AGPLv3. Note that the repository's own licence field is not one of those strings, it records NOASSERTION, with license.md sitting at the root alongside the README.

The consequence for anyone shipping a commercial application, theme or plugin is that the README points them to the commercial license rather than the AGPLv3 path. Teams evaluating it should settle that question first, because the code is small enough that reading both files takes less time than discovering the constraint during legal review.

Two entry points, and the type definitions come from src

The package manifest names three fields that decide how it lands in your build: main is intro.js, module is intro.module.js, and types points at src/index.d.ts. The primary language of the repository is TypeScript, and the source lives in src/ with rollup.config.js and babel.config.js at the root, plus separate tsconfig.json, tsconfig.release.json and tsconfig.test.json files.

The consequence is that resolution is bundler-dependent. CommonJS consumers get the first file, ES module bundlers get the second, and type checking reads a declaration inside the source tree rather than a declaration shipped alongside the built bundle. Anyone who patches the type resolution, or who assumes the types file is part of the compiled output, should check what dist actually contains. The project also carries .browserslistrc, which is what decides how far back the build downlevels syntax.

The test suite needs Docker and a pinned browser image

Running everything means three suites at once, because test runs test:prettier, test:jest and test:cypress together. The Jest part is local. The Cypress part shells out to a container: it waits for a dev server at http://localhost:10001/dist/intro.js and then runs a pinned image, cypress/included:cypress-13.17.0-node-22.13.0-chrome-131.0.6778.264-1-ff-134.0-edge-131.0.2903.112-1, mounting the working directory and adding host.docker.internal as a gateway.

Two consequences. Contributors without a working Docker install cannot run the full test command, they can run test:jest alone. And the artefact under test is dist/intro.js served on port 10001, so a visual regression run depends on the dev server serving that file. The suite also distinguishes two snapshot types, base for updating snapshots and regression for comparing against them, which tells you the screenshots are the contract that breaks most visibly.

The README names no framework wrapper and points at the hosted docs

There is a section headed Using with that says Intro.js has many wrappers for different purposes and sends you to introjs.com/docs for more information. Nothing else about them appears in the repository README, including no code sample and no package name.

What the repository does show is the shape of the feature surface through its example directory: bootstrap, RTL, auto-position, callbacks, custom-class, disable-interaction, dynamic-start, groups, hint, html-tooltip, multi-page, programmatic, svg and withoutElement, plus a plain hello-world and an index.html. The consequence is that the interesting behaviour, dynamic starting, callback wiring, tours that span pages, HTML tooltips, blocking interaction, exists as runnable examples and hosted documentation rather than as instructions you can follow from the README alone. Budget time for that detour if you need any of it.

Four acquisition routes, with different upgrade stories

The project lists four ways to get a local copy. Clone the repository with git clone https://github.com/usablica/intro.js.git, add it with yarn add intro.js, add it with npm install intro.js --save, or pull it from a CDN at jsDelivr or cdnjs.

The four are not equivalent, and the README does not resolve the difference. A clone means you own the source and can build it, since the build instructions ask for nodejs and npm, then npm install, then npm run build to minify the static resources. A package manager install pins a version in your lockfile and gives you the same artefact on every machine. A CDN copy ties your tour to whatever that URL serves, and no pinning pattern is documented here. Choosing between them is mostly choosing who absorbs a breaking upgrade: your lockfile, your build, or a hosted file.

Version 8.6.0 shipped on the same day as the last push

The release cadence tells you how quickly a tour can change under you. v8.6.0 is dated 2026-09-21, v8.5.0 on 2026-07-21 and v8.4.0 on 2026-07-20, and the most recent push to the default branch is dated 2026-09-21, the same day as the current release. The version field in package.json matches, 8.6.0, so the manifest and the tag agree.

The interesting part is the spacing. Two minor versions landed a day apart in July 2026, and the next one came roughly two months later, so this is a project that ships in bursts rather than on a calendar. For a dependency whose job is to appear once per user and then stay out of the way, bursts are tolerable, but they are an argument for pinning an exact version and reading the changelog before taking a minor bump. Support questions are pointed at the Stackoverflow tag rather than at an issue tracker process.

Editorial conclusion

Intro.js fits teams that want a tour running in an afternoon and control their own markup, and that read the licence before shipping. It does not fit teams needing framework-specific setup without reading the hosted docs, nor anyone expecting a pinned CDN URL from the README, and commercial products are pointed at a purchased license. Before you commit, confirm your usage against the licence section, decide between the package and the CDN, and check whether your Docker setup can run the Cypress visual regression suite.

Frequently asked questions

What is intro.js?

Intro.js is a user onboarding and product walkthrough library, version 8.6.0, published as npm package intro.js with homepage introjs.com. Steps are declared with data-intro, data-step and data-hint attributes on your own elements, and run by calling introJs().start().

how to use intro js

Include intro.js and introjs.css, or introjs-rtl.min.css for right-to-left languages, add data-intro and data-step to your elements, then call introJs().start(). Passing one selector parameter limits the tour to matching elements, for example introJs(".introduction-farm").start().

is intro js free

The open-source license is GNU AGPLv3, and the npm install route is free of charge. For a commercial application, theme or plugin the README names the commercial license as the appropriate one, with your source kept proprietary and a purchase made at introjs.com.

intro js vs driver js

The README contains no feature comparison between the two. The only mention of driver.js is a usage trends link on npm-compare that also lists @reactour/tour and vue-tour, which is a download comparison rather than an API comparison. Answering the API question means reading introjs.com/docs directly.

Official sources

  1. Issues
  2. Project website
  3. README
  4. Releases
  5. usablica/intro.js on GitHub
Add this badge to your README

If you maintain this project, the badge below links readers to this analysis and shows its maintenance status from the daily GitHub snapshot. Paste the markdown into your README; add ?metric=license or ?metric=stars to the image URL for a different field.

Add this badge to your README

markdown
[![Hysen Labs](https://hysenlabs.com/badge/usablica-intro-js.svg)](https://hysenlabs.com/projects/usablica-intro-js)

Star history chart for your README

markdown
[![Star history](https://hysenlabs.com/chart/usablica-intro-js.svg)](https://hysenlabs.com/projects/usablica-intro-js)

Was this useful?