README

Nova Simple Value Metric

A Laravel Nova card that renders a simple value metric with a title, footer, optional help text and an optional action button.

Installation

Install the package via Composer:

composer require marshmallow/simple-value-metric

The card registers itself through Laravel package auto-discovery (Marshmallow\SimpleValueMetric\CardServiceProvider), so no further setup is required.

Usage

Add the card to the cards() method of any Nova resource or dashboard:

use Marshmallow\SimpleValueMetric\SimpleValueMetric;

protected function cards()
{
    return [
        (new SimpleValueMetric)
            ->title('Scored quotations')
            ->calculate(function ($metric) {
                return $metric->formattedValue(72)
                    ->footer('99% of the quotations are orders!');
            })
            ->help('72 of a total of 73 quotations are now orders :)'),
    ];
}

The value is set inside the calculate() callback so it can be computed at render time. The callback receives the card instance, on which you call the fluent methods below.

Available methods

The card width can be set with Nova's standard $width property (1/3, 1/2, or full); it defaults to 1/3.

Adding a button

use Marshmallow\SimpleValueMetric\SimpleValueMetric;

(new SimpleValueMetric)
    ->title('Open quotations')
    ->calculate(function ($metric) {
        return $metric->formattedValue(12)
            ->footer('Quotations awaiting review')
            ->button('/nova/resources/quotations', 'View all');
    });

Security

If you discover any security related issues, please email stef@marshmallow.dev instead of using the issue tracker.

Credits

• Marshmallow
• All Contributors

License

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