Introduction
React bindings for Secured with a provider, lifecycle hooks, file helpers, vault access, and text review workflows.
@secured-ai/react wraps @secured-ai/core in a React-first API. It gives you a provider for sharing a PrivacyClient, hooks for detection and obfuscation workflows, and direct access to advanced features like vault context, file processing, and text review.
SDK access token required
React apps still initialize the underlying browser PrivacyClient. Create an SDK access token in Settings > SDK Access Tokens, add your allowed origins, and pass it with baseUrl before mounting SecuredProvider. See SDK Access Tokens.
What ships today
Provider + status
Mount a shared PrivacyClient and read readiness state inside React.
Text hooks
Detect, scan, obfuscate, restore, and manage sessions with composable hooks.
Vault + review
Use the vault subsystem and build human-in-the-loop review flows.
Quick start
Wire it into a form in a few minutes.
Package surface
@secured-ai/react currently exports:
SecuredProviderusePrivacyClientusePrivacyStatususeDetectuseScanuseObfuscateuseRestoreuseSessionsuseTextReviewuseFileDetectuseFileObfuscateuseVault
It also re-exports the PrivacyClient class and the main vault and string-matching utilities from @secured-ai/core, so app code can stay on one import surface when that is more convenient. See API Surface for the full export map.
When to use the React package
Use @secured-ai/react when you want React-friendly state handling around:
- shared client lifecycle
- loading and error state in components
- debounced scanning from inputs
- session-aware obfuscation and restoration across components
- file upload flows
- vault-aware replacement reuse in a React app
If you only need one-off imperative calls outside React, @secured-ai/core is still the underlying source of truth.