- How do I install filament-onboarding in a Laravel Filament v5 app?
- Install with composer require wallacemartinss/filament-onboarding, register the plugin in your PanelProvider, then publish and run its migrations. Register any application-specific completion conditions and author journeys in the Filament panel. It is a standard Laravel package with a service provider, config, migrations, and views/assets.
- Does filament-onboarding support Laravel 11 or 12 with Filament v5?
- The package targets Filament v5 and current PHP 8.x Laravel applications, but the provided context makes it v5-only. Check the composer.json constraints for exact Laravel and PHP versions before installing. Panels still on Filament v3 or v4 must upgrade first.
- How do onboarding steps complete automatically in filament-onboarding?
- A step supports five completion modes, and three can tick themselves: an application-registered condition, reaching a page, and watching a video. Conditions are predicates your Laravel app owns, such as has_completed_profile or created_first_invoice. Product users author the journey and step content in the panel, while engineering owns only the condition logic.
- Can I use filament-onboarding with multiple Filament panels or tenants?
- The provided evaluation does not confirm whether journeys and progress are scoped per Filament panel or per tenant. Progress is user-scoped and database-driven, but exact keying is a blocking question for multi-tenant admin panels. Confirm panel and tenant scoping, plus journey-version keying, before rollout.
- How often are onboarding conditions evaluated, and will the checklist slow every panel page?
- Because the checklist follows users across every panel page, expect a middleware or render hook that evaluates progress during panel requests. The overview does not specify caching, invalidation, or whether conditions run on every request. Measure query count and condition-evaluation cost, then add caching or fail-open handling before a broad rollout.
- What happens if an onboarding condition throws an exception or a spotlight tour selector breaks?
- The package overview does not state its exception or selector-failure behavior, so treat fail-open as a requirement to verify. A throwing condition could block step completion or panel rendering depending on exception handling. A changed Filament DOM selector can leave a spotlight tour stuck or mispositioned, so test dismissal and recovery paths.
- Is journey content versioned, and can I edit a live onboarding journey safely?
- Journeys are authored as database content, but the overview does not mention journey versioning or rollback. Editing a live journey could affect in-flight user progress unless versions are keyed separately. Confirm versioning, copy review, and rollback behavior before letting product teams edit production journeys.
- Are filament-onboarding spotlight tours and video steps accessible and keyboard-friendly?
- Accessibility behavior is not documented in the provided material, and spotlight overlays plus video-gated steps are common failure points. Verify keyboard dismissal, focus trapping, screen-reader announcements, reduced-motion support, and RTL layout. Also confirm that users can skip or dismiss tours without losing progress.
- What is the test coverage and maintenance risk for filament-onboarding?
- The README includes a GitHub Actions tests badge, so there is a CI signal, but the provided overview does not quantify coverage. Review the suite for conditions, tours, migrations, and panel integration, and add feature tests around critical journeys. As a single-maintainer package with a small install base and no dependents, bus factor is the main maintenance risk.
- What are the alternatives to filament-onboarding for Laravel Filament onboarding tours?
- Alternatives include hard-coded Filament modal tours, custom Livewire widgets, or generic product-tour JavaScript libraries. filament-onboarding differentiates by storing journeys, steps, and user progress in the database and by catching up existing users through condition-based steps. Weigh that fit against Filament v5-only coupling and single-maintainer risk.