Plugin de Consentimiento de Cookies Orestbida

El Plugin de Consentimiento de Cookies Orestbida es una extensión para Grav CMS que te permite gestionar las cookies en tu sitio web utilizando la popular biblioteca JavaScript Cookie Consent de Orestbida. Este plugin proporciona un banner de consentimiento de cookies personalizable y compatible con el GDPR, permitiendo a los usuarios aceptar o rechazar las cookies según sus preferencias.

Instalación

La instalación del plugin de Consentimiento de Cookies Orestbida se puede realizar de tres maneras: utilizando el Gestor de Paquetes de Grav (GPM), instalación manual o a través del Plugin de Administración.

Instalación mediante GPM (Preferida)

Para instalar el plugin a través del Gestor de Paquetes de Grav (GPM), navega hasta la raíz de tu instalación de Grav usando tu terminal y ejecuta el siguiente comando:

BASH
bin/gpm install orestbida-cookie-consent

Esto instalará el plugin en el directorio /user/plugins de tu instalación de Grav. Los archivos del plugin se ubicarán en:

TXT
/your/site/grav/user/plugins/orestbida-cookie-consent

Instalación Manual

Para instalar el plugin manualmente, sigue estos pasos:

  1. Descarga la última versión del plugin desde GitHub.
  2. Extrae el archivo zip en el directorio /user/plugins de tu instalación de Grav.
  3. Renombra la carpeta extraída a orestbida-cookie-consent.

Los archivos del plugin deberían estar ahora en:

TXT
/your/site/grav/user/plugins/orestbida-cookie-consent

Instalación mediante el Plugin de Administración

Si estás utilizando el Plugin de Administración de Grav, puedes instalar el plugin de Consentimiento de Cookies Orestbida directamente desde el Panel de Administración:

  1. Navega a la sección Plugins en el Panel de Administración.
  2. Haz clic en el botón Add.
  3. Busca Orestbida Cookie Consent y haz clic en Install.

Configuración

Antes de configurar el plugin, debes copiar el archivo de configuración predeterminado desde:

TXT
user/plugins/orestbida-cookie-consent/orestbida-cookie-consent.yaml

a:

TXT
user/config/plugins/orestbida-cookie-consent.yaml

Luego, edita el archivo copiado para personalizar los ajustes del plugin. Si estás utilizando el Plugin de Administración, el archivo de configuración se creará automáticamente y se guardará en la carpeta user/config/plugins/ cuando guardes los ajustes.

Configuración Predeterminada

Aquí está la configuración predeterminada con explicaciones para cada opción:

YAML
enabled: true                  # Activar o desactivar el plugin.
cdn: true                      # Usar la CDN para cargar la biblioteca de Cookie Consent.
theme:                         # Elegir un tema para el banner de cookies (opciones: default, light-funky, dark-turquoise, elegant).

# Ajustes del Modal de Consentimiento
consent_layout:               # Diseño del modal de consentimiento (opciones: box, box_inline, box_wide, cloud, cloud_inline, bar, bar_inline).
consent_position:             # Posición del modal de consentimiento (opciones: top_center, top_left, top_right, bottom_center, bottom_left, bottom_right, middle_center, middle_left, middle_right).

# Ajustes del Modal de Preferencias
preferences_layout:           # Diseño del modal de preferencias (opciones: box, bar, bar_wide).
preferences_position:         # Posición del modal de preferencias (opciones: left, right).

# Categorías de Cookies
categories:
  necessary: true              # Activar la categoría "Necesarias" (siempre activa y no se puede desactivar).
  functionality: false         # Activar la categoría "Funcionalidad".
  analytics: false             # Activar la categoría "Analíticas".
  marketing: false             # Activar la categoría "Marketing".

# Ajustes Avanzados
autoshow: true  # Mostrar automáticamente el modal de consentimiento si el consentimiento no es válido.
show_delay: 3000 # Establecer el retraso en milisegundos antes de que se muestre el banner de consentimiento de cookies.
hideFromBots: false # Detiene la ejecución del plugin cuando se detecta un bot/rastreador, para evitar que indexen el contenido del modal.
disablePageInteraction: false # Crea una superposición oscura y bloquea el desplazamiento de la página hasta que se exprese el consentimiento.

# Idioma
language_autodetect: browser # Detectar automáticamente el idioma del visitante (opciones: browser, document, off).
translations: []             # Anulaciones opcionales por idioma de las traducciones integradas (ver "Soporte de Idiomas" más abajo).

autoshow y show_delay

  • autoshow se asigna directamente a la opción nativa autoShow de CookieConsent.
  • El plugin también llama a CookieConsent.show() después de show_delay milisegundos.
  • Esto significa que show_delay se aplica al momento de visualización controlado por el plugin.

Soporte de Idiomas

El banner detecta automáticamente el idioma del navegador del visitante (navigator.language) y muestra la traducción correspondiente, sin necesidad de configuración adicional ni trabajo de traducción manual. Esto se controla mediante la opción language_autodetect:

  • browser (predeterminado): usar el idioma del navegador del visitante.
  • document: usar el atributo <html lang="..."> de la página en su lugar.
  • off: mostrar siempre el idioma configurado/predeterminado del plugin (el comportamiento previo).

Si no hay una traducción disponible para el idioma detectado, el banner recurre al idioma predeterminado del sitio (el idioma activo actualmente en Grav).

Idiomas Integrados

El plugin incluye traducciones listas para usar del banner en 8 idiomas: inglés (en), alemán (de), francés (fr), español (es), italiano (it), neerlandés (nl), portugués (pt) y polaco (pl). No necesitas traducir nada tú mismo para dar soporte a visitantes en estos idiomas.

Personalizar una Traducción

Todo el texto del banner (título, descripción, botones, contenido de las secciones, ...) proviene de las traducciones integradas mencionadas anteriormente. Si deseas personalizar el texto para un idioma específico (por ejemplo, usar tu propia redacción para el título o los botones), añade una entrada bajo translations en el Panel de Administración (o en orestbida-cookie-consent.yaml) para ese idioma. Solo los campos que rellenes se sobrescriben; cualquier campo que dejes vacío conserva el texto integrado para ese idioma:

YAML
translations:
  - language: en
    consent_title: 'This website uses cookies'

Ya no existen los clásicos campos de contenido para un solo idioma en la configuración de este plugin; la lista translations anterior es la única forma de personalizar el texto del banner. Esto evita una fuente común de confusión: un valor introducido en un único campo anteriormente solo se aplicaba al idioma activo actual del sitio, por lo que silenciosamente no tenía efecto para los visitantes cuyo navegador resolvía a un idioma diferente (autodetectado).

Esto incluye consent_footer (por ejemplo, enlaces a tu aviso legal/política de privacidad): se establece por idioma dentro de una entrada de translations, igual que cualquier otro campo traducible. Si un idioma no tiene su propio pie de página, simplemente queda vacío; establácelo explícitamente para cada idioma que lo necesite.

YAML
translations:
  - language: en
    consent_footer: '<a href="/imprint">Imprint</a> <a href="/privacy">Privacy Policy</a>'
  - language: de
    consent_footer: '<a href="/impressum">Impressum</a> <a href="/datenschutz">Datenschutz</a>'

Idioma del Panel de Administración

Independientemente de las traducciones del propio banner, el formulario de configuración de este plugin en el Panel de Administración de Grav está traducido a los mismos 8 idiomas (en, de, fr, es, it, nl, pt, pl). Si el idioma de tu Panel de Administración está configurado en uno de estos, las etiquetas de los campos y el texto de ayuda del plugin se mostrarán en ese idioma en lugar de recurrir al inglés.

Uso

Una vez que el plugin esté instalado y configurado, el banner de consentimiento de cookies aparecerá automáticamente en tu sitio web. Los usuarios pueden interactuar con el banner para aceptar o rechazar las cookies según sus preferencias. El plugin soporta múltiples categorías de cookies, permitiéndote ofrecer un control granular sobre el uso de las cookies.

Personalización del Banner

Puedes personalizar la apariencia y el comportamiento del banner de consentimiento de cookies modificando las opciones de configuración en el archivo orestbida-cookie-consent.yaml. Por ejemplo:

  • Cambia el tema para que coincida con el diseño de tu sitio web.
  • Ajusta el diseño y la posición del modal de consentimiento.
  • Personaliza el texto de los botones, títulos y descripciones mediante las anulaciones de translations descritas en Soporte de Idiomas.

Añadir CSS Personalizado

Si necesitas una personalización adicional, puedes añadir tus propios estilos CSS sobrescribiendo los estilos predeterminados del plugin. Coloca tu CSS personalizado en un archivo e inclúyelo en tu tema de Grav.