https://github.com/kiritokatklian/nova-permission
A Laravel Nova tool for Spatie's laravel-permission library
https://github.com/kiritokatklian/nova-permission
laravel-nova laravel-nova-3 laravel-nova-4 nova permissions spatie-laravel spatie-laravel-permission
Last synced: 5 months ago
JSON representation
A Laravel Nova tool for Spatie's laravel-permission library
- Host: GitHub
- URL: https://github.com/kiritokatklian/nova-permission
- Owner: kiritokatklian
- License: mit
- Fork: true (vyuldashev/nova-permission)
- Created: 2022-02-17T11:24:21.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2025-11-09T22:20:52.000Z (8 months ago)
- Last Synced: 2026-01-14T14:35:48.395Z (5 months ago)
- Topics: laravel-nova, laravel-nova-3, laravel-nova-4, nova, permissions, spatie-laravel, spatie-laravel-permission
- Language: PHP
- Homepage: https://novapackages.com/packages/vyuldashev/nova-permission
- Size: 1.15 MB
- Stars: 78
- Watchers: 2
- Forks: 21
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# A Laravel Nova tool for Spatie's laravel-permission library
[](https://packagist.org/packages/kiritokatklian/nova-permission)
[](https://packagist.org/packages/kiritokatklian/nova-permission)
## Note
Credits to [vyuldashev](https://github.com/vyuldashev). Since the original package hasn't been updated for a while now and there's no sign from vyuldashev, I created this fork with all the latest changes. I use this mainly in my projects, but feel welcome to use it as well. PRs are also welcome.
## Version Compatibility
With the release of Nova 4.0, there are now two separate versions of Nova Permissions. Unfortuantly due to the nature of the update, the new one isn't backwards copmatible. So please choose your version accordingly.
| Laravel Nova | Nova Permission |
| :---: | :---: |
| 3.0 | 3.0 - 3.2.2 |
| 4.0 | 4.0 |
| 5.0 | 5.0 |
## Installation
You can install the package in to a Laravel project that uses [Nova](https://nova.laravel.com) via composer:
```bash
composer require kiritokatklian/nova-permission
```
Go through the [Installation](https://github.com/spatie/laravel-permission#installation) section in order to setup [laravel-permission](https://packagist.org/packages/spatie/laravel-permission).
Next up, you must register the tool with Nova. This is typically done in the `tools` method of the `NovaServiceProvider`.
```php
// in app/Providers/NovaServiceProvider.php
// ...
public function tools()
{
return [
// ...
\Vyuldashev\NovaPermission\NovaPermissionTool::make(),
];
}
```
Next, add middleware to `config/nova.php`
```php
// in config/nova.php
'middleware' => [
// ...
\Vyuldashev\NovaPermission\ForgetCachedPermissions::class,
],
```
Finally, add `MorphToMany` fields to you `app/Nova/User` resource:
```php
// ...
use Laravel\Nova\Fields\MorphToMany;
public function fields(Request $request)
{
return [
// ...
MorphToMany::make('Roles', 'roles', \Vyuldashev\NovaPermission\Role::class),
MorphToMany::make('Permissions', 'permissions', \Vyuldashev\NovaPermission\Permission::class),
];
}
```
Or if you want to attach multiple permissions at once, use `RoleBooleanGroup` and `PermissionBooleanGroup` fields (requires at least Nova 2.6.0):
```php
// ...
use Vyuldashev\NovaPermission\PermissionBooleanGroup;
use Vyuldashev\NovaPermission\RoleBooleanGroup;
public function fields(Request $request)
{
return [
// ...
RoleBooleanGroup::make('Roles'),
PermissionBooleanGroup::make('Permissions'),
];
}
```
If your `User` could have a single role at any given time, you can use `RoleSelect` field. This field will render a standard select where you can pick a single role from.
```php
// ...
use Vyuldashev\NovaPermission\PermissionBooleanGroup;
use Vyuldashev\NovaPermission\RoleSelect;
public function fields(Request $request)
{
return [
// ...
RoleSelect::make('Role', 'roles'),
];
}
```
## Customization
If you want to use custom resource classes you can define them when you register a tool:
```php
// in app/Providers/NovaServiceProvider.php
// ...
public function tools()
{
return [
// ...
\Vyuldashev\NovaPermission\NovaPermissionTool::make()
->roleResource(CustomRole::class)
->permissionResource(CustomPermission::class),
];
}
```
If you want to show your roles and policies with a custom label, you can set `$labelAttribute` when instantiating your fields:
```php
// ...
use Vyuldashev\NovaPermission\PermissionBooleanGroup;
use Vyuldashev\NovaPermission\RoleSelect;
public function fields(Request $request)
{
return [
// ...
RoleBooleanGroup::make('Roles', 'roles', null, 'description'),
PermissionBooleanGroup::make('Permissions', 'permissions', null, 'description'),
RoleSelect::make('Role', 'roles', null, 'description'),
];
}
```
## Define Policies
```php
// in app/Providers/NovaServiceProvider.php
// ...
public function tools()
{
return [
// ...
\Vyuldashev\NovaPermission\NovaPermissionTool::make()
->rolePolicy(RolePolicy::class)
->permissionPolicy(PermissionPolicy::class),
];
}
```
## Usage
A new menu item called "Permissions & Roles" will appear in your Nova app after installing this package.