Laravel Nova

https://nova.laravel.com/docs/v4/
Admin
Laravel Nova is an elegant administration panel for Laravel applications, providing tools to manage...
Tokens:84,557
Snippets:1,145
Trust Score:9.9
Update:3 months ago
Show doc for...
Tokens:
Raw
### Run Nova Installation and Migration Commands

Source: https://nova.laravel.com/docs/v4/installation

Execute the nova:install and migrate Artisan commands to finalize Nova setup and apply database migrations.

```bash
php artisan nova:install

php artisan migrate
```

--------------------------------

### Install Nova Node Modules

Source: https://nova.laravel.com/docs/v4/customization/frontend

Prepare Nova's node_modules by running 'npm run nova:install' or the explicit 'npm --prefix' command to compile custom package assets with Nova mixins.

```bash
npm run nova:install

# Or use the explicit command...
npm --prefix='vendor/laravel/nova' ci
```

--------------------------------

### Customize Storage with Queue and Relationships

Source: https://nova.laravel.com/docs/v4/resources/file-fields

This example demonstrates using the `store` method to store a file, dispatch a job for thumbnail optimization, and update a model's media relationship.

```php
use Laravel\Nova\Http\Requests\NovaRequest;

File::make('Attachment')
    ->store(function (NovaRequest $request, $model) {
        return function () use ($model, $request) {
            $media = $model->media()->updateOrCreate([], [
                'path'=> $request->file('attachment')->store('/path', 'public')
            ]);

            OptimizeMedia::dispatch($media);
        };
    })
```

--------------------------------

### Complete Lens Definition Example

Source: https://nova.laravel.com/docs/v4/lenses/defining-lenses

This example demonstrates a complete lens definition for 'Most Valuable Users', including the `query` and `fields` methods. It shows how to join tables, group by users, and format currency.

```php
<?php

namespace App\Nova\Lenses;

use Illuminate\Support\Facades\DB;
use Laravel\Nova\Fields\ID;
use Laravel\Nova\Fields\Number;
use Laravel\Nova\Fields\Text;
use Laravel\Nova\Http\Requests\LensRequest;
use Laravel\Nova\Http\Requests\NovaRequest;
use Laravel\Nova\Lenses\Lens;

class MostValuableUsers extends Lens
{
    /**
     * Get the query builder / paginator for the lens.
     *
     * @param  \Laravel\Nova\Http\Requests\LensRequest  $request
     * @param  \Illuminate\Database\Eloquent\Builder  $query
     * @return mixed
     */
    public static function query(LensRequest $request, $query)
    {
        return $request->withOrdering($request->withFilters(
            $query->select(self::columns())
                ->join('licenses', 'users.id', '=', 'licenses.user_id')
                ->groupBy('users.id', 'users.name')
                ->withCasts([
                    'revenue' => 'float',
                ])
        ), fn ($query) => $query->orderBy('revenue', 'desc'));
    }

    /**
     * Get the columns that should be selected.
     *
     * @return array
     */
    protected static function columns()
    {
        return [
            'users.id',
            'users.name',
            DB::raw('sum(licenses.price) as revenue'),
        ];
    }

    /**
     * Get the fields available to the lens.
     *
     * @param  \Laravel\Nova\Http\Requests\NovaRequest  $request
     * @return array
     */
    public function fields(NovaRequest $request)
    {
        return [
            ID::make('ID', 'id'),
            Text::make('Name', 'name'),

            Number::make('Revenue', 'revenue', function ($value) {
                return '$'.number_format($value, 2);
            }),
        ];
    }

    /**
     * Get the cards available for the lens.
     *
     * @param  \Laravel\Nova\Http\Requests\NovaRequest  $request
     * @return array
     */
    public function cards(NovaRequest $request)
    {
        return [];
    }

    /**
     * Get the filters available for the lens.
     *
     * @param  \Laravel\Nova\Http\Requests\NovaRequest  $request
     * @return array
     */
    public function filters(NovaRequest $request)
    {
        return [];
    }

    /**
     * Get the actions available for the lens.
     *
     * @param  \Laravel\Nova\Http\Requests\NovaRequest  $request
     * @return array
     */
    public function actions(NovaRequest $request)
    {
        return [];
    }

    /**
     * Get the URI key for the lens.
     *
     * @return string
     */
    public function uriKey()
    {
        return 'most-profitable-users';
    }
}
```

--------------------------------

### Calculate New Users Progress

Source: https://nova.laravel.com/docs/v4/metrics/defining-metrics

The `calculate` method should return a `ProgressResult`. This example uses the `count` helper to count users created this month against a target of 200.

```php
<?php

namespace App\Nova\Metrics;

use App\Models\User;
use Laravel\Nova\Http\Requests\NovaRequest;
use Laravel\Nova\Metrics\Progress;

class NewUsers extends Progress
{
    /**
     * 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, function ($query) {
            return $query->where('created_at', '>=', now()->startOfMonth());
        }, target: 200);
    }

    /**
     * Get the URI key for the metric.
     *
     * @return string
     */
    public function uriKey()
    {
        return 'new-users';
    }
}
```

--------------------------------

### Boolean Filter Implementation Example

Source: https://nova.laravel.com/docs/v4/filters/defining-filters

This example demonstrates a typical boolean filter implementation in Nova. The 'apply' method modifies the Eloquent query based on selected options, and the 'options' method defines the available filter choices.

```php
<?php

namespace App\Nova\Filters;

use Laravel\Nova\Filters\BooleanFilter;
use Laravel\Nova\Http\Requests\NovaRequest;

class UserType extends BooleanFilter
{
    /**
     * Apply the filter to the given query.
     *
     * @param  \Laravel\Nova\Http\Requests\NovaRequest  $request
     * @param  \Illuminate\Database\Eloquent\Builder  $query
     * @param  mixed  $value
     * @return \Illuminate\Database\Eloquent\Builder
     */
    public function apply(NovaRequest $request, $query, $value)
    {
        // $value = ['admin' => true / false, 'editor' => true / false]

        return $query->where('is_admin', $value['admin'])
                     ->where('is_editor', $value['editor']);
    }

    /**
     * Get the filter's available options.
     *
     * @param  \Laravel\Nova\Http\Requests\NovaRequest  $request
     * @return array
     */
    public function options(NovaRequest $request)
    {
        return [
            'Administrator' => 'admin',
            'Editor' => 'editor',
        ];
    }
}
```

--------------------------------

### Action with Then Callback

Source: https://nova.laravel.com/docs/v4/actions/defining-actions

This example shows how to define an action whose `handle` method returns the processed models. A `then` callback is then registered when the action is added to a resource, allowing post-execution logic on the returned models.

```php
public function handle(ActionFields $fields, Collection $models)
{
    foreach ($models as $model) {
        (new AccountData($model))->send();
    }

    return $models;
}
```

```php
public function actions(NovaRequest $request)
{
    return [
        (new Actions\EmailAccountProfile)->then(function ($models) {
            $models->each(function ($model) {
                //
            });
        }),
    ];
}
```

--------------------------------

### Compiling Field Assets with NPM

Source: https://nova.laravel.com/docs/v4/customization/fields

Commands to install Nova's dependencies, compile assets for development, and compile/minify assets for production.

```bash
# Prepare Laravel Nova's dependencies...
npm run nova:install

# Compile your assets for local development...
npm run dev

# Compile and minify your assets...
npm run prod
```

--------------------------------

### Simulate File Storage with Laravel Route

Source: https://nova.laravel.com/docs/v4/resources/file-fields

This example demonstrates how a Laravel route would store an uploaded file using the `store` method and update a user's profile photo path.

```php
use Illuminate\Http\Request;

Route::post('/photo', function (Request $request) {
    $path = $request->profile_photo->store('/', 'public');

    $request->user()->update([
        'profile_photo' => $path,
    ]);
});
```

--------------------------------

### Retrieve and Access Stored File

Source: https://nova.laravel.com/docs/v4/resources/file-fields

Shows how to retrieve a stored file using the Storage facade and get its public URL.

```php
use Illuminate\Support\Facades\Storage;

Storage::get($user->profile_photo);
Storage::url($user->profile_photo);
```

--------------------------------

### Update Composer Packages

Source: https://nova.laravel.com/docs/v4/installation

Run the composer update command to install Nova and its dependencies.

```bash
composer update --prefer-dist
```

--------------------------------

### Defining Tool Navigation Menu

Source: https://nova.laravel.com/docs/v4/customization/tools

Customize the left-side navigation links for your tool by implementing the `menu` method in your tool class. This example uses `MenuSection` to create a menu item.

```php
use Illuminate\Http\Request;
use Laravel\Nova\Menu\MenuSection;

/**
 * Build the menu that renders the navigation links for the tool.
 *
 * @param  \Illuminate\Http\Request  $request
 * @return mixed
 */
public function menu(Request $request)
{
    return MenuSection::make('Price Tracker')
        ->path('/price-tracker')
        ->icon('server');
}
```

--------------------------------

### Implement a Birthday Date Filter

Source: https://nova.laravel.com/docs/v4/filters/defining-filters

Example of a `BirthdayFilter` class extending `DateFilter`. The `apply` method modifies the query to filter records by birthday.

```php
<?php

namespace App\Nova\Filters;

use Illuminate\Support\Carbon;
use Laravel\Nova\Filters\DateFilter;
use Laravel\Nova\Http\Requests\NovaRequest;

class BirthdayFilter extends DateFilter
{
    /**
     * Apply the filter to the given query.
     *
     * @param  \Laravel\Nova\Http\Requests\NovaRequest  $request
     * @param  \Illuminate\Database\Eloquent\Builder  $query
     * @param  mixed  $value
     * @return \Illuminate\Database\Eloquent\Builder
     */
    public function apply(NovaRequest $request, $query, $value)
    {
        return $query->where('birthday', '<=', Carbon::parse($value));
    }
}
```

--------------------------------

### Enable Vue DevTools

Source: https://nova.laravel.com/docs/v4/customization/frontend

Compile Nova's JavaScript for development by navigating to the Nova vendor directory, renaming webpack.mix.js.dist, installing dependencies, and running the dev script. Remember to clean up node_modules and publish Nova assets.

```bash
cd ./vendor/laravel/nova
mv webpack.mix.js.dist webpack.mix.js
npm ci
npm run dev
rm -rf node_modules
cd -
php artisan nova:publish
```

--------------------------------

### Implement a Custom Select Filter

Source: https://nova.laravel.com/docs/v4/filters/defining-filters

This example shows a `UserType` filter. The `apply` method modifies the Eloquent query based on the selected value, and the `options` method defines the available choices for the filter.

```php
<?php

namespace App\Nova\Filters;

use Laravel\Nova\Filters\Filter;
use Laravel\Nova\Http\Requests\NovaRequest;

class UserType extends Filter
{
    /**
     * Apply the filter to the given query.
     *
     * @param  \Laravel\Nova\Http\Requests\NovaRequest  $request
     * @param  \Illuminate\Database\Eloquent\Builder  $query
     * @param  mixed  $value
     * @return \Illuminate\Database\Eloquent\Builder
     */
    public function apply(NovaRequest $request, $query, $value)
    {
        return $query->where('type', $value);
    }

    /**
     * Get the filter's available options.
     *
     * @param  \Laravel\Nova\Http\Requests\NovaRequest  $request
     * @return array
     */
    public function options(NovaRequest $request)
    {
        return [
            'Administrator' => 'admin',
            'Editor' => 'editor',
        ];
    }
}
```

--------------------------------

### Define Post Update Policy

Source: https://nova.laravel.com/docs/v4/resources/authorization

Implement the `update` method in a policy to control which users can update a specific resource. This example allows users with the type 'editor' to update posts.

```php
<?php

namespace App\Policies;

use App\Models\User;
use App\Models\Post;
use Illuminate\Auth\Access\HandlesAuthorization;

class PostPolicy
{
    use HandlesAuthorization;

    /**
     * Determine whether the user can update the post.
     *
     * @param  \App\Models\User  $user
     * @param  \App\Models\Post  $post
     * @return mixed
     */
    public function update(User $user, Post $post)
    {
        return $user->type == 'editor';
    }
}
```

--------------------------------

### Nova Resource Hook: afterCreate

Source: https://nova.laravel.com/docs/v4/resources/the-basics

Define a static `afterCreate` method on a Nova resource to execute custom logic after a resource is created within Nova. This example sends an email verification notification.

```php
use App\Models\User;
use App\Nova\Resource;
use Illuminate\Database\Eloquent\Model;
use Laravel\Nova\Http\Requests\NovaRequest;

class User extends Resource
{
    /**
     * Register a callback to be called after the resource is created.
     *
     * @param  \Laravel\Nova\Http\Requests\NovaRequest  $request
     * @param  \Illuminate\Database\Eloquent\Model  $model
     * @return void
     */
    public static function afterCreate(NovaRequest $request, Model $model)
    {
        $model->sendEmailVerificationNotification();
    }
}
```

--------------------------------

### Set Metric Width

Source: https://nova.laravel.com/docs/v4/metrics/registering-metrics

Use the `width` method when registering a metric to control its size within the Nova content area. Examples show setting a metric to two-thirds or full width.

```php
/**
 * Get the cards available for the request.
 *
 * @param  \Laravel\Nova\Http\Requests\NovaRequest  $request
 * @return array
 */
public function cards(NovaRequest $request)
{
    return [
        // Two-thirds of the content area...
        (new Metrics\UsersPerDay)->width('2/3'),

        // Full width...
        (new Metrics\UsersPerDay)->width('full'),
    ];
}
```

--------------------------------

### Update Nova Installation

Source: https://nova.laravel.com/docs/v4/installation

Run the composer update command to update your Nova installation to the latest version.

```bash
composer update
```

--------------------------------

### Registering an Action with `make`

Source: https://nova.laravel.com/docs/v4/actions/registering-actions

Instantiate an action using the `make` method, passing any necessary constructor arguments.

```php
/**
 * Get the actions available for the resource.
 *
 * @param  \Laravel\Nova\Http\Requests\NovaRequest  $request
 * @return array
 */
public function actions(NovaRequest $request)
{
    return [
        Actions\EmailAccountProfile::make()
    ];
}
```

--------------------------------

### Registering a Lens Using 'make'

Source: https://nova.laravel.com/docs/v4/lenses/registering-lenses

Instantiate a lens using the 'make' method, passing any necessary constructor arguments.

```php
/**
 * Get the lenses available for the resource.
 *
 * @param  \Laravel\Nova\Http\Requests\NovaRequest  $request
 * @return array
 */
public function lenses(NovaRequest $request)
{
    return [
        Lenses\MostValuableUsers::make(),
    ];
}
```

--------------------------------

### Registering a Metric Using `make` on a Resource Index

Source: https://nova.laravel.com/docs/v4/metrics/registering-metrics

Instantiate a metric using the `make` method and add it to the resource's `cards` method. Arguments passed to `make` are forwarded to the metric's constructor.

```php
use App\Nova\Metrics\UsersPerDay;
use Laravel\Nova\Http\Requests\NovaRequest;

/**
 * Get the cards available for the resource.
 *
 * @param  \Laravel\Nova\Http\Requests\NovaRequest  $request
 * @return array
 */
public function cards(NovaRequest $request)
{
    return [
        UsersPerDay::make()
    ];
}
```

--------------------------------

### Define BelongsToMany Relationship in Eloquent

Source: https://nova.laravel.com/docs/v4/resources/relationships

Example of defining a belongs-to-many relationship in an Eloquent model.

```php
public function roles()
{
    return $this->belongsToMany(Role::class);
}
```

--------------------------------

### Compiling and Minifying Assets for Production

Source: https://nova.laravel.com/docs/v4/customization/tools

Use the `npm run prod` command to compile and minify your tool's assets for production deployment. This optimizes your assets for performance.

```bash
# Compile and minify your assets...
npm run prod
```

--------------------------------

### Invokable Class for Pivot Fields

Source: https://nova.laravel.com/docs/v4/resources/relationships

Example of an invokable class that returns an array of pivot fields for a BelongsToMany relationship.

```php
<?php

namespace App\Nova;

use Laravel\Nova\Fields\Text;

class RoleUserFields
{
    /**
     * Get the pivot fields for the relationship.
     *
     * @param  \Laravel\Nova\Http\Requests\NovaRequest  $request
     * @param  \Illuminate\Database\Eloquent\Model  $relatedModel
     * @return array
     */
    public function __invoke($request, $relatedModel)
    {
        return [
            Text::make('Notes'),
        ];
    }
}
```

--------------------------------

### Configure Mix Alias for laravel/nova

Source: https://nova.laravel.com/docs/v4/upgrade

Update webpack.mix.js to define a 'laravel-nova' alias pointing to the packages.js file within your Nova installation.

```javascript
'laravel-nova': path.join(
  __dirname,
  '../../vendor/laravel/nova/resources/js/mixins/packages.js'
),
```

```javascript
'laravel-nova': path.join(
  __dirname,
  'vendor/laravel/nova/resources/js/mixins/packages.js'
),
```

--------------------------------

### Create a Menu Section as a Link

Source: https://nova.laravel.com/docs/v4/customization/menus

Configure a menu section to act as a direct link to a specified path.

```php
use Laravel\Nova\Menu\MenuSection;

MenuSection::make('Dashboard')->path('/dashboards/main')
```

--------------------------------

### Create Resource Menu Item

Source: https://nova.laravel.com/docs/v4/customization/menus

Use the `resource` method to quickly create a menu item linking to a Nova resource. Pass the resource class name.

```php
use App\Nova\User;
use Laravel\Nova\Menu\MenuItem;

MenuItem::resource(User::class)
```

--------------------------------

### Create a Menu Section Linking to a Nova Dashboard

Source: https://nova.laravel.com/docs/v4/customization/menus

Conveniently create a menu section that links directly to a Nova dashboard using the `dashboard` method.

```php
use App\Nova\Dashboards\Sales;
use Laravel\Nova\Menu\MenuSection;

MenuSection::dashboard(Sales::class),
```

--------------------------------

### Trend Metric Data Retrieval

Source: https://nova.laravel.com/docs/v4/resources/fields

Example of how to retrieve and format data within a trend metric, using the resourceId available in the request.

```php
return $this->countByDays(
    $request,
    PostView::where('post_id', '=', $request->resourceId)
);
```

--------------------------------

### Create a Menu Section Linking to a Nova Lens

Source: https://nova.laravel.com/docs/v4/customization/menus

Create a menu section link to a specific Nova lens for a resource using the `lens` method.

```php
use App\Nova\Lenses\MostValuableUsers;
use App\Nova\User;
use Laravel\Nova\Menu\MenuSection;

MenuSection::lens(User::class, MostValuableUsers::class)
```

--------------------------------

### Update Composer Dependencies

Source: https://nova.laravel.com/docs/v4/upgrade

Install updated Composer dependencies after modifying composer.json. This command fetches the latest versions of your project's packages.

```shell
composer update mirrors

composer update
```

--------------------------------

### Configure Composer HTTP Basic Authentication

Source: https://nova.laravel.com/docs/v4/installation

Set up Composer to use your Nova account email and license key for authentication to avoid manual prompts.

```bash
composer config http-basic.nova.laravel.com your-nova-account-email@your-domain.com your-license-key
```

--------------------------------

### BooleanGroup Field JSON Output

Source: https://nova.laravel.com/docs/v4/resources/fields

When saved, a BooleanGroup field is converted to JSON format. This example shows a typical JSON representation of selected options.

```json
{
  "create": true,
  "read": false,
  "update": false,
  "delete": false
}
```

--------------------------------

### Manually Building Partition Metric Results

Source: https://nova.laravel.com/docs/v4/metrics/defining-metrics

Manually provide partition metric results using the `result` method when query helpers are insufficient. This offers maximum flexibility in defining metric groups and their values.

```php
return $this->result([
    'Group 1' => 100,
    'Group 2' => 200,
    'Group 3' => 300,
]);
```

--------------------------------

### Initiate File Download

Source: https://nova.laravel.com/docs/v4/actions/defining-actions

Use ActionResponse::download to trigger a file download for the user, specifying the filename and the file's URL.

```php
use Laravel\Nova\Actions\ActionResponse;

return ActionResponse::download('Invoice.pdf', 'https://example.com/invoice.pdf');
```

--------------------------------

### Invokable Class for Pivot Fields

Source: https://nova.laravel.com/docs/v4/resources/relationships

An example of an invokable class that defines pivot fields for a MorphToMany relationship. This class is used with the `fields` method on the MorphToMany field.

```php
<?php

namespace App\Nova;

use Laravel\Nova\Fields\Text;

class TaggableFields
{
    /**
     * Get the pivot fields for the relationship.
     *
     * @param  \Laravel\Nova\Http\Requests\NovaRequest  $request
     * @param  \Illuminate\Database\Eloquent\Model  $relatedModel
     * @return array
     */
    public function __invoke($request, $relatedModel)
    {
        return [
            Text::make('Notes'),
        ];
    }
}
```

--------------------------------

### Registering a Basic Action

Source: https://nova.laravel.com/docs/v4/actions/registering-actions

Attach a defined action to a resource by adding it to the `actions` method's return array.

```php
/**
 * Get the actions available for the resource.
 *
 * @param  \Laravel\Nova\Http\Requests\NovaRequest  $request
 * @return array
 */
public function actions(NovaRequest $request)
{
    return [
        new Actions\EmailAccountProfile
    ];
}
```

--------------------------------

### Search Relationships with SearchableRelation

Source: https://nova.laravel.com/docs/v4/search/the-basics

To search against related models, define the `searchableColumns` method and return an instance of `Laravel\Nova\Query\Search\SearchableRelation`. This example searches the 'name' column of the 'author' relationship.

```php
use Laravel\Nova\Query\Search\SearchableRelation;

/**
 * Get the searchable columns for the resource.
 *
 * @return array
 */
public static function searchableColumns()
{
    return ['id', new SearchableRelation('author', 'name')];
}
```

--------------------------------

### Registering Tool Assets

Source: https://nova.laravel.com/docs/v4/customization/tools

Register your tool's compiled JavaScript and CSS files to make them available to the Nova front-end. This is done within the `boot` method of your tool class.

```php
use Laravel\Nova\Nova;
use Laravel\Nova\Events\ServingNova;

/**
 * Perform any tasks that need to happen on tool registration.
 *
 * @return void
 */
public function boot()
{
    Nova::script('price-tracker', __DIR__.'/../dist/js/tool.js');
    Nova::style('price-tracker', __DIR__.'/../dist/css/tool.css');
}
```

--------------------------------

### Defining Tool Options in PHP

Source: https://nova.laravel.com/docs/v4/customization/resource-tools

Expose methods on your tool class to allow runtime configuration. Use withMeta to pass options to the Vue component.

```php
<?php

namespace Acme\StripeInspector;

use Laravel\Nova\ResourceTool;

class StripeInspector extends ResourceTool
{
    /**
     * Get the displayable name of the resource tool.
     *
     * @return string
     */
    public function name()
    {
        return 'Stripe Inspector';
    }

    /**
     * Indicates that the Stripe inspector should allow refunds.
     *
     * @return $this
     */
    public function issuesRefunds()
    {
        return $this->withMeta(['issuesRefunds' => true]);
    }

    /**
     * Get the component name for the resource tool.
     *
     * @return string
     */
    public function component()
    {
        return 'stripe-inspector';
    }
}
```

--------------------------------

### Override Default Currency for a Field

Source: https://nova.laravel.com/docs/v4/resources/fields

Specify a different currency for a specific Currency field using the `currency` method. Ensure the `ext-intl` PHP extension or `symfony/polyfill-intl-icu` is installed.

```php
Currency::make('Price')->currency('EUR'),
```

--------------------------------

### Invokable File Storage Class

Source: https://nova.laravel.com/docs/v4/resources/file-fields

An example of an invokable class for file storage. The `__invoke` method handles the storage logic and returns an array of attributes to update on the model.

```php
<?php

namespace App\Nova;

use Laravel\Nova\Http\Requests\NovaRequest;

class StoreAttachment
{
    /**
     * Store the incoming file upload.
     *
     * @param  \Laravel\Nova\Http\Requests\NovaRequest  $request
     * @param  \Illuminate\Database\Eloquent\Model  $model
     * @param  string  $attribute
     * @param  string  $requestAttribute
     * @param  string|null  $disk
     * @param  string|null  $storagePath
     * @return array
     */
    public function __invoke(NovaRequest $request, $model, $attribute, $requestAttribute, $disk, $storagePath)
    {
        return [
            'attachment' => $request->attachment->store('/', 's3'),
            'attachment_name' => $request->attachment->getClientOriginalName(),
            'attachment_size' => $request->attachment->getSize(),
        ];
    }
}
```

--------------------------------

### Create Resource Menu Item with Multiple Filters

Source: https://nova.laravel.com/docs/v4/customization/menus

Link to a resource with multiple filters applied by chaining the `applies` method. Each `applies` call takes a filter instance and its value.

```php
use App\Nova\User;
use Laravel\Nova\Menu\MenuItem;
use \App\Nova\Filters\EmailFilter;
use \App\Nova\Filters\StatusFilter;

MenuItem::filter('Filtered Users', User::class)
    ->applies(EmailFilter::make(), '@laravel.com')
    ->applies(StatusFilter::make(), 'active')
```

--------------------------------

### Basic Trix Field

Source: https://nova.laravel.com/docs/v4/resources/fields

Use the Trix field for rich text content that will be stored as HTML in a TEXT database column. It requires no special setup beyond its definition.

```php
use Laravel\Nova\Fields\Trix;

Trix::make('Biography'),
```

--------------------------------

### Implement Trend Metric Calculation

Source: https://nova.laravel.com/docs/v4/metrics/defining-metrics

The `calculate` method in a trend metric class should return a `Laravel\Nova\Metrics\TrendResult` object. This example uses the `countByDays` helper to query user creation data.

```php
<?php

namespace App\Nova\Metrics;

use App\Models\User;
use Laravel\Nova\Http\Requests\NovaRequest;
use Laravel\Nova\Metrics\Trend;

class UsersPerDay extends Trend
{
    /**
     * Calculate the value of the metric.
     *
     * @param  \Laravel\Nova\Http\Requests\NovaRequest  $request
     * @return mixed
     */
    public function calculate(NovaRequest $request)
    {
        return $this->countByDays($request, User::class);
    }

    /**
     * Get the ranges available for the metric.
     *
     * @return array
     */
    public function ranges()
    {
        return [
            30 => '30 Days',
            60 => '60 Days',
            90 => '90 Days',
        ];
    }

    /**
     * Get the URI key for the metric.
     *
     * @return string
     */
    public function uriKey()
    {
        return 'users-per-day';
    }
}
```

--------------------------------

### Customize Entire File Storage Process

Source: https://nova.laravel.com/docs/v4/resources/file-fields

Use the `store` method with a callable to take full control of the file storage logic. The callable receives the request and model, and should return an array of key/value pairs to update the model.

```php
use Illuminate\Http\Request;

File::make('Attachment')
    ->store(function (Request $request, $model) {
        return [
            'attachment' => $request->attachment->store('/', 's3'),
            'attachment_name' => $request->attachment->getClientOriginalName(),
            'attachment_size' => $request->attachment->getSize(),
        ];
    })
```

--------------------------------

### Compiling Card Assets for Development

Source: https://nova.laravel.com/docs/v4/customization/cards

Compile your card's JavaScript and CSS assets for local development using the npm run dev command.

```bash
npm run dev
```

--------------------------------

### Check Nova License Configuration

Source: https://nova.laravel.com/docs/v4/installation

Run the 'nova:check-license' Artisan command to verify that your Nova license key configuration is correct.

```bash
php artisan nova:check-license
```

--------------------------------

### Filter Relatable Query by User ID

Source: https://nova.laravel.com/docs/v4/resources/authorization

Override the `relatableQuery` method to filter models available in relationship selection menus, for example, to show only podcasts belonging to the current user.

```php
/**
 * Build a "relatable" query for the given resource.
 *
 * This query determines which instances of the model may be attached to other resources.
 *
 * @param  \Laravel\Nova\Http\Requests\NovaRequest  $request
 * @param  \Illuminate\Database\Eloquent\Builder  $query
 * @param  \Laravel\Nova\Fields\Field  $field
 * @return \Illuminate\Database\Eloquent\Builder
 */
public static function relatableQuery(NovaRequest $request, $query)
{
    return $query->where('user_id', $request->user()->id);
}
```

--------------------------------

### Dynamically Setting Tool Options

Source: https://nova.laravel.com/docs/v4/customization/resource-tools

Resource tools allow dynamic option setting by calling desired options as methods during registration. Arguments passed become the option's value.

```php
use Acme\StripeInspector\StripeInspector;

/**
 * Get the fields displayed by the resource.
 *
 * @param  \Laravel\Nova\Http\Requests\NovaRequest  $request
 * @return array
 */
public function fields(NovaRequest $request)
{
    return [
        ID::make('ID', 'id')->sortable(),

        StripeInspector::make()->issuesRefunds(),
    ];
}
```

--------------------------------

### Create a Dynamic Timestamp Filter

Source: https://nova.laravel.com/docs/v4/filters/defining-filters

Example of a dynamic filter that filters on a column determined at runtime. It passes the column name to the constructor and overrides the `key` method for unique identification.

```php
<?php

namespace App\Nova\Filters;

use Illuminate\Support\Carbon;
use Laravel\Nova\Filters\DateFilter;
use Laravel\Nova\Http\Requests\NovaRequest;

class TimestampFilter extends DateFilter
{
    /**
     * The column that should be filtered on.
     *
     * @var string
     */
    protected $column;

    /**
     * Create a new filter instance.
     *
     * @param  string  $column
     * @return void
     */
    public function __construct($column)
    {
        $this->column = $column;
    }

    /**
     * Apply the filter to the given query.
     *
     * @param  \Laravel\Nova\Http\Requests\NovaRequest  $request
     * @param  \Illuminate\Database\Eloquent\Builder  $query
     * @param  mixed  $value
     * @return \Illuminate\Database\Eloquent\Builder
     */
    public function apply(NovaRequest $request, $query, $value)
    {
        return $query->where($this->column, '<=', Carbon::parse($value));
    }

    /**
     * Get the key for the filter.
     *
     * @return string
     */
    public function key()
    {
        return 'timestamp_'.$this->column;
    }
}
```

--------------------------------

### Publish Nova Stubs

Source: https://nova.laravel.com/docs/v4/customization/stubs

Execute this command to publish Nova's stub files to your project's `./stubs/nova` directory for customization.

```bash
php artisan nova:stubs
```

--------------------------------

### Authorize Adding Relationship Models

Source: https://nova.laravel.com/docs/v4/resources/authorization

Define an `add{Model}` method in your policy to authorize users adding related models. For example, `addComment` on a `PodcastPolicy` authorizes adding comments to a podcast.

```php
<?php

namespace App\Policies;

use App\Models\User;
use App\Models\Podcast;
use Illuminate\Auth\Access\HandlesAuthorization;

class PodcastPolicy
{
    use HandlesAuthorization;

    /**
     * Determine whether the user can add a comment to the podcast.
     *
     * @param  \App\Models\User  $user
     * @param  \App\Models\Podcast  $podcast
     * @return mixed
     */
    public function addComment(User $user, Podcast $podcast)
    {
        return true;
    }
}
```

--------------------------------

### Enable Markdown File Uploads

Source: https://nova.laravel.com/docs/v4/resources/fields

Allow drag-and-drop photo uploads into the Markdown field by chaining the 'withFiles' method and specifying the filesystem disk.

```php
use Laravel\Nova\Fields\Markdown;

Markdown::make('Biography')->withFiles('public'),
```

--------------------------------

### Compiling and Minifying Card Assets

Source: https://nova.laravel.com/docs/v4/customization/cards

Compile and minify your card's assets for production using the npm run prod command.

```bash
npm run prod
```

--------------------------------

### Dependent Field Vue Template

Source: https://nova.laravel.com/docs/v4/customization/fields

When using `DependentFormField`, refer to your field in the Vue template using `this.currentField` instead of `this.field`. This example shows a basic text input for a dependent field.

```vue
<template>
  <DefaultField :field="currentField" :errors="errors">
    <template #field>
      <input
        :id="currentField.uniqueKey"
        type="text"
        class="w-full form-control form-input form-input-bordered"
        :class="errorClasses"
        :placeholder="currentField.placeholder"
        v-model="value"
      />

      <p v-if="hasError" class="my-2 text-red-500">
        {{ firstError }}
      </p>
    </template>
  </DefaultField>
</template>

<script>
import { DependentFormField, HandlesValidationErrors } from 'laravel-nova'

export default {
  mixins: [DependentFormField, HandlesValidationErrors],

  //
}
</script>
```

--------------------------------

### Send Nova Notification Directly

Source: https://nova.laravel.com/docs/v4/customization/notifications

Send a Nova notification to a user directly using the `notify` method. Ensure your user model is notifiable. This example uses the `NovaNotification` class for customization.

```php
use Laravel\Nova\Notifications\NovaNotification;
use Laravel\Nova\URL;

$request->user()->notify(
    NovaNotification::make()
        ->message('Your report is ready to download.')
        ->action('Download', URL::remote('https://example.com/report.pdf'))
        ->icon('download')
        ->type('info')
);
```

--------------------------------

### Create a Menu Section Linking to a Nova Resource

Source: https://nova.laravel.com/docs/v4/customization/menus

Quickly generate a menu section link to a Nova resource's index page using the `resource` method.

```php
use App\Nova\User;
use Laravel\Nova\Menu\MenuSection;

MenuSection::resource(User::class)
```

--------------------------------

### Customize Filterable Field Logic with a Closure

Source: https://nova.laravel.com/docs/v4/resources/fields

Provide a closure to the `filterable()` method to customize how a field is filtered. This example shows how to implement a 'LIKE' query for a text field based on the provided value.

```php
Text::make('Email')->filterable(function ($request, $query, $value, $attribute) {
    $query->where($attribute, 'LIKE', "{$value}%");
}),
```

--------------------------------

### Validate Vapor File Field Size

Source: https://nova.laravel.com/docs/v4/resources/fields

To validate Vapor file fields, inspect the file directly using the Storage facade. This example checks if the document size exceeds 1 MB.

```php
use Illuminate\Support\Facades\Storage;

VaporFile::make('Document')
    ->rules('bail', 'required', function ($attribute, $value, $fail) use ($request) {
        if (Storage::size($request->input('vaporFile')[$attribute]['key']) > 1000000) {
            return $fail('The document size may not be greater than 1 MB');
        }
    }),
```

--------------------------------

### Register Action with Fullscreen Modal

Source: https://nova.laravel.com/docs/v4/actions/registering-actions

Use the `fullscreen` method when registering an action to make its confirmation modal display in fullscreen.

```php
/**
 * Get the actions available for the resource.
 *
 * @param  \Laravel\Nova\Http\Requests\NovaRequest  $request
 * @return array
 */
public function actions(NovaRequest $request)
{
    return [
        Actions\EmailAccountProfile::make()->fullscreen()
    ];
}
```

--------------------------------

### Create a Main Menu Section with Groups and Items

Source: https://nova.laravel.com/docs/v4/customization/menus

Define a main menu section with nested groups and various types of menu items like dashboards, resources, and external links.

```php
use App\Nova\Dashboards\Sales;
use App\Nova\Lenses\MostValuableUsers;
use App\Nova\License;
use App\Nova\Refund;
use App\Nova\User;
use Illuminate\Http\Request;
use Laravel\Nova\Menu\Menu;
use Laravel\Nova\Menu\MenuGroup;
use Laravel\Nova\Menu\MenuItem;
use Laravel\Nova\Menu\MenuSection;
use Laravel\Nova\Nova;

Nova::mainMenu(function (Request $request, Menu $menu) {
    return [
        MenuSection::make('Business', [
            MenuGroup::make('Licensing', [
                MenuItem::dashboard(Sales::class),
                MenuItem::resource(License::class),
                MenuItem::resource(Refund::class),
                MenuItem::externalLink('Stripe Payments', 'https://dashboard.stripe.com/payments?status%5B%5D=successful'),
            ]),

            MenuGroup::make('Customers', [
                MenuItem::lens(User::class, MostValuableUsers::class),
            ]),
        ]),
    ];
});
```

--------------------------------

### Create Dashboard Menu Item

Source: https://nova.laravel.com/docs/v4/customization/menus

Link to a custom Nova dashboard using the `dashboard` factory method. Pass the dashboard class name.

```php
use App\Nova\Dashboards\Main;
use Laravel\Nova\Menu\MenuItem;

MenuItem::dashboard(Main::class)
```

--------------------------------

### Defining Card Options with `withMeta`

Source: https://nova.laravel.com/docs/v4/customization/cards

Expose runtime configuration options to your card's Vue component by defining public methods that call `withMeta`. These options are passed as metadata to the frontend.

```php
<?php

namespace Acme\Analytics;

use Laravel\Nova\Card;

class Analytics extends Card
{
    /**
     * The width of the card (1/3, 2/3, 1/2, 1/4, 3/4, or full).
     *
     * @var string
     */
    public $width = '1/3';
    
    /**
     * The height strategy of the card (fixed or dynamic).
     *
     * @var string
     */
    public $height = 'fixed';

    /**
     * Indicates that the analytics should show current visitors.
     *
     * @return $this
     */
    public function currentVisitors()
    {
        return $this->withMeta(['currentVisitors' => true]);
    }

    /**
     * Get the component name for the card.
     *
     * @return string
     */
    public function component()
    {
        return 'analytics';
    }
}
```

--------------------------------

### Create an Image Field with Disk

Source: https://nova.laravel.com/docs/v4/resources/file-fields

Use the Image field to display a thumbnail preview of a file. Specify the disk to use for storage.

```php
use Laravel\Nova\Fields\Image;

Image::make('Profile Photo')->disk('public'),
```

--------------------------------

### Setting Page Title with Inertia.js Head Component

Source: https://nova.laravel.com/docs/v4/customization/tools

Utilize the Inertia.js `Head` component within your Vue page components to manage the page title. This example shows how to set the title to 'PriceTracker'.

```vue
<template>
  <Head title="PriceTracker" />
</template>
```

--------------------------------

### Customize File Download Behavior

Source: https://nova.laravel.com/docs/v4/resources/file-fields

Use the `download` method with a callable to customize how files are downloaded, returning the result of `Storage::download`.

```php
use Laravel\Nova\Fields\Image;
use Illuminate\Support\Facades\Storage;

Image::make('Profile Photo')
    ->disk('public')
    ->download(function ($request, $model, $disk, $value) {
        return Storage::disk($disk)->download($value, 'avatar');
    }),
```

--------------------------------

### Register Nova License Key in config/nova.php

Source: https://nova.laravel.com/docs/v4/installation

Set the 'license_key' option in your config/nova.php configuration file to register your Nova license. Use the NOVA_LICENSE_KEY environment variable for security.

```php
'license_key' => env('NOVA_LICENSE_KEY', ''),
```

--------------------------------

### Storing Original Filename and Size with File Field

Source: https://nova.laravel.com/docs/v4/resources/file-fields

Configure a File field to store the original client filename and size in specified database columns. This setup is useful for later retrieval and display.

```php
use Illuminate\Http\Request;
use Laravel\Nova\Fields\File;
use Laravel\Nova\Fields\Text;

/**
 * Get the fields displayed by the resource.
 *
 * @param  \Laravel\Nova\Http\Requests\NovaRequest  $request
 * @return array
 */
public function fields(NovaRequest $request)
{
    return [
        // ...

        File::make('Attachment')
                ->disk('s3')
                ->storeOriginalName('attachment_name')
                ->storeSize('attachment_size'),

        Text::make('Attachment Name')->exceptOnForms(),

        Text::make('Attachment Size')
                ->exceptOnForms()
                ->displayUsing(function ($value) {
                    return number_format($value / 1024, 2).'kb';
                }),
    ];
}
```

--------------------------------

### Configure Global Search Debounce Timing

Source: https://nova.laravel.com/docs/v4/search/global-search

Adjust the delay in milliseconds before the global search is triggered after user input by using the 'Nova::globalSearchDebounce' method in your NovaServiceProvider. The example sets the debounce to 1 second.

```php
Nova::globalSearchDebounce(1); // 1 second
```

--------------------------------

### Create Lens Menu Item

Source: https://nova.laravel.com/docs/v4/customization/menus

Create a menu item linking to a Nova lens. Use the `lens` method, passing the resource class and the lens class.

```php
use App\Nova\Lenses\MostValuableUsers;
use App\Nova\User;
use Laravel\Nova\Menu\MenuItem;

MenuItem::lens(User::class, MostValuableUsers::class)
```

--------------------------------

### Create Collapsable Menu Sections

Source: https://nova.laravel.com/docs/v4/customization/menus

Make menu sections collapsable by calling the `collapsable` method. Nova remembers the open state between requests.

```php
use Laravel\Nova\Menu\MenuSection;

MenuSection::make('Resources', [
    //
])->collapsable()
```

--------------------------------

### Generate a Nova Asset

Source: https://nova.laravel.com/docs/v4/customization/assets

Use the `nova:asset` Artisan command to generate a new custom asset. The asset name should follow the Composer `vendor/package` format. Nova will prompt for NPM dependency installation and compilation.

```bash
php artisan nova:asset acme/analytics
```

--------------------------------

### Generate Partition Metric Class

Source: https://nova.laravel.com/docs/v4/metrics/defining-metrics

Use the `nova:partition` Artisan command to generate a new partition metric class. By default, new metrics are placed in the `app/Nova/Metrics` directory.

```bash
php artisan nova:partition UsersPerPlan
```

--------------------------------

### Set Field Value Using `dependsOn`

Source: https://nova.laravel.com/docs/v4/resources/fields

Use `dependsOn` with the `setValue` method to automatically set a field's value based on another field's value. This example sets 'Updated At' to be 7 days after 'Created At'.

```php
use Laravel\Nova\Fields\DateTime;
use Laravel\Nova\Fields\FormData;
use Laravel\Nova\Http\Requests\NovaRequest;

DateTime::make('Created At'),

DateTime::make('Updated At')->dependsOn(['created_at'], function (DateTime $field, NovaRequest $request, FormData $form) {
    $field->setValue(Carbon::parse($form->created_at)->addDays(7));
}),
```

--------------------------------

### Set Custom Initial Path for Nova

Source: https://nova.laravel.com/docs/v4/installation

Define a specific string path to be loaded when Nova is first visited. This is typically done in the NovaServiceProvider's register method.

```php
use Laravel\Nova\Nova;

/**
 * Register any application services.
 *
 * @return void
 */
public function register()
{
    Nova::initialPath('/resources/users');

    // ...
}
```

--------------------------------

### Generate a Custom Nova Tool

Source: https://nova.laravel.com/docs/v4/customization/tools

Use the `nova:tool` Artisan command to generate a new custom tool. The tool name should follow the Composer `vendor/package` format. Nova will prompt for NPM dependency installation and asset compilation.

```bash
php artisan nova:tool acme/price-tracker
```

--------------------------------

### Compiling Assets for Development

Source: https://nova.laravel.com/docs/v4/customization/tools

Use the `npm run dev` command to compile your tool's assets for local development. This command is typically used with the `webpack.mix.js` configuration.

```bash
# Compile your assets for local development...
npm run dev
```

--------------------------------

### Access Request Resource IDs in `dependsOn`

Source: https://nova.laravel.com/docs/v4/resources/fields

Retrieve current resource and related resource IDs within a `dependsOn` closure using the `resource` method. This example adjusts validation rules for a 'Price' field based on the selected 'Book'.

```php
use Laravel\Nova\Fields\BelongsTo;
use Laravel\Nova\Fields\Currency;

BelongsTo::make(__('Books'), 'books', Book::class),

Currency::make('Price')
    ->dependsOn('books', function ($field, NovaRequest $request, $formData) {
        $bookId = (int) $formData->resource(Book::uriKey(), $formData->books);

        if ($bookId == 1) {
            $field->rules([
                'required', 'numeric', 'min:10', 'max:199'
            ])->help('Price starts from $10-$199');

            return;
        }

        $field->rules([
            'required', 'numeric', 'min:0', 'max:99'
        ])->help('Price starts from $0-$99');
    }),
```

--------------------------------

### Instantiate Custom Filter with `make`

Source: https://nova.laravel.com/docs/v4/customization/filters

Alternatively, use the `make` method to instantiate your custom filter. Any arguments passed to `make` will be forwarded to the filter's constructor.

```php
use Acme\AgeRange\AgeRange;

/**
 * Get the filters available for the resource.
 *
 * @param  \Laravel\Nova\Http\Requests\NovaRequest  $request
 * @return array
 */
public function filters(NovaRequest $request)
{
    return [
        AgeRange::make(),
    ];
}
```

--------------------------------

### Provide Custom Variables to Frontend with Nova::provideToScript

Source: https://nova.laravel.com/docs/v4/customization/frontend

Register custom variables in Nova's frontend config using Nova::provideToScript within a Nova::serving listener.

```php
use Laravel\Nova\Nova;
use Laravel\Nova\Events\ServingNova;

/**
 * Bootstrap any application services.
 *
 * @return void
 */
public function boot()
{
    Nova::serving(function (ServingNova $event) {
        Nova::provideToScript([
            'mail_driver' => config('mail.default'),
        ]);
    });
}
```

--------------------------------

### Toggle Field Visibility Using `dependsOn`

Source: https://nova.laravel.com/docs/v4/resources/fields

Dynamically show or hide fields based on the value of another field using `dependsOn` with the `show` and `hide` methods. This example hides the 'User' field unless 'Anonymous Comment' is false.

```php
use Laravel\Nova\Fields\BelongsTo;
use Laravel\Nova\Fields\Boolean;
use Laravel\Nova\Fields\FormData;
use Laravel\Nova\Http\Requests\NovaRequest;

Boolean::make('Anonymous Comment', 'anonymous')
    ->default(true),

BelongsTo::make('User')
    ->hide()
    ->rules('sometimes')
    ->dependsOn('anonymous', function (BelongsTo $field, NovaRequest $request, FormData $formData) {
        if ($formData->boolean('anonymous') === false) {
            $field->show()->rules('required');
        }
    }),
```

--------------------------------

### Generate New Users Progress Metric

Source: https://nova.laravel.com/docs/v4/metrics/defining-metrics

Use the `nova:progress` Artisan command to generate a new progress metric class. By default, new metrics are placed in the `app/Nova/Metrics` directory.

```bash
php artisan nova:progress NewUsers
```

--------------------------------

### Generate a Custom Nova Card

Source: https://nova.laravel.com/docs/v4/customization/cards

Use the `nova:card` Artisan command to generate a new custom card. The card name should follow the Composer `vendor/package` format. Nova will prompt for NPM dependency installation, asset compilation, and `composer.json` updates.

```bash
php artisan nova:card acme/analytics
```

--------------------------------

### Generate a New Resource Tool

Source: https://nova.laravel.com/docs/v4/customization/resource-tools

Use the `nova:resource-tool` Artisan command to generate a new custom resource tool. The tool name must follow the Composer `vendor/package` format. Nova will prompt for NPM dependency installation and asset compilation.

```bash
php artisan nova:resource-tool acme/stripe-inspector
```
Tokens:
Raw