mrshanebarron/tour

Guided feature walkthrough for Laravel. Supports Livewire and Blade.

dev-main 2025-12-14 04:34 UTC

Requires

• php: ^8.1
• illuminate/support: ^10.0|^11.0|^12.0

Requires (Dev)

• orchestra/testbench: ^8.0|^9.0
• pestphp/pest: ^2.0

MIT

• Shane Barron

• ui
• component
• laravel
• tour
• blade
• livewire

README

Guided feature walkthrough with tooltips. Built for Laravel with support for Livewire, Blade, and Alpine.js.

Installation

composer require mrshanebarron/tour

The service provider will be auto-discovered. If you need to register it manually:

// config/app.php
'providers' => [
    // ...
    MrShaneBarron\Tour\TourServiceProvider::class,
];

Usage

Livewire Component

<livewire:ld-tour />

Blade Component

<x-ld-tour />

With Props

<x-ld-tour
    :steps="[]"
    :autoStart="false"
    :showProgress="true"
/>

Props

Prop	Type	Default	Description
steps	array	[]	Tour steps with 'target', 'title', 'content'
autoStart	boolean	false	Start tour automatically
showProgress	boolean	true	Show step progress indicator

Configuration

Publish the config file:

php artisan vendor:publish --tag=ld-tour-config

This will create a config/ld-tour.php file where you can customize default values.

Customization

Publishing Views

Customize the component appearance by publishing the views:

php artisan vendor:publish --tag=ld-tour-views

Views will be published to resources/views/vendor/ld-tour/.

Styling

The component uses Tailwind CSS classes by default. You can customize styles by:

1. Publishing views and modifying the Blade templates
2. Using the class attribute to add custom classes
3. Overriding default styles in your CSS

<x-ld-tour class="custom-class" />

Events

The component dispatches Livewire events you can listen to:

Event	Payload	Description
tour:updated	Component data	Fired when state changes
tour:initialized	Initial data	Fired on component mount

// In your Livewire component
protected $listeners = ['tour:updated' => 'handleUpdate'];

public function handleUpdate($data)
{
    // Handle the update
}

Alpine.js Integration

The component works seamlessly with Alpine.js:

<div x-data="{ ' }} selected: null {{ ' }">
    <x-ld-tour x-model="selected" />
    <p x-text="selected"></p>
</div>

Requirements

• PHP 8.1+
• Laravel 10.x, 11.x, or 12.x
• Livewire 3.x
• Tailwind CSS 3.x (optional, for default styling)

Testing

composer test

Changelog

Please see CHANGELOG for recent changes.

Contributing

Contributions are welcome! Please see CONTRIBUTING for details.

Security

If you discover a security vulnerability, please email [e-mail] instead of using the issue tracker.

Credits

• Shane Barron
• All Contributors

License

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