Update readme with more usage examples and document how to customize partition links.

Author: anderly

README.md

@@ -3,7 +3,7 @@
 [![Latest Version on Packagist](https://img.shields.io/packagist/v/saintsystems/nova-linkable-metrics.svg?style=flat-square)](https://packagist.org/packages/saintsystems/nova-linkable-metrics)
 [![Total Downloads](https://img.shields.io/packagist/dt/saintsystems/nova-linkable-metrics.svg?style=flat-square)](https://packagist.org/packages/saintsystems/nova-linkable-metrics)
 
-Add custom router-links to your Laravel Nova metrics.
+Add custom links to your Laravel Nova metrics.
 
 ![screenshot](screenshot.gif)
 
@@ -19,30 +19,45 @@ composer require saintsystems/nova-linkable-metrics
 
 To add the link ability to your Laravel Nova metric cards, you need to add the `Linkable` traits to your metrics.
 
-For example, within your custom Nova value metric card:
+For example, within your custom Nova value metric:
 ```php
-// in your Nova value metric card class:
-use SaintSystems\Nova\LinkableMetrics\LinkableValue;
+    // App\Nova\Metrics\NewUsers.php
 
-use LinkableValue;
+    use SaintSystems\Nova\LinkableMetrics\LinkableValue;
+
+    class NewUsers extends Value
+    {
+        use LinkableValue;
+
+        //...omitted for brevity
 
 ```
 
-Within your custom Nova trend metric card:
+Within your custom Nova trend metric:
 ```php
-// in your Nova value metric card class:
-use SaintSystems\Nova\LinkableMetrics\LinkableTrend;
+    // App\Nova\Metrics\UsersPerDay.php
 
-use LinkableTrend;
+    use SaintSystems\Nova\LinkableMetrics\LinkableTrend;
+
+    class UsersPerDay extends Trend
+    {
+        use LinkableTrend;
+
+        //...omitted for brevity
 
 ```
 
-Within your custom Nova trend partition card:
+Within your custom Nova partition metric:
 ```php
-// in your Nova value metric card class:
-use SaintSystems\Nova\LinkableMetrics\LinkablePartition;
+    // App\Nova\Metrics\UsersByStatus.php
+
+    use SaintSystems\Nova\LinkableMetrics\LinkablePartition;
+
+    class UsersByStatus extends Partition
+    {
+        use LinkablePartition;
 
-use LinkablePartition;
+        //...omitted for brevity
 
 ```
 
@@ -65,14 +80,41 @@ You can define metric links using the `route` method from the `Linkable` trait i
     protected function cards()
     {
         return [
-            (new TotalUsers)->width('1/3')->route('nova.pages.index', ['resource' => 'users']),
+            (new NewUsers)->width('1/3')->route('nova.pages.index', ['resource' => 'users']),
         ];
     }
 ```
 
 **OR using a Lens Route**
 
 ```php
+    // App\Nova\Lenses\UnverifiedEmail.php
+
+    class UnverifiedEmail extends Lens
+    {
+        //... omitted for brevity
+
+        public static function query(LensRequest $request, $query)
+        {
+            return $request->withOrdering($request->withFilters(
+                $query->whereNull('email_verified_at')
+            ));
+        }
+
+        //... omitted for brevity
+
+        /**
+         * Get the URI key for the lens.
+         *
+         * @return string
+         */
+        public function uriKey()
+        {
+            return 'unverified-email';
+        }
+
+    }
+
     // App\Nova\Dashboards\Main.php
 
     /**
@@ -83,14 +125,47 @@ You can define metric links using the `route` method from the `Linkable` trait i
     protected function cards()
     {
         return [
-            (new TotalUsers)->width('1/3')->route('nova.pages.lens', ['resource' => 'users', 'lens' => 'active-users']),
+            (new NewUsers)->width('1/3')->route('nova.pages.lens', ['resource' => 'users', 'lens' => 'unverified-email']),
         ];
     }
 ```
 
 **OR using a Filter Route**
 
 ```php
+    // App\Nova\Filters\UserStatus.php
+
+    class UserStatus extends Filter
+    {
+        //... omitted for brevity
+
+        /**
+         * Apply the filter to the given query.
+         *
+         * @param  \Laravel\Nova\Http\Requests\NovaRequest  $request
+         * @param  \Illuminate\Database\Eloquent\Builder  $query
+         * @return \Illuminate\Database\Eloquent\Builder
+         */
+        public function apply(NovaRequest $request, $query, $value)
+        {
+            return $query->where('active', $value);
+        }
+
+        /**
+         * Get the filter's available options.
+         *
+         * @param  \Laravel\Nova\Http\Requests\NovaRequest  $request
+         * @return array
+         */
+        public function options(NovaRequest $request)
+        {
+            return [
+                'Active' => '1',
+                'Inactive' => '0'
+            ];
+        }
+    }
+
     // App\Nova\Dashboards\Main.php
 
     /**
@@ -103,12 +178,12 @@ You can define metric links using the `route` method from the `Linkable` trait i
         $filter = base64_encode(json_encode([
             [
                 'class' => UserStatus::class,
-                'value' => 'active',
+                'value' => '1',
             ],
         ]));
 
         return [
-            (new TotalUsers)->width('1/3')->route('nova.pages.index', ['resource' => 'users', 'users_filter' => $filter]),
+            (new NewUsers)->width('1/3')->route('nova.pages.index', ['resource' => 'users', 'users_filter' => $filter]),
         ];
     }
 ```
@@ -138,6 +213,48 @@ You can define metric links using the `route` method from the `Linkable` trait i
     }
 ```
 
+**Customizing Partition Links**
+
+By default, Partition metrics can have links just like Value and Trend metrics. However, using the default `route` method like on Value and Trend metrics (as shown above) will simply link the PartitionMetric card title to the provided route/url.
+
+For greater customization, you may pass a Closure to the new `link` method on the LinkablePartitionResult class that allows you to customize the link for each individual partition in the generated chart, and even pass partition information to the route like below:
+
+```php
+    // App\Nova\Metrics\UsersByStatus
+
+    use SaintSystems\Nova\LinkableMetrics\LinkablePartition;
+
+    class UsersByStatus extends Partition
+    {
+        use LinkablePartition;
+
+    /**
+     * Calculate the value of the metric.
+     *
+     * @param  \Laravel\Nova\Http\Requests\NovaRequest  $request
+     * @return mixed
+     */
+    public function calculate(NovaRequest $request)
+    {
+        return $this->count($request, User::class, 'active')
+            ->label(fn ($value) => match ($value) {
+                1 => 'Active',
+                0 => 'Inactive'
+            })
+            ->link(fn ($value) => match ($value) {
+                // 1 => null,
+                default => route('nova.pages.index', ['resource' => 'users', 'users_filter' => base64_encode(json_encode([
+                    [
+                        'class' => UserStatus::class,
+                        'value' => $value,
+                    ],
+                ]))], false)
+            });
+    }
+
+    // ... omitted for brevity
+```
+
 ## Credits
 
 - [Adam Anderly](https://github.com/anderly)