Frameworks

Apprenez à contrôler PrivacyKit depuis JavaScript et à l'intégrer dans les frameworks populaires. Comprend le support TypeScript et des conseils pratiques pour React, Vue, Angular, Svelte et Next.js.

Sommaire


Contrôler PrivacyKit depuis JavaScript

Utilisez window.PrivacyKit pour lire le consentement, vérifier des expressions de consentement, ouvrir des boîtes de dialogue et écouter les changements de consentement. C'est utile lorsque votre application nécessite un contrôle programmatique, par exemple dans React, Vue ou en JavaScript pur.

JavaScript
const api = window.PrivacyKit;

api.onReady(() => {
  const consent = window.PrivacyKit.readConsent();
  const initialState = consent ? JSON.stringify(consent, null, 2) : "";
  console.log(initialState);
});

api.onConsentChanged((consent) => {
  const updatedState = consent ? JSON.stringify(consent, null, 2) : "";
  console.log(updatedState);
});

function handleOpenConsentDialogBtnClick() {
  api.openConsentDialog();
}

function handleOpenPrivacyPolicyDialogBtnClick() {
  api.openPrivacyPolicyDialog();
}

function handleToggleComplianceMonitorBtnClick() {
  api.toggleComplianceMonitor();
}

Support TypeScript

Améliorez l'expérience développeur avec l'autocomplétion, la sécurité de types et le support natif des web components PrivacyKit.

tsconfig.json

Avec les outils modernes (Next.js / Vite / TypeScript 5+), les fichiers .d.ts situés en dehors de src doivent être explicitement inclus pour être pris en compte par le compilateur.

{
  "include": ["src", "types/**/*.d.ts"]
}

Notes par framework

Recommandations spécifiques pour intégrer les custom elements PrivacyKit.

  • React : incluez le fichier de définitions TypeScript pour utiliser les web components PrivacyKit comme éléments natifs dans JSX.
  • Vue 3 : configurez compilerOptions.isCustomElement pour les balises PrivacyKit.
  • Angular : ajoutez CUSTOM_ELEMENTS_SCHEMA là où les custom elements sont utilisés.
  • Svelte : aucune configuration supplémentaire n'est requise à l'exécution.
Note pour Next.js
  • <consent-dialog> fonctionne dans les Server Components — placez-le directement dans votre layout.
  • Pour utiliser l'API JS (onConsentChanged, onReady, etc.), appelez-la dans useEffect au sein d'un composant 'use client'.