Installation

Install the package:

npm install driver.js
# or
pnpm add driver.js
# or
yarn add driver.js

Import the library and its stylesheet, then highlight an element:

import { driver } from "driver.js";
import "driver.js/dist/driver.css";

const driverObj = driver();

driverObj.highlight({
  element: "#some-element",
  popover: {
    title: "Title",
    description: "Description",
  },
});

Hints and Checklists

Hints and checklists are separate entries, so you only load them when you use them.

import { hints } from "driver.js/hints";
import "driver.js/dist/hints.css";

import { checklist } from "driver.js/checklist";
import "driver.js/dist/driver.css";
import "driver.js/dist/checklist.css";

Hints don’t need driver.css. Checklists do, because their items run tours.

CDN

<script
  src="https://cdn.jsdelivr.net/npm/driver.js@latest/dist/driver.js.iife.js"
></script>
<link
  rel="stylesheet"
  href="https://cdn.jsdelivr.net/npm/driver.js@latest/dist/driver.css"
/>

<!-- Only if you use hints -->
<script
  src="https://cdn.jsdelivr.net/npm/driver.js@latest/dist/hints.iife.js"
></script>
<link
  rel="stylesheet"
  href="https://cdn.jsdelivr.net/npm/driver.js@latest/dist/hints.css"
/>

<!-- Only if you use checklists. Load it after the main script. -->
<script
  src="https://cdn.jsdelivr.net/npm/driver.js@latest/dist/checklist.iife.js"
></script>
<link
  rel="stylesheet"
  href="https://cdn.jsdelivr.net/npm/driver.js@latest/dist/checklist.css"
/>

The CDN builds expose globals instead of modules:

const driver = window.driver.js.driver;
const hints = window.driverHints.hints;
const checklist = window.driverChecklist.checklist;

const driverObj = driver();

Next: Basic Usage.