Skip to main content

PermissionGuard

PermissionGuard​

@vendure/dashboardpermission-guard.tsx
v3.4.0

This component is used to protect a route from unauthorized access. It will render the children if the user has the required permissions.

Example

<PermissionGuard requires={['UpdateTaxCategory']}>
    <Button type="submit">
        <Trans>Update</Trans>
    </Button>
</PermissionGuard>
Signature
function PermissionGuard(props: Readonly<PermissionGuardProps>): void

Parameters

props​

parameter
Readonly<PermissionGuardProps>

PermissionGuardProps​

@vendure/dashboardpermission-guard.tsx
v3.4.0

The props for the PermissionGuard component.

Signature
interface PermissionGuardProps {
    requires: Permission | string | string[] | Permission[];
    children: React.ReactNode;
}

requires​

property
Permission | string | string[] | Permission[]

The permission(s) required to access the children.

children​

property
React.ReactNode

The children to render if the user has the required permissions.