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

    Interface ScriptIntegration

    Integração de script de terceiros condicionada a consentimento.

    Utils

    0.2.0

    Breaking Change em v0.4.1: O campo category mudou de Category para string para suportar categorias customizadas. Código existente usando strings literais continua funcionando sem alterações.

    const integration: ScriptIntegration = {
      id: 'my-script',
      category: 'analytics',
      src: 'https://example.com/script.js',
      cookies: ['_example'],
      init: () => console.log('Script initialized')
    }
    interface ScriptIntegration {
        async?: boolean;
        attrs?: Record<string, string>;
        bootstrap?: () => void | Promise<void>;
        category: string;
        config?: Record<string, unknown>;
        cookies?: string[];
        cookiesInfo?: {
            duration: string;
            name: string;
            provider: string;
            purpose: string;
        }[];
        defer?: boolean;
        id: string;
        init?: () => void;
        name?: string;
        nonce?: string;
        onConsentUpdate?: (
            consent: { consented: boolean; preferences: ConsentPreferences },
        ) => void;
        priority?: number;
        src: string;
    }
    Index

    Properties

    async? attrs? bootstrap? category config? cookies? cookiesInfo? defer? id init? name? nonce? onConsentUpdate? priority? src

    Properties

    async?: boolean

    Se o script deve ser carregado de forma assíncrona

    attrs?: Record<string, string>

    Atributos HTML adicionais para a tag script

    bootstrap?: () => void | Promise<void>

    Rotina opcional executada antes do carregamento principal (ex.: bootstrap de Consent Mode)

    category: string

    Categoria LGPD à qual o script pertence. Suporta tanto categorias predefinidas quanto customizadas.

    config?: Record<string, unknown>

    Configuração específica da integração

    cookies?: string[]

    Lista de cookies que o script pode definir

    cookiesInfo?: {
        duration: string;
        name: string;
        provider: string;
        purpose: string;
    }[]

    Informações detalhadas dos cookies (nome, finalidade, duração, fornecedor)

    defer?: boolean

    Se o script deve ser deferido

    id: string

    Identificador único da integração

    init?: () => void

    Função de inicialização executada após carregamento do script

    name?: string

    Nome legível da integração (opcional)

    nonce?: string

    Nonce CSP opcional aplicado à tag script

    onConsentUpdate?: (
        consent: { consented: boolean; preferences: ConsentPreferences },
    ) => void

    Callback disparado quando o consentimento é atualizado

    priority?: number

    Prioridade para ordenação na fila do loader (maior = executa primeiro dentro da categoria)

    src: string

    URL do script a ser carregado

    Settings

    Member Visibility

    On This Page

    Properties