Download the PHP package amjadiqbal/laravel-driver-js without Composer
On this page you can find all versions of the php package amjadiqbal/laravel-driver-js. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download amjadiqbal/laravel-driver-js
More information about amjadiqbal/laravel-driver-js
Files in amjadiqbal/laravel-driver-js
Package laravel-driver-js
Short Description A professional Laravel wrapper for Driver.js. Easily create interactive product tours, feature highlights, and user onboarding flows using a fluent PHP API.
License MIT
Informations about the package laravel-driver-js
amjadiqbal/laravel-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: https://driverjs.com
Issues • Install • Usage • API • Config
Requirements
- PHP ^8.2
- Laravel 10 or 11
- Driver.js v1.3+
Installation
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
Fluent API
Blade Component
Where $steps is an array:
Configuration
config/driver-js.php
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
| Fluent Method | Driver.js Option / Action | Notes |
|---|---|---|
| allowClose(bool) | allowClose | Enable closing overlay |
| overlayColor(string) | overlayColor | RGBA or HEX |
| opacity(float) | opacity | Overlay opacity |
| set(key, value) | any config key | Direct set |
| addStep(selector, title, description, options) | defineSteps -> step | Popover title/description |
| defineSteps(array) | defineSteps | Bulk steps |
| drive() | drive | Start tour |
| highlight(selector) | highlight | Highlight element |
| moveNext() | moveNext | Next step |
| movePrevious() | movePrevious | Previous step |
| destroy() | destroy | Destroy tour |
| onHighlighting(handler) | onHighlighting callback | Provide global callback name |
Blade Component Props
steps: array of Driver.js steps (as shown above)config: array of overrides; merged withconfig('driver-js')
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
windowfunctions before initializing Driver
Step Options
- The
addStepmethod supports anoptionsarray to pass step-level options supported by Driver.js (e.g., popover position, padding). These are forwarded as-is to the step object.
Documentation
- API Docs: https://driverjs.com
- YouTube: Tutorials and walkthroughs on product tours and onboarding
- DEV Community: Implementation guides and tips
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:
License
MIT
All versions of laravel-driver-js with dependencies
illuminate/support Version ^10.0|^11.0
illuminate/view Version ^10.0|^11.0