A powerful access control system that provides role-based and permission-based UI management with session validation capabilities. Perfect for building secure applications with fine-grained access control.Documentation Index
Fetch the complete documentation index at: https://mintlify.com/fgrreloaded/rigidui/llms.txt
Use this file to discover all available pages before exploring further.
Installation
Usage
- Basic Setup
- Multiple Roles
- Conditional Styling
- Hook Usage
Features
Role-Based Control
Control UI elements based on user roles with support for single or multiple role requirements.
Permission Management
Fine-grained permission control with flexible role-to-permission mapping.
Session Validation
Automatic session validation with expiration checking and active status verification.
Multiple Display Modes
Choose between hiding, disabling, or showing fallback content for unauthorized access.
Conditional Wrappers
Apply different styling or layouts based on user access levels.
TypeScript Support
Full TypeScript support with comprehensive type definitions.
API Reference
UserSession
Unique user identifier
User email address
Username
Display name of the user
URL to user avatar image
Array of user roles
Array of user permissions
Additional user data
Whether the user account is active
Session expiration time
Last activity timestamp
Unique session identifier
AccessManagerProvider
Current user session data
Mapping of roles to their permissions
Global callback for unauthorized access attempts
AccessGate
Required roles for access
Required permissions for access
Whether all roles are required (AND vs OR)
Whether all permissions are required
Whether a valid session is required
How to handle unauthorized access
Content to show when access is denied
Callback when access is denied
Additional CSS classes for the container
CSS classes to apply when disabled
SessionGuard
Content to show when session is invalid
URL to redirect to when session expires
Callback when session expires
ConditionalWrapper
Required roles to check
Required permissions to check
Whether all roles are required
Whether all permissions are required
Whether a valid session is required
Wrapper component to apply when access is granted
Wrapper component to apply when access is denied
usePermissionCheck
A hook that returns a boolean indicating whether the user has the required permissions.Required roles to check
Required permissions to check
Whether all roles are required
Whether all permissions are required
Whether a valid session is required