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

    Interface ConsentContextValue

    Valor do contexto de consentimento, incluindo estado e métodos de manipulação.

    Types

    0.1.0

    interface ConsentContextValue {
        acceptAll: () => void;
        closePreferences: () => void;
        consented: boolean;
        isModalOpen?: boolean;
        openPreferences: () => void;
        preferences: ConsentPreferences;
        rejectAll: () => void;
        resetConsent: () => void;
        setPreference: (cat: string, value: boolean) => void;
        setPreferences: (preferences: ConsentPreferences) => void;
    }
    Index

    Properties

    acceptAll closePreferences consented isModalOpen? openPreferences preferences rejectAll resetConsent setPreference setPreferences

    Properties

    acceptAll: () => void

    Aceita todas as categorias de consentimento.

    closePreferences: () => void

    Fecha o modal de preferências.

    consented: boolean

    Indica se o usuário consentiu.

    isModalOpen?: boolean

    Indica se o modal de preferências está aberto.

    openPreferences: () => void

    Abre o modal de preferências.

    preferences: ConsentPreferences

    Preferências atuais do usuário.

    rejectAll: () => void

    Rejeita todas as categorias de consentimento.

    resetConsent: () => void

    Reseta o consentimento do usuário.

    setPreference: (cat: string, value: boolean) => void

    Define a preferência para uma categoria específica. Suporta tanto categorias predefinidas quanto customizadas.

    Type Declaration

      • (cat: string, value: boolean): void

      • Parameters

        • cat: string

          ID da categoria (predefinida ou customizada)

        • value: boolean

          Valor do consentimento para a categoria

        Returns void

    v0.4.1: Parâmetro cat mudou de Category para string para suportar categorias customizadas. O uso com strings literais continua funcionando.

    // ✅ Continua funcionando (categorias predefinidas)
    setPreference('analytics', true)
    setPreference('marketing', false)

    // ✅ Novo: categorias customizadas
    setPreference('custom-tracking', true)
    setPreferences: (preferences: ConsentPreferences) => void

    Define múltiplas preferências de uma vez e salva.

    Settings

    Member Visibility

    On This Page

    Properties