react-lgpd-consent - v0.3.4
    Preparing search index...

    Interface ConsentPreferences

    Preferências de consentimento do usuário por categoria.

    Types

    0.1.0

    Contém o estado de consentimento para cada categoria ativa no projeto. A categoria 'necessary' está sempre presente e definida como true, pois cookies essenciais não podem ser desabilitados pelo usuário.

    • As chaves são determinadas pela configuração de enabledCategories no ConsentProvider
    • Categorias não habilitadas no projeto não aparecem no objeto
    • TypeScript infere automaticamente as chaves baseado na configuração
    • Estado é persistido no cookie e restaurado em novas sessões
    • true: Usuário consentiu explicitamente para a categoria
    • false: Usuário rejeitou explicitamente a categoria
    • Ausência da chave: Categoria não está habilitada no projeto
    • Use com ConsentScriptLoader para carregamento condicional
    • Estado é automaticamente reativo - mudanças atualizam scripts
    • Compatível com Google Analytics Enhanced Consent Mode
    • Suporta integração com ferramentas de tag management
    const preferences: ConsentPreferences = {
      necessary: true,    // Sempre true (cookies essenciais)
      analytics: false,   // Usuário rejeitou análise
      marketing: true     // Usuário aceitou marketing
    };

    function MyComponent() {
      const { preferences } = useConsent();

      return (
        <div>
          {preferences.analytics && <AnalyticsComponent />}
          {preferences.marketing && <PersonalizationEngine />}
          {preferences.functional && <ChatWidget />}
        </div>
      );
    }

    function hasConsentForFeature(preferences: ConsentPreferences): boolean {
      // Feature requer analytics OU marketing
      return preferences.analytics || preferences.marketing;
    }

    function hasFullConsent(preferences: ConsentPreferences): boolean {
      // Verificar se todas as categorias opcionais foram aceitas
      const optionalCategories = Object.keys(preferences).filter(key => key !== 'necessary');
      return optionalCategories.every(key => preferences[key] === true);
    }
    interface ConsentPreferences {
        necessary: boolean;
        [key: string]: boolean;
    }

    Indexable

    • [key: string]: boolean

      Estado de consentimento para outras categorias ativas no projeto. As chaves correspondem aos IDs das categorias configuradas.

    Index

    Properties

    necessary

    Properties

    necessary: boolean

    Categoria de cookies necessários - sempre presente e verdadeira. Cookies essenciais não podem ser desabilitados pelo usuário.

    Settings

    Member Visibility

    On This Page

    Comportamento DinâmicoValores e SignificadosIntegração com Scripts
    Properties