lupennat / nova-expandable-many
Laravel Nova - Expandable Many
Installs: 16 812
Dependents: 0
Suggesters: 0
Security: 0
Stars: 4
Watchers: 3
Forks: 4
Open Issues: 1
Language:Vue
Requires
- php: ^7.4|^8.0
- laravel/nova: >=4.32.6
Requires (Dev)
- friendsofphp/php-cs-fixer: ^3.16
README
Requirements
php: ^7.4 | ^8
laravel/nova: ^4
Installation
composer require lupennat/nova-expandable-many:^3.0
Usage
Register Trait HasExpandableMany
globally on Resources.
the Trait include an override of
indexFields
method, it call methodwithoutListableFieldsNotExpandable
instead ofwithoutListableFields
on FieldCollection; if you already register a custom ovveride ofindexFields
you can do it manually without using provided trait.
ExpandableMany Package automatically enable a new method expandable
for all Many Relationship Fields:
- BelongsToMany
- HasMany
- HasManyThrough
- MorphedByMany
- MorphMany
- MorphToMany
The relation table (without any custom actions and lenses) will be displayed as a collapsable row on the index page.
use Laravel\Nova\Fields\HasMany; use Laravel\Nova\Http\Requests\NovaRequest; class User extends Resource { use Lupennat\ExpandableMany\HasExpandableMany; public function fields(Request $request) { return [ HasMany::make('User Post', 'posts', Post::class)->expandable(); ]; } }
By Default expandable use Show
and Hide
as labels, you can change labels using meta
HasMany::make('User Post', 'posts', Post::class)->expandable() ->withMeta([ 'expandableShowLabel' => 'Custom Show', 'expandableHideLabel' => 'Custom Hide', ])
you can also define a custom HTML using
HasMany::make('User Post', 'posts', Post::class)->expandable() ->withMeta([ 'expandableShowHtml' => '<strong>Custom Show Html</strong>', 'expandableHideHtml' => '<strong>Custom Hide Html</strong>', ])
if both custom label and HTML are defined, HTML will be used
By Default expandable do not store on browser history any status, you can change it using meta
HasMany::make('User Post', 'posts', Post::class)->expandable() ->withMeta([ // 'expandableStoreStatus' => 'full', // will store status also for relationships 'expandableStoreStatus' => 'accordion', // will store status only for accordion 'expandableStoreStatus' => '', // will not store any status ])
Expandable can be skipped and an empty field is shown (by Default is false)
HasMany::make('User Post', 'posts', Post::class)->expandable() ->withMeta([ 'expandableSkip' => true, 'expandableSkipLabel' => '', // default is '—' ])
Expandable can disable standard actions (By Default is enabled)
HasMany::make('User Post', 'posts', Post::class)->expandable() ->withMeta([ 'expandableUseStandardActions' => false, // disable create/edit/view/delete/restore ])
Display Callback
Expandable Many will resolve a display callback foreach resource, you can use it to manipulate meta attributes dinamically.
HasMany::make('User Post', 'posts', Post::class) ->expandable(function(HasMany $field, $resource) { $resource->loadCount('posts'); $field->withMeta([ 'expandableShowLabel' => 'Show ' . $resource->posts_count, 'expandableSkip' => $resource->posts_count === 0 ]); })
By Default Expandable do not resolve relations, accessing a relationAttribute through the
$resource
will execute a query against database to load all related models.
Lens
If you want to use Expandable Many inside a Lens, you need to register also the trait HasExpandableManyLens
inside your Lens.
use Laravel\Nova\Fields\HasMany; use Laravel\Nova\Http\Requests\NovaRequest; use Laravel\Nova\Lenses\Lens; class UserLens extends Lens { use Lupennat\ExpandableMany\HasExpandableManyLens; public function fields(Request $request) { return [ HasMany::make('User Post', 'posts', Post::class)->expandable(); ]; } }
Credits
This package is based on the original idea from Nova Expandable Row