README

Role and permission management UI for Spatie Laravel Permission with team support, built with Inertia and React.

Requirements

• PHP 8.3+
• Laravel 13+
• spatie/laravel-permission configured with team support (teams set to true)
• Inertia + React stack
• A Team model with a slug column as the route key

Installation

composer require aprendible/permission-ui

Publish config

php artisan vendor:publish --tag=permission-ui-config

Publish frontend pages (required)

php artisan vendor:publish --tag=permission-ui-resources

Configuration

The publishable config/permission-ui.php lets you configure:

Model Bindings

'models' => [
    'team' => App\Models\Team::class,
    'user' => App\Models\User::class,
    'membership' => App\Models\Membership::class,
],

The {team} route parameter is resolved using slug lookup on the configured team model.

Routes

'routes' => [
    'prefix' => 'settings/teams/{team}',
    'middleware' => ['web', 'auth', 'verified', \App\Http\Middleware\EnsureTeamMembership::class],
],

All routes are registered under this prefix with the given middleware stack.

Gate Abilities

'gates' => [
    'manage_roles' => 'updateMember',
    'manage_permissions' => 'update',
],

The package uses these gate names when authorizing actions. Your application must define them, typically via policies or Gate::define.

Routes

Usage Example

// In your AppServiceProvider or a policy
Gate::define('updateMember', function (User $user, Team $team) {
    return $team->members()
        ->where('user_id', $user->id)
        ->where('role', TeamRole::Owner->value)
        ->exists();
});

{{-- Navigation link to the roles page for the current team --}}
<a href="{{ route('permission-ui.roles.index', $currentTeam) }}">
    Roles
</a>

Gate Reference

Commands

permission-ui:make:permission

Create permissions for a new resource and register them in config:

# CRUD permissions (default: create, edit, delete, show)
php artisan permission-ui:make:permission Post

# Custom actions
php artisan permission-ui:make:permission Article --actions=create,edit,delete,publish,archive

Creates permissions like post:create, post:edit, etc., in the database and adds the resource to config/permission-ui.php under the resources key.

permission-ui:sync

Sync all permissions from config and enums to the database (idempotent):

php artisan permission-ui:sync

Run this on every deploy. It reads the resources array from config and ensures all permissions exist via findOrCreate.

Config reference

'resources' => [
    'post' => ['create', 'edit', 'delete', 'publish'],
    'category' => ['create', 'edit', 'delete'],
],

Once created, permissions appear automatically in the UI and can be assigned to roles from the role editor.

Development

composer install
php artisan test

License

MIT