Fathom by Jefferson Gonçalves

• Version Compatibility
  • Navigation group
• Requirements
• Installation
• Settings Page
  • Disabling the Settings Page
• Testing
• Changelog
• Contributing
• Security Vulnerabilities
• Credits
• License

Filament plugin for Fathom Analytics with a built-in settings page. Automatically injects the Fathom tracking script into all Filament panels and provides a settings page to manage tracking configuration directly from the admin panel.

#Version Compatibility

#Navigation group

Put the settings page in one of your panel's own navigation groups (a string or a closure):

FathomPlugin::make()
    ->navigationGroup(fn (): string => __('admin.navigation.settings')),

#Requirements

• PHP 8.2 or higher
• Laravel 11.0 or higher
• Filament 5.x

#Installation

You can install the package via composer:

composer require jeffersongoncalves/filament-fathom:"^3.0"

Publish and run the spatie/laravel-settings migrations:

php artisan vendor:publish --provider="Spatie\LaravelSettings\LaravelSettingsServiceProvider" --tag="migrations"

Publish and run the Fathom settings migrations:

php artisan vendor:publish --tag=fathom-settings-migrations
php artisan migrate

Register the plugin in your Filament PanelProvider:

use JeffersonGoncalves\Filament\Fathom\FathomPlugin;

public function panel(Panel $panel): Panel
{
    return $panel
        // ...
        ->plugins([
            FathomPlugin::make(),
        ]);
}

#Settings Page

The plugin provides a settings page where you can configure:

• Website ID - Your Fathom site ID (e.g. ABCDEFGH)
• Canonical URL - Use canonical URL instead of actual URL for tracking
• Auto Tracking - Automatically track page views on page load
• SPA Mode - Single Page Application tracking mode (auto, history, hash)
• Honor Do Not Track - Respect the browser Do Not Track setting

#Disabling the Settings Page

If you only want the automatic script injection without the settings page:

FathomPlugin::make()->settingsPage(false)

#Testing

composer test

#Changelog

Please see CHANGELOG for more information on what has changed recently.

#Contributing

Please see CONTRIBUTING for details.

#Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

#Credits

• Jefferson Gonçalves
• All Contributors

#License

The MIT License (MIT). Please see License File for more information.