Home

Awesome

<h1 align="center"><img height="150" src="https://driverjs.com/driver.svg" /><br> Driver.js</h1> <p align="center"> <a href="https://github.com/kamranahmedse/driver.js/blob/master/license"> <img src="https://img.shields.io/badge/License-MIT-yellow.svg" /> </a> <a href="https://npmjs.org/package/driver.js"> <img src="https://img.shields.io/npm/v/driver.js.svg" alt="version" /> </a> <a href="https://npmjs.org/package/driver.js"> <img src="https://img.shields.io/npm/dt/driver.js.svg" alt="downloads" /> </a> </p> <p align="center"> <b>Powerful, highly customizable vanilla JavaScript engine to drive the user's focus across the page</b></br> <sub>No external dependencies, light-weight, supports all major browsers and highly customizable </sub><br> </p> <br /> <br />

Documentation

For demos and documentation, visit driverjs.com

Please note that above documentation is for version 1.x which is the complete rewrite of driver.js.<br> For 0.x documentation, please visit this page

<br />

So, yet another tour library?

No, it's more than a tour library. Tours are just one of the many use-cases. Driver.js can be used wherever you need some sort of overlay for the page; some common usecases could be: highlighting a page component when user is interacting with some component to keep them focused, providing contextual help e.g. popover with dimmed background when user is filling a form, using it as a focus shifter to bring user's attention to some component on page, using it to simulate those "Turn off the Lights" widgets that you might have seen on video players online, usage as a simple modal, and of-course product tours etc.

Driver.js is written in Vanilla TypeScript, has zero dependencies and is highly customizable. It has several options allowing you to change how it behaves and also provides you the hooks to manipulate the elements as they are highlighted, about to be highlighted, or deselected.

Also, comparing the size of Driver.js with other libraries, it's the most light-weight, it is just ~5kb gzipped while others are 12kb+.

<br>

Contributions

Feel free to submit pull requests, create issues or spread the word.

License

MIT © Kamran Ahmed