ahmedsaoud31/laravel-permission-to-vuejs

Laravel Permission Package To Use it in VueJs

dev-master 2024-09-27 12:58 UTC

Requires

• spatie/laravel-permission: >=2.0

MIT

• Ahmed Abeoelsaoud

README

Update: now support Vue 3

npm package

Composer package

After installed you can do like this in Vuejs:

<div v-if="can('edit post')">
  <!-- Edit post form -->
</div>

<div v-if="is('super-admin')">
  <!-- Show admin tools -->
</div>

<!-- you can use OR operator -->
<div v-if="can('edit post | delete post | publish post')">
  <!-- Do something -->
</div>

<div v-if="is('editor | tester | user')">
  <!-- Do something -->
</div>

<!-- you can use AND operator -->
<div v-if="can('edit post & delete post & publish post')">
  <!-- Do something -->
</div>

<div v-if="is('editor & tester & user')">
  <!-- Do something -->
</div>

If you need to use it in <script> or <script setup> tag

<script setup>
  import { is, can } from 'laravel-permission-to-vuejs'
  
  if(is('super-admin')){
    // do admin actions
  }
	
  if(can('edit post')){
    // do edit post action
  }
</script>

This package require to use laravel-permission

Installation

PHP side

composer require ahmedsaoud31/laravel-permission-to-vuejs=dev-master

JavaScript side VueJs 3

npm i laravel-permission-to-vuejs

JavaScript side VueJs 2

npm i laravel-permission-to-vuejs@2.0.5

Config

First, add the LaravelAndVueJS\Traits\LaravelPermissionToVueJS trait to your User model(s):

use LaravelAndVueJS\Traits\LaravelPermissionToVueJS;

// Spatie package
use Spatie\Permission\Traits\HasRoles;

class User extends Authenticatable
{
    use LaravelPermissionToVueJS;
    
    // Spatie package
    use HasRoles;

    // ...
}

Second, add and use the laravel-permission-to-vuejs plugin in app.js file:

import { createApp } from 'vue'
import LaravelPermissionToVueJS from 'laravel-permission-to-vuejs'
import App from './components/App.vue'
const app = createApp(App)
app.use(LaravelPermissionToVueJS)
app.mount('#app')

Third, pass permissions from Laravel To Vuejs, in HTML header add this code:

<script type="text/javascript">
    window.Laravel = {
        csrfToken: "{{ csrf_token() }}",
        jsPermissions: {!! auth()->check()?auth()->user()->jsPermissions():0 !!}
    }
</script>

If you need to update roles and permission or reload user authintaction after switch user without reload the application, You can use reloadRolesAndPermissions() function

// in component
<script>
    import { reloadRolesAndPermissions } from 'laravel-permission-to-vuejs'

    // after your event call reloadRolesAndPermissions() function
    reloadRolesAndPermissions()
</script>

License

The MIT License (MIT).