Kamran Ahmed
630adda553
Two separate vite runs rather than one multi-entry build. Multi-entry splits the shared popover primitive into a chunk, which would make the tour bundle depend on a second file and cost every existing user bytes for a feature they may never use; it also merged both stylesheets into driver.css. Standing the entries alone keeps driver.css byte-identical to master and the tour bundle within ~120 bytes of it, and lets hints be used without the tour. Importing both duplicates the primitive (~2KB gzip), which is safe because the copies only handle their own popovers. The hints run writes to dist-hints/ and the postbuild folds it into dist/. That indirection is not incidental: vite-plugin-dts takes its entry from package.json's `types` field when bundling, not from the lib entry, so pointing it at hints emits the tour's API under the hints name and overwrites dist/driver.js.d.ts. api-extractor rolls up the hints declarations from an explicit entry instead. hints/package.json is a resolution shim for legacy node10, which predates `exports`; attw is green across node10, node16 ESM/CJS and bundler for both entries. sideEffects marks only CSS, so bundlers can drop unused code from either entry. Sizes (gzip): tour 6.7KB unchanged in CSS and ~6.8KB in JS, hints 4.2KB JS + 0.4KB CSS standalone.
Driver.js
Powerful, highly customizable library for Product Tours and Feature Introductions
No external dependencies, light-weight, supports all major browsers and highly customizable
- Simple: is simple to use and has no external dependency at all
- Light-weight: is just 5kb gzipped as compared to other libraries which are +12kb gzipped
- 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 for your web applications
- Focus shifters: add focus shifters for users
- User friendly: Everything is controllable by keyboard
- TypeScript: Written in TypeScript
- Consistent behavior: usable across all browsers
- MIT Licensed: free for personal and commercial use
Documentation
For demos and documentation, visit driverjs.com
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 it 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+.
Developing locally
The library lives in src/. To try your changes against a set of live examples, run the playground — an Astro app in playground/ that imports the library straight from source, so edits hot-reload instantly:
pnpm install
pnpm run playground:install
pnpm dev
Each example lives in its own file under playground/src/examples/ and shows up as a page in the sidebar. To add one, drop an entry into the relevant group (highlight.ts, popover.ts, tour.ts, api.ts).
Other useful scripts:
pnpm build
pnpm test
Contributions
Feel free to submit pull requests, create issues or spread the word.
License
MIT © Kamran Ahmed