Skip to content

Easy to use package to implement spatie's permission package into a inertia project.

License

Notifications You must be signed in to change notification settings

wijzijnweb/laravel-inertia-permissions

Repository files navigation

Implementing Spatie's Permissions package into Inertia Laravel project.

Easy to use package to implement Spatie's Permissions package into Inertia Laravel project. The package also includes a Vue components to display and edit the roles of the current user and to manage roles and permissions.

Installation

You can install the package via composer:

composer require wijzijnweb/laravel-inertia-permissions

You can publish and run the migrations with

php artisan migrate

Add the following to your vite.config.js file

resolve: {
    alias: {
        '@laravel-inertia-permissions': 'vendor/wijzijnweb/laravel-inertia-permissions/resources/js'
    }
}

Optionally, you can add the following to your jsconfig.json file:

{
    "compilerOptions": {
        "paths": {
            "@laravel-inertia-permissions/*": ["./vendor/wijzijnweb/laravel-inertia-permissions/resources/js/*"]
        }
    }
}

Usage

Permissions and Roles are automatically Shared with Inertia. You can access them in your Vue components like this:

import usePermissions from '@laravel-inertia-permissions/Uses/usePermissions.js';

const { can, is } = usePermissions()

if (can('edit articles')) {
    // do something
}

if (is('writer')) {
    // do something
}
import FormRoles from '@laravel-inertia-permissions/Components/FormRoles.vue';
import FormPermissions from '@laravel-inertia-permissions/Components/FormPermissions.vue';

<FormRoles v-model="form.roles" />
<FormPermissions v-model="form.permissions" />

You can also use the directives to hide specific elements. To that you need to register the directives in your app.js file:

import {
    hasRoleDirective,
    hasPermissionDirective
} from '@laravel-inertia-permissions/Directives/permissionDirective.js';

createApp({render: () => h(App, props)})
    .directive('hasRole', hasRoleDirective)
    .directive('hasPermission', hasPermissionDirective)

After that you can use the directives in your Vue components: You can use the pipe symbol and the ampersand to check for multiple roles or permissions:

 <MyComponent v-has-role="'admin|writer'" />
 <MyComponent v-has-permission="'edit articles&delete articles'" />

There is also a component to prevent the user from seeing something with a feedback message:

import HasPermission from '@laravel-inertia-permissions/Components/HasPermission.vue';

<HasPermission permission="edit articles" role="writer">
    <p>You can edit articles</p>
</HasPermission>

Changelog

Please see CHANGELOG for more information on what has changed recently.

Credits

License

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

About

Easy to use package to implement spatie's permission package into a inertia project.

Resources

License

Stars

Watchers

Forks

Packages

No packages published