Beautiful onboarding experiences for Filament Admin

Published on by

Beautiful onboarding experiences for Filament Admin image

The Onboarding Manager Pro is a premium package that allows you to create beautiful onboarding experiences for Filament Admin in minutes.

Configurable from a simple service provider, it allows you to:

  • Prevent users from accessing Filament without first completing required parts of your onboarding.
  • Add optional onboarding steps with the beautiful dashboard widget.
  • Guide your users through one or multiple wizards.
  • Redirect users to links (e.g. for an OAuth-process) or guide them through a multi-step wizard.
  • Beautiful design & integration with Filament Admin.
  • Advanced widget design with native support for columns and column spans.
  • Support for dark mode. 🌚
  • Can be easily translated with a language file.
  • Redirect to custom route after completing onboard flow.

Creating tracks

Creating onboarding flows is called creating "tracks". Tracks can be easily created from a service provider (for example, an OnboardingServiceProvider):

use Filament\Facades\Filament;
use RalphJSmit\Filament\Onboard\Facades\Onboard;
 
public function boot(): void
{
Filament::serving(function() {
Onboard::addTrack(/** Your steps */)
});
}

In each track, you can add steps that symbolize a step that a user takes in your application. For example, consider an OAuth-flow of a third party app:

Onboard::addTrack([
Onboard::addStep(name: 'Connect Notion', identifier: 'widget::connect-notion')
->description('Sign in with Notion and grant access to your workspace.')
->icon('heroicon-o-check-circle')
->link('Add workspace →', route('callbacks.notion.authorize'))
->completeIf(fn () => auth()->user()->workspaces()->exists())
->columnSpan(1),
// Other steps
// Onboard::addStep(/** */)...
// Onboard::addStep(/** */)...
])->columns(3)

Next, register the RalphJSmit\Filament\Onboard\Widgets\OnboardTrackWidget as a dashboard widget and voilà:

If you want to force users to complete the step before being allowed to access the admin panel, you can mark the track as necessary to complete using the ->completeBeforeAccess():

// Add middleware: RalphJSmit\Filament\Onboard\Http\Middleware\OnboardMiddleware
 
// Add track:
Onboard::addTrack([
Onboard::addStep(name: 'Connect Notion', identifier: 'widget::connect-notion')
->link('Add workspace →', route('callbacks.notion.authorize'))
->completeIf(fn () => auth()->user()->workspaces()->exists()),
//..
])
->completeBeforeAccess()

Complex layouts

If you want to create complex layouts, you can use the ->columns() and ->columnSpan() methods to create beautiful grid layouts.

The individual cards will automatically wrap to the next row if there is no more space.

It also supports changing the ->columnSpan() and nr of ->columns() on different breakpoints, so you can craft a different layout for e.g. mobile v. desktop v. ultra-wide devices.

The onboarding widget will automatically display the completed steps in green, and the uncompleted steps in your primary color:

Onboard::addTrack([
Onboard::addStep('Create list', 'widget::create-list')
->columnSpan(2)
->completeIf(fn () => auth()->user()->lists()->exists()),
Onboard::addStep('Connect', 'widget::connect')
->columnSpan(2)
->completeIf(fn () => auth()->user()->workspaces()->exists()),
Onboard::addStep('Embed form on site', 'widget::embed-form')
->columnSpan(3)
->completeIf(fn () => auth()->user()->copied_embed_form !== null),
Onboard::addStep('Tweak the design', 'widget::tweak-design')
->columnSpan(3)
->completeIf(fn () => auth()->user()->designs->first->created_at->lt(auth()->user()->designs->first->updated_at)),
Onboard::addStep('Send newsletters', 'widget::send-newsletters')
->columnSpan(4)
->completeIf(fn () => auth()->user()->created_at->lt(now()->subWeek(2))),
])->columns(7);

Creating wizards

It is also possible to force your users to go through one or more wizards before they can complete the onboarding flow. For example, you can use this to ensure that all your users have a complete profile (e.g. their address or other profile information) or that they have chosen a subscription plan:

Onboard::addStep('Your title', 'onboard::unique-identifier')
->wizard([
Step::make("Your label")
->statePath('step_1') // It is recommended to keep the form data in a separate array key for each step.
->schema([
TextInput::make('name')
->required(),
Select::make('plan_id')
->label('Choose your trial plan')
->options([
'default' => 'Regular',
'pro' => 'Pro',
'unlimited' => 'Unlimited'
])
->required(),
// More components...
])
// More steps...
])

Conclusion

As you can see, it's really easy to create advanced and premium-looking onboarding flows to your Filament admin application.

You can buy the plugin as a single license with 2 installs and unlimited updates for €49 or an unlimited license for just €99.

Eric L. Barnes photo

Eric is the creator of Laravel News and has been covering Laravel since 2012.

Filed in:
Cube

Laravel Newsletter

Join 40k+ other developers and never miss out on new tips, tutorials, and more.

image
DocuWriter.ai

Save hours of manually writing Code Documentation, Comments & DocBlocks, Test suites and Refactoring.

Visit DocuWriter.ai
Laravel Forge logo

Laravel Forge

Easily create and manage your servers and deploy your Laravel applications in seconds.

Laravel Forge
Tinkerwell logo

Tinkerwell

The must-have code runner for Laravel developers. Tinker with AI, autocompletion and instant feedback on local and production environments.

Tinkerwell
No Compromises logo

No Compromises

Joel and Aaron, the two seasoned devs from the No Compromises podcast, are now available to hire for your Laravel project. ⬧ Flat rate of $7500/mo. ⬧ No lengthy sales process. ⬧ No contracts. ⬧ 100% money back guarantee.

No Compromises
Kirschbaum logo

Kirschbaum

Providing innovation and stability to ensure your web application succeeds.

Kirschbaum
Shift logo

Shift

Running an old Laravel version? Instant, automated Laravel upgrades and code modernization to keep your applications fresh.

Shift
Bacancy logo

Bacancy

Supercharge your project with a seasoned Laravel developer with 4-6 years of experience for just $2500/month. Get 160 hours of dedicated expertise & a risk-free 15-day trial. Schedule a call now!

Bacancy
LoadForge logo

LoadForge

Easy, affordable load testing and stress tests for websites, APIs and databases.

LoadForge
Paragraph logo

Paragraph

Manage your Laravel app as if it was a CMS – edit any text on any page or in any email without touching Blade or language files.

Paragraph
Lucky Media logo

Lucky Media

Bespoke software solutions built for your business. We ♥ Laravel

Lucky Media
Lunar: Laravel E-Commerce logo

Lunar: Laravel E-Commerce

E-Commerce for Laravel. An open-source package that brings the power of modern headless e-commerce functionality to Laravel.

Lunar: Laravel E-Commerce
DocuWriter.ai logo

DocuWriter.ai

Save hours of manually writing Code Documentation, Comments & DocBlocks, Test suites and Refactoring.

DocuWriter.ai
Rector logo

Rector

Your partner for seamless Laravel upgrades, cutting costs, and accelerating innovation for successful companies

Rector

The latest

View all →
Generate Code Coverage in Laravel With PCOV image

Generate Code Coverage in Laravel With PCOV

Read article
Non-backed Enums in Database Queries and a withSchedule() bootstrap method in Laravel 11.1 image

Non-backed Enums in Database Queries and a withSchedule() bootstrap method in Laravel 11.1

Read article
Laravel Pint --bail Flag image

Laravel Pint --bail Flag

Read article
Laravel Herd for Windows is now released! image

Laravel Herd for Windows is now released!

Read article
The Laravel Worldwide Meetup is Today image

The Laravel Worldwide Meetup is Today

Read article
Cache Routes with Cloudflare in Laravel image

Cache Routes with Cloudflare in Laravel

Read article