ModelResource

Metrics

On the index page, you can display informational blocks with statistics - metrics. To do this, return an array of Metric in the metrics() method of the IndexPage.

 namespaces
namespace App\MoonShine\Resources\Post\Pages;
 
use App\Models\Post;
use App\Models\Comment;
use MoonShine\UI\Components\Metrics\Wrapped\Metric;
use MoonShine\UI\Components\Metrics\Wrapped\ValueMetric;
use MoonShine\Laravel\Pages\Crud\IndexPage; 
 
class PostIndexPage extends IndexPage
{
    // ...
 
    /**
     * @return list<Metric>
     */
    protected function metrics(): array
    {
        return [
            ValueMetric::make('Articles')
                ->value(fn() => Post::count())
                ->columnSpan(6),
            ValueMetric::make('Comments')
                ->value(fn() => Comment::count())
                ->columnSpan(6),
        ];
    }
}
 namespaces
namespace App\MoonShine\Resources\Post\Pages;
 
use App\Models\Post;
use App\Models\Comment;
use MoonShine\UI\Components\Metrics\Wrapped\Metric;
use MoonShine\UI\Components\Metrics\Wrapped\ValueMetric;
use MoonShine\Laravel\Pages\Crud\IndexPage; 
 
class PostIndexPage extends IndexPage
{
    // ...
 
    /**
     * @return list<Metric>
     */
    protected function metrics(): array
    {
        return [
            ValueMetric::make('Articles')
                ->value(fn() => Post::count())
                ->columnSpan(6),
            ValueMetric::make('Comments')
                ->value(fn() => Comment::count())
                ->columnSpan(6),
        ];
    }
}

metrics metrics_dark

For more detailed information, refer to the sections Metrics.

The metrics() method is also available in the ModelResource class for backward compatibility, but it is recommended to define metrics directly in IndexPage.

If you need to wrap the metrics in a Fragment:

 namespaces
use Closure;
use MoonShine\Crud\Components\Fragment;
 
protected function fragmentMetrics(): ?Closure
{
    return static fn(array $components): Fragment => Fragment::make($components)->name('metrics');
}
 namespaces
use Closure;
use MoonShine\Crud\Components\Fragment;
 
protected function fragmentMetrics(): ?Closure
{
    return static fn(array $components): Fragment => Fragment::make($components)->name('metrics');
}