An open API service indexing awesome lists of open source software.

https://github.com/muetze42/nova-resource-card

With this package You can use Nova Resources Index as Card.
https://github.com/muetze42/nova-resource-card

laravel laravel-nova laravel-nova-4 laravel-nova-card

Last synced: 2 months ago
JSON representation

With this package You can use Nova Resources Index as Card.

Awesome Lists containing this project

README

        

# Nova Resource Card

With this package You can use Nova Resources Index as Card.
(For example on the Dashboard or other Nova resource)

Limitations:

* No search
* No pagination
* No actions
* No cards

![Dashboard Preview](docs/preview-dashboard.png)
![Resource Preview](docs/preview-resource.png)
![Preview with footer link](docs/preview-with-footer-link.png)

Examples from [example-app-nvpRt7](https://github.com/Muetze42/example-app-nvpRt7)

This package will certainly be extended in the course of time. Watch this package for Updates.
For suggestions and wishes
please [create an issue](https://github.com/Muetze42/norman-huth-nova-resource-card/issues).

# Install

```
composer require norman-huth/nova-resource-card
```

# Usage

This usage examples use the Laravel Nova User resource class as example.

## Add Nova Resource Card To A Dashboard

```php
use NormanHuth\NovaResourceCard\NovaResourceCard;

class Main extends Dashboard
{
/**
* Get the cards for the dashboard.
*
* @return array
*/
public function cards(): array
{
return [
new NovaResourceCard(\App\Nova\Resources\User::class)
];
}
}
```

## Add Nova Resource Card To A Other Nova Resource

```php
use NormanHuth\NovaResourceCard\NovaResourceCard;

class User extends Resource
{
/**
* Get the cards available for the request.
*
* @param NovaRequest $request
* @return array
*/
public function cards(NovaRequest $request): array
{
return [
new NovaResourceCard(\App\Nova\Resources\User::class),
];
}
}
```

## Card Methods

### Activate Footer Link To The Resource Index

Use the `setFooterLinkLabel` method.

```php
(new NovaResourceCard(\App\Nova\Resources\User::class))->setFooterLinkLabel(__('To All Users'))
```

### Use A Other Nova Resource As Footer Link Target

Use the `setFooterLinkResource` method.

```php
(new NovaResourceCard(\App\Nova\Resources\User::class))
->setFooterLinkLabel(__('Go To Orders'))
->setFooterLinkResource(\App\Nova\Resources\Order::class)
```

### Use A External Url For Footer Link

Use the `setFooterLinkExternalUrl` method.

```php
(new NovaResourceCard(\App\Nova\Resources\User::class))
->setFooterLinkLabel(__('Visit Website'))
->setFooterLinkExternalUrl('https://huth.it')
```

### Set Detail Link Resource

By default, this package generate the detail link by `Resource::$model`, so that you can use several resources for one model without any effort.

Use the `setDetailLinkResource` method.

```php
(new NovaResourceCard(\App\Nova\Resources\User::class))
->setDetailLinkResource(\App\Nova\Resources\Order::class)
```

### Set Card Width

Use the `width` method.

`#[ExpectedValues(values: ['full', '1/3', '1/2', '1/4', '2/3', '3/4'])]`

```php
(new NovaResourceCard(\App\Nova\Resources\User::class))->width('1/2')
```

### Add Classes To Card Element

Use the `addCardClasses` method.

```php
(new NovaResourceCard(\App\Nova\Resources\User::class))->addCardClasses(['bg-white', 'dark:bg-gray-800'])
(new NovaResourceCard(\App\Nova\Resources\User::class))->addCardClasses('bg-white dark:bg-gray-800')
```

### Add Classes To Resource Heading

Use the `addResourceHeadingClasses` method.

```php
(new NovaResourceCard(\App\Nova\Resources\User::class))->addResourceHeadingClasses(['bg-white', 'dark:bg-gray-800'])
(new NovaResourceCard(\App\Nova\Resources\User::class))->addResourceHeadingClasses('bg-white dark:bg-gray-800')
```

### Add Classes To Resource IndexErrorDialog

Use the `addResourceIndexErrorDialogClasses` method.

```php
(new NovaResourceCard(\App\Nova\Resources\User::class))->addResourceIndexErrorDialogClasses(['my-class', 'p-2'])
(new NovaResourceCard(\App\Nova\Resources\User::class))->addResourceIndexErrorDialogClasses('my-class p-2'')
```

### Add Classes To Resource IndexEmptyDialog

Use the `addResourceIndexEmptyDialogClasses` method.

```php
(new NovaResourceCard(\App\Nova\Resources\User::class))->addResourceIndexEmptyDialogClasses(['my-class', 'p-2'])
(new NovaResourceCard(\App\Nova\Resources\User::class))->addResourceIndexEmptyDialogClasses('my-class p-2'')
```

### Add Classes To Resource ResourceTable

Use the `addResourceResourceTableClasses` method.

```php
(new NovaResourceCard(\App\Nova\Resources\User::class))->addResourceResourceTableClasses(['my-class', 'p-2'])
(new NovaResourceCard(\App\Nova\Resources\User::class))->addResourceResourceTableClasses('my-class p-2'')
```

---

### Advanced Usage

Create your own Nova resource to customize it even more.

You should set `$globallySearchable` to false so that this resource is not included in the global search.
(See: [Disabling Global Search For A Resource](https://nova.laravel.com/docs/4.0/search/global-search.html#disabling-global-search-for-a-resource))

Examples Resource from [example-app-nvpRt7](https://github.com/Muetze42/example-app-nvpRt7)

```php
class CardUser extends Resource
{
/**
* The model the resource corresponds to.
*
* @var string
*/
public static string $model = \App\Models\User::class;

/**
* Indicates if the resource should be globally searchable.
*
* @var bool
*/
public static $globallySearchable = false;

/**
* Get the displayable label of the resource.
*
* @return string
*/
public static function label(): string
{
return __('Latest Users');
}

/**
* The pagination per-page options configured for this resource.
*
* @return array
*/
public static $perPageOptions = [5];

/**
* Build an "index" query for the given resource.
*
* @param NovaRequest $request
* @param \Illuminate\Database\Eloquent\Builder $query
* @return \Illuminate\Database\Eloquent\Builder
*/
public static function indexQuery(NovaRequest $request, $query): \Illuminate\Database\Eloquent\Builder
{
return $query->orderByDesc('created_at');
}

/**
* Get the fields displayed by the resource.
*
* @param NovaRequest $request
* @return array
*/
public function fields(NovaRequest $request): array
{
return [
ID::make()->sortable(),
Text::make(__('Name'), 'name'),
];
}

/**
* Determine if the current user can delete the given resource.
*
* @param \Illuminate\Http\Request $request
* @return bool
*/
public function authorizedToDelete(Request $request): bool
{
return false;
}

/**
* Determine if the current user can restore the given resource.
*
* @param \Illuminate\Http\Request $request
* @return bool
*/
public function authorizedToRestore(Request $request): bool
{
return false;
}

/**
* Determine if the current user can update the given resource.
*
* @param \Illuminate\Http\Request $request
* @return bool
*/
public function authorizedToUpdate(Request $request): bool
{
return false;
}

/**
* Determine if the current user can force delete the given resource.
*
* @param \Illuminate\Http\Request $request
* @return bool
*/
public function authorizedToForceDelete(Request $request): bool
{
return false;
}

/**
* Determine if the current user can replicate the given resource or throw an exception.
*
* @param \Illuminate\Http\Request $request
* @return bool
*/
public function authorizeToReplicate(Request $request): bool
{
return false;
}

// ...
```