# :cookie: react-cookie-consent :cookie: A small, simple and customizable cookie consent bar for use in React applications. [![NPM](https://nodei.co/npm/react-cookie-consent.png)](https://npmjs.org/package/react-cookie-consent) Demo: https://mastermindzh.github.io/react-cookie-consent/ Example branch: https://github.com/Mastermindzh/react-cookie-consent/tree/example ## Default look ![default look](https://raw.githubusercontent.com/Mastermindzh/react-cookie-consent/master/images/default.png) ## Table of contents - [Installation](#installation) - [Using it](#using-it) - [Props](#props) - [Debugging it](#debugging-it) - [Styling it](#styling-it) - [Examples](#examples) - [changing the bar background to red](#changing-the-bar-background-to-red) - [changing the button font-weight to bold](#changing-the-button-font-weight-to-bold) - [Using predefined CSS classes](#using-predefined-css-classes) - [Accept on scroll](#accept-on-scroll) - [Flipping the buttons](#flipping-the-buttons) - [Extra cookie options](#extra-cookie-options) - [rainbows!](#rainbows) - [contributor information](#contributor-information) - [Projects using react-cookie-consent](#projects-using-react-cookie-consent) ## Installation ```shell npm install react-cookie-consent ``` or use yarn: ```shell yarn add react-cookie-consent ``` ## Using it You can import the cookie bar like this: ```js 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: ```js import CookieConsent, { Cookies } from "react-cookie-consent"; ``` Then you can use the component anywhere in your React app like so: ```jsx This website uses cookies to enhance the user experience. ``` You can optionally set some props like this (next chapter will show all props): ```js This website uses cookies to enhance the user experience.{" "} This bit of text is smaller :O ``` 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: ```js { 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"); } }} > ``` 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: ```js { alert("nay!"); }} > ``` ## Props | Prop | Type | Default value | Description | | ------------------------ | :-------------------------------: | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | | location | string, "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. | | children | string or React component | | Content to appear inside the bar | | disableStyles | boolean | false | If enabled the component will have no default style. (you can still supply style through props) | | hideOnAccept | boolean | true | If disabled the component will not hide it self after the accept button has been clicked. You will need to hide yourself (see onAccept) | | acceptOnScroll | boolean | false | Defines whether "accept" should be fired after the user scrolls a certain distance (see acceptOnScrollPercentage) | | acceptOnScrollPercentage | number | 25 | Percentage of the page height the user has to scroll to trigger the accept function if acceptOnScroll is enabled | | buttonText | string or React component | "I understand" | Text to appear on the button | | declineButtonText | string or React component | "I decline" | Text to appear on the decline button | | cookieName | string | "CookieConsent" | Name of the cookie used to track whether the user has agreed. | | cookieValue | string or boolean or number | true | Value to be saved under the cookieName. | | declineCookieValue | string or boolean or number | false | Value to be saved under the cookieName when declined. | | setDeclineCookie | boolean | true | Whether to set a cookie when the user clicks "decline" | | onAccept | function | `({ acceptedByScrolling }) => {}` | Function to be called after the accept button has been clicked. | | onDecline | function | `() => {}` | Function to be called after the decline button has been clicked. | | debug | boolean | undefined | Bar will be drawn regardless of cookie for debugging purposes. | | expires | number | 365 | Number of days before the cookie expires. | | extraCookieOptions | object | `{}` | Extra info (apart from expiry date) to add to the cookie | | overlay | boolean | false | Whether to show a page obscuring overlay or not. | | containerClasses | string | "" | CSS classes to apply to the surrounding container | | buttonClasses | string | "" | CSS classes to apply to the button | | buttonWrapperClasses | string | "" | CSS classes to apply to the div wrapping the buttons | | declineButtonClasses | string | "" | CSS classes to apply to the decline button | | buttonId | string | "" | Id to apply to the button | | declineButtonId | string | "" | Id to apply to the decline button | | contentClasses | string | "" | CSS classes to apply to the content | | overlayClasses | string | "" | CSS classes to apply to the surrounding overlay | | style | object | [look at source][style] | React styling object for the bar. | | buttonStyle | object | [look at source][buttonstyle] | React styling object for the button. | | declineButtonStyle | object | [look at source][declinebuttonstyle] | React styling object for the decline button. | | contentStyle | object | [look at source][contentstyle] | React styling object for the content. | | overlayStyle | object | [look at source][overlaystyle] | React styling object for the overlay. | | disableButtonStyles | boolean | false | If enabled the button will have no default style. (you can still supply style through props) | | enableDeclineButton | boolean | false | If enabled the decline button will be rendered | | flipButtons | boolean | false | If enabled the accept and decline buttons will be flipped | | ButtonComponent | React component | button | React Component to render as a button. | | sameSite | string, "strict", "lax" or "none" | none | Cookies sameSite attribute value | | cookieSecurity | boolean | undefined | Cookie security level. Defaults to true unless running on http. | ## 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: ```js ``` **Note:** Don't forget to remove the `debug`-property for production. ## 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 ```js ``` #### changing the button font-weight to bold ```js ``` #### 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: ```js This website uses cookies to enhance the user experience.{" "} This bit of text is smaller :O ``` Which results in: ![bootstrap styling](https://github.com/Mastermindzh/react-cookie-consent/blob/master/images/css_classes.png?raw=true) #### Accept on scroll You can make the cookiebar disappear after scrolling a certain percentage using acceptOnScroll and acceptOnScrollPercentage. ```js { alert("consent given"); }} > Hello scroller :) ``` #### Flipping the buttons If you enable the decline button you can pass along the "flipButtons" property to turn the buttons around: ```js Flipped buttons ``` Which results in: ![flipped buttons](./images/flipped.png) #### Extra cookie options You can add more cookie options using the extraCookieOptions parameter like so: ```js cookie bar ``` #### rainbows! ![rainbows!](https://github.com/Mastermindzh/react-cookie-consent/blob/master/images/rainbow.png?raw=true) If you're crazy enough you can even make a rainbow colored bar: ```js This website uses cookies to enhance the user experience.{" "} This bit of text is smaller :O ``` #### Overlay ![overlay](https://github.com/Mastermindzh/react-cookie-consent/blob/master/images/overlay.png?raw=true) You can also generate a page-obfuscating overlay that will prevent actions other than interacting with the cookie consent button(s). ```js This website uses cookies to enhance the user experience. ``` [style]: https://github.com/Mastermindzh/react-cookie-consent/blob/master/src/index.js#L18-L29 [buttonstyle]: https://github.com/Mastermindzh/react-cookie-consent/blob/master/src/index.js#L30-L40 [declinebuttonstyle]: https://github.com/Mastermindzh/react-cookie-consent/blob/master/src/index.js#L41-L51 [contentstyle]: https://github.com/Mastermindzh/react-cookie-consent/blob/master/src/index.js#L52-L55 [overlaystyle]: https://github.com/Mastermindzh/react-cookie-consent/blob/master/src/index.js#L62-L69 ## 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 ## Projects using react-cookie-consent The list below features the projects which use react-cookie-consent (that I know off): - [bs-react-cookie-consent](https://github.com/ctbucha/bs-react-cookie-consent) - [comicrelief's storybook](https://github.com/comicrelief/storybook) - [inici Gatsby theme](https://github.com/kuworking/gatsby-theme-kuworking-core) - [Scrivito Example App](https://github.com/Scrivito/scrivito_example_app_js)