@vox-pulse/react
v0.1.0
Published
VoxPulse SDK for React and Next.js
Maintainers
Readme
@vox-pulse/react
SDK Vox Pulse pour React et Next.js.
npm install @vox-pulse/reactRécupérez votre clé publique dans Vox Pulse → Dashboard → Paramètres (elle
commence par vpk_). Cette clé est conçue pour vivre dans le navigateur : elle
n'autorise que l'envoi de retours, jamais la lecture.
Utilisation
// main.tsx / app/layout.tsx
import { VoxPulseProvider } from "@vox-pulse/react";
<VoxPulseProvider
apiKey="vpk_..."
apiBase="https://votre-instance-vox-pulse"
user={{ email, plan, mrr }}
>
<App />
</VoxPulseProvider>// n'importe quel composant
import { useVoxPulse } from "@vox-pulse/react";
const { track, sendFeedback, identify } = useVoxPulse();Sur Next.js App Router, le provider est un composant client : placez-le dans un
fichier portant "use client".
apiBase
Passez toujours l'URL de votre instance Vox Pulse :
apiBase: "https://votre-instance-vox-pulse"Sans elle, le SDK ne sait pas où envoyer les retours.
Ce qui est transmis
À chaque retour : le titre et la description saisis, l'URL de la page (sans
query string ni fragment), le navigateur, l'OS, la taille de la fenêtre, et le
contexte utilisateur que vous avez fourni via identify().
Aucun cookie de votre application n'est transmis : les requêtes partent en
credentials: "omit".
Licence
MIT
