Skip to content

Turn cookie banner off (keep analytics running) #93

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
lksbrssr wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Turn cookie banner off (keep analytics running) #93

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions .env.example
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,11 @@ NEXT_PUBLIC_ADMIN_DID=did:plc:pgwr6hkosgznfl5nz7egajei
# Leave empty to disable Google Analytics. NEXT_PUBLIC_ prefix exposes it to the client.
NEXT_PUBLIC_GA_ID=

# Analytics cookie-consent banner. ON by default: the consent banner + footer
# "Cookie settings" link are shown and analytics only loads after the visitor
# agrees. Set to "off" to hide the banner and load analytics directly.
NEXT_PUBLIC_COOKIE_CONSENT=on
# Analytics cookie-consent banner. OFF by default: no banner is shown and
# analytics loads directly (cookies still set) when NEXT_PUBLIC_GA_ID is set.
# Set to "on" to show the consent banner + footer "Cookie settings" link and
# gate analytics on the visitor's choice (recommended for EU/UK).
NEXT_PUBLIC_COOKIE_CONSENT=off

# GraphQL indexer URL for org.plresearch.* records
# Default: https://api.hi.gainforest.app/graphql
Expand Down
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ These files are edited directly as JSON and consumed by hardcoded FA2 sub-pages
| `COOKIE_SECRET` | Yes | 32+ character secret for encrypting session cookies |
| `PUBLIC_URL` | No | Production URL (empty defaults to localhost) |
| `NEXT_PUBLIC_GA_ID` | No | Google Analytics 4 Measurement ID (empty disables analytics) |
| `NEXT_PUBLIC_COOKIE_CONSENT` | No | `off` hides the analytics consent banner + footer link and loads analytics directly; anything else (default) shows the consent banner |
| `NEXT_PUBLIC_COOKIE_CONSENT` | No | `on` shows the analytics consent banner + footer link and gates analytics on consent; anything else (default) hides the banner and loads analytics directly (cookies still set) |

## Deployment

Expand Down
9 changes: 5 additions & 4 deletions src/lib/cookie-consent.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
// Feature flag for the analytics cookie-consent banner + footer "Cookie
// settings" link.
//
// ON by default: the consent banner is shown and Google Analytics only loads
// after the visitor agrees. Set NEXT_PUBLIC_COOKIE_CONSENT=off to hide the
// banner and load analytics directly.
// OFF by default: no consent banner is shown and Google Analytics loads
// directly (cookies still set) whenever NEXT_PUBLIC_GA_ID is present. Set
// NEXT_PUBLIC_COOKIE_CONSENT=on to bring the consent banner back and gate
// analytics on the visitor's choice.
export const COOKIE_CONSENT_ENABLED =
process.env.NEXT_PUBLIC_COOKIE_CONSENT !== 'off'
process.env.NEXT_PUBLIC_COOKIE_CONSENT === 'on'