PHPackages                             jibaymcs/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. jibaymcs/filament-tour

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

jibaymcs/filament-tour
======================

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

v5.0.0(2mo ago)12247.8k↓40.3%40[7 issues](https://github.com/JibayMcs/filament-tour/issues)[3 PRs](https://github.com/JibayMcs/filament-tour/pulls)MITPHPPHP >8.2CI failing

Since Aug 22Pushed 2mo ago2 watchersCompare

[ Source](https://github.com/JibayMcs/filament-tour)[ Packagist](https://packagist.org/packages/jibaymcs/filament-tour)[ Docs](https://github.com/jibaymcs/filament-tour)[ GitHub Sponsors](https://github.com/JibayMcs)[ RSS](/packages/jibaymcs-filament-tour/feed)WikiDiscussions 3.x Synced 1mo ago

READMEChangelog (10)Dependencies (22)Versions (19)Used By (0)

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

[](#bring-the-power-of-driverjs-to-your-filament-panels-and-start-a-tour-)

Due to a heavy workload, I'm unable to continue fixing and improving Filament-Tour.
-----------------------------------------------------------------------------------

[](#due-to-a-heavy-workload-im-unable-to-continue-fixing-and-improving-filament-tour)

But if you feel like patching it, modifying it or rewriting it, don't hesitate to contribute to the project!
------------------------------------------------------------------------------------------------------------

[](#but-if-you-feel-like-patching-it-modifying-it-or-rewriting-it-dont-hesitate-to-contribute-to-the-project)

With the power of [DriverJS](https://driverjs.com) bring to your users an elegant way to discover your panels !

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

[](#installation)

You can install this filament plugin via composer:

For Filament V4.x

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

For Filament V3.x

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

For Filament V2.x

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

You can publish the config file with:

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

Optionally, you can publish the views using

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

This is the contents of the published config file:

```
 return [
    "only_visible_once" => true,
];
```

Usage
-----

[](#usage)

```
use JibayMcs\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 seen the tour.

```
// default  : true
FilamentTourPlugin::make()->onlyVisibleOnce(false)
```

Start a tour !
==============

[](#start-a-tour-)

Let's follow this example to add a tour to your dashboard page.

If you don't already have a customized dashboard, please refer to the following tutorial: [FIlamentPHP - Dashboard - Customizing the dashboard page](https://filamentphp.com/docs/3.x/panels/dashboard#customizing-the-dashboard-page)

Use the correct trait to registers your tours !
-----------------------------------------------

[](#use-the-correct-trait-to-registers-your-tours-)

```