README

Laravel Driver.js is your definitive guide to building product tours in Laravel. With a fluent, expressive PHP API on top of Driver.js, it turns onboarding, feature spotlights and contextual help into something you write the same way you write everything else.

Most product tours end up as a wall of JavaScript config living far away from the code that decides who should see them. That's where Laravel Driver.js comes in. We've fine-tuned the process, giving you a complete solution for everything tour-related — steps, positioning, hooks, theming and completion tracking, all described in PHP and rendered straight into your Blade views.

Quick Look

use RealRashid\LaravelDriverJs\Facades\DriverJs;

DriverJs::tour('onboarding')
    ->showProgress()
    ->step('#header', 'Welcome!', 'This is your dashboard.')
    ->step('#sidebar', 'Navigation', 'Your tools live here.')
    ->render();

<head>
    @driverjsAssets
</head>

@driverjsTour('onboarding')

Demo Application

TourDeck is a ready-to-run Laravel dashboard that demonstrates every mode this package supports — tours, highlights, modals, confirm-before-exit and theming. It lives in its own repository:

git clone https://github.com/realrashid/tour-deck.git
cd tour-deck
composer install
cp .env.example .env
php artisan key:generate
php artisan serve

Open http://localhost:8000 and the onboarding tour starts on first load.

Documentation

Ready to explore all the features and options Laravel Driver.js offers? Dive into our comprehensive documentation:

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

If you discover a security vulnerability in Laravel Driver.js, please help us maintain the security of this project by responsibly disclosing it to us. To report a security vulnerability, please send an email to realrashid05@gmail.com. We'll address the issue as promptly as possible. See SECURITY.md for what is in scope.

Credits

Support My Work

If you find Laravel Driver.js helpful and would like to support my work, you can buy me a coffee. Your support will help keep this project alive and thriving. It's a small token of appreciation that goes a long way.

License

The MIT License (MIT). Please see License File for more information.

Made with ❤️ from Pakistan

realrashid / laravel-driverjs

Maintainers

Package info

Fund package maintenance!

Statistics

Security