|
| 1 | +# Dashboard |
| 2 | + |
| 3 | +Class: `Code16\Sharp\Show\Fields\SharpShowDashboardField`. |
| 4 | + |
| 5 | +The field allows you to integrate a [Dashboard](../building-dashboard.md) into your Show Page. |
| 6 | + |
| 7 | +## Constructor |
| 8 | + |
| 9 | +This field needs, as first parameter, either the entity key or the `SharpDashboardEntity` class that declares the dashboard which will be included in the Show Page. |
| 10 | + |
| 11 | +For instance: |
| 12 | + |
| 13 | +```php |
| 14 | +SharpShowDashboardField::make('posts_dashboard') |
| 15 | +``` |
| 16 | + |
| 17 | +or |
| 18 | + |
| 19 | +```php |
| 20 | +SharpShowDashboardField::make(PostDashboardEntity::class) |
| 21 | +``` |
| 22 | +::: warning |
| 23 | +This last syntax is better in terms of DX (since it allows using the IDE to navigate to the Entity List implementation), but it won’t work in two specific cases: if you use a custom `SharpEntityResolver` or if you your Entity is declared with multiple keys. |
| 24 | +::: |
| 25 | + |
| 26 | +## Configuration |
| 27 | + |
| 28 | +### `hideFilterWithValue(string $filterName, $value)` |
| 29 | +This is the most important method of the field, since it will not only hide a filter but also set its value. The purpose is to allow to **scope the data to the instance** of the Show Page. For example, let’s say we display a Post and that we want to embed a dashboard with the post's statistics: |
| 30 | + |
| 31 | + |
| 32 | +```php |
| 33 | +class PostShow extends SharpShow |
| 34 | +{ |
| 35 | + // ... |
| 36 | + |
| 37 | + public function buildShowFields(FieldsContainer $showFields): void |
| 38 | + { |
| 39 | + $showFields->addField( |
| 40 | + SharpShowDashboardField::make(PostDashboardEntity::class) |
| 41 | + ->hideFilterWithValue(PostFilter::class, 64) |
| 42 | + ); |
| 43 | + } |
| 44 | +} |
| 45 | +``` |
| 46 | + |
| 47 | +Here we're scoping the `PostDashboard` declared in the `PostDashboardEntity` to the instance of the `Post` with id 64. |
| 48 | + |
| 49 | + |
| 50 | +You can pass a closure as the value, and it will contain the current Show instance id. In most cases, you'll have to write this: |
| 51 | + |
| 52 | +```php |
| 53 | +SharpShowDashboardField::make(PostDashboardEntity::class) |
| 54 | + ->hideFilterWithValue(PostFilter::class, fn ($instanceId) => $instanceId); |
| 55 | +``` |
| 56 | + |
| 57 | +**One final note**: sometimes the linked filter is really just a scope, never displayed to the user. In this case, it can be tedious to write a full implementation in the Dashboard. In this situation, you can use the `HiddenFiler` class for the filter, passing a key: |
| 58 | + |
| 59 | +```php |
| 60 | +class PostShow extends SharpShow |
| 61 | +{ |
| 62 | + // ... |
| 63 | + |
| 64 | + public function buildShowFields(FieldsContainer $showFields): void |
| 65 | + { |
| 66 | + $showFields->addField( |
| 67 | + SharpShowDashboardField::make(PostDashboardEntity::class) |
| 68 | + ->hideFilterWithValue('post', fn ($instanceId) => $instanceId); |
| 69 | + ); |
| 70 | + } |
| 71 | +} |
| 72 | +``` |
| 73 | + |
| 74 | +```php |
| 75 | +use \Code16\Sharp\EntityList\Filters\HiddenFilter; |
| 76 | + |
| 77 | +class PostDashboard extends SharpDashboard |
| 78 | +{ |
| 79 | + // ... |
| 80 | + |
| 81 | + protected function getFilters(): ?array |
| 82 | + { |
| 83 | + return [ |
| 84 | + HiddenFilter::make('post') |
| 85 | + ]; |
| 86 | + } |
| 87 | + |
| 88 | + protected function buildWidgetsData(): void |
| 89 | + { |
| 90 | + return $this->setFigureData('visit_count', |
| 91 | + figure: Post::query() |
| 92 | + ->findOrFail($this->queryParams->filterFor('post')) |
| 93 | + ->get()?->visit_count |
| 94 | + ); |
| 95 | + } |
| 96 | +} |
| 97 | +``` |
| 98 | + |
| 99 | +### `hideDashboardCommand(array|string $commands): self` |
| 100 | + |
| 101 | +Use it to hide any dashboard command in this particular Dashboard (useful when reusing a Dashboard). This will apply before looking at authorizations. |
| 102 | + |
| 103 | +## Display in layout |
| 104 | + |
| 105 | +To display your dashboard in your show page's layout, you have to use the `addDashboardSection()` method in your Show Page's `buildShowLayout()` method. |
| 106 | + |
| 107 | +```php |
| 108 | +protected function buildShowLayout(ShowLayout $showLayout): void |
| 109 | + { |
| 110 | + $showLayout |
| 111 | + ->addSection(function (ShowLayoutSection $section) { |
| 112 | + $section |
| 113 | + ->addColumn(7, function (ShowLayoutColumn $column) { |
| 114 | + $column |
| 115 | + ->withFields(categories: 5, author: 7) |
| 116 | + // ... |
| 117 | + }) |
| 118 | + ->addColumn(5, function (ShowLayoutColumn $column) { |
| 119 | + // ... |
| 120 | + }); |
| 121 | + }) |
| 122 | + ->addDashboardSection(PostDashboardEntity::class); |
| 123 | + } |
| 124 | +``` |
0 commit comments