PHPackages                             amjadiqbal/laravel-driver-js - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Utility &amp; Helpers](/categories/utility)
4. /
5. amjadiqbal/laravel-driver-js

ActiveLibrary[Utility &amp; Helpers](/categories/utility)

amjadiqbal/laravel-driver-js
============================

A professional Laravel wrapper for Driver.js. Easily create interactive product tours, feature highlights, and user onboarding flows using a fluent PHP API.

v0.1.0(4mo ago)14MITPHPPHP ^8.2CI failing

Since Feb 23Pushed 4mo agoCompare

[ Source](https://github.com/amjadiqbal/laravel-driver-js)[ Packagist](https://packagist.org/packages/amjadiqbal/laravel-driver-js)[ RSS](/packages/amjadiqbal-laravel-driver-js/feed)WikiDiscussions main Synced today

READMEChangelog (1)Dependencies (8)Versions (2)Used By (0)

 [![Laravel Driver.js](https://raw.githubusercontent.com/amjadiqbal/laravel-driver-js/main/assets/laravel-driver-js.png)](https://raw.githubusercontent.com/amjadiqbal/laravel-driver-js/main/assets/laravel-driver-js.png)

 [![License](https://camo.githubusercontent.com/7013272bd27ece47364536a221edb554cd69683b68a46fc0ee96881174c4214c/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6c6963656e73652d4d49542d626c75652e737667)](https://github.com/amjadiqbal/laravel-driver-js/blob/main/LICENSE) [![Packagist Version](https://camo.githubusercontent.com/82a1e751b9bd6b41decc2192eebf352ad0eb1665ae815689017e0d6a5844dc2d/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f616d6a6164697162616c2f6c61726176656c2d6472697665722d6a732e737667)](https://packagist.org/packages/amjadiqbal/laravel-driver-js) [![Downloads](https://camo.githubusercontent.com/dc031a77df111d1dbe6bef57a90f44fdeaa36d029b3ec58e909a17f50382daf5/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f616d6a6164697162616c2f6c61726176656c2d6472697665722d6a732e737667)](https://packagist.org/packages/amjadiqbal/laravel-driver-js) [![CI](https://github.com/amjadiqbal/laravel-driver-js/actions/workflows/tests.yml/badge.svg)](https://github.com/amjadiqbal/laravel-driver-js/actions/workflows/tests.yml) [![Code Style](https://github.com/amjadiqbal/laravel-driver-js/actions/workflows/pint.yml/badge.svg)](https://github.com/amjadiqbal/laravel-driver-js/actions/workflows/pint.yml) [![Static Analysis](https://github.com/amjadiqbal/laravel-driver-js/actions/workflows/phpstan.yml/badge.svg)](https://github.com/amjadiqbal/laravel-driver-js/actions/workflows/phpstan.yml) [![Coverage](https://camo.githubusercontent.com/6777823bc617baa78ad50cbc53fe99cd51241bed47882e6a170c14ba1162a341/68747470733a2f2f636f6465636f762e696f2f67682f616d6a6164697162616c2f6c61726176656c2d6472697665722d6a732f6272616e63682f6d61696e2f67726170682f62616467652e737667)](https://codecov.io/gh/amjadiqbal/laravel-driver-js) [![Release](https://camo.githubusercontent.com/0708dd62884cc863fcd4efaa19936df6d28dde9f407b40e7e4dfe191358add65/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f762f72656c656173652f616d6a6164697162616c2f6c61726176656c2d6472697665722d6a733f646973706c61795f6e616d653d746167)](https://github.com/amjadiqbal/laravel-driver-js/releases) [![PHP](https://camo.githubusercontent.com/63866f34512ff2a9a7a1fbeaff3aee4cad6882b0ab1402cbd87e3a6e1c8e625b/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f5048502d253545382e322d3737374242343f6c6f676f3d706870)](https://camo.githubusercontent.com/63866f34512ff2a9a7a1fbeaff3aee4cad6882b0ab1402cbd87e3a6e1c8e625b/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f5048502d253545382e322d3737374242343f6c6f676f3d706870) [![Laravel](https://camo.githubusercontent.com/59f312f34c663004eef0059fab56cf5ae4fa7ca6c49c3535ff5c12e694203e30/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f4c61726176656c2d313025323025374325323031312d4646324432303f6c6f676f3d6c61726176656c)](https://camo.githubusercontent.com/59f312f34c663004eef0059fab56cf5ae4fa7ca6c49c3535ff5c12e694203e30/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f4c61726176656c2d313025323025374325323031312d4646324432303f6c6f676f3d6c61726176656c) [![Driver.js](https://camo.githubusercontent.com/eac098ce25fd5fc14dbaebb1350c2af5adb74919c37fc1fd72e70660bc1e2a26/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f4472697665722e6a732d312e332532422d626c61636b)](https://driverjs.com) [![Tests](https://camo.githubusercontent.com/90528acd04d70d3ac043f77eb108a24aaea609726dfac552f446330b8252ed0f/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f54657374732d506573742d324135464533)](https://pestphp.com)

amjadiqbal/laravel-driver-js
============================

[](#amjadiqballaravel-driver-js)

Professional Laravel wrapper for Driver.js (v1.3+). Easily create interactive product tours, feature highlights, and user onboarding flows using a fluent PHP API.

- SEO: Laravel product tours, interactive onboarding, feature highlights, guided walkthroughs, Driver.js for Laravel
- Website:

 [Issues](https://github.com/amjadiqbal/laravel-driver-js/issues) • [Install](#installation) • [Usage](#usage) • [API](#methods-mapping) • [Config](#configuration)

Requirements
------------

[](#requirements)

- PHP ^8.2
- Laravel 10 or 11
- Driver.js v1.3+

Installation
------------

[](#installation)

```
composer require amjadiqbal/laravel-driver-js
php artisan vendor:publish --tag=driver-js-config
php artisan vendor:publish --tag=driver-js-views
```

Features
--------

[](#features)

- Fluent PHP API mirroring Driver.js options and actions
- Blade component for quick start
- Config publishing with sensible defaults and CDN control
- Callback wiring from PHP config to global JS functions
- Pest tests via Orchestra Testbench
- GitHub Actions CI and Laravel Pint code style

Usage
-----

[](#usage)

### Fluent API

[](#fluent-api)

```
use AmjadIqbal\DriverJS\Facades\Driver;

$tour = Driver::make()
    ->allowClose(true)
    ->overlayColor('rgba(0,0,0,0.6)')
    ->addStep('#selector', 'Title', 'Description')
    ->addStep('.cta', 'Get Started', 'Click here to begin')
    ->drive();

$json = $tour->toJson();
```

### Blade Component

[](#blade-component)

```

```

Where `$steps` is an array:

```
$steps = [
    [
        'element' => '#selector',
        'popover' => [
            'title' => 'Title',
            'description' => 'Description',
        ],
    ],
];
```

Configuration
-------------

[](#configuration)

`config/driver-js.php`

```
return [
    'cdn_js' => 'https://unpkg.com/driver.js/dist/driver.min.js',
    'cdn_css' => 'https://unpkg.com/driver.js/dist/driver.min.css',
    'allowClose' => true,
    'overlayColor' => 'rgba(0, 0, 0, 0.5)',
    'opacity' => 0.6,
];
```

You can override any of these values per-tour via the Blade `:config` prop or by constructing a builder with initial config: `Driver::make(['overlayColor' => '...'])`.

CDN keys (`cdn_js`, `cdn_css`) are used by the Blade component to load assets and are not forwarded to the Driver constructor.

Methods Mapping
---------------

[](#methods-mapping)

Fluent MethodDriver.js Option / ActionNotesallowClose(bool)allowCloseEnable closing overlayoverlayColor(string)overlayColorRGBA or HEXopacity(float)opacityOverlay opacityset(key, value)any config keyDirect setaddStep(selector, title, description, options)defineSteps -&gt; stepPopover title/descriptiondefineSteps(array)defineStepsBulk stepsdrive()driveStart tourhighlight(selector)highlightHighlight elementmoveNext()moveNextNext stepmovePrevious()movePreviousPrevious stepdestroy()destroyDestroy touronHighlighting(handler)onHighlighting callbackProvide global callback name### Blade Component Props

[](#blade-component-props)

- `steps`: array of Driver.js steps (as shown above)
- `config`: array of overrides; merged with `config('driver-js')`

### Callbacks

[](#callbacks)

- Provide callback names as strings, e.g. `onHighlighting('onHighlight')`
- Ensure a matching global function exists: `window.onHighlight = function (element) { ... }`
- The component resolves names to `window` functions before initializing Driver

### Step Options

[](#step-options)

- The `addStep` method supports an `options` array to pass step-level options supported by Driver.js (e.g., popover position, padding). These are forwarded as-is to the step object.

Documentation
-------------

[](#documentation)

- API Docs:
- YouTube: Tutorials and walkthroughs on product tours and onboarding
- DEV Community: Implementation guides and tips

CI &amp; Code Style
-------------------

[](#ci--code-style)

- Tests: GitHub Actions workflow runs Pest on supported PHP versions
- Code Style: Laravel Pint workflow validates formatting (non-mutating with `--test`)
- Local commands:

```
composer test
composer lint
```

License
-------

[](#license)

MIT

###  Health Score

32

—

LowBetter than 69% of packages

Maintenance76

Regular maintenance activity

Popularity5

Limited adoption so far

Community6

Small or concentrated contributor base

Maturity36

Early-stage or recently created project

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Unknown

Total

1

Last Release

131d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/a7bf302435a7ec2ff19aa5995f1baf92d6d0a4dcafbced1f3e8609fa848a4e6e?d=identicon)[amjadiqbal](/maintainers/amjadiqbal)

---

Top Contributors

[![amjadiqbal](https://avatars.githubusercontent.com/u/36040604?v=4)](https://github.com/amjadiqbal "amjadiqbal (6 commits)")

---

Tags

laravellaravel-packagefluent-apionboardingdriverjsproduct toursfeature highlightsguided walkthroughsinteractive tutorials

###  Code Quality

TestsPest

Static AnalysisPHPStan

Code StyleLaravel Pint

Type Coverage Yes

### Embed Badge

![Health badge](/badges/amjadiqbal-laravel-driver-js/health.svg)

```
[![Health](https://phpackages.com/badges/amjadiqbal-laravel-driver-js/health.svg)](https://phpackages.com/packages/amjadiqbal-laravel-driver-js)
```

###  Alternatives

[psalm/plugin-laravel

Psalm plugin for Laravel

3355.3M346](/packages/psalm-plugin-laravel)[livewire/flux

The official UI component library for Livewire.

9527.8M127](/packages/livewire-flux)[moonshine/moonshine

Laravel administration panel

1.3k253.1k81](/packages/moonshine-moonshine)[webwizo/laravel-shortcodes

Wordpress like shortcodes for Laravel 11, 12 and 13

217700.9k8](/packages/webwizo-laravel-shortcodes)[tallstackui/tallstackui

TallStackUI is a powerful suite of Blade components that elevate your workflow of Livewire applications.

725173.0k14](/packages/tallstackui-tallstackui)[hasinhayder/tyro-dashboard

Tyro Dashboard - Beautiful admin dashboard for managing Tyro roles, privileges, users, and settings

5443.8k](/packages/hasinhayder-tyro-dashboard)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)
