novius/laravel-nova-contexts

A Laravel Nova tool to manage resources's contexts.

2.0.0 2022-06-14 08:30 UTC

Requires

• php: >=8.0
• laravel/nova: ^4.0

Requires (Dev)

• friendsofphp/php-cs-fixer: ^3.8

AGPL-3.0-or-later

• nova
• laravel
• contexts

README

This package allows you to manage resource contexts.

It provides :

• Default context choice during back-office navigation (on nova card).
• Context filter bases on default context.
• Context field for resources.

Requirements

• PHP >= 8.0
• Laravel Nova >= 4.0

NOTE: These instructions are for Laravel Nova >= 4.0. If you are using prior version, please see the previous version's docs.

Installation

composer require novius/laravel-nova-contexts

Configuration

Some options that you can override are available.

php artisan vendor:publish --provider="Novius\LaravelNovaContexts\LaravelNovaContextsServiceProvider" --tag="config"

Context selector

A card is available to navigate between contexts. You can easily add it to custom resource index.

<?php

namespace App\Models;

use Laravel\Nova;
use Novius\LaravelNovaContexts\LaravelNovaContexts;

class Page extends Resource
{
    // Some resources definitions...
    
    public function cards(Request $request)
    {
        return [
            (new LaravelNovaContexts())->dynamicHeight(),
        ];
    }
}

Models configuration

To make a model "contextable", just use HasContext trait.

<?php

namespace App\Models;

use Illuminate\Database\Eloquent\Model;
use Novius\LaravelNovaContexts\Traits\HasContext;

class Page extends Model
{
    use HasContext;

    /**
     * @return string
     */
    public function contextFieldName(): string
    {
        return 'locale';
    }
}

Nova resource field configuration

You can add context field to your Nova resource's fields:

public function fields(Request $request)
{
    return [
        // ...
        
        ContextField::make('locale'),
        
        // ...
    ];
}

Nova resource filter configuration

You can add context filter to your Nova resource's filters :

/**
 * Get the filters available for the resource.
 *
 * @param \Illuminate\Http\Request $request
 * @return array
 */
public function filters(Request $request)
{
    return [
        new ContextFilter($this->model()),
    ];
}

Lint

Run php-cs with:

composer run-script lint

Contributing

Contributions are welcome!

Leave an issue on Github, or create a Pull Request.

Licence

This package is under GNU Affero General Public License v3 or (at your option) any later version.