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

    Interface CategoryDefinition

    Definição detalhada de uma categoria de cookie para uso interno.

    Types

    0.2.0

    Esta interface define a estrutura completa de uma categoria de cookies, incluindo metadados e configurações específicas para processamento e exibição na interface do usuário.

    // Categoria padrão da biblioteca
    const analyticsCategory: CategoryDefinition = {
      id: 'analytics',
      name: 'Cookies Analíticos',
      description: 'Utilizados para análise de uso do site',
      essential: false,
      cookies: ['_ga', '_ga_*', '_gid']
    };

    // Categoria customizada específica do projeto
    const chatCategory: CategoryDefinition = {
      id: 'chat',
      name: 'Chat de Suporte',
      description: 'Widget de chat para suporte ao cliente',
      essential: false
    };
    interface CategoryDefinition {
        cookies?: string[];
        cookiesInfo?: CookieDescriptor[];
        description: string;
        essential?: boolean;
        id: string;
        name: string;
    }
    Index

    Properties

    cookies? cookiesInfo? description essential? id name

    Properties

    cookies?: string[]

    Lista de nomes de cookies ou padrões específicos desta categoria.

    ['_ga', '_ga_*', '_gid']
    cookiesInfo?: CookieDescriptor[]

    Metadados detalhados sobre cookies típicos desta categoria. Não exaustivo; serve para orientar UI e documentação.

    description: string

    Descrição detalhada da finalidade da categoria.

    'Utilizados para análise de uso e comportamento no site'
    essential?: boolean

    Indica se é uma categoria essencial que não pode ser desabilitada pelo usuário.

    false
    id: string

    Identificador único da categoria.

    'analytics'
    name: string

    Nome amigável exibido na interface do usuário.

    'Cookies Analíticos'

    Settings

    Member Visibility

    On This Page

    Properties