Web SDK documentation
  1. Directives
  2. IfAllowedDirective

File

core/common/if-allowed.directive.ts

Description

A structural directive that conditionally includes a template only if the user has all or any of the roles passed as an input. By default the directive checks all roles:

Example :
<button *c8yIfAllowed="['ROLE_RECORD_DELETE', 'ROLE_ENTRY_DELETE']" (click)="delete()" title="Delete">
  Delete
</button>

To check if the user has any of the required roles to view the element you need to use the allowAny input:

Example :
<button *c8yIfAllowed="['ROLE_RECORD_DELETE', 'ROLE_ENTRY_DELETE']; allowAny: true" (click)="delete()" title="Delete">
  Delete
</button>

or use the shorter version

Example :
<button *c8yIfAllowed="['ROLE_RECORD_DELETE', 'ROLE_ENTRY_DELETE']; allowAny" (click)="delete()" title="Delete">
  Delete
</button>

Metadata

Selector [c8yIfAllowed]
Standalone true

Index

Methods
Inputs
Accessors

Constructor

constructor(template: TemplateRef, container: ViewContainerRef, permissions: Permissions)
Parameters :
Name Type Optional
template TemplateRef<any> No
container ViewContainerRef No
permissions Permissions No

Inputs

c8yIfAllowed
Type : string | []

One or many roles required for the element to be rendered
c8yIfAllowedAllowAny
Type : boolean

Switches to the mode where at least one of the provided roles is sufficient for the element to be rendered

Methods

ngOnInit
ngOnInit()
Returns : void

Accessors

c8yIfAllowed
setc8yIfAllowed(roleIds: string | string[])

One or many roles required for the element to be rendered

Parameters :
Name Type Optional
roleIds string | string[] No
Returns : void
c8yIfAllowedAllowAny
setc8yIfAllowedAllowAny(allowAny: boolean)

Switches to the mode where at least one of the provided roles is sufficient for the element to be rendered

Parameters :
Name Type Optional
allowAny boolean No
Returns : void

results matching ""

    No results matching ""