@use-cookie-consent/react

useCookieConsent hook for React.js

Headless state management for GDPR cookie consent

• Headless - bring your own styles, we will provide the logic.
• Hook-based - extremely intuitive for React developers.
• React Context support - wrap your app in a provider and synchronse UI updates across the app.
• Tiny - less than 2kB gzipped.

Description

This package provides a wrapper around @use-cookie-consent/core package to provide best experience for React applications. Namely, it provides a React context, which provides all the functionality of core package but with reactive updates.

Installation

npm install @use-cookie-consent/react

or

yarn add @use-cookie-consent/react

Usage

Basic usage

The first step to this setup is to wrap your app in the CookieConsentProvider:

import { CookieConsentProvider } from '@use-cookie-consent/react'

export default function App() {
  return {
    <CookieConsentProvider>
      ...
    </CookieConsentProvider>
  }
}

Then you can read and update the cookie consent data from any component which is inside of the <CookieConsentProvider>. Both components you see below are not connected to each other in any way except the useCookieConsentContext function. You would put both of them separately somewhere in your app WITHOUT connecting them by any callbacks or passing state through props.

// This component is an example of a component that you use to
// accept/decline cookie consent, without reading any data.
const CookieBanner = () => {
  const { acceptAllCookies, declineAllCookies, acceptCookies } =
    useCookieConsentContext();

  return (
    <div>
      <button onClick={acceptAllCookies}>Accept all</button>
      <button onClick={() => acceptCookies({ thirdParty: true })}>
        Accept third-party
      </button>
      <button onClick={() => acceptCookies({ firstParty: true })}>
        Accept first-party
      </button>
      <button onClick={declineAllCookies}>Reject all</button>
    </div>
  );
};

// This component is an example of a component which would show
// the state of the cookie consent, without updating anything.
const CookiesPreview = () => {
  const { consent } = useCookieConsentContext();

  return (
    <div>
      <div>
        {`Third-party cookies ${consent.thirdParty ? 'approved' : 'rejected'}`}
      </div>
      <div>
        {`First-party cookies ${consent.firstParty ? 'approved' : 'rejected'}`}
      </div>
    </div>
  );
};

Thanks to @pixelass for prividing the examples you see above.

Contributors

• Antoni Silvestrovic
• Gregor Adams

Discussions and Questions

For non-issues please consider joining our Discord here!

License

MIT