Skip to content

Interface: RbacPluginOptions ​

Defined in: packages/vue/src/plugin.ts:6

Extends ​

Properties ​

PropertyTypeDescriptionInherited fromDefined in
components?booleanRegister <Can> and <HasRole> globally. Default: true.-packages/vue/src/plugin.ts:10
directives?booleanRegister v-can and v-role globally. Default: true.-packages/vue/src/plugin.ts:8
globalProperties?booleanAdd $can, $canAny, $canAll, $hasRole, $hasAnyRole, $hasAllRoles, $rbac to templates. Default: true.-packages/vue/src/plugin.ts:12
loading?booleanStart in the loading state (snapshot still being fetched): <Can>, <HasRole>, v-can and v-role render nothing, not even the fallback or a not branch, until setSnapshot() is called. Every check (can, cannot, hasRole, ...) returns false meanwhile. Default: false.RbacStateOptions.loadingpackages/vue/src/state.ts:15
snapshot?RbacSnapshot | nullInitial snapshot, usually await rbac.for(user).snapshot() sent by the server. null = guest.RbacStateOptions.snapshotpackages/vue/src/state.ts:9
superAdminRoles?readonly string[]Roles that pass every permission check, like a Gate::before super-admin rule. Default: [].RbacStateOptions.superAdminRolespackages/vue/src/state.ts:19
wildcard?booleanMatch permissions with wildcard semantics (articles.* covers articles.edit). Default: false.RbacStateOptions.wildcardpackages/vue/src/state.ts:17

Released under the MIT License. Inspired by spatie/laravel-permission.