spatie/filament-simple-stats

Opinionated prebuilt stat widgets to quickly add to your Filament dashboards.

Fund package maintenance!
Spatie

0.1.4 2024-06-05 14:16 UTC

This package is auto-updated.

Last update: 2024-10-30 00:46:18 UTC


README

Latest Version on Packagist GitHub Tests Action Status GitHub Code Style Action Status Total Downloads

Opinionated prebuilt stat widgets to quickly add to your Filament dashboards. This package combines the power of Filament Stat widgets and the Flowframe/laravel-trend package to provide you with a simple way to add stats to your Filament dashboards.

Support us

We invest a lot of resources into creating best in class open source packages. You can support us by buying one of our paid products.

We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on our contact page. We publish all received postcards on our virtual postcard wall.

Installation

You can install the package via composer:

composer require spatie/filament-simple-stats

Usage

Inside your Filament Widget class:

protected function getStats(): array
    {
        return [
            SimpleStat::make(User::class)->last30Days()->dailyCount(),
            SimpleStat::make(Purchase::class)->last30Days()->dailySum('earnings'),
        ];
    }

Modify the query

You can use the where method to change the query. For example, to only show stats related to a specific user:

protected function getStats(): array
    {
        return [
            SimpleStat::make(Purchase::class)->where('user_id', auth()->id())->last30Days()->dailySum('earnings'),
        ];
    }

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

License

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