yassi/nova-custom-form

dev-master 2018-09-24 10:35 UTC

Requires

• laravel/nova: ~1.0

MIT

• Yasser Lahbibi

• framework
• nova
• laravel
• custom-form

README

This package allows you to define entirely customizable components for specific Nova Resources.

Installation

composer require yassi/nova-custom-form

Then you need to add the service provider to your config/app.php after the NovaServiceProvider:

 /*
    |--------------------------------------------------------------------------
    | Autoloaded Service Providers
    |--------------------------------------------------------------------------
    |
    | The service providers listed here will be automatically loaded on the
    | request to your application. Feel free to add your own services to
    | this array to grant expanded functionality to your applications.
    |
    */

    'providers' => [

        ...
        App\Providers\NovaServiceProvider::class,
        ...
        Yassi\NovaCustomForm\NovaCustomFormServiceProvider::class,
        ...

Once installed and registered, simply add the CustomFormTrait to your App\Nova\Resource:

namespace App\Nova;

use Laravel\Nova\Resource as NovaResource;
use Laravel\Nova\Http\Requests\NovaRequest;
use Yassi\NovaCustomForm\CustomFormTrait;

abstract class Resource extends NovaResource
{
   use CustomFormTrait;
    ...

Create a new form

This is exactly the same process as for any other Nova Tool, ResourceTool or Field. You can simply use that command in your terminal:

php artisan nova:form @vendor/package-name

This will create your form component in /nova-components/PackageName. If you've installed the dependencies during the previous process, you can directly go ahead and use:

cd /nova-components/PackageName && yarn watch

You can modify the Create and Edit components inside /nova-components/PackageName/resources/js/components as you like :)

Attach a new form to a resource

The CustomFormTrait adds a static method "form" to your resources and passes the current request as an argument. By default, that function returns null, meaning it will use the default Nova form. You just need to override that function and return a new instance of your custom form.

namespace App\Nova;

use Laravel\Nova\Fields\ID;
use Illuminate\Http\Request;
use Laravel\Nova\Fields\Text;
use Laravel\Nova\Fields\Gravatar;
use Laravel\Nova\Fields\Password;
use Vendor\PackageName\PackageName;

class User extends Resource
{
    ...
    
    /**
     * This method registers the custom form
     * to be used for the User resource.
     * 
     * @return PackageName
     */
    public static function form ($request) {
        return new PackageName;
    }
    

You can specify which user or which type of user get access to this custom form:

public static function form ($request) {
    return $request->user()->email === '[e-mail]' ? new PackageName : null;
}