Getting Started
Installation
npm install @nis2shield/react-guard
# or
yarn add @nis2shield/react-guard
Requirements
- React 18.2.0 or higher
- React DOM 18.2.0 or higher
Basic Setup
Wrap your application with Nis2Provider to enable security
features:
import {
Nis2Provider,
SessionWatchdog,
AuditBoundary
} from '@nis2shield/react-guard';
function App() {
return (
<Nis2Provider
config={{
auditEndpoint: '/api/nis2/telemetry/',
idleTimeoutMinutes: 15,
debug: process.env.NODE_ENV === 'development'
}}
>
<AuditBoundary fallback={<ErrorPage />}>
<SessionWatchdog
onIdle={() => window.location.href = '/logout'}
/>
<YourApp />
</AuditBoundary>
</Nis2Provider>
);
}
Configuration Options
| Option | Type | Default | Description |
|---|---|---|---|
| auditEndpoint | string | required | URL to send telemetry reports |
| idleTimeoutMinutes | number | 15 | Minutes before idle timeout |
| debug | boolean | false | Enable console logging |