nova-dependency-container

by epartment

A Laravel Nova field container allowing to depend on other fields values

246 Stars 90 Forks Last release: 5 months ago (1.2.11) MIT License 100 Commits 23 Releases

Available items

No Items, yet!

The developer of this repository has not created any items for sale yet. Need a bug fixed? Help with integration? A different license? Create a request here:

Nova Field Dependency Container

Latest Version on Packagist Total Downloads License


Description

A container for grouping fields that depend on other field values. Dependencies can be set on any field type or value.


Demo

Demo


Versions

  • install v1.2.x for Laravel v5.8 or v6.x and Nova 2.x
  • install v1.1.2 for Laravel v5.7 and Nova v1.x


Installation

The package can be installed through Composer.

composer require epartment/nova-dependency-container


Usage

  1. Add the
    Epartment\NovaDependencyContainer\HasDependencies
    trait to your Nova Resource.
  2. Add the
    Epartment\NovaDependencyContainer\NovaDependencyContainer
    to your Nova Resource
    fields
    method.
class Page extends Resource
{
    use HasDependencies;

public function fields(Request $request)
{
    return [

        Select::make('Name format', 'name_format')->options([
            0 => 'First Name',
            1 => 'First Name / Last Name',
            2 => 'Full Name'
        ])->displayUsingLabels(),

        NovaDependencyContainer::make([
            Text::make('First Name', 'first_name')
        ])->dependsOn('name_format', 0),

    ];
}

}


Dependencies

The package supports four kinds of dependencies:

  1. ->dependsOn('field', 'value')
  2. ->dependsOnNot('field', 'value')
  3. ->dependsOnEmpty('field')
  4. ->dependsOnNotEmpty('field')
  5. ->dependsOnNullOrZero('field')

These dependencies can be combined by chaining the methods on the

NovaDependencyContainer
:
NovaDependencyContainer::make([
  // dependency fields
])
->dependsOn('field1', 'value1')
->dependsOnNotEmpty('field2')
->dependsOn('field3', 'value3')

The fields used as dependencies can be of any Laravel Nova field type. Currently only two relation field types are supported,

BelongsTo
and
MorphTo
.

Here is an example using a checkbox:

Demo


BelongsTo dependency

If we follow the example of a Post model belongsTo a User model, taken from Novas documentation BelongsTo, the dependency setup has the following construction.

We use the singular form of the

belongsTo
resource in lower case, in this example
Post
becomes
post
. Then we define in dot notation, the property of the resource we want to depend on. In this example we just use the
id
property, as in
post.id
.
BelongsTo::make('Post'),

NovaDependencyContainer::make([ Boolean::make('Visible') ]) ->dependsOn('post.id', 2)

When the

Post
resource with
id
2 is being selected, a
Boolean
field will appear.


BelongsToMany dependency

A BelongsToMany setup is similar to that of a BelongsTo.

The

dependsOn
method should be pointing to the name of the intermediate table. If it is called
role_user
, the setup should be
BelongsToMany::make('Roles')
    ->fields(function() {
        return [
            NovaDependencyContainer::make([
                // pivot field rules_all
                Boolean::make('Rules All', 'rules_all')
            ])
            ->dependsOn('role_user', 1)
        ]
    }),

If the pivot field name occurs multiple times, consider using custom intermediate table models and define it in the appropiate model relation methods. The only reliable solution I found was using mutators to get/set a field which was being used multiple times. Although this may seem ugly, the events which should be fired on the intermediate model instance, when using an Observer, would work unreliable with every new release of Nova.

If Nova becomes reliable firing eloquent events on the intermediate table, I will update this examples with a more elegant approach using events instead.

Here is an (ugly) example of a get/set mutator setup for an intermediate table using a pivot field called

type
.
// model User
class User ... { 

public function roles() { return $this->belongsToMany->using(RoleUser::class)->withPivot('rules_all'); }

}

// model Role class Role ... {

public function users() { return $this->belongsToMany->using(RoleUser::class)->withPivot('rules_all'); }

}

// intermediate table use Illuminate\Database\Eloquent\Relations\Pivot; class RoleUser extends Pivot {

protected $table 'role_user';

public function getType1Attribute() {
    return $this->type;
}

public function setType1Attribute($value) {
    $this->attributes['type'] = $value;
}

// ... repeat for as many types as needed

}

And now for the dependency container.

->fields(function() {
    return [
        NovaDependencyContainer::make([
            // pivot field rules_all
            Select::make('Type', 'type_1')
                ->options([ 
                    /* some options */ 
                ])
                ->displayUsingLabels()
        ])
        ->dependsOn('role_user', 1)
        ,

    NovaDependencyContainer::make([
        // pivot field rules_all
        Select::make('Type', 'type_2')
            ->options([ 
                /* different options */ 
            ])
            ->displayUsingLabels()
    ])
    ->dependsOn('role_user', 2)
    ,

    // .. and so on
]

}),


MorphTo dependency

A similar example taken from Novas documentation for MorphTo is called commentable. It uses 3 Models;

Comment
,
Video
and
Post
. Here
Comment
has the morphable fields
commentable_id
and
commentable_type

For a

MorphTo
dependency, the following construction is needed.

Commentable
becomes lower case
commentable
and the value to depend on is the resource singular form. In this example the dependency container will add two additional fields,
Additional Text
and
Visible
, only when the
Post
resource is selected.
MorphTo::make('Commentable')->types([
    Post::class,
    Video::class,
]),

NovaDependencyContainer::make([ Text::make('Additional Text', 'additional'), Boolean::make('Visible', 'visible') ]) ->dependsOn('commentable', 'Post')


License

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

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.