Building a Next.js cookie consent banner

Mar 27, 2024

Posted by

On this page

To ensure compliance with privacy regulations like GDPR, you may need to ask for consent from users to track them using cookies. PostHog enables you to track users with or without cookies, but you need to set up the logic to ensure you are compliant both ways.

In this tutorial, we build a basic Next.js app, set up PostHog, build a cookie consent banner, and add the logic for users to opt-in or out of tracking cookies.

Don't want to bother with cookies at all? Here's how to use PostHog without cookie banners.

Create a Next.js app and add PostHog

First, once Node is installed, create a Next.js app. Run the command below, select No for TypeScript, Yes for use app router, and the defaults for every other option.

Terminal
npx create-next-app@latest cookie-banner

To add PostHog to our app, go into your app folder and create a providers.js file. Here we create a client-side PostHog provider that initializes in a useEffect using the project API key and instance address (get them from your project settings). Make sure to include the use client directive and the phInstance state (for future use). Altogether, this looks like this:

JavaScript
// app/providers.js
'use client'
import posthog from 'posthog-js'
import { PostHogProvider } from 'posthog-js/react'


export function PHProvider({ children }) {
  if (typeof window !== 'undefined') {
    posthog.init('<ph_project_api_key>', {
      api_host: 'https://us.i.posthog.com',
    })
  }
  return <PostHogProvider client={posthog}>{children}</PostHogProvider>
}

We can then import the PHProvider component from the provider.js file in our app/layout.js file, and wrap our app in it.

JavaScript
// app/layout.js
import { PHProvider } from './providers'


export default function RootLayout({ children }) {
  return (
    <html lang="en">
      <PHProvider>
        <body>{children}</body>
      </PHProvider>
    </html>
  )
}

After setting this up and running npm run dev, PostHog starts autocapturing events, but a PostHog-related cookie is set for the user without their consent.

Cookie set

Creating a cookie banner

Create another file in the app folder named banner.js for the banner component with a bit of text explaining cookies and buttons to accept or decline.

Importantly, to avoid a hydration error, we must check if the frontend has mounted and only show the component if so. We can use useState and useEffect to do this. Together, this looks like this:

JavaScript
// app/banner.js
'use client';
import { useEffect, useState } from "react";


export function Banner() {
  const [consentGiven, setConsentGiven] = useState('');


  useEffect(() => {
    // We want this to only run once the client loads
    // or else it causes a hydration error
    setConsentGiven('undecided');
  }, []);


  return (
    <div>
      {consentGiven === 'undecided' && (
        <div>
          <p>
            We use tracking cookies to understand how you use 
            the product and help us improve it.
            Please accept cookies to help us improve.
          </p>
          <button type="button">Accept cookies</button>
          <span> </span>
          <button type="button">Decline cookies</button>
        </div>
      )}
    </div>
  )
}

After creating this, we import the component into layout.js and set it up inside our PHProvider and body components:

JavaScript
import './globals.css'
import { PHProvider } from './providers'
import Banner from './banner'


export default function RootLayout({ children }) {
  return (
    <html lang="en">
      <PHProvider>
        <body>
          {children}
          <Banner />
        </body>
      </PHProvider>
    </html>
  )
}

This creates an ugly but functional cookie banner at the bottom of our site. You can customize and style it how you want.

Banner

Handling and storing user consent

Next, we add the logic to handle and store the user's consent. We do this in banner.js by adding handleAcceptCookies and handleDeclineCookies functions called when a user chooses to accept or decline cookies. We save this chioce to local storage.

We also add a cookieConsentGiven function that returns the user's consent state from local storage, which we call on first load. If there isn't a value in local storage, we set the consent state to undecided.

JavaScript
// app/banner.js
'use client';
import { useEffect, useState } from "react";


export function cookieConsentGiven() {
  if (!localStorage.getItem('cookie_consent')) {
    return 'undecided';
  }
  return localStorage.getItem('cookie_consent');
}


export default function Banner() {
  const [consentGiven, setConsentGiven] = useState('');


  useEffect(() => {
    // We want this to only run once the client loads
    // or else it causes a hydration error
    setConsentGiven(cookieConsentGiven());
  }, []);


  const handleAcceptCookies = () => {
    localStorage.setItem('cookie_consent', 'yes');
    setConsentGiven('yes');
  };


  const handleDeclineCookies = () => {
    localStorage.setItem('cookie_consent', 'no');
    setConsentGiven('no');
  };


  return (
    <div>
      {consentGiven === 'undecided' && (
        <div>
          <p>
            We use tracking cookies to understand how you use 
            the product and help us improve it.
            Please accept cookies to help us improve.
          </p>
          <button type="button" onClick={handleAcceptCookies}>Accept cookies</button>
          <span> </span>
          <button type="button" onClick={handleDeclineCookies}>Decline cookies</button>
        </div>
      )}
    </div>
  );
}

Controlling PostHog persistence based on consent

Now that we can ask for and store user consent, we can use this to control whether PostHog sets a cookie or not. There are 3 possible states:

  1. If the user hasn't made a consent choice, show the banner and initialize PostHog in memory mode.

  2. If the user declines consent, hide the banner and keep PostHog in memory mode.

  3. If the user accepts consent, hide the banner and switch PostHog to localStorage+cookie mode.

To start implementing this, we add a useEffect dependent on the consentGiven in banner.js to update the PostHog configuration based on the user's consent.

JavaScript
// app/banner.js
'use client';
import { useEffect, useState } from "react";
import { usePostHog } from "posthog-js/react";


export function cookieConsentGiven() {
  if (!localStorage.getItem('cookie_consent')) {
    return 'undecided';
  }
  return localStorage.getItem('cookie_consent');
}


export default function Banner() {
  const [consentGiven, setConsentGiven] = useState('');
  const posthog = usePostHog();


  useEffect(() => {
    // We want this to only run once the client loads
    // or else it causes a hydration error
    setConsentGiven(cookieConsentGiven());
  }, []);


  useEffect(() => {
    if (consentGiven !== '') {
      posthog.set_config({ persistence: consentGiven === 'yes' ? 'localStorage+cookie' : 'memory' });
    }
  }, [consentGiven]);


  const handleAcceptCookies = () => {
    localStorage.setItem('cookie_consent', 'yes');
    setConsentGiven('yes');
  };


  const handleDeclineCookies = () => {
    localStorage.setItem('cookie_consent', 'no');
    setConsentGiven('no');
  };


  return (
    <div>
      {consentGiven === 'undecided' && (
        <div>
          <p>
            We use tracking cookies to understand how you use 
            the product and help us improve it.
            Please accept cookies to help us improve.
          </p>
          <button type="button" onClick={handleAcceptCookies}>Accept cookies</button>
          <span> </span>
          <button type="button" onClick={handleDeclineCookies}>Decline cookies</button>
        </div>
      )}
    </div>
  );
}

To ensure, we initialize PostHog correctly on future loads, we also need to update providers.js to set the persistence config option based on the user's consent state. We can do this by reusing the cookieConsentGiven function.

JavaScript
// app/providers.js
'use client'
import posthog from 'posthog-js'
import { PostHogProvider } from 'posthog-js/react'
import { cookieConsentGiven } from './banner'


export function PHProvider({ children }) {
  if (typeof window !== 'undefined') {
    posthog.init('<ph_project_api_key>', {
      api_host: 'https://us.i.posthog.com',
      persistence: cookieConsentGiven() === 'yes' ? 'localStorage+cookie' : 'memory'
    })
  }
  return <PostHogProvider client={posthog}>{children}</PostHogProvider>
}

When users visit your site now, PostHog is initialized either with or without cookies based on their consent choice.

Consented with local storage

Further reading

Comments