PermissionGuard

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

Was this chapter helpful?

Edited Apr 20, 2026·View source

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

Was this chapter helpful?

Edited Apr 20, 2026·View source

Example

Tsx

<PermissionGuard requires={['UpdateTaxCategory']}>    <Button type="submit">        <Trans>Update</Trans>    </Button></PermissionGuard>

Signature

function PermissionGuard(props: Readonly<PermissionGuardProps>): void

Parameters

parameterReadonly<PermissionGuardProps>

PermissionGuardProps

The props for the PermissionGuard component.

Signature

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

propertyPermission | string | string[] | Permission[]

The permission(s) required to access the children.

propertyReact.ReactNode

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