rcc
4.7/53
react-cookie-consent
npm i react-cookie-consent
rcc

react-cookie-consent

A small, simple and customizable cookie consent bar for use in React applications.

by Rick van Lieshout

8.0.1 (see all)License:MITTypeScript:Built-In
npm i react-cookie-consent
Readme

🍪 react-cookie-consent 🍪

A small, simple and customizable cookie consent bar for use in React applications.

NPM

Demo: https://mastermindzh.github.io/react-cookie-consent/

Example branch: https://github.com/Mastermindzh/react-cookie-consent/tree/example

Downloads Dependent repos (via libraries.io) GitHub contributors Minified size npm type definitions license-mit

Default look

default look

Table of contents

Installation

npm install react-cookie-consent

or use yarn:

yarn add react-cookie-consent

Using it

You can import the cookie bar like this:

import CookieConsent from "react-cookie-consent";

If you want to set/remove cookies yourself you can optionally import Cookies (straight from js-cookie) like this:

import CookieConsent, { Cookies } from "react-cookie-consent";

Then you can use the component anywhere in your React app like so:

<CookieConsent>This website uses cookies to enhance the user experience.</CookieConsent>

You can optionally set some props like this (next chapter will show all props):

<CookieConsent
  location="bottom"
  buttonText="Sure man!!"
  cookieName="myAwesomeCookieName2"
  style={{ background: "#2B373B" }}
  buttonStyle={{ color: "#4e503b", fontSize: "13px" }}
  expires={150}
>
  This website uses cookies to enhance the user experience.{" "}
  <span style={{ fontSize: "10px" }}>This bit of text is smaller :O</span>
</CookieConsent>

One of the props (onAccept) is a function, this function will be called after the user has clicked the accept button. It is called with an object containing a boolean property acceptedByScrolling to indicate if the acceptance was triggered by the user scrolling You can provide a function like so:

<CookieConsent
  onAccept={(acceptedByScrolling) => {
    if (acceptedByScrolling) {
      // triggered if user scrolls past threshold
      alert("Accept was triggered by user scrolling");
    } else {
      alert("Accept was triggered by clicking the Accept button");
    }
  }}
></CookieConsent>

If the decline button is enabled then the (onDecline) prop function can be used, this function will be called after the user has clicked the decline button. You can enable the button and provide a function like so:

<CookieConsent
  enableDeclineButton
  onDecline={() => {
    alert("nay!");
  }}
></CookieConsent>

getting the cookies value in your own code

react-cookie-consent exports a function called getCookieConsentValue. You can use it in your own code like so:

import CookieConsent, { Cookies, getCookieConsentValue } from "react-cookie-consent";

console.log(getCookieConsentValue());

reset the cookies value in your own code

react-cookie-consent exports a function called resetCookieConsentValue. You can use it in order to remove cookie in client-site:

import CookieConsent, { Cookies, resetCookieConsentValue } from "react-cookie-consent";

console.log(resetCookieConsentValue());

That option would be interesting if you want to allow user to change their consent. If you want to show again the consent bar, you must force "visible" prop to show again the bar.

Props

PropTypeDefault valueDescription
locationstring, "top", "bottom" or "none""bottom"Syntactic sugar to easily enable you to place the bar at the top or the bottom of the browser window. Use "none" to disable.
visiblestring, "show", "hidden" or "byCookieValue""byCookieValue"Force the consent bar visibility. If "byCookieValue", visibility are defined by cookie consent existence.
childrenstring or React componentContent to appear inside the bar
disableStylesbooleanfalseIf enabled the component will have no default style. (you can still supply style through props)
hideOnAcceptbooleantrueIf disabled the component will not hide it self after the accept button has been clicked. You will need to hide yourself (see onAccept)
buttonTextstring or React component"I understand"Text to appear on the button
declineButtonTextstring or React component"I decline"Text to appear on the decline button
cookieNamestring"CookieConsent"Name of the cookie used to track whether the user has agreed.
cookieValuestring or boolean or numbertrueValue to be saved under the cookieName.
declineCookieValuestring or boolean or numberfalseValue to be saved under the cookieName when declined.
setDeclineCookiebooleantrueWhether to set a cookie when the user clicks "decline"
onAcceptfunction() => {}Function to be called after the accept button has been clicked.
onDeclinefunction() => {}Function to be called after the decline button has been clicked.
debugbooleanundefinedBar will be drawn regardless of cookie for debugging purposes.
expiresnumber365Number of days before the cookie expires.
extraCookieOptionsobject{}Extra info (apart from expiry date) to add to the cookie
overlaybooleanfalseWhether to show a page obscuring overlay or not.
containerClassesstring""CSS classes to apply to the surrounding container
buttonClassesstring""CSS classes to apply to the button
buttonWrapperClassesstring""CSS classes to apply to the div wrapping the buttons
customButtonWrapperAttributesReact.HTMLAttributes<HTMLDivElement>{}Allows you to set custom (data) attributes on the button wrapper div
declineButtonClassesstring""CSS classes to apply to the decline button
buttonIdstring""Id to apply to the button
declineButtonIdstring""Id to apply to the decline button
contentClassesstring""CSS classes to apply to the content
overlayClassesstring""CSS classes to apply to the surrounding overlay
styleobjectlook at sourceReact styling object for the bar.
buttonStyleobjectlook at sourceReact styling object for the button.
declineButtonStyleobjectlook at sourceReact styling object for the decline button.
contentStyleobjectlook at sourceReact styling object for the content.
overlayStyleobjectlook at sourceReact styling object for the overlay.
disableButtonStylesbooleanfalseIf enabled the button will have no default style. (you can still supply style through props)
enableDeclineButtonbooleanfalseIf enabled the decline button will be rendered
flipButtonsbooleanfalseIf enabled the accept and decline buttons will be flipped
ButtonComponentReact componentbuttonReact Component to render as a button.
sameSitestring, "strict", "lax" or "none"noneCookies sameSite attribute value
cookieSecuritybooleanundefinedCookie security level. Defaults to true unless running on http.
ariaAcceptLabelstringAccept cookiesAria label to set on the accept button
ariaDeclineLabelstringDecline cookiesAria label to set on the decline button
acceptOnScrollbooleanfalseDefines whether "accept" should be fired after the user scrolls a certain distance (see acceptOnScrollPercentage)
acceptOnScrollPercentagenumber25Percentage of the page height the user has to scroll to trigger the accept function if acceptOnScroll is enabled
customContentAttributesobject{}Allows you to set custom (data) attributes on the content div
customContainerAttributesobject{}Allows you to set custom (data) attributes on the container div
onOverlayClickfunction() => {}allows you to react to a click on the overlay
acceptOnOverlayClickbooleanfalseDetermines whether the cookies should be accepted after clicking on the overlay
customButtonPropsobject{}Allows you to set custom props on the button component
customDeclineButtonPropsobject{}Allows you to set custom props on the decline button component

Debugging it

Because the cookie consent bar will be hidden once accepted, you will have to set the prop debug={true} to evaluate styling changes:

<CookieConsent debug={true}></CookieConsent>

Note: Don't forget to remove the debug-property for production.

Why are there two cookies? One of which named "Legacy"

The short story is that some browsers don't support the SameSite=None attribute. The modern browsers force you to have SameSite set to something other than none.

So react-cookie-consent fixes this like so:

  • set the fallback cookie (e.g -legacy) first, this will always succeed (on all browsers)
  • set the correct cookie second (this will work on modern browsers, fail on older ones)

This happens on lines 29-37

When checking the cookie it'll do it in reverse. If the regular cookie exists, it'll use that. If no regular cookie exists it'll check whether the legacy cookie exists. If both are non-existent no consent was given.

The long story can be found here: pull-request#68

Styling it

You can provide styling for the bar, the button and the content. Note that the bar has a display: flex property as default and is parent to its children "content" and "button".

The styling behaves kind of responsive. The minimum content width has been chosen to be "300px" as a default value. If the button does not fit into the same line it is wrapped around into the next line.

You can style each component by using the style, buttonStyle and contentStyle prop. These will append / replace the default styles of the components. Alternatively you can provide CSS classnames as containerClasses, buttonClasses and contentClasses to apply predefined CSS classes.

You can use disableStyles={true} to disable any built-in styling.

Examples

Changing the bar background to red

<CookieConsent style={{ background: "red" }}></CookieConsent>

Changing the button font-weight to bold

<CookieConsent buttonStyle={{ fontWeight: "bold" }}></CookieConsent>

Using predefined CSS classes

You can pass predefined CSS classes to the components using the containerClasses, buttonClasses and contentClasses props. The example below uses bootstrap classes:

<CookieConsent
  disableStyles={true}
  location={OPTIONS.BOTTOM}
  buttonClasses="btn btn-primary"
  containerClasses="alert alert-warning col-lg-12"
  contentClasses="text-capitalize"
>
  This website uses cookies to enhance the user experience.{" "}
  <span style={{ fontSize: "10px" }}>This bit of text is smaller :O</span>
</CookieConsent>

Which results in:

bootstrap styling

Accept on scroll

You can make the cookiebar disappear after scrolling a certain percentage using acceptOnScroll and acceptOnScrollPercentage. It is legal in some use-cases, Italy being one of them. Consult your legislation on whether this is allowed.

<CookieConsent
  acceptOnScroll={true}
  acceptOnScrollPercentage={50}
  onAccept={(byScroll) => {
    alert(`consent given. \n\n By scrolling? ${byScroll}`);
  }}
>
  Hello scroller :)
</CookieConsent>

Flipping the buttons

If you enable the decline button you can pass along the "flipButtons" property to turn the buttons around:

<CookieConsent enableDeclineButton flipButtons>
  Flipped buttons
</CookieConsent>

Which results in:

flipped buttons

You can add more cookie options using the extraCookieOptions parameter like so:

<CookieConsent extraCookieOptions={{ domain: "myexample.com" }}>cookie bar</CookieConsent>

Rainbows!

rainbows!

If you're crazy enough you can even make a rainbow colored bar:

<CookieConsent
  buttonText="OMG DOUBLE RAINBOW"
  cookieName="myAwesomeCookieName2"
  style={{
    background: "linear-gradient(to right, orange , yellow, green, cyan, blue, violet)",
    textShadow: "2px 2px black",
  }}
  buttonStyle={{
    background: "linear-gradient(to left, orange , yellow, green, cyan, blue, violet)",
    color: "white",
    fontWeight: "bolder",
    textShadow: "2px 2px black",
  }}
>
  This website uses cookies to enhance the user experience.{" "}
  <span style={{ fontSize: "10px" }}>This bit of text is smaller :O</span>
</CookieConsent>

Overlay

overlay

You can also generate a page-obfuscating overlay that will prevent actions other than interacting with the cookie consent button(s).

<CookieConsent location="bottom" cookieName="myAwesomeCookieName3" expires={999} overlay>
  This website uses cookies to enhance the user experience.
</CookieConsent>

Contributor information

When making a PR please think about the following things:

  • Update the ChangeLog (or include what you did in the PR and I'll add it, up to you)
  • No need to build or update the package.json. I will do both on release.
  • Please don't change code convention / style

The list below features the projects which use react-cookie-consent (that I know off):