4ad88a327e
* feat: add GDPR cookie consent banner
Add a GDPR-compliant cookie consent banner that gates analytics (Google
Analytics) and functional cookies (comments) until user consent is given.
Features:
- Theme-consistent styling using CSS variables (light/dark mode)
- Settings panel with category toggles (necessary, analytics, functional)
- Consent stored in cookie for 365 days
- Google Analytics only loads after analytics consent
- Comments only load after functional consent
- Translations for all 32 supported languages
- Accessible with proper ARIA attributes and focus management
Configuration in hugo.yaml:
params:
cookies:
enabled: true
categories:
analytics: true
functional: true
When cookies.enabled is false, scripts load normally without consent gating.
Closes #412
* refactor: move consent-gated GA to cookies/analytics.html
Move Google Analytics consent logic to avoid shadowing Hugo's internal
`_internal/google_analytics.html` template.
Changes:
- Rename google_analytics.html → cookies/analytics.html
- Update head.html to conditionally load:
- cookies.enabled=true: cookies/analytics.html (consent-gated)
- cookies.enabled=false: Hugo's _internal/google_analytics.html
- Align cookies/analytics.html with Hugo's internal template:
- Support Privacy.GoogleAnalytics.Disable setting
- Support Privacy.GoogleAnalytics.RespectDoNotTrack setting
- Add UA- prefix deprecation warning
Note: Custom JS is required for consent-gated GA because Hugo templates
render at build time, but consent happens at runtime. We cannot call
Hugo's internal template after the user grants consent - we must
dynamically inject the GA script via JavaScript.
* style: indent cookies/analytics.html
* refactor: don't use default, put default configurations in params.toml
* fix: don't use `description` as translation key because it's reserved and will throw error
* fix: remove footer/components/custom-font.html call
* fix: banner showSettings key
* style: indent comments/include
* Add missing article.alert translation back
* style: format i18n toml files
* style: indent head/head.html
* style adjustment
* style: add missing -
* style: format demo/config/params.toml
* style: remove redundant comments from cookies.scss
* style: update box-shadow for cookie banner content
---------
Co-authored-by: delize <4028612+delize@users.noreply.github.com>
Co-authored-by: Jimmy Cai <jimmy@cai.im>
51 lines
2.1 KiB
HTML
51 lines
2.1 KiB
HTML
{{- if not site.Config.Privacy.GoogleAnalytics.Disable -}}
|
|
{{- with site.Config.Services.GoogleAnalytics.ID -}}
|
|
{{- if strings.HasPrefix (lower .) "ua-" -}}
|
|
{{- warnf "Google Analytics 4 (GA4) replaced Google Universal Analytics (UA) effective 1 July 2023. See https://support.google.com/analytics/answer/11583528. Create a GA4 property and data stream, then replace the Google Analytics ID in your site configuration with the new value." -}}
|
|
{{- else -}}
|
|
{{/* Consent-gated Google Analytics - only loads after analytics consent */}}
|
|
<script>
|
|
(function() {
|
|
var gaId = {{ . }};
|
|
var loaded = false;
|
|
var respectDNT = {{ site.Config.Privacy.GoogleAnalytics.RespectDoNotTrack }};
|
|
|
|
function loadGA() {
|
|
if (loaded) return;
|
|
|
|
// Respect Do Not Track browser setting if configured
|
|
if (respectDNT) {
|
|
var dnt = (navigator.doNotTrack || window.doNotTrack || navigator.msDoNotTrack);
|
|
if (dnt == "1" || dnt == "yes") {
|
|
return;
|
|
}
|
|
}
|
|
|
|
loaded = true;
|
|
|
|
var script = document.createElement('script');
|
|
script.async = true;
|
|
script.src = 'https://www.googletagmanager.com/gtag/js?id=' + gaId;
|
|
document.head.appendChild(script);
|
|
|
|
window.dataLayer = window.dataLayer || [];
|
|
function gtag(){dataLayer.push(arguments);}
|
|
gtag('js', new Date());
|
|
gtag('config', gaId);
|
|
}
|
|
|
|
window.addEventListener('onCookieConsentChange', function(e) {
|
|
if (e.detail && e.detail.analytics) {
|
|
loadGA();
|
|
}
|
|
});
|
|
|
|
if (window.cookieConsent && window.cookieConsent.hasConsent('analytics')) {
|
|
loadGA();
|
|
}
|
|
})();
|
|
</script>
|
|
{{- end -}}
|
|
{{- end -}}
|
|
{{- end -}}
|