schmeits/filament-pan-analytics-widget

Filament Pan Analytics Widget

A Filament dashboard widget for panphp/pan, the lightweight and privacy-focused product analytics library. It shows the impressions, hovers and clicks that pan collected, with the share of hovers and clicks per impression.

Compatibility

Version 4.x is for Filament 3, despite the number. It lives on the 4.x branch and still gets fixes.

Installation

This widget reads the pan_analytics table of pan, so install and migrate pan first:

composer require panphp/pan
php artisan install:pan

Then install the widget:

composer require schmeits/filament-pan-analytics-widget

Numbers and percentages are formatted in the app locale with the PHP intl extension. Without intl the widget shows plain numbers.

Optionally, publish the translations (English and Dutch are included):

php artisan vendor:publish --tag="filament-pan-analytics-widget-translations"

Usage

Add the plugin and the widget to your panel:

use Schmeits\FilamentPanAnalyticsWidget\FilamentPanAnalyticsWidgetPlugin;
use Schmeits\FilamentPanAnalyticsWidget\Widgets\PanAnalyticsTableWidget;

public function panel(Panel $panel): Panel
{
    return $panel
        // ...
        ->plugin(FilamentPanAnalyticsWidgetPlugin::make())
        ->widgets([
            PanAnalyticsTableWidget::class,
        ]);
}

Options

FilamentPanAnalyticsWidgetPlugin::make()
    // Show a search field for the name column.
    ->searchable()
    // Decide who may see the widget. Everyone with access to the panel sees it by default.
    ->authorize(fn (): bool => auth()->user()?->can('viewAnalytics') ?? false)

Both options also accept a closure, which is evaluated when the widget renders.

Without the plugin on the panel the widget still works: it is visible, without search.

Upgrading from 4.x to 5.x

• Requires Filament 4 or 5 (Laravel 12 or 13). Stay on 4.x for Filament 3.
• FilamentPanAnalyticsWidgetPlugin::getSearchable() is now isSearchable().
• The page size options are 5, 10, 25 and 50. The "all" option is gone.
• The unused facade, FilamentPanAnalyticsWidget class, testing mixin, stubs and the filament-pan-analytics-widget:: view namespace are removed.
• The headers.id translation key is removed. New keys: not_available and empty.heading / empty.description. Re-publish the translations if you published them before.

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

• Tally Schmeits
• Punyapal Shah for his contribution to Pinkary where I got some inspiration for a refactor
• All Contributors

License

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