# Driver.js > Lightweight, dependency-free JavaScript library for product tours, element highlights, feature hints and onboarding checklists. Works with any framework. Install with `npm install driver.js`. Each feature is its own entry with its own stylesheet: - Tours and highlights: `import { driver } from "driver.js"` and `import "driver.js/dist/driver.css"` - Hints: `import { hints } from "driver.js/hints"` and `import "driver.js/dist/hints.css"` - Checklists: `import { checklist } from "driver.js/checklist"` with `import "driver.js/dist/driver.css"` and `import "driver.js/dist/checklist.css"` - Headless tours, for your own UI: `import { driver } from "driver.js/headless"`, no stylesheet Every page below is Markdown. Drop the `.md` suffix for the HTML version. ## Introduction - [Installation](https://driverjs.com/docs/installation.md): Install Driver.js with npm, yarn, pnpm, or a CDN script tag and add the lightweight, zero-dependency JavaScript tour library to your project in seconds. - [Basic Usage](https://driverjs.com/docs/basic-usage.md): Get started with Driver.js: import the library, configure your steps, and create your first multi-step product tour or element highlight in minutes. ## Tours - [Tour Basics](https://driverjs.com/docs/tour-basics.md): Build a multi-step product tour with Driver.js. Animate between steps or jump instantly, tune the animation speed, and show a step counter like 1 of 5. - [Popover](https://driverjs.com/docs/popover.md): Position Driver.js popovers with the side and align options, choose which buttons they show, change the button text, and add your own buttons and click handlers. - [Simple Highlight](https://driverjs.com/docs/simple-highlight.md): Highlight any element on the page with Driver.js. Spotlight a single element and show a popover to deliver contextual help, beyond just product tours. - [Interactive Tours](https://driverjs.com/docs/interactive-tours.md): Build Driver.js tours that react to your app: advance when users click the highlighted element, wait for elements that render on demand, skip optional steps and follow re-rendered elements. - [Action-Driven Tours](https://driverjs.com/docs/action-driven-tours.md): Build Driver.js tours that only move on when the user performs the real action: type a value, pick an option, click, right-click. Block clicks elsewhere, give feedback on wrong actions and recover when the UI changes. - [Headless Tours](https://driverjs.com/docs/headless-tours.md): Run Driver.js tours with your own UI. The headless build finds each step's element, waits for it and moves through the steps, but draws nothing and leaves the page alone. ## Hints & Checklists - [Feature Hints](https://driverjs.com/docs/hints.md): Add pulsing hint beacons to your UI with Driver.js. Users click a beacon to open a popover explaining the feature. Style the beacons and popovers to match your product. - [Checklists](https://driverjs.com/docs/checklists.md): Add an onboarding checklist to your app with Driver.js. Items launch product tours, follow links or wait for the user to do something, and tick themselves off as users make progress. - [Checklist Themes](https://driverjs.com/docs/checklist-themes.md): Ready-made themes for Driver.js checklists: dark mode, gradient header, GIF banner, numbered steps, progress ring, cards, compact and a completion celebration. Copy the CSS and go. ## Recipes - [All Recipes](https://driverjs.com/docs/recipes.md): Short, copy-ready Driver.js recipes for common jobs: first-run onboarding, teaching a form or a menu, resuming tours, confirming exits, analytics, frameworks and theming. - [First-Run Onboarding](https://driverjs.com/docs/first-run-onboarding.md): Show a Driver.js tour once, on a user's first visit, remember that they've seen it, and give them a button to replay it. - [Teach a Form](https://driverjs.com/docs/teach-a-form.md): Explain a form field by field with Driver.js highlights, or walk users through filling it in with steps that only move on when each field is valid. - [Walk Through a Menu](https://driverjs.com/docs/walk-through-a-menu.md): Guide users through a Driver.js tour that opens a dropdown and picks an item, keeps the menu usable, and recovers when the menu closes. - [Steps Inside a Dialog](https://driverjs.com/docs/steps-inside-a-dialog.md): Run Driver.js tour steps inside a modal dialog: wait for it to open, dim the dialog like the page, and move back to the page when it closes. - [Wait for a Save](https://driverjs.com/docs/wait-for-a-save.md): Keep a Driver.js tour on a step until your app finishes a save or a request, show a done state, then move on. Or load data before the next step. - [Resume a Tour](https://driverjs.com/docs/resume-a-tour.md): Save the step a user was on when they closed a Driver.js tour, and pick up from there the next time. - [Multi-Page Tours](https://driverjs.com/docs/multi-page-tours.md): Continue a Driver.js tour across page loads or client-side routes: save the step, let the app navigate, and resume on the next page. - [Confirm Before Closing](https://driverjs.com/docs/confirm-before-closing.md): Ask users to confirm before a Driver.js tour closes early, or stop them from leaving a tour they have to finish. - [Announce a Feature](https://driverjs.com/docs/announce-a-feature.md): Point out a new feature once with a Driver.js highlight, or leave a hint beacon on it that stays dismissed after the user has seen it. - [React and Vue](https://driverjs.com/docs/react-and-vue.md): Use Driver.js in React, Vue and Next.js: create the driver once the elements are on the page, keep it client-side, and destroy it on unmount. - [Start From a Help Menu](https://driverjs.com/docs/start-from-a-help-menu.md): Add a Take the tour item to your help menu that starts a Driver.js tour at the step for the screen the user is on. - [Right-Click and Double-Click Steps](https://driverjs.com/docs/right-click-and-double-click.md): Teach a right-click menu or a double-click with Driver.js action steps that accept only that gesture and block the others. - [Track Tour Analytics](https://driverjs.com/docs/track-tour-analytics.md): Find out whether users finished a Driver.js tour or closed it, and on which step they left, and send it to your analytics. - [Getting-Started Checklist](https://driverjs.com/docs/getting-started-checklist.md): Build a Driver.js getting-started checklist whose items each launch a short tour and tick themselves off when the tour is finished. - [Custom Buttons](https://driverjs.com/docs/custom-buttons.md): Add Skip and Restart buttons to Driver.js popovers, rename the built-in buttons, and translate them for other languages. - [Match Your Brand](https://driverjs.com/docs/match-your-brand.md): Give Driver.js popovers a dark theme or your brand colors with a popover class, a few CSS rules and the CSS variables. - [Build Your Own Tour UI](https://driverjs.com/docs/build-your-own-tour-ui.md): Four tours with completely different UIs, built on driver.js/headless: a checklist panel, a chat assistant, a hand-drawn spotlight and hints inside a form. Live demos with the full code. ## Reference - [Configuration](https://driverjs.com/docs/configuration.md): Explore every Driver.js configuration option. Configure the driver globally, per step, or on the fly, with full TypeScript autocomplete and type safety. - [API Reference](https://driverjs.com/docs/api.md): Complete Driver.js API reference: every method available on the driver, hints and checklist instances, with examples. - [Theming](https://driverjs.com/docs/theming.md): Theme Driver.js to match your brand. Apply custom classes and CSS to the popover, buttons, overlay, hints and checklists, or restyle the driver from the ground up. - [Migrate to 1.x](https://driverjs.com/docs/migrating-from-0x.md): Upgrade from Driver.js 0.x to 1.x with this step-by-step migration guide covering the new API, imports, and architecture changes in the 1.0 rewrite. ## Optional - [Full documentation in one file](https://driverjs.com/llms-full.txt) - [Changelog](https://driverjs.com/docs/changelog.md): Track what's new in Driver.js. See the latest features, changes, and fixes shipping in each release, plus what's currently in the works.