Upgrade guide

The Filament Onboarding plugin has a V2 version that already has support for Filament V3.

If you want to upgrade to Onboarding Manager V2, and therefore Filament V3 support, take the following steps:

• Require ralphjsmit/laravel-filament-onboard ^2.0 instead of a 1.x version.
• For each of the panels that you want to use the Onboard plugin in, please register the plugin like follows:

use RalphJSmit\Filament\Onboard\FilamentOnboard;

$panel
    ->plugin(FilamentOnboard::make())

• Filament V3 offers plugins the ability to be customized per panel. This means that instead of global config values that apply to all panels, you can now set different values per panel. If you want, review the config/filament-onboard.php configuration file. Set the values that you want to change using the methods on the FilamentOnboard class. The methods look very similar to the keys they had in the config. For example, the key redirect-route has become a method FilamentOnboard::make()->redirectRoute(). You can also choose to do nothing. The package will retain compatibility with your current config. Whilst we do recommend to stay up-to-date and migrate your config, it is not a strictly requirement. An example plugin configuration could look like:

$panel
    ->plugin(
        FilamentOnboard::make()
            ->redirectRoute('some-route-name')
            ->prefix('welcome')
            // ..
    )

• Replace all code referring Onboard::addTrack() and Onboard::make()->addTrack() with RalphJSmit\Filament\Onboard\Track::make(). The Onboard facade has been removed.
• Replace all code referring Onboard::addStep() and Onboard::make()->addStep() with RalphJSmit\Filament\Onboard\Step::make(). The Onboard facade has been removed.
• Previously, all tracks were registered in the boot() method of a service provider which you could choose. Now, the logic for registering tracks has moved into the panel service providers. That has the benefit that you can now register different tracks per panel. For example, a different onboarding track in your admin panel than the track for your normal users. For upgrading, it means that you will need to copy the code that you previously had as Onboard::addTrack(), and update it to use the $plugin->addTrack() method. You will also need to create the track using Track::make():

$panel
    ->plugin(
        FilamentOnboard::make()
            ->addTrack(fn () => Track::make([
                Step::make(/** */),
                // Other steps...
            ])
                ->completeBeforeAccess(/** */),
                // Other methods on the Track...
            )
            // ..
    )

• Please make sure that you are registering the track inside ->addTrack() using a closure: fn () => Track::make(). If you register it without a closure, it will throw an error.
• If you have extended components like the Track, TrackCollection, Step or StepCollection, please check your custom overrides with the new code. The best is to publish your views again.

The V2 is available to all customers who previously purchased a license for V1.