Skip to content

Interface: VueRbac ​

Defined in: packages/vue/src/state.ts:30

Client-side, reactive view of the current user's roles & permissions.

Every check reads reactive state, so calling it inside computed, a template or a render function re-runs when VueRbac.setSnapshot is called.

This is for UI only: the server must always enforce authorization.

Properties ​

PropertyModifierTypeDescriptionDefined in
loadingreadonlyReadonly<Ref<boolean>>true until the first setSnapshot() when created with loading: true (reactive).packages/vue/src/state.ts:34
snapshotreadonlyReadonly<Ref<DeepReadonly<RbacSnapshot>>>Current snapshot (read-only, reactive).packages/vue/src/state.ts:32

Methods ​

can() ​

ts
can(permission): boolean;

Defined in: packages/vue/src/state.ts:38

true if the user has the permission (or, for a list, ALL of them).

Parameters ​

ParameterType
permissionNameList

Returns ​

boolean


canAll() ​

ts
canAll(permissions): boolean;

Defined in: packages/vue/src/state.ts:41

Parameters ​

ParameterType
permissionsNameList

Returns ​

boolean


canAny() ​

ts
canAny(permissions): boolean;

Defined in: packages/vue/src/state.ts:40

Parameters ​

ParameterType
permissionsNameList

Returns ​

boolean


cannot() ​

ts
cannot(permission): boolean;

Defined in: packages/vue/src/state.ts:39

Parameters ​

ParameterType
permissionNameList

Returns ​

boolean


hasAllRoles() ​

ts
hasAllRoles(roles): boolean;

Defined in: packages/vue/src/state.ts:45

Parameters ​

ParameterType
rolesNameList

Returns ​

boolean


hasAnyRole() ​

ts
hasAnyRole(roles): boolean;

Defined in: packages/vue/src/state.ts:44

Parameters ​

ParameterType
rolesNameList

Returns ​

boolean


hasRole() ​

ts
hasRole(roles): boolean;

Defined in: packages/vue/src/state.ts:43

true if the user has the role, or ANY of the roles. Supports 'writer|editor'.

Parameters ​

ParameterType
rolesNameList

Returns ​

boolean


isSuperAdmin() ​

ts
isSuperAdmin(): boolean;

Defined in: packages/vue/src/state.ts:47

true if the user has one of the configured superAdminRoles.

Returns ​

boolean


setSnapshot() ​

ts
setSnapshot(snapshot): void;

Defined in: packages/vue/src/state.ts:36

Replaces the snapshot, e.g. after login (snapshot) or logout (null). Ends the loading state.

Parameters ​

ParameterType
snapshotRbacSnapshot | null

Returns ​

void

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