|
<h1 align="center"><img src="./demo/images/driver.png" /> Driver.js</h1> |
|
|
|
<p align="center"> |
|
<a href="https://creativecommons.org/licenses/by/4.0/"> |
|
<img src="https://img.shields.io/badge/License-CC%20BY%204.0-lightgrey.svg" /> |
|
</a> |
|
<a href="http://makeapullrequest.com"> |
|
<img src="https://img.shields.io/badge/contributions-welcome-green.svg" /> |
|
</a> |
|
<a href="http://twitter.com/kamranahmedse"> |
|
<img src="https://img.shields.io/badge/author-kamranahmedse-blue.svg" /> |
|
</a> |
|
</p> |
|
|
|
<p align="center"> |
|
<b>A powerful yet light-weight, vanilla JavaScript engine to drive the user's focus across the page</b></br> |
|
<sub>Only ~4kb, no external dependency, supports all major browsers and highly customizable <sub> |
|
</p> |
|
|
|
<br /> |
|
|
|
* **Simple**: is simple to use and has no external dependency at all |
|
* **Light-weight**: ~4kb in size, vanilla JavaScript and no external dependency |
|
* **Highly customizable**: has a powerful API and can be used however you want |
|
* **Highlight anything**: highlight any (literally any) element on page |
|
* **Feature introductions**: create powerful feature introductions and onboarding strategies |
|
* **Focus shifters**: add focus shifters for users |
|
* **User friendly**: Everything is controllable by keyboard |
|
* **Consistent behavior**: usable across all browsers (including in-famous IE) |
|
* **MIT Licensed**: free for personal and commercial use |
|
|
|
 |
|
|
|
For Usage and Examples, [have a look at demo](http://kamranahmed.info/driver) |
|
|
|
## Installation |
|
|
|
```zsh |
|
yarn add driver.js |
|
``` |
|
|
|
Or include directly |
|
|
|
Or include Choices directly: |
|
|
|
```html |
|
<!-- Include Driver CSS --> |
|
<link rel="stylesheet" href="/dist/driver.min.css"> |
|
<!-- Include Driver JavaScript --> |
|
<script src="/dist/driver.min.js"></script> |
|
``` |