driver.js README

The project's README from github.com/nilbuild/driver.js. As one markdown file: README.md.




Driver.js

jsdelivr hits downloads

Powerful, highly customizable library for Product Tours and Feature Introductions
No external dependencies, light-weight, supports all major browsers and highly customizable



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

driver.js (nilbuild/driver.js)

Searching Database…

26.9K ·GitHub
Driver.js
Что это такое?Driver.js — это легковесная JavaScript-библиотека для создания пошаговых туров по продукту, знакомства с новыми функциями и оверлеев с подсветкой, которые направляют внимание пользователя на веб-странице.
Это фреймворк или просто библиотека?Это самостоятельная библиотека без внешних зависимостей, написанная на Vanilla TypeScript; её можно импортировать в любое веб-приложение.
Как добавить её в проект?Установите её как пакет и импортируйте в своё JS/TS-приложение; примеры использования и полная документация доступны на сайте документации driverjs.com.
Нужны ли для её использования другие библиотеки?Нет, у неё вообще нет внешних зависимостей, и она работает во всех основных браузерах без дополнительной настройки.
Это только для туров или её можно использовать и для других оверлеев?Это не только инструмент для туров: её можно использовать для контекстных всплывающих подсказок, смещения фокуса, модальных окон с затемнённым фоном или виджетов в стиле «выключить свет», а не только для пошаговых туров.
Насколько она большая по сравнению с другими библиотеками для туров?Driver.js весит около 5 КБ в gzip-сжатии, тогда как другие похожие библиотеки — 12 КБ и более, что делает её одной из самых легковесных.
Могу ли я управлять тем, что происходит при подсветке элементов?Да, она предоставляет хуки, с помощью которых можно изменять элементы перед тем, как их подсветят, во время подсветки или при снятии выделения.
Можно ли управлять ею с клавиатуры?Да, всем в Driver.js можно управлять с клавиатуры, что делает её удобной с точки зрения доступности.
Как попробовать примеры локально?Клонируйте репозиторий и запустите песочницу (playground) на основе Astro, которая подключает библиотеку напрямую из исходного кода и автоматически перезагружается при изменениях; примеры находятся в playground/src/examples/.
What are similar projects?shepherd, floating-ui, intro.js, react-dropzone, tippyjs, You-Dont-Need-JavaScript, material-ui, styled-components
Which topics is it in?spotlight, overlay, ui, productivity, frontend, library, typescript, javascript, web, developer-tools, mit, open-source
Creator
nilbuild
Size
8.6 MB
Stars
26.9K
Updated
CommitOct 18Release1.10.2Oct 18
Age
8y
Commits · 90 Days