release 7.6.0

* added customButtonWrapperAttributes prop

* escape characters in README

.prettierignore

@@ -0,0 +1 @@
+build/*

CHANGELOG.md

@@ -5,6 +5,65 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [[7.6.0]](https://github.com/Mastermindzh/react-cookie-consent/releases/tag/7.6.0]
+
+- Added `customButtonWrapperAttributes` prop which allows to add custom attributes to the button wrapper div
+
+## [[7.5.0]](https://github.com/Mastermindzh/react-cookie-consent/releases/tag/7.5.0)
+
+- Added `customDeclineButtonProps` to add custom properties to the decline button
+
+## [[7.4.1]](https://github.com/Mastermindzh/react-cookie-consent/releases/tag/7.4.1)
+
+- Small version error in package.json that actually didn't make it work with React 18
+
+## [[7.4.0]](https://github.com/Mastermindzh/react-cookie-consent/releases/tag/7.4.0)
+
+- Added support for React 18
+- Updated example and codebase to use React 18
+
+## [[7.3.1]](https://github.com/Mastermindzh/react-cookie-consent/releases/tag/7.3.1)
+
+- Added type annotations on public functions
+
+## [[7.3.0]](https://github.com/Mastermindzh/react-cookie-consent/releases/tag/7.3.0)
+
+- added `customButtonProps` that allows to use custom props with the button component. Specifically useful for library buttons components, for e.g. MUI Button.
+
+## [[7.2.1]](https://github.com/Mastermindzh/react-cookie-consent/releases/tag/7.2.1)
+
+- hideOnDecline added to typescript files
+- Added .prettieringore
+
+## [[7.2.0]](https://github.com/Mastermindzh/react-cookie-consent/releases/tag/7.2.0)
+
+- Added `onOverlayClick` which allows you to react to a click on the overlay
+- Added `acceptOnOverlayClick` which accepts the cookies when the overlay is clicked and runs `onOverlayClick`
+
+## [[7.1.1]](https://github.com/Mastermindzh/react-cookie-consent/releases/tag/7.1.1)
+
+- `customContentAttributes` and `customContainerAttributes` are now optional in the typing file as they should be
+
+## [[7.1.0](https://github.com/Mastermindzh/react-cookie-consent/releases/tag/7.1.0)]
+
+- Added custom attribute props for content and container
+
+## [[7.0.1](https://github.com/Mastermindzh/react-cookie-consent/releases/tag/7.0.1)]
+
+- Configured webpack to remove self from build artefact. Should now work in Nextjs and Gatsby (only tested those..)
+
+## [[7.0.0](https://github.com/Mastermindzh/react-cookie-consent/releases/tag/7.0.0)]
+
+- Switched from CommonJS to UMD module
+
+## [[6.4.1](https://github.com/Mastermindzh/react-cookie-consent/releases/tag/6.4.1))]
+
+- Added missing typing
+
+## [[6.4.0](https://github.com/Mastermindzh/react-cookie-consent/releases/tag/6.4.0))]
+
+- Added visible prop
+
 ## [[6.3.0](https://github.com/Mastermindzh/react-cookie-consent/releases/tag/6.2.3))]
 
 - Added the (optional) scrolling effect back in as it is declared legal in some countries now.

README.md

@@ -138,7 +138,7 @@ That option would be interesting if you want to allow user to change their conse
 ## 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.            |
 | visible                       | string, "show", "hidden" or "byCookieValue" | "byCookieValue"                      | Force the consent bar visibility. If "byCookieValue", visibility are defined by cookie consent existence.                               |
 | children                      |          string or React component          |                                      | Content to appear inside the bar                                                                                                        |
@@ -159,6 +159,7 @@ That option would be interesting if you want to allow user to change their conse
 | 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                                                                                    |
+| customButtonWrapperAttributes |   `React.HTMLAttributes<HTMLDivElement>`    | `{}`                                 | Allows you to set custom (data) attributes on the button wrapper div                                                                    |
 | 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                                                                                                       |
@@ -174,11 +175,17 @@ That option would be interesting if you want to allow user to change their conse
 | 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.                                                                         |
+| cookieSecurity                |                   boolean                   | undefined                            | Cookie security level. Defaults to true unless running on http.                                                                         |
 | ariaAcceptLabel               |                   string                    | Accept cookies                       | Aria label to set on the accept button                                                                                                  |
 | ariaDeclineLabel              |                   string                    | Decline cookies                      | Aria label to set on the decline button                                                                                                 |
 | 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                        |
+| customContentAttributes       |                   object                    | `{}`                                 | Allows you to set custom (data) attributes on the content div                                                                           |
+| customContainerAttributes     |                   object                    | `{}`                                 | Allows you to set custom (data) attributes on the container div                                                                         |
+| onOverlayClick                |                  function                   | `() => {}`                           | allows you to react to a click on the overlay                                                                                           |
+| acceptOnOverlayClick          |                   boolean                   | false                                | Determines whether the cookies should be accepted after clicking on the overlay                                                         |
+| customButtonProps             |                   object                    | `{}`                                 | Allows you to set custom props on the button component                                                                                  |
+| customDeclineButtonProps      |                   object                    | `{}`                                 | Allows you to set custom props on the decline button component                                                                          |
 
 ## Debugging it
 
@@ -200,7 +207,7 @@ 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 [186-192](https://github.com/Mastermindzh/react-cookie-consent/blob/master/src/index.js#L186-L192)
+This happens on lines [29-37](https://github.com/Mastermindzh/react-cookie-consent/blob/master/src/index.js#L29-L37)
 
 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.
 
@@ -331,11 +338,11 @@ You can also generate a page-obfuscating overlay that will prevent actions other
 
 <!-- links -->
 
-[style]: https://github.com/Mastermindzh/react-cookie-consent/blob/master/src/index.js#L18-L29
+[style]: https://github.com/Mastermindzh/react-cookie-consent/blob/master/src/index.js#L78-L89
-[buttonstyle]: https://github.com/Mastermindzh/react-cookie-consent/blob/master/src/index.js#L30-L40
+[buttonstyle]: https://github.com/Mastermindzh/react-cookie-consent/blob/master/src/index.js#L90-L100
-[declinebuttonstyle]: https://github.com/Mastermindzh/react-cookie-consent/blob/master/src/index.js#L41-L51
+[declinebuttonstyle]: https://github.com/Mastermindzh/react-cookie-consent/blob/master/src/index.js#L101-L111
-[contentstyle]: https://github.com/Mastermindzh/react-cookie-consent/blob/master/src/index.js#L52-L55
+[contentstyle]: https://github.com/Mastermindzh/react-cookie-consent/blob/master/src/index.js#L112-L115
-[overlaystyle]: https://github.com/Mastermindzh/react-cookie-consent/blob/master/src/index.js#L62-L69
+[overlaystyle]: https://github.com/Mastermindzh/react-cookie-consent/blob/master/src/index.js#L116-L124
 
 ## Contributor information
 

build/index.d.ts

@@ -4,6 +4,7 @@ import Cookies from "js-cookie";
 export interface CookieConsentProps {
   location?: "top" | "bottom" | "none";
   sameSite?: "strict" | "lax" | "none";
+  visible?: "hidden" | "show" | "byCookieValue";
   cookieSecurity?: boolean;
   style?: object;
   buttonStyle?: object;
@@ -12,6 +13,7 @@ export interface CookieConsentProps {
   children?: React.ReactNode;
   disableStyles?: boolean;
   hideOnAccept?: boolean;
+  hideOnDecline?: boolean;
   onAccept?: (acceptedByScrolling?: boolean) => void;
   onDecline?: Function;
   buttonText?: Function | React.ReactNode;
@@ -37,10 +39,17 @@ export interface CookieConsentProps {
   overlay?: boolean;
   overlayClasses?: string;
   overlayStyle?: object;
+  onOverlayClick?: () => void;
+  acceptOnOverlayClick?: boolean;
   ariaAcceptLabel?: string;
   ariaDeclineLabel?: string;
   acceptOnScroll?: boolean;
   acceptOnScrollPercentage?: number;
+  customContentAttributes?: object;
+  customContainerAttributes?: object;
+  customButtonProps?: object;
+  customDeclineButtonProps?: object;
+  customButtonWrapperAttributes?: React.HTMLAttributes<HTMLDivElement>;
 }
 
 export default class CookieConsent extends React.Component<CookieConsentProps, {}> {}
@@ -53,4 +62,17 @@ export default class CookieConsent extends React.Component<CookieConsentProps, {
  */
 export function getCookieConsentValue(name?: string): string;
 
+/**
+ * Reset the consent cookie
+ * Remove the cookie on browser in order to allow user to change their consent
+ * @param {*} name optional name of the cookie
+ */
+export function resetCookieConsentValue(name?: string): void;
+
+/**
+ * Get the legacy cookie name by the regular cookie name
+ * @param {string} name of cookie to get
+ */
+export function getLegacyCookieName(name: string): string;
+
 export { Cookies };

package.json

@@ -4,7 +4,7 @@
     "name": "Rick van Lieshout",
     "email": "info@rickvanlieshout.com"
   },
-  "version": "6.3.0",
+  "version": "7.6.0",
   "description": "A small, simple and customizable cookie consent bar for use in React applications.",
   "main": "build/index.js",
   "types": "build/index.d.ts",
@@ -13,7 +13,7 @@
     "prop-types": "^15.7.2"
   },
   "peerDependencies": {
-    "react": "^16.13.1 || ^17.0.0"
+    "react": "^16.13.1 || ^17.0.0 || ^18.0.0"
   },
   "scripts": {
     "build": "webpack",
@@ -43,22 +43,22 @@
   },
   "homepage": "https://github.com/Mastermindzh/react-cookie-consent#readme",
   "devDependencies": {
-    "@babel/cli": "^7.12.1",
+    "@babel/cli": "^7.17.6",
-    "@babel/core": "^7.12.3",
+    "@babel/core": "^7.17.8",
-    "@babel/plugin-proposal-object-rest-spread": "^7.12.1",
+    "@babel/plugin-proposal-object-rest-spread": "^7.17.3",
-    "@babel/plugin-transform-object-assign": "^7.12.1",
+    "@babel/plugin-transform-object-assign": "^7.16.7",
-    "@babel/plugin-transform-react-jsx": "^7.12.1",
+    "@babel/plugin-transform-react-jsx": "^7.17.3",
-    "@babel/preset-env": "^7.12.1",
+    "@babel/preset-env": "^7.16.11",
     "@mastermindzh/prettier-config": "^1.0.0",
     "@types/js-cookie": "^2.2.6",
-    "babel-loader": "^8.1.0",
+    "babel-loader": "^8.2.4",
     "copy-webpack-plugin": "^6.2.1",
     "husky": "^4.3.0",
     "lint-staged": "^10.5.1",
-    "prettier": "^2.1.2",
+    "prettier": "^2.6.2",
-    "react": "^16.13.1",
+    "react": "^18.0.0",
-    "webpack": "^5.3.2",
+    "webpack": "^5.71.0",
-    "webpack-cli": "^4.1.0"
+    "webpack-cli": "^4.9.2"
   },
   "prettier": "@mastermindzh/prettier-config",
   "husky": {

src/index.d.ts

@@ -4,6 +4,7 @@ import Cookies from "js-cookie";
 export interface CookieConsentProps {
   location?: "top" | "bottom" | "none";
   sameSite?: "strict" | "lax" | "none";
+  visible?: "hidden" | "show" | "byCookieValue";
   cookieSecurity?: boolean;
   style?: object;
   buttonStyle?: object;
@@ -12,6 +13,7 @@ export interface CookieConsentProps {
   children?: React.ReactNode;
   disableStyles?: boolean;
   hideOnAccept?: boolean;
+  hideOnDecline?: boolean;
   onAccept?: (acceptedByScrolling?: boolean) => void;
   onDecline?: Function;
   buttonText?: Function | React.ReactNode;
@@ -37,10 +39,17 @@ export interface CookieConsentProps {
   overlay?: boolean;
   overlayClasses?: string;
   overlayStyle?: object;
+  onOverlayClick?: () => void;
+  acceptOnOverlayClick?: boolean;
   ariaAcceptLabel?: string;
   ariaDeclineLabel?: string;
   acceptOnScroll?: boolean;
   acceptOnScrollPercentage?: number;
+  customContentAttributes?: object;
+  customContainerAttributes?: object;
+  customButtonProps?: object;
+  customDeclineButtonProps?: object;
+  customButtonWrapperAttributes?: React.HTMLAttributes<HTMLDivElement>;
 }
 
 export default class CookieConsent extends React.Component<CookieConsentProps, {}> {}
@@ -53,4 +62,17 @@ export default class CookieConsent extends React.Component<CookieConsentProps, {
  */
 export function getCookieConsentValue(name?: string): string;
 
+/**
+ * Reset the consent cookie
+ * Remove the cookie on browser in order to allow user to change their consent
+ * @param {*} name optional name of the cookie
+ */
+export function resetCookieConsentValue(name?: string): void;
+
+/**
+ * Get the legacy cookie name by the regular cookie name
+ * @param {string} name of cookie to get
+ */
+export function getLegacyCookieName(name: string): string;
+
 export { Cookies };

src/index.js

@@ -15,10 +15,10 @@ export const SAME_SITE_OPTIONS = {
 };
 
 export const VISIBLE_OPTIONS = {
-  HIDDEN: 'hidden',
+  HIDDEN: "hidden",
-  SHOW: 'show',
+  SHOW: "show",
-  BY_COOKIE_VALUE: 'byCookieValue'
+  BY_COOKIE_VALUE: "byCookieValue",
-}
+};
 
 /**
  * Returns the value of the consent cookie
@@ -27,11 +27,11 @@ export const VISIBLE_OPTIONS = {
  * @param {*} name optional name of the cookie
  */
 export const getCookieConsentValue = (name = defaultCookieConsentName) => {
-  let cookieValue = Cookies.get(name);
+  const cookieValue = Cookies.get(name);
 
   // if the cookieValue is undefined check for the legacy cookie
   if (cookieValue === undefined) {
-    cookieValue = Cookies.get(getLegacyCookieName(name));
+    return Cookies.get(getLegacyCookieName(name));
   }
   return cookieValue;
 };
@@ -159,6 +159,17 @@ class CookieConsent extends Component {
     }
   }
 
+  /**
+   * Handle a click on the overlay
+   */
+  overlayClick() {
+    const { acceptOnOverlayClick, onOverlayClick } = this.props;
+    if (acceptOnOverlayClick) {
+      this.accept();
+    }
+    onOverlayClick();
+  }
+
   /**
    * Set a persistent decline cookie
    */
@@ -190,7 +201,7 @@ class CookieConsent extends Component {
       cookieSecurity = location ? location.protocol === "https:" : true;
     }
 
-    let cookieOptions = { expires, ...extraCookieOptions, sameSite, secure: cookieSecurity };
+    const cookieOptions = { expires, ...extraCookieOptions, sameSite, secure: cookieSecurity };
 
     // Fallback for older browsers where can not set SameSite=None, SEE: https://web.dev/samesite-cookie-recipes/#handling-incompatible-clients
     if (sameSite === SAME_SITE_OPTIONS.NONE) {
@@ -218,12 +229,12 @@ class CookieConsent extends Component {
     const { acceptOnScrollPercentage } = this.props;
 
     // (top / height) - height * 100
-    let rootNode = document.documentElement,
+    const rootNode = document.documentElement,
       body = document.body,
       top = "scrollTop",
       height = "scrollHeight";
 
-    let percentage =
+    const percentage =
       ((rootNode[top] || body[top]) /
         ((rootNode[height] || body[height]) - rootNode.clientHeight)) *
       100;
@@ -279,6 +290,11 @@ class CookieConsent extends Component {
       overlayStyle,
       ariaAcceptLabel,
       ariaDeclineLabel,
+      customContainerAttributes,
+      customContentAttributes,
+      customButtonProps,
+      customDeclineButtonProps,
+      customButtonWrapperAttributes,
     } = this.props;
 
     let myStyle = {};
@@ -338,6 +354,7 @@ class CookieConsent extends Component {
           onClick={() => {
             this.decline();
           }}
+          {...customDeclineButtonProps}
         >
           {declineButtonText}
         </ButtonComponent>
@@ -354,6 +371,7 @@ class CookieConsent extends Component {
         onClick={() => {
           this.accept();
         }}
+        {...customButtonProps}
       >
         {buttonText}
       </ButtonComponent>
@@ -367,16 +385,22 @@ class CookieConsent extends Component {
       <ConditionalWrapper
         condition={overlay}
         wrapper={(children) => (
-          <div style={myOverlayStyle} className={overlayClasses}>
+          <div
+            style={myOverlayStyle}
+            className={overlayClasses}
+            onClick={() => {
+              this.overlayClick();
+            }}
+          >
             {children}
           </div>
         )}
       >
-        <div className={`${containerClasses}`} style={myStyle}>
+        <div className={`${containerClasses}`} style={myStyle} {...customContainerAttributes}>
-          <div style={myContentStyle} className={contentClasses}>
+          <div style={myContentStyle} className={contentClasses} {...customContentAttributes}>
             {this.props.children}
           </div>
-          <div className={`${buttonWrapperClasses}`}>
+          <div className={`${buttonWrapperClasses}`} {...customButtonWrapperAttributes}>
             {buttonsToRender.map((button) => {
               return button;
             })}
@@ -425,10 +449,17 @@ CookieConsent.propTypes = {
   overlay: PropTypes.bool,
   overlayClasses: PropTypes.string,
   overlayStyle: PropTypes.object,
+  onOverlayClick: PropTypes.func,
+  acceptOnOverlayClick: PropTypes.bool,
   ariaAcceptLabel: PropTypes.string,
   ariaDeclineLabel: PropTypes.string,
   acceptOnScroll: PropTypes.bool,
   acceptOnScrollPercentage: PropTypes.number,
+  customContentAttributes: PropTypes.object,
+  customContainerAttributes: PropTypes.object,
+  customButtonProps: PropTypes.object,
+  customDeclineButtonProps: PropTypes.object,
+  customButtonWrapperAttributes: PropTypes.object,
 };
 
 CookieConsent.defaultProps = {
@@ -462,10 +493,17 @@ CookieConsent.defaultProps = {
   ButtonComponent: ({ children, ...props }) => <button {...props}>{children}</button>,
   overlay: false,
   overlayClasses: "",
+  onOverlayClick: () => {},
+  acceptOnOverlayClick: false,
   ariaAcceptLabel: "Accept cookies",
   ariaDeclineLabel: "Decline cookies",
   acceptOnScroll: false,
   acceptOnScrollPercentage: 25,
+  customContentAttributes: {},
+  customContainerAttributes: {},
+  customButtonProps: {},
+  customDeclineButtonProps: {},
+  customButtonWrapperAttributes: {},
 };
 
 export default CookieConsent;

webpack.config.js

@@ -6,17 +6,21 @@ module.exports = {
   output: {
     path: path.resolve(__dirname, "build"),
     filename: "index.js",
-    libraryTarget: "commonjs2", // THIS IS THE MOST IMPORTANT LINE! :mindblow: I wasted more than 2 days until realize this was the line most important in all this guide.
+    library: {
+      name: "ReactCookieConsent",
+      type: "umd",
+    },
     environment: {
       arrowFunction: false, // the generated runtime-code should not use arrow functions
     },
+    globalObject: `typeof self !== 'undefined' ? self : this`,
   },
   module: {
     rules: [
       {
         test: /\.js$/,
         include: path.resolve(__dirname, "src"),
-        exclude: /(node_modules|bower_components|build)/,
+        exclude: /(node_modules|build)/,
         use: {
           loader: "babel-loader",
           options: {