Interface AdvancedConsentTexts

Sistema de textos avançado com suporte a internacionalização e contextos específicos.

Interface expandida que permite personalização granular de todas as mensagens da biblioteca. Suporta múltiplos idiomas, contextos específicos (e-commerce, SaaS, governo), variações de tom, e compliance completo com LGPD/ANPD.

Since

0.4.1

Version

0.4.1 - Nova interface com suporte avançado a i18n e contextos

Example: Configuração multilíngue

const multiLangTexts: AdvancedConsentTexts = {
  // Herda de ConsentTexts básico
  bannerMessage: 'Utilizamos cookies para melhorar sua experiência.',
  acceptAll: 'Aceitar todos',
  declineAll: 'Recusar',
  preferences: 'Preferências',
  modalTitle: 'Preferências de Cookies',
  modalIntro: 'Personalize suas preferências de cookies.',
  save: 'Salvar',
  necessaryAlwaysOn: 'Cookies necessários (sempre ativos)',

  // Textos expandidos
  variants: {
    formal: {
      bannerMessage: 'Este sítio utiliza cookies para otimizar a experiência de navegação.',
      acceptAll: 'Concordar com todos os cookies'
    },
    casual: {
      bannerMessage: '🍪 Olá! Usamos cookies para tornar tudo mais gostoso aqui.',
      acceptAll: 'Aceitar tudo'
    }
  },

  // Internacionalização
  i18n: {
    en: {
      bannerMessage: 'We use cookies to enhance your experience.',
      acceptAll: 'Accept All',
      declineAll: 'Decline'
    },
    es: {
      bannerMessage: 'Utilizamos cookies para mejorar su experiencia.',
      acceptAll: 'Aceptar Todo',
      declineAll: 'Rechazar'
    }
  }
}

interface AdvancedConsentTexts {
    accept?: string;
    acceptAll: string;
    accessibility?: {
        bannerLabel?: string;
        keyboardNavigation?: string;
        liveRegion?: string;
        modalLabel?: string;
        toggleState?: { disabled?: string; enabled?: string };
    };
    bannerMessage: string;
    brandingPoweredBy?: string;
    cancel?: string;
    categories?: {
        analytics?: { description?: string; examples?: string; name?: string };
        functional?: { description?: string; examples?: string; name?: string };
        marketing?: { description?: string; examples?: string; name?: string };
        necessary?: { description?: string; examples?: string; name?: string };
        performance?: { description?: string; examples?: string; name?: string };
    };
    close?: string;
    confirm?: string;
    contactInfo?: string;
    contexts?: {
        ecommerce?: {
            cartAbandonment?: string;
            paymentSecurity?: string;
            personalizedOffers?: string;
            productRecommendations?: string;
        };
        education?: {
            accessibility?: string;
            learningAnalytics?: string;
            parentalConsent?: string;
            studentProgress?: string;
        };
        government?: {
            accessibility?: string;
            citizenServices?: string;
            dataProtection?: string;
            transparency?: string;
        };
        saas?: {
            customerSupport?: string;
            featureUsage?: string;
            performanceMonitoring?: string;
            userAnalytics?: string;
        };
    };
    controllerInfo?: string;
    cookieDetails?: {
        noCookies?: string;
        tableHeaders?: {
            duration?: string;
            name?: string;
            provider?: string;
            purpose?: string;
            type?: string;
        };
        toggleDetails?: { collapse?: string; expand?: string };
    };
    dataTypes?: string;
    declineAll: string;
    feedback?: {
        consentUpdated?: string;
        cookiesRejected?: string;
        saveError?: string;
        saveSuccess?: string;
        settingsReset?: string;
    };
    i18n?: {
        de?: Partial<Omit<ConsentTexts, "i18n" | "variants" | "contexts">>;
        en?: Partial<Omit<ConsentTexts, "i18n" | "variants" | "contexts">>;
        es?: Partial<Omit<ConsentTexts, "i18n" | "variants" | "contexts">>;
        fr?: Partial<Omit<ConsentTexts, "i18n" | "variants" | "contexts">>;
        it?: Partial<Omit<ConsentTexts, "i18n" | "variants" | "contexts">>;
    };
    lawfulBasis?: string;
    loading?: string;
    modalIntro: string;
    modalTitle: string;
    necessaryAlwaysOn: string;
    policyLink?: string;
    preferences: string;
    preferencesButton?: string;
    preferencesDescription?: string;
    preferencesTitle?: string;
    reject?: string;
    retentionPeriod?: string;
    save: string;
    technical?: {
        browserSettings?: string;
        disablingImpact?: string;
        persistentCookies?: string;
        sessionCookies?: string;
        thirdPartyCookies?: string;
    };
    thirdPartySharing?: string;
    transferCountries?: string;
    userRights?: string;
    variants?: {
        casual?: Partial<
            Pick<
                ConsentTexts,
                "bannerMessage"
                | "acceptAll"
                | "declineAll"
                | "modalTitle",
            >,
        >;
        concise?: Partial<
            Pick<
                ConsentTexts,
                "bannerMessage"
                | "acceptAll"
                | "declineAll"
                | "modalTitle",
            >,
        >;
        detailed?: Partial<
            Pick<
                ConsentTexts,
                "bannerMessage"
                | "acceptAll"
                | "declineAll"
                | "modalTitle",
            >,
        >;
        formal?: Partial<
            Pick<
                ConsentTexts,
                "bannerMessage"
                | "acceptAll"
                | "declineAll"
                | "modalTitle",
            >,
        >;
    };
}

Hierarchy (View Summary)

ConsentTexts
- AdvancedConsentTexts

Properties

`Optional`accept

accept?: string

(Opcional) Texto alternativo aceitar.

acceptAll

acceptAll: string

Texto do botão para aceitar todos os cookies.

`Optional`accessibility

accessibility?: {
    bannerLabel?: string;
    keyboardNavigation?: string;
    liveRegion?: string;
    modalLabel?: string;
    toggleState?: { disabled?: string; enabled?: string };
}

Labels ARIA e textos para leitores de tela

Type Declaration

OptionalbannerLabel?: string
Label do banner para leitores de tela
OptionalkeyboardNavigation?: string
Instrução de navegação por teclado
OptionalliveRegion?: string
Região live para anúncios dinâmicos
OptionalmodalLabel?: string
Label do modal para leitores de tela
OptionaltoggleState?: { disabled?: string; enabled?: string }
Estado do toggle de categoria

bannerMessage

bannerMessage: string

Mensagem principal exibida no banner de consentimento.

`Optional`brandingPoweredBy

brandingPoweredBy?: string

(Opcional) Texto "fornecido por".

`Optional`cancel

cancel?: string

Texto para cancelar ação

`Optional`categories

categories?: {
    analytics?: { description?: string; examples?: string; name?: string };
    functional?: { description?: string; examples?: string; name?: string };
    marketing?: { description?: string; examples?: string; name?: string };
    necessary?: { description?: string; examples?: string; name?: string };
    performance?: { description?: string; examples?: string; name?: string };
}

Textos específicos para cada categoria de cookie

`Optional`close

close?: string

(Opcional) Texto do botão fechar.

`Optional`confirm

confirm?: string

Texto para confirmar ação

`Optional`contactInfo

contactInfo?: string

(Opcional) Informações de contato do DPO.

`Optional`contexts

contexts?: {
    ecommerce?: {
        cartAbandonment?: string;
        paymentSecurity?: string;
        personalizedOffers?: string;
        productRecommendations?: string;
    };
    education?: {
        accessibility?: string;
        learningAnalytics?: string;
        parentalConsent?: string;
        studentProgress?: string;
    };
    government?: {
        accessibility?: string;
        citizenServices?: string;
        dataProtection?: string;
        transparency?: string;
    };
    saas?: {
        customerSupport?: string;
        featureUsage?: string;
        performanceMonitoring?: string;
        userAnalytics?: string;
    };
}

Textos otimizados para diferentes contextos

Type Declaration

Optionalecommerce?: {
    cartAbandonment?: string;
    paymentSecurity?: string;
    personalizedOffers?: string;
    productRecommendations?: string;
}
Contexto e-commerce
Optionaleducation?: {
    accessibility?: string;
    learningAnalytics?: string;
    parentalConsent?: string;
    studentProgress?: string;
}
Contexto educacional
Optionalgovernment?: {
    accessibility?: string;
    citizenServices?: string;
    dataProtection?: string;
    transparency?: string;
}
Contexto governamental
Optionalsaas?: {
    customerSupport?: string;
    featureUsage?: string;
    performanceMonitoring?: string;
    userAnalytics?: string;
}
Contexto SaaS

`Optional`controllerInfo

controllerInfo?: string

(Opcional) Informação sobre o controlador dos dados.

`Optional`cookieDetails

cookieDetails?: {
    noCookies?: string;
    tableHeaders?: {
        duration?: string;
        name?: string;
        provider?: string;
        purpose?: string;
        type?: string;
    };
    toggleDetails?: { collapse?: string; expand?: string };
}

Cabeçalhos para tabela de detalhes de cookies

Type Declaration

OptionalnoCookies?: string
Texto quando não há cookies para mostrar
OptionaltableHeaders?: {
    duration?: string;
    name?: string;
    provider?: string;
    purpose?: string;
    type?: string;
}
OptionaltoggleDetails?: { collapse?: string; expand?: string }
Botão para expandir/colapsar detalhes

`Optional`dataTypes

dataTypes?: string

(Opcional) Tipos de dados coletados.

declineAll

declineAll: string

Texto do botão para recusar todos os cookies.

`Optional`feedback

feedback?: {
    consentUpdated?: string;
    cookiesRejected?: string;
    saveError?: string;
    saveSuccess?: string;
    settingsReset?: string;
}

Mensagens de feedback ao usuário

Type Declaration

OptionalconsentUpdated?: string
Consentimento atualizado
OptionalcookiesRejected?: string
Cookies rejeitados
OptionalsaveError?: string
Erro ao salvar preferências
OptionalsaveSuccess?: string
Preferências salvas com sucesso
OptionalsettingsReset?: string
Configurações resetadas

`Optional`i18n

i18n?: {
    de?: Partial<Omit<ConsentTexts, "i18n" | "variants" | "contexts">>;
    en?: Partial<Omit<ConsentTexts, "i18n" | "variants" | "contexts">>;
    es?: Partial<Omit<ConsentTexts, "i18n" | "variants" | "contexts">>;
    fr?: Partial<Omit<ConsentTexts, "i18n" | "variants" | "contexts">>;
    it?: Partial<Omit<ConsentTexts, "i18n" | "variants" | "contexts">>;
}

Suporte a múltiplos idiomas

Type Declaration

Optionalde?: Partial<Omit<ConsentTexts, "i18n" | "variants" | "contexts">>
Textos em alemão
Optionalen?: Partial<Omit<ConsentTexts, "i18n" | "variants" | "contexts">>
Textos em inglês
Optionales?: Partial<Omit<ConsentTexts, "i18n" | "variants" | "contexts">>
Textos em espanhol
Optionalfr?: Partial<Omit<ConsentTexts, "i18n" | "variants" | "contexts">>
Textos em francês
Optionalit?: Partial<Omit<ConsentTexts, "i18n" | "variants" | "contexts">>
Textos em italiano

`Optional`lawfulBasis

lawfulBasis?: string

(Opcional) Base legal para o processamento.

`Optional`loading

loading?: string

Texto de carregamento

modalIntro

modalIntro: string

Texto introdutório do modal.

modalTitle

modalTitle: string

Título do modal de preferências.

necessaryAlwaysOn

necessaryAlwaysOn: string

Texto explicativo para cookies necessários.

`Optional`policyLink

policyLink?: string

(Opcional) Link para política de privacidade.

preferences

preferences: string

Texto do botão para abrir preferências.

`Optional`preferencesButton

preferencesButton?: string

(Opcional) Texto alternativo para botão de preferências.

`Optional`preferencesDescription

preferencesDescription?: string

(Opcional) Descrição do modal.

`Optional`preferencesTitle

preferencesTitle?: string

(Opcional) Título alternativo do modal.

`Optional`reject

reject?: string

(Opcional) Texto alternativo rejeitar.

`Optional`retentionPeriod

retentionPeriod?: string

(Opcional) Prazo de armazenamento dos dados.

save

save: string

Texto do botão para salvar preferências.

`Optional`technical

technical?: {
    browserSettings?: string;
    disablingImpact?: string;
    persistentCookies?: string;
    sessionCookies?: string;
    thirdPartyCookies?: string;
}

Informações técnicas sobre cookies

Type Declaration

OptionalbrowserSettings?: string
Como desabilitar cookies no navegador
OptionaldisablingImpact?: string
Impacto de desabilitar cookies
OptionalpersistentCookies?: string
Explicação sobre cookies persistentes
OptionalsessionCookies?: string
Explicação sobre cookies de sessão
OptionalthirdPartyCookies?: string
Explicação sobre cookies de terceiros

`Optional`thirdPartySharing

thirdPartySharing?: string

(Opcional) Compartilhamento com terceiros.

`Optional`transferCountries

transferCountries?: string

(Opcional) Países para transferência de dados.

`Optional`userRights

userRights?: string

(Opcional) Direitos do titular dos dados.

`Optional`variants

variants?: {
    casual?: Partial<
        Pick<
            ConsentTexts,
            "bannerMessage"
            | "acceptAll"
            | "declineAll"
            | "modalTitle",
        >,
    >;
    concise?: Partial<
        Pick<
            ConsentTexts,
            "bannerMessage"
            | "acceptAll"
            | "declineAll"
            | "modalTitle",
        >,
    >;
    detailed?: Partial<
        Pick<
            ConsentTexts,
            "bannerMessage"
            | "acceptAll"
            | "declineAll"
            | "modalTitle",
        >,
    >;
    formal?: Partial<
        Pick<
            ConsentTexts,
            "bannerMessage"
            | "acceptAll"
            | "declineAll"
            | "modalTitle",
        >,
    >;
}

Diferentes variações de tom para a mesma mensagem

Type Declaration

Optionalcasual?: Partial<
    Pick<
        ConsentTexts,
        "bannerMessage"
        | "acceptAll"
        | "declineAll"
        | "modalTitle",
    >,
>
Tom casual/amigável
Optionalconcise?: Partial<
    Pick<
        ConsentTexts,
        "bannerMessage"
        | "acceptAll"
        | "declineAll"
        | "modalTitle",
    >,
>
Tom conciso/direto
Optionaldetailed?: Partial<
    Pick<
        ConsentTexts,
        "bannerMessage"
        | "acceptAll"
        | "declineAll"
        | "modalTitle",
    >,
>
Tom detalhado/explicativo
Optionalformal?: Partial<
    Pick<
        ConsentTexts,
        "bannerMessage"
        | "acceptAll"
        | "declineAll"
        | "modalTitle",
    >,
>
Tom formal/profissional

Interface AdvancedConsentTexts

Category

Since

Version

Example: Configuração multilíngue

Hierarchy (View Summary)

Index

Properties

Properties

Optionalaccept

acceptAll

Optionalaccessibility

Type Declaration

OptionalbannerLabel?: string

OptionalkeyboardNavigation?: string

OptionalliveRegion?: string

OptionalmodalLabel?: string

OptionaltoggleState?: { disabled?: string; enabled?: string }

bannerMessage

OptionalbrandingPoweredBy

Optionalcancel

Optionalcategories

Optionalclose

Optionalconfirm

OptionalcontactInfo

Optionalcontexts

Type Declaration

Optionalecommerce?: { cartAbandonment?: string; paymentSecurity?: string; personalizedOffers?: string; productRecommendations?: string;}

Optionaleducation?: { accessibility?: string; learningAnalytics?: string; parentalConsent?: string; studentProgress?: string;}

Optionalgovernment?: { accessibility?: string; citizenServices?: string; dataProtection?: string; transparency?: string;}

Optionalsaas?: { customerSupport?: string; featureUsage?: string; performanceMonitoring?: string; userAnalytics?: string;}

OptionalcontrollerInfo

OptionalcookieDetails

Type Declaration

OptionalnoCookies?: string

OptionaltableHeaders?: { duration?: string; name?: string; provider?: string; purpose?: string; type?: string;}

OptionaltoggleDetails?: { collapse?: string; expand?: string }

OptionaldataTypes

declineAll

Optionalfeedback

Type Declaration

OptionalconsentUpdated?: string

OptionalcookiesRejected?: string

OptionalsaveError?: string

OptionalsaveSuccess?: string

OptionalsettingsReset?: string

Optionali18n

Type Declaration

Optionalde?: Partial<Omit<ConsentTexts, "i18n" | "variants" | "contexts">>

Optionalen?: Partial<Omit<ConsentTexts, "i18n" | "variants" | "contexts">>

Optionales?: Partial<Omit<ConsentTexts, "i18n" | "variants" | "contexts">>

Optionalfr?: Partial<Omit<ConsentTexts, "i18n" | "variants" | "contexts">>

Optionalit?: Partial<Omit<ConsentTexts, "i18n" | "variants" | "contexts">>

OptionallawfulBasis

Optionalloading

modalIntro

modalTitle

necessaryAlwaysOn

OptionalpolicyLink

preferences

OptionalpreferencesButton

OptionalpreferencesDescription

OptionalpreferencesTitle

Optionalreject

OptionalretentionPeriod

save

Optionaltechnical

Type Declaration

OptionalbrowserSettings?: string

OptionaldisablingImpact?: string

OptionalpersistentCookies?: string

OptionalsessionCookies?: string

OptionalthirdPartyCookies?: string

OptionalthirdPartySharing

OptionaltransferCountries

OptionaluserRights

Optionalvariants

Type Declaration

Optionalcasual?: Partial< Pick< ConsentTexts, "bannerMessage" | "acceptAll" | "declineAll" | "modalTitle", >,>

Optionalconcise?: Partial< Pick< ConsentTexts, "bannerMessage" | "acceptAll" | "declineAll" | "modalTitle", >,>

`Optional`accept

`Optional`accessibility

`Optional`bannerLabel?: string

`Optional`keyboardNavigation?: string

`Optional`liveRegion?: string

`Optional`modalLabel?: string

`Optional`toggleState?: { disabled?: string; enabled?: string }

`Optional`brandingPoweredBy

`Optional`cancel

`Optional`categories

`Optional`close

`Optional`confirm

`Optional`contactInfo

`Optional`contexts

`Optional`ecommerce?: {
cartAbandonment?: string;
paymentSecurity?: string;
personalizedOffers?: string;
productRecommendations?: string;
}

`Optional`education?: {
accessibility?: string;
learningAnalytics?: string;
parentalConsent?: string;
studentProgress?: string;
}

`Optional`government?: {
accessibility?: string;
citizenServices?: string;
dataProtection?: string;
transparency?: string;
}

`Optional`saas?: {
customerSupport?: string;
featureUsage?: string;
performanceMonitoring?: string;
userAnalytics?: string;
}

`Optional`controllerInfo

`Optional`cookieDetails

`Optional`noCookies?: string

`Optional`tableHeaders?: {
duration?: string;
name?: string;
provider?: string;
purpose?: string;
type?: string;
}

`Optional`toggleDetails?: { collapse?: string; expand?: string }

`Optional`dataTypes

`Optional`feedback

`Optional`consentUpdated?: string

`Optional`cookiesRejected?: string

`Optional`saveError?: string

`Optional`saveSuccess?: string

`Optional`settingsReset?: string

`Optional`i18n

`Optional`de?: Partial<Omit<ConsentTexts, "i18n" | "variants" | "contexts">>

`Optional`en?: Partial<Omit<ConsentTexts, "i18n" | "variants" | "contexts">>

`Optional`es?: Partial<Omit<ConsentTexts, "i18n" | "variants" | "contexts">>

`Optional`fr?: Partial<Omit<ConsentTexts, "i18n" | "variants" | "contexts">>

`Optional`it?: Partial<Omit<ConsentTexts, "i18n" | "variants" | "contexts">>

`Optional`lawfulBasis

`Optional`loading

`Optional`policyLink

`Optional`preferencesButton

`Optional`preferencesDescription

`Optional`preferencesTitle

`Optional`reject

`Optional`retentionPeriod

`Optional`technical

`Optional`browserSettings?: string

`Optional`disablingImpact?: string

`Optional`persistentCookies?: string

`Optional`sessionCookies?: string

`Optional`thirdPartyCookies?: string

`Optional`thirdPartySharing

`Optional`transferCountries

`Optional`userRights

`Optional`variants

`Optional`casual?: Partial<
Pick<
ConsentTexts,
"bannerMessage"
| "acceptAll"
| "declineAll"
| "modalTitle",
>,
>

`Optional`concise?: Partial<
Pick<
ConsentTexts,
"bannerMessage"
| "acceptAll"
| "declineAll"
| "modalTitle",
>,
>

`Optional`detailed?: Partial<
Pick<
ConsentTexts,
"bannerMessage"
| "acceptAll"
| "declineAll"
| "modalTitle",
>,
>

`Optional`formal?: Partial<
Pick<
ConsentTexts,
"bannerMessage"
| "acceptAll"
| "declineAll"
| "modalTitle",
>,
>