rdarcy1 / nova-enum-field

An enum field for Laravel Nova

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

An enum field for Laravel Nova

Latest Version on Packagist Build Status MIT License Total Downloads

Laravel Nova field to add enums to resources. This field uses the BenSampo/laravel-enum package, so make sure to check out the installation instructions there first.

Screenshot of the enum field

Installation

You can install this package in a Laravel app that uses Nova via composer:

composer require simplesquid/nova-enum-field

Model Setup

This package requires that you use Attribute Casting in your models. From the docs at BenSampo/laravel-enum, this can be done like so:

use BenSampo\Enum\Tests\Enums\UserType;
use Illuminate\Database\Eloquent\Model;

class Example extends Model
{
    protected $casts = [
        'user_type' => UserType::class,
    ];
}

Usage

You can use the Enum field in your Nova resource like so:

namespace App\Nova;

use App\Enums\UserRole;
use SimpleSquid\Nova\Fields\Enum\Enum;

class User extends Resource
{
    // ...

    public function fields(Request $request)
    {
        return [
            // ...

            Enum::make('Role')->attachEnum(UserRole::class),

            // ...
        ];
    }
}

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email security@simplesquid.co.za instead of using the issue tracker.

Credits

Package skeleton based on spatie/skeleton-php.

About us

SimpleSquid is a small web development and design company based in Cape Town, South Africa.

License

The MIT License (MIT). Please see License File for more information.

About

An enum field for Laravel Nova

License:MIT License


Languages

Language:PHP 100.0%