优雅/filament-kpi

用于 elegantly/laravel-kpi 的插件

v1.0.0 2024-09-17 16:07 UTC

This package is auto-updated.

Last update: 2024-09-19 17:02:50 UTC


README

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

此插件允许您使用 elegantly/laravel-kpi 创建图表和统计数据,如下所示

use Elegantly\FilamentKpi\Widgets\KpiStat;
use App\Kpis\Users\UsersCountKpi;

KpiStat::kpi(UsersCountKpi::class);
class UsersChart extends KpiChart
{
    protected static string $kpi = UsersCountKpi::class;
}

安装

您可以通过 composer 安装此包

composer require elegantly/filament-kpi

使用方法

显示 Kpi 统计数据

namespace App\Filament\Resources\UserResource\Widgets;

use Elegantly\FilamentKpi\Widgets\KpiStat;
use App\Kpis\Users\UsersCountKpi;
use Filament\Widgets\StatsOverviewWidget;

class UsersStatsOverview extends StatsOverviewWidget
{
    protected static ?string $pollingInterval = null;

    protected function getCards(): array
    {
        return [
            KpiStat::kpi(
                definition: UsersCountKpi::class,
                interval: KpiInterval::Day, // (optional) default to UsersCountKpi::getSnapshotInterval()
                diff: true, // (optional) default to is_subclass_of(UsersCountKpi::class, HasDifference::class)
            ),
        ];
    }
}

显示 Kpi 图表

namespace App\Filament\Resources\UserResource\Widgets;

use Elegantly\FilamentKpi\Widgets\KpiChart;
use App\Kpis\Users\UsersCountKpi;

class UsersChart extends KpiChart
{
    protected static string $kpi = UsersCountKpi::class;
}

测试

composer test

变更日志

请参阅 CHANGELOG 以获取有关最近更改的更多信息。

贡献

请参阅 CONTRIBUTING 了解详细信息。

安全漏洞

请查看 我们的安全策略 了解如何报告安全漏洞。

鸣谢

许可证

MIT 许可证 (MIT)。有关更多信息,请参阅 许可证文件