PHPackages                             viezel/filament-tour - 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 & Helpers](/categories/utility)
4. /
5. viezel/filament-tour

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

viezel/filament-tour
====================

Bring the power of DriverJs to your Filament panels and start a tour !

4.0.0(9mo ago)54.2k↑12.5%2MITPHPPHP ^8.1|^8.2|^8.3|^8.4CI failing

Since Dec 13Pushed 9mo ago1 watchersCompare

[ Source](https://github.com/viezel/filament-tour)[ Packagist](https://packagist.org/packages/viezel/filament-tour)[ Docs](https://github.com/viezel/filament-tour)[ RSS](/packages/viezel-filament-tour/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (6)Dependencies (11)Versions (12)Used By (0)

Bring the power of DriverJs to your Filament panels
===================================================

[](#bring-the-power-of-driverjs-to-your-filament-panels)

With the power of [DriverJS](https://driverjs.com) bring to your users an elegant way to discover your panels. Original work done by [JibayMcs](https://github.com/JibayMcs).

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

[](#installation)

You can install this filament plugin via composer:

For Filament v4.x

```
composer require viezel/filament-tour
```

For Filament v3.x

```
composer require viezel/filament-tour:"^3.0"
```

For Filament v2.x

```
composer require jibaymcs/filament-tour:"^2.0"
```

You can publish the config/views/migrations file with:

```
php artisan vendor:publish --tag="filament-tour-config"
php artisan vendor:publish --tag="filament-tour-views"
php artisan vendor:publish --tag="filament-tour-migrations"
```

This is the contents of the published config file:

```
 return [
    'only_visible_once' => true,
    'enable_css_selector' => false,
    'tour_prefix_id' => 'tour_',
    'highlight_prefix_id' => 'highlight_',
];
```

Usage
-----

[](#usage)

```
use Viezel\FilamentTour\FilamentTourPlugin;

public function panel(Panel $panel) {
	return $panel->default()
		->[...]
		->plugins([ FilamentTourPlugin::make() ]);
}
```

You can also enable or disable the check on the local storage if the current user have already completed the tour.

```
// default  : true
FilamentTourPlugin::make()->onlyVisibleOnce(fn() => app()->isProduction())
```

Tour Autostart
==============

[](#tour-autostart)

By default, the tours will be started automatically when the page is loaded.

You can disable this behaviour globally by setting `auto_start_tours` to false in `config/filament-tour.php`.

```