mirror of
https://github.com/Mastermindzh/react-cookie-consent.git
synced 2025-08-23 17:44:55 +02:00
Compare commits
33 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
541194819b | ||
| 91d86af611 | |||
|
413abc7fd8 | ||
| 2a1e52b24a | |||
| 775ec9db96 | |||
| eaaf6f8797 | |||
| 8c86599f24 | |||
| 719bb2f496 | |||
| 9a0c974b2a | |||
| c2f92ec130 | |||
| 7136086602 | |||
|
c3ba87e62f | ||
| 239001cb19 | |||
| e024961eae | |||
| a19649bbcf | |||
| 696200262e | |||
| e52811b3a8 | |||
|
814202780b | ||
|
|
d01995e3b4 | ||
| 56de263dce | |||
|
0228e7f32c | ||
| 50216eec3c | |||
| 3e9e988e96 | |||
| 1c6f335500 | |||
| eb45e7a652 | |||
| 26306f7490 | |||
| 7d8f52018d | |||
| a494066785 | |||
|
7f15b25e89 | ||
| 0f4893af4b | |||
|
1ad4474d93 | ||
|
6a5aac9cd7 | ||
| c656e311e6 |
2
.gitignore
vendored
2
.gitignore
vendored
@@ -1 +1,3 @@
|
|||||||
node_modules
|
node_modules
|
||||||
|
build/index.js.LICENSE.txt
|
||||||
|
example/*
|
||||||
|
|||||||
1
.prettierignore
Normal file
1
.prettierignore
Normal file
@@ -0,0 +1 @@
|
|||||||
|
build/*
|
||||||
73
CHANGELOG.md
73
CHANGELOG.md
@@ -5,6 +5,79 @@ 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/),
|
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).
|
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
||||||
|
|
||||||
|
## [next]
|
||||||
|
|
||||||
|
- 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.
|
||||||
|
|
||||||
|
## [6.2.4]
|
||||||
|
|
||||||
|
- version bumps :)
|
||||||
|
|
||||||
|
## [[6.2.3](https://github.com/Mastermindzh/react-cookie-consent/releases/tag/6.2.3)]
|
||||||
|
|
||||||
|
- Added support for IE11, the webpack generated runtime-code should not use arrow functions
|
||||||
|
|
||||||
|
## [[6.2.2](https://github.com/Mastermindzh/react-cookie-consent/releases/tag/6.2.2)]
|
||||||
|
|
||||||
|
- Fixed the return type of getCookieConsentValue in the dts file.
|
||||||
|
|
||||||
|
## [[6.2.1](https://github.com/Mastermindzh/react-cookie-consent/releases/tag/6.2.1)]
|
||||||
|
|
||||||
|
Added the `getCookieConsentValue` to the dts file.
|
||||||
|
|
||||||
|
## [[6.2.0](https://github.com/Mastermindzh/react-cookie-consent/releases/tag/6.2.0)]
|
||||||
|
|
||||||
|
Added the exported function `getCookieConsentValue` to get the cookie value from custom code
|
||||||
|
|
||||||
|
## [[6.1.0](https://github.com/Mastermindzh/react-cookie-consent/releases/tag/6.1.0)]
|
||||||
|
|
||||||
|
Added support for React 17
|
||||||
|
|
||||||
|
## [[6.0.0](https://github.com/Mastermindzh/react-cookie-consent/releases/tag/6.0.0)]
|
||||||
|
|
||||||
|
### removed
|
||||||
|
|
||||||
|
Accepting by scrolling is no longer allowed and has thus been removed from the package.
|
||||||
|
For details see [issue 88](https://github.com/Mastermindzh/react-cookie-consent/issues/88)
|
||||||
|
|
||||||
## [[5.2.0](https://github.com/Mastermindzh/react-cookie-consent/releases/tag/5.2.0)]
|
## [[5.2.0](https://github.com/Mastermindzh/react-cookie-consent/releases/tag/5.2.0)]
|
||||||
|
|
||||||
### added
|
### added
|
||||||
|
|||||||
157
README.md
157
README.md
@@ -20,18 +20,21 @@ Example branch: https://github.com/Mastermindzh/react-cookie-consent/tree/exampl
|
|||||||
|
|
||||||
- [Installation](#installation)
|
- [Installation](#installation)
|
||||||
- [Using it](#using-it)
|
- [Using it](#using-it)
|
||||||
|
- [getting the cookies value in your own code](#getting-the-cookies-value-in-your-own-code)
|
||||||
- [Props](#props)
|
- [Props](#props)
|
||||||
- [Debugging it](#debugging-it)
|
- [Debugging it](#debugging-it)
|
||||||
- [Why are there two cookies? One of which named "Legacy"](#why-are-there-two-cookies--one-of-which-named--legacy-)
|
- [Why are there two cookies? One of which named "Legacy"](#why-are-there-two-cookies-one-of-which-named-legacy)
|
||||||
- [Styling it](#styling-it)
|
- [Styling it](#styling-it)
|
||||||
- [Examples](#examples)
|
- [Examples](#examples)
|
||||||
- [changing the bar background to red](#changing-the-bar-background-to-red)
|
- [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)
|
- [Changing the button font-weight to bold](#changing-the-button-font-weight-to-bold)
|
||||||
- [Using predefined CSS classes](#using-predefined-css-classes)
|
- [Using predefined CSS classes](#using-predefined-css-classes)
|
||||||
|
- [Accept on scroll](#accept-on-scroll)
|
||||||
- [Flipping the buttons](#flipping-the-buttons)
|
- [Flipping the buttons](#flipping-the-buttons)
|
||||||
- [Extra cookie options](#extra-cookie-options)
|
- [Extra cookie options](#extra-cookie-options)
|
||||||
- [rainbows!](#rainbows)
|
- [Rainbows!](#rainbows)
|
||||||
- [contributor information](#contributor-information)
|
- [Overlay](#overlay)
|
||||||
|
- [Contributor information](#contributor-information)
|
||||||
- [Projects using react-cookie-consent](#projects-using-react-cookie-consent)
|
- [Projects using react-cookie-consent](#projects-using-react-cookie-consent)
|
||||||
|
|
||||||
<!-- tocstop -->
|
<!-- tocstop -->
|
||||||
@@ -84,12 +87,17 @@ You can optionally set some props like this (next chapter will show all props):
|
|||||||
</CookieConsent>
|
</CookieConsent>
|
||||||
```
|
```
|
||||||
|
|
||||||
One of the props (onAccept) is a function, this function will be called after the user has clicked the accept button. You can provide a function like so:
|
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
|
```js
|
||||||
<CookieConsent
|
<CookieConsent
|
||||||
onAccept={() => {
|
onAccept={(acceptedByScrolling) => {
|
||||||
alert("Accept was triggered by clicking the Accept button");
|
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>
|
></CookieConsent>
|
||||||
```
|
```
|
||||||
@@ -105,47 +113,77 @@ If the decline button is enabled then the (onDecline) prop function can be used,
|
|||||||
></CookieConsent>
|
></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:
|
||||||
|
|
||||||
|
```js
|
||||||
|
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:
|
||||||
|
|
||||||
|
```js
|
||||||
|
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
|
## Props
|
||||||
|
|
||||||
| Prop | Type | Default value | Description |
|
| 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. |
|
| 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 |
|
| visible | string, "show", "hidden" or "byCookieValue" | "byCookieValue" | Force the consent bar visibility. If "byCookieValue", visibility are defined by cookie consent existence. |
|
||||||
| disableStyles | boolean | false | If enabled the component will have no default style. (you can still supply style through props) |
|
| children | string or React component | | Content to appear inside the bar |
|
||||||
| 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) |
|
| disableStyles | boolean | false | If enabled the component will have no default style. (you can still supply style through props) |
|
||||||
| buttonText | string or React component | "I understand" | Text to appear on the button |
|
| 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) |
|
||||||
| declineButtonText | string or React component | "I decline" | Text to appear on the decline button |
|
| buttonText | string or React component | "I understand" | Text to appear on the button |
|
||||||
| cookieName | string | "CookieConsent" | Name of the cookie used to track whether the user has agreed. |
|
| declineButtonText | string or React component | "I decline" | Text to appear on the decline button |
|
||||||
| cookieValue | string or boolean or number | true | Value to be saved under the cookieName. |
|
| cookieName | string | "CookieConsent" | Name of the cookie used to track whether the user has agreed. |
|
||||||
| declineCookieValue | string or boolean or number | false | Value to be saved under the cookieName when declined. |
|
| cookieValue | string or boolean or number | true | Value to be saved under the cookieName. |
|
||||||
| setDeclineCookie | boolean | true | Whether to set a cookie when the user clicks "decline" |
|
| declineCookieValue | string or boolean or number | false | Value to be saved under the cookieName when declined. |
|
||||||
| onAccept | function | `() => {}` | Function to be called after the accept button has been clicked. |
|
| setDeclineCookie | boolean | true | Whether to set a cookie when the user clicks "decline" |
|
||||||
| onDecline | function | `() => {}` | Function to be called after the decline button has been clicked. |
|
| onAccept | function | `() => {}` | Function to be called after the accept button has been clicked. |
|
||||||
| debug | boolean | undefined | Bar will be drawn regardless of cookie for debugging purposes. |
|
| onDecline | function | `() => {}` | Function to be called after the decline button has been clicked. |
|
||||||
| expires | number | 365 | Number of days before the cookie expires. |
|
| debug | boolean | undefined | Bar will be drawn regardless of cookie for debugging purposes. |
|
||||||
| extraCookieOptions | object | `{}` | Extra info (apart from expiry date) to add to the cookie |
|
| expires | number | 365 | Number of days before the cookie expires. |
|
||||||
| overlay | boolean | false | Whether to show a page obscuring overlay or not. |
|
| extraCookieOptions | object | `{}` | Extra info (apart from expiry date) to add to the cookie |
|
||||||
| containerClasses | string | "" | CSS classes to apply to the surrounding container |
|
| overlay | boolean | false | Whether to show a page obscuring overlay or not. |
|
||||||
| buttonClasses | string | "" | CSS classes to apply to the button |
|
| containerClasses | string | "" | CSS classes to apply to the surrounding container |
|
||||||
| buttonWrapperClasses | string | "" | CSS classes to apply to the div wrapping the buttons |
|
| buttonClasses | string | "" | CSS classes to apply to the button |
|
||||||
| declineButtonClasses | string | "" | CSS classes to apply to the decline button |
|
| buttonWrapperClasses | string | "" | CSS classes to apply to the div wrapping the buttons |
|
||||||
| buttonId | string | "" | Id to apply to the button |
|
| declineButtonClasses | string | "" | CSS classes to apply to the decline button |
|
||||||
| declineButtonId | string | "" | Id to apply to the decline button |
|
| buttonId | string | "" | Id to apply to the button |
|
||||||
| contentClasses | string | "" | CSS classes to apply to the content |
|
| declineButtonId | string | "" | Id to apply to the decline button |
|
||||||
| overlayClasses | string | "" | CSS classes to apply to the surrounding overlay |
|
| contentClasses | string | "" | CSS classes to apply to the content |
|
||||||
| style | object | [look at source][style] | React styling object for the bar. |
|
| overlayClasses | string | "" | CSS classes to apply to the surrounding overlay |
|
||||||
| buttonStyle | object | [look at source][buttonstyle] | React styling object for the button. |
|
| style | object | [look at source][style] | React styling object for the bar. |
|
||||||
| declineButtonStyle | object | [look at source][declinebuttonstyle] | React styling object for the decline button. |
|
| buttonStyle | object | [look at source][buttonstyle] | React styling object for the button. |
|
||||||
| contentStyle | object | [look at source][contentstyle] | React styling object for the content. |
|
| declineButtonStyle | object | [look at source][declinebuttonstyle] | React styling object for the decline button. |
|
||||||
| overlayStyle | object | [look at source][overlaystyle] | React styling object for the overlay. |
|
| contentStyle | object | [look at source][contentstyle] | React styling object for the content. |
|
||||||
| disableButtonStyles | boolean | false | If enabled the button will have no default style. (you can still supply style through props) |
|
| overlayStyle | object | [look at source][overlaystyle] | React styling object for the overlay. |
|
||||||
| enableDeclineButton | boolean | false | If enabled the decline button will be rendered |
|
| disableButtonStyles | boolean | false | If enabled the button will have no default style. (you can still supply style through props) |
|
||||||
| flipButtons | boolean | false | If enabled the accept and decline buttons will be flipped |
|
| enableDeclineButton | boolean | false | If enabled the decline button will be rendered |
|
||||||
| ButtonComponent | React component | button | React Component to render as a button. |
|
| flipButtons | boolean | false | If enabled the accept and decline buttons will be flipped |
|
||||||
| sameSite | string, "strict", "lax" or "none" | none | Cookies sameSite attribute value |
|
| ButtonComponent | React component | button | React Component to render as a button. |
|
||||||
| cookieSecurity | boolean | undefined | Cookie security level. Defaults to true unless running on http. |
|
| sameSite | string, "strict", "lax" or "none" | none | Cookies sameSite attribute value |
|
||||||
| ariaAcceptLabel | string | Accept cookies | Aria label to set on the accept button |
|
| cookieSecurity | boolean ¡ | undefined | Cookie security level. Defaults to true unless running on http. |
|
||||||
| ariaDeclineLabel | string | Decline cookies | Aria label to set on the decline button |
|
| 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 |
|
||||||
|
|
||||||
## Debugging it
|
## Debugging it
|
||||||
|
|
||||||
@@ -186,13 +224,13 @@ You can use `disableStyles={true}` to disable any built-in styling.
|
|||||||
|
|
||||||
### Examples
|
### Examples
|
||||||
|
|
||||||
#### changing the bar background to red
|
#### Changing the bar background to red
|
||||||
|
|
||||||
```js
|
```js
|
||||||
<CookieConsent style={{ background: "red" }}></CookieConsent>
|
<CookieConsent style={{ background: "red" }}></CookieConsent>
|
||||||
```
|
```
|
||||||
|
|
||||||
#### changing the button font-weight to bold
|
#### Changing the button font-weight to bold
|
||||||
|
|
||||||
```js
|
```js
|
||||||
<CookieConsent buttonStyle={{ fontWeight: "bold" }}></CookieConsent>
|
<CookieConsent buttonStyle={{ fontWeight: "bold" }}></CookieConsent>
|
||||||
@@ -219,6 +257,23 @@ Which results in:
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
#### 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](https://www.garanteprivacy.it/web/guest/home/docweb/-/docweb-display/docweb/9679893) being one of them. Consult your legislation on whether this is allowed.
|
||||||
|
|
||||||
|
```js
|
||||||
|
<CookieConsent
|
||||||
|
acceptOnScroll={true}
|
||||||
|
acceptOnScrollPercentage={50}
|
||||||
|
onAccept={(byScroll) => {
|
||||||
|
alert(`consent given. \n\n By scrolling? ${byScroll}`);
|
||||||
|
}}
|
||||||
|
>
|
||||||
|
Hello scroller :)
|
||||||
|
</CookieConsent>
|
||||||
|
```
|
||||||
|
|
||||||
#### Flipping the buttons
|
#### Flipping the buttons
|
||||||
|
|
||||||
If you enable the decline button you can pass along the "flipButtons" property to turn the buttons around:
|
If you enable the decline button you can pass along the "flipButtons" property to turn the buttons around:
|
||||||
@@ -241,7 +296,7 @@ You can add more cookie options using the extraCookieOptions parameter like so:
|
|||||||
<CookieConsent extraCookieOptions={{ domain: "myexample.com" }}>cookie bar</CookieConsent>
|
<CookieConsent extraCookieOptions={{ domain: "myexample.com" }}>cookie bar</CookieConsent>
|
||||||
```
|
```
|
||||||
|
|
||||||
#### rainbows!
|
#### Rainbows!
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@@ -287,7 +342,7 @@ You can also generate a page-obfuscating overlay that will prevent actions other
|
|||||||
[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#L52-L55
|
||||||
[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#L62-L69
|
||||||
|
|
||||||
## contributor information
|
## Contributor information
|
||||||
|
|
||||||
When making a PR please think about the following things:
|
When making a PR please think about the following things:
|
||||||
|
|
||||||
|
|||||||
33
build/index.d.ts
vendored
33
build/index.d.ts
vendored
@@ -4,6 +4,7 @@ import Cookies from "js-cookie";
|
|||||||
export interface CookieConsentProps {
|
export interface CookieConsentProps {
|
||||||
location?: "top" | "bottom" | "none";
|
location?: "top" | "bottom" | "none";
|
||||||
sameSite?: "strict" | "lax" | "none";
|
sameSite?: "strict" | "lax" | "none";
|
||||||
|
visible?: "hidden" | "show" | "byCookieValue";
|
||||||
cookieSecurity?: boolean;
|
cookieSecurity?: boolean;
|
||||||
style?: object;
|
style?: object;
|
||||||
buttonStyle?: object;
|
buttonStyle?: object;
|
||||||
@@ -12,7 +13,8 @@ export interface CookieConsentProps {
|
|||||||
children?: React.ReactNode;
|
children?: React.ReactNode;
|
||||||
disableStyles?: boolean;
|
disableStyles?: boolean;
|
||||||
hideOnAccept?: boolean;
|
hideOnAccept?: boolean;
|
||||||
onAccept?: ({ acceptedByScrolling }: { acceptedByScrolling?: boolean }) => void;
|
hideOnDecline?: boolean;
|
||||||
|
onAccept?: (acceptedByScrolling?: boolean) => void;
|
||||||
onDecline?: Function;
|
onDecline?: Function;
|
||||||
buttonText?: Function | React.ReactNode;
|
buttonText?: Function | React.ReactNode;
|
||||||
declineButtonText?: Function | React.ReactNode;
|
declineButtonText?: Function | React.ReactNode;
|
||||||
@@ -29,8 +31,6 @@ export interface CookieConsentProps {
|
|||||||
declineButtonClasses?: string;
|
declineButtonClasses?: string;
|
||||||
buttonId?: string;
|
buttonId?: string;
|
||||||
declineButtonId?: string;
|
declineButtonId?: string;
|
||||||
acceptOnScroll?: boolean;
|
|
||||||
acceptOnScrollPercentage?: number;
|
|
||||||
extraCookieOptions?: object;
|
extraCookieOptions?: object;
|
||||||
disableButtonStyles?: boolean;
|
disableButtonStyles?: boolean;
|
||||||
enableDeclineButton?: boolean;
|
enableDeclineButton?: boolean;
|
||||||
@@ -39,10 +39,37 @@ export interface CookieConsentProps {
|
|||||||
overlay?: boolean;
|
overlay?: boolean;
|
||||||
overlayClasses?: string;
|
overlayClasses?: string;
|
||||||
overlayStyle?: object;
|
overlayStyle?: object;
|
||||||
|
onOverlayClick?: () => void;
|
||||||
|
acceptOnOverlayClick?: boolean;
|
||||||
ariaAcceptLabel?: string;
|
ariaAcceptLabel?: string;
|
||||||
ariaDeclineLabel?: string;
|
ariaDeclineLabel?: string;
|
||||||
|
acceptOnScroll?: boolean;
|
||||||
|
acceptOnScrollPercentage?: number;
|
||||||
|
customContentAttributes?: object;
|
||||||
|
customContainerAttributes?: object;
|
||||||
}
|
}
|
||||||
|
|
||||||
export default class CookieConsent extends React.Component<CookieConsentProps, {}> {}
|
export default class CookieConsent extends React.Component<CookieConsentProps, {}> {}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Returns the value of the consent cookie
|
||||||
|
* Retrieves the regular value first and if not found the legacy one according
|
||||||
|
* to: https://web.dev/samesite-cookie-recipes/#handling-incompatible-clients
|
||||||
|
* @param {*} name optional name of the cookie
|
||||||
|
*/
|
||||||
|
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);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get the legacy cookie name by the regular cookie name
|
||||||
|
* @param {string} name of cookie to get
|
||||||
|
*/
|
||||||
|
export function getLegacyCookieName(name: string);
|
||||||
|
|
||||||
export { Cookies };
|
export { Cookies };
|
||||||
|
|||||||
2603
build/index.js
2603
build/index.js
File diff suppressed because one or more lines are too long
1
example
Submodule
1
example
Submodule
Submodule example added at bff8dd76c5
12618
package-lock.json
generated
12618
package-lock.json
generated
File diff suppressed because it is too large
Load Diff
@@ -4,7 +4,7 @@
|
|||||||
"name": "Rick van Lieshout",
|
"name": "Rick van Lieshout",
|
||||||
"email": "info@rickvanlieshout.com"
|
"email": "info@rickvanlieshout.com"
|
||||||
},
|
},
|
||||||
"version": "5.2.0",
|
"version": "7.2.1",
|
||||||
"description": "A small, simple and customizable cookie consent bar for use in React applications.",
|
"description": "A small, simple and customizable cookie consent bar for use in React applications.",
|
||||||
"main": "build/index.js",
|
"main": "build/index.js",
|
||||||
"types": "build/index.d.ts",
|
"types": "build/index.d.ts",
|
||||||
@@ -13,7 +13,7 @@
|
|||||||
"prop-types": "^15.7.2"
|
"prop-types": "^15.7.2"
|
||||||
},
|
},
|
||||||
"peerDependencies": {
|
"peerDependencies": {
|
||||||
"react": "^16.13.1"
|
"react": "^16.13.1 || ^17.0.0"
|
||||||
},
|
},
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"build": "webpack",
|
"build": "webpack",
|
||||||
@@ -21,7 +21,8 @@
|
|||||||
"patch": "npm --no-git-tag-version version patch",
|
"patch": "npm --no-git-tag-version version patch",
|
||||||
"minor": "npm --no-git-tag-version version minor",
|
"minor": "npm --no-git-tag-version version minor",
|
||||||
"major": "npm --no-git-tag-version version major",
|
"major": "npm --no-git-tag-version version major",
|
||||||
"release": "npm run build && git add -A && PACKAGE_VERSION=$(cat package.json | grep version | head -1 | awk -F: '{ print $2 }' | sed 's/[\",]//g' | tr -d '[[:space:]]') && git tag $PACKAGE_VERSION && git commit -m 'release $PACKAGE_VERSION' && git push && git push --tags && npm publish",
|
"preversion": "grep \"\\[$npm_package_version\\]\" CHANGELOG.md > /dev/null || ( echo 'You need to add an entry in CHANGELOG.md for this version.' && false )",
|
||||||
|
"release": "npm run build && git add -A && git tag $npm_package_version && git commit -m \"release $npm_package_version\" && git push && git push --tags && npm publish",
|
||||||
"release-patch": "npm run patch && npm run release",
|
"release-patch": "npm run patch && npm run release",
|
||||||
"release-minor": "npm run minor && npm run release",
|
"release-minor": "npm run minor && npm run release",
|
||||||
"release-major": "npm run major && npm run release"
|
"release-major": "npm run major && npm run release"
|
||||||
|
|||||||
32
src/index.d.ts
vendored
32
src/index.d.ts
vendored
@@ -4,6 +4,7 @@ import Cookies from "js-cookie";
|
|||||||
export interface CookieConsentProps {
|
export interface CookieConsentProps {
|
||||||
location?: "top" | "bottom" | "none";
|
location?: "top" | "bottom" | "none";
|
||||||
sameSite?: "strict" | "lax" | "none";
|
sameSite?: "strict" | "lax" | "none";
|
||||||
|
visible?: "hidden" | "show" | "byCookieValue";
|
||||||
cookieSecurity?: boolean;
|
cookieSecurity?: boolean;
|
||||||
style?: object;
|
style?: object;
|
||||||
buttonStyle?: object;
|
buttonStyle?: object;
|
||||||
@@ -12,7 +13,8 @@ export interface CookieConsentProps {
|
|||||||
children?: React.ReactNode;
|
children?: React.ReactNode;
|
||||||
disableStyles?: boolean;
|
disableStyles?: boolean;
|
||||||
hideOnAccept?: boolean;
|
hideOnAccept?: boolean;
|
||||||
onAccept?: () => void;
|
hideOnDecline?: boolean;
|
||||||
|
onAccept?: (acceptedByScrolling?: boolean) => void;
|
||||||
onDecline?: Function;
|
onDecline?: Function;
|
||||||
buttonText?: Function | React.ReactNode;
|
buttonText?: Function | React.ReactNode;
|
||||||
declineButtonText?: Function | React.ReactNode;
|
declineButtonText?: Function | React.ReactNode;
|
||||||
@@ -37,10 +39,38 @@ export interface CookieConsentProps {
|
|||||||
overlay?: boolean;
|
overlay?: boolean;
|
||||||
overlayClasses?: string;
|
overlayClasses?: string;
|
||||||
overlayStyle?: object;
|
overlayStyle?: object;
|
||||||
|
onOverlayClick?: () => void;
|
||||||
|
acceptOnOverlayClick?: boolean;
|
||||||
ariaAcceptLabel?: string;
|
ariaAcceptLabel?: string;
|
||||||
ariaDeclineLabel?: string;
|
ariaDeclineLabel?: string;
|
||||||
|
acceptOnScroll?: boolean;
|
||||||
|
acceptOnScrollPercentage?: number;
|
||||||
|
customContentAttributes?: object;
|
||||||
|
customContainerAttributes?: object;
|
||||||
|
customButtonProps?: object;
|
||||||
}
|
}
|
||||||
|
|
||||||
export default class CookieConsent extends React.Component<CookieConsentProps, {}> {}
|
export default class CookieConsent extends React.Component<CookieConsentProps, {}> {}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Returns the value of the consent cookie
|
||||||
|
* Retrieves the regular value first and if not found the legacy one according
|
||||||
|
* to: https://web.dev/samesite-cookie-recipes/#handling-incompatible-clients
|
||||||
|
* @param {*} name optional name of the cookie
|
||||||
|
*/
|
||||||
|
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);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get the legacy cookie name by the regular cookie name
|
||||||
|
* @param {string} name of cookie to get
|
||||||
|
*/
|
||||||
|
export function getLegacyCookieName(name: string);
|
||||||
|
|
||||||
export { Cookies };
|
export { Cookies };
|
||||||
|
|||||||
177
src/index.js
177
src/index.js
@@ -14,6 +14,50 @@ export const SAME_SITE_OPTIONS = {
|
|||||||
NONE: "none",
|
NONE: "none",
|
||||||
};
|
};
|
||||||
|
|
||||||
|
export const VISIBLE_OPTIONS = {
|
||||||
|
HIDDEN: "hidden",
|
||||||
|
SHOW: "show",
|
||||||
|
BY_COOKIE_VALUE: "byCookieValue",
|
||||||
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Returns the value of the consent cookie
|
||||||
|
* Retrieves the regular value first and if not found the legacy one according
|
||||||
|
* to: https://web.dev/samesite-cookie-recipes/#handling-incompatible-clients
|
||||||
|
* @param {*} name optional name of the cookie
|
||||||
|
*/
|
||||||
|
export const getCookieConsentValue = (name = defaultCookieConsentName) => {
|
||||||
|
let cookieValue = Cookies.get(name);
|
||||||
|
|
||||||
|
// if the cookieValue is undefined check for the legacy cookie
|
||||||
|
if (cookieValue === undefined) {
|
||||||
|
cookieValue = Cookies.get(getLegacyCookieName(name));
|
||||||
|
}
|
||||||
|
return cookieValue;
|
||||||
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 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 const resetCookieConsentValue = (name = defaultCookieConsentName) => {
|
||||||
|
Cookies.remove(name);
|
||||||
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get the legacy cookie name by the regular cookie name
|
||||||
|
* @param {string} name of cookie to get
|
||||||
|
*/
|
||||||
|
const getLegacyCookieName = (name) => {
|
||||||
|
return `${name}-legacy`;
|
||||||
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Default name of the cookie which is set by CookieConsent
|
||||||
|
*/
|
||||||
|
const defaultCookieConsentName = "CookieConsent";
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* A function to wrap elements with a "wrapper" on a condition
|
* A function to wrap elements with a "wrapper" on a condition
|
||||||
* @param {object} wrappingOptions
|
* @param {object} wrappingOptions
|
||||||
@@ -28,7 +72,6 @@ const ConditionalWrapper = ({ condition, wrapper, children }) => {
|
|||||||
class CookieConsent extends Component {
|
class CookieConsent extends Component {
|
||||||
constructor(props) {
|
constructor(props) {
|
||||||
super(props);
|
super(props);
|
||||||
this.accept.bind(this);
|
|
||||||
|
|
||||||
this.state = {
|
this.state = {
|
||||||
visible: false,
|
visible: false,
|
||||||
@@ -88,35 +131,51 @@ class CookieConsent extends Component {
|
|||||||
// if cookie undefined or debug
|
// if cookie undefined or debug
|
||||||
if (this.getCookieValue() === undefined || debug) {
|
if (this.getCookieValue() === undefined || debug) {
|
||||||
this.setState({ visible: true });
|
this.setState({ visible: true });
|
||||||
|
// if acceptOnScroll is set to true and (cookie is undefined or debug is set to true), add a listener.
|
||||||
|
if (this.props.acceptOnScroll) {
|
||||||
|
window.addEventListener("scroll", this.handleScroll, { passive: true });
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
componentWillUnmount() {
|
||||||
|
// remove listener if still set
|
||||||
|
this.removeScrollListener();
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Set a persistent accept cookie
|
* Set a persistent accept cookie
|
||||||
*/
|
*/
|
||||||
accept() {
|
accept(acceptedByScrolling = false) {
|
||||||
const { cookieName, cookieValue, hideOnAccept, onAccept } = this.props;
|
const { cookieName, cookieValue, hideOnAccept, onAccept } = this.props;
|
||||||
|
|
||||||
this.setCookie(cookieName, cookieValue);
|
this.setCookie(cookieName, cookieValue);
|
||||||
|
|
||||||
onAccept();
|
onAccept(acceptedByScrolling ?? false);
|
||||||
|
|
||||||
if (hideOnAccept) {
|
if (hideOnAccept) {
|
||||||
this.setState({ visible: false });
|
this.setState({ visible: false });
|
||||||
|
this.removeScrollListener();
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Handle a click on the overlay
|
||||||
|
*/
|
||||||
|
overlayClick() {
|
||||||
|
const { acceptOnOverlayClick, onOverlayClick } = this.props;
|
||||||
|
if (acceptOnOverlayClick) {
|
||||||
|
this.accept();
|
||||||
|
}
|
||||||
|
onOverlayClick();
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Set a persistent decline cookie
|
* Set a persistent decline cookie
|
||||||
*/
|
*/
|
||||||
decline() {
|
decline() {
|
||||||
const {
|
const { cookieName, declineCookieValue, hideOnDecline, onDecline, setDeclineCookie } =
|
||||||
cookieName,
|
this.props;
|
||||||
declineCookieValue,
|
|
||||||
hideOnDecline,
|
|
||||||
onDecline,
|
|
||||||
setDeclineCookie,
|
|
||||||
} = this.props;
|
|
||||||
|
|
||||||
if (setDeclineCookie) {
|
if (setDeclineCookie) {
|
||||||
this.setCookie(cookieName, declineCookieValue);
|
this.setCookie(cookieName, declineCookieValue);
|
||||||
@@ -129,14 +188,6 @@ class CookieConsent extends Component {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* Get the legacy cookie name by the regular cookie name
|
|
||||||
* @param {string} name of cookie to get
|
|
||||||
*/
|
|
||||||
getLegacyCookieName(name) {
|
|
||||||
return `${name}-legacy`;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Function to set the consent cookie based on the provided variables
|
* Function to set the consent cookie based on the provided variables
|
||||||
* Sets two cookies to handle incompatible browsers, more details:
|
* Sets two cookies to handle incompatible browsers, more details:
|
||||||
@@ -154,7 +205,7 @@ class CookieConsent extends Component {
|
|||||||
|
|
||||||
// Fallback for older browsers where can not set SameSite=None, SEE: https://web.dev/samesite-cookie-recipes/#handling-incompatible-clients
|
// 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) {
|
if (sameSite === SAME_SITE_OPTIONS.NONE) {
|
||||||
Cookies.set(this.getLegacyCookieName(cookieName), cookieValue, cookieOptions);
|
Cookies.set(getLegacyCookieName(cookieName), cookieValue, cookieOptions);
|
||||||
}
|
}
|
||||||
|
|
||||||
// set the regular cookie
|
// set the regular cookie
|
||||||
@@ -168,20 +219,50 @@ class CookieConsent extends Component {
|
|||||||
*/
|
*/
|
||||||
getCookieValue() {
|
getCookieValue() {
|
||||||
const { cookieName } = this.props;
|
const { cookieName } = this.props;
|
||||||
|
return getCookieConsentValue(cookieName);
|
||||||
let cookieValue = Cookies.get(cookieName);
|
|
||||||
|
|
||||||
// if the cookieValue is undefined check for the legacy cookie
|
|
||||||
if (cookieValue === undefined) {
|
|
||||||
cookieValue = Cookies.get(this.getLegacyCookieName(cookieName));
|
|
||||||
}
|
|
||||||
return cookieValue;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* checks whether scroll has exceeded set amount and fire accept if so.
|
||||||
|
*/
|
||||||
|
handleScroll = () => {
|
||||||
|
const { acceptOnScrollPercentage } = this.props;
|
||||||
|
|
||||||
|
// (top / height) - height * 100
|
||||||
|
let rootNode = document.documentElement,
|
||||||
|
body = document.body,
|
||||||
|
top = "scrollTop",
|
||||||
|
height = "scrollHeight";
|
||||||
|
|
||||||
|
let percentage =
|
||||||
|
((rootNode[top] || body[top]) /
|
||||||
|
((rootNode[height] || body[height]) - rootNode.clientHeight)) *
|
||||||
|
100;
|
||||||
|
|
||||||
|
if (percentage > acceptOnScrollPercentage) {
|
||||||
|
this.accept(true);
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
removeScrollListener = () => {
|
||||||
|
const { acceptOnScroll } = this.props;
|
||||||
|
if (acceptOnScroll) {
|
||||||
|
window.removeEventListener("scroll", this.handleScroll);
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
render() {
|
render() {
|
||||||
// If the bar shouldn't be visible don't render anything.
|
// If the bar shouldn't be visible don't render anything.
|
||||||
if (!this.state.visible) {
|
switch (this.props.visible) {
|
||||||
return null;
|
case VISIBLE_OPTIONS.HIDDEN:
|
||||||
|
return null;
|
||||||
|
case VISIBLE_OPTIONS.BY_COOKIE_VALUE:
|
||||||
|
if (!this.state.visible) {
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
break;
|
||||||
|
default:
|
||||||
|
break;
|
||||||
}
|
}
|
||||||
|
|
||||||
const {
|
const {
|
||||||
@@ -209,6 +290,9 @@ class CookieConsent extends Component {
|
|||||||
overlayStyle,
|
overlayStyle,
|
||||||
ariaAcceptLabel,
|
ariaAcceptLabel,
|
||||||
ariaDeclineLabel,
|
ariaDeclineLabel,
|
||||||
|
customContainerAttributes,
|
||||||
|
customContentAttributes,
|
||||||
|
customButtonProps,
|
||||||
} = this.props;
|
} = this.props;
|
||||||
|
|
||||||
let myStyle = {};
|
let myStyle = {};
|
||||||
@@ -276,12 +360,15 @@ class CookieConsent extends Component {
|
|||||||
// add accept button
|
// add accept button
|
||||||
buttonsToRender.push(
|
buttonsToRender.push(
|
||||||
<ButtonComponent
|
<ButtonComponent
|
||||||
|
{...customButtonProps}
|
||||||
key="acceptButton"
|
key="acceptButton"
|
||||||
style={myButtonStyle}
|
style={myButtonStyle}
|
||||||
className={buttonClasses}
|
className={buttonClasses}
|
||||||
id={buttonId}
|
id={buttonId}
|
||||||
aria-label={ariaAcceptLabel}
|
aria-label={ariaAcceptLabel}
|
||||||
onClick={this.accept}
|
onClick={() => {
|
||||||
|
this.accept();
|
||||||
|
}}
|
||||||
>
|
>
|
||||||
{buttonText}
|
{buttonText}
|
||||||
</ButtonComponent>
|
</ButtonComponent>
|
||||||
@@ -295,13 +382,19 @@ class CookieConsent extends Component {
|
|||||||
<ConditionalWrapper
|
<ConditionalWrapper
|
||||||
condition={overlay}
|
condition={overlay}
|
||||||
wrapper={(children) => (
|
wrapper={(children) => (
|
||||||
<div style={myOverlayStyle} className={overlayClasses}>
|
<div
|
||||||
|
style={myOverlayStyle}
|
||||||
|
className={overlayClasses}
|
||||||
|
onClick={() => {
|
||||||
|
this.overlayClick();
|
||||||
|
}}
|
||||||
|
>
|
||||||
{children}
|
{children}
|
||||||
</div>
|
</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}
|
{this.props.children}
|
||||||
</div>
|
</div>
|
||||||
<div className={`${buttonWrapperClasses}`}>
|
<div className={`${buttonWrapperClasses}`}>
|
||||||
@@ -317,6 +410,7 @@ class CookieConsent extends Component {
|
|||||||
|
|
||||||
CookieConsent.propTypes = {
|
CookieConsent.propTypes = {
|
||||||
location: PropTypes.oneOf(Object.keys(OPTIONS).map((key) => OPTIONS[key])),
|
location: PropTypes.oneOf(Object.keys(OPTIONS).map((key) => OPTIONS[key])),
|
||||||
|
visible: PropTypes.oneOf(Object.keys(VISIBLE_OPTIONS).map((key) => VISIBLE_OPTIONS[key])),
|
||||||
sameSite: PropTypes.oneOf(Object.keys(SAME_SITE_OPTIONS).map((key) => SAME_SITE_OPTIONS[key])),
|
sameSite: PropTypes.oneOf(Object.keys(SAME_SITE_OPTIONS).map((key) => SAME_SITE_OPTIONS[key])),
|
||||||
style: PropTypes.object,
|
style: PropTypes.object,
|
||||||
buttonStyle: PropTypes.object,
|
buttonStyle: PropTypes.object,
|
||||||
@@ -352,8 +446,15 @@ CookieConsent.propTypes = {
|
|||||||
overlay: PropTypes.bool,
|
overlay: PropTypes.bool,
|
||||||
overlayClasses: PropTypes.string,
|
overlayClasses: PropTypes.string,
|
||||||
overlayStyle: PropTypes.object,
|
overlayStyle: PropTypes.object,
|
||||||
|
onOverlayClick: PropTypes.func,
|
||||||
|
acceptOnOverlayClick: PropTypes.bool,
|
||||||
ariaAcceptLabel: PropTypes.string,
|
ariaAcceptLabel: PropTypes.string,
|
||||||
ariaDeclineLabel: PropTypes.string,
|
ariaDeclineLabel: PropTypes.string,
|
||||||
|
acceptOnScroll: PropTypes.bool,
|
||||||
|
acceptOnScrollPercentage: PropTypes.number,
|
||||||
|
customContentAttributes: PropTypes.object,
|
||||||
|
customContainerAttributes: PropTypes.object,
|
||||||
|
customButtonProps: PropTypes.object,
|
||||||
};
|
};
|
||||||
|
|
||||||
CookieConsent.defaultProps = {
|
CookieConsent.defaultProps = {
|
||||||
@@ -361,9 +462,10 @@ CookieConsent.defaultProps = {
|
|||||||
hideOnAccept: true,
|
hideOnAccept: true,
|
||||||
hideOnDecline: true,
|
hideOnDecline: true,
|
||||||
location: OPTIONS.BOTTOM,
|
location: OPTIONS.BOTTOM,
|
||||||
|
visible: VISIBLE_OPTIONS.BY_COOKIE_VALUE,
|
||||||
onAccept: () => {},
|
onAccept: () => {},
|
||||||
onDecline: () => {},
|
onDecline: () => {},
|
||||||
cookieName: "CookieConsent",
|
cookieName: defaultCookieConsentName,
|
||||||
cookieValue: true,
|
cookieValue: true,
|
||||||
declineCookieValue: false,
|
declineCookieValue: false,
|
||||||
setDeclineCookie: true,
|
setDeclineCookie: true,
|
||||||
@@ -386,8 +488,15 @@ CookieConsent.defaultProps = {
|
|||||||
ButtonComponent: ({ children, ...props }) => <button {...props}>{children}</button>,
|
ButtonComponent: ({ children, ...props }) => <button {...props}>{children}</button>,
|
||||||
overlay: false,
|
overlay: false,
|
||||||
overlayClasses: "",
|
overlayClasses: "",
|
||||||
|
onOverlayClick: () => {},
|
||||||
|
acceptOnOverlayClick: false,
|
||||||
ariaAcceptLabel: "Accept cookies",
|
ariaAcceptLabel: "Accept cookies",
|
||||||
ariaDeclineLabel: "Decline cookies",
|
ariaDeclineLabel: "Decline cookies",
|
||||||
|
acceptOnScroll: false,
|
||||||
|
acceptOnScrollPercentage: 25,
|
||||||
|
customContentAttributes: {},
|
||||||
|
customContainerAttributes: {},
|
||||||
|
customButtonProps: {},
|
||||||
};
|
};
|
||||||
|
|
||||||
export default CookieConsent;
|
export default CookieConsent;
|
||||||
|
|||||||
@@ -6,14 +6,21 @@ module.exports = {
|
|||||||
output: {
|
output: {
|
||||||
path: path.resolve(__dirname, "build"),
|
path: path.resolve(__dirname, "build"),
|
||||||
filename: "index.js",
|
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: {
|
module: {
|
||||||
rules: [
|
rules: [
|
||||||
{
|
{
|
||||||
test: /\.js$/,
|
test: /\.js$/,
|
||||||
include: path.resolve(__dirname, "src"),
|
include: path.resolve(__dirname, "src"),
|
||||||
exclude: /(node_modules|bower_components|build)/,
|
exclude: /(node_modules|build)/,
|
||||||
use: {
|
use: {
|
||||||
loader: "babel-loader",
|
loader: "babel-loader",
|
||||||
options: {
|
options: {
|
||||||
|
|||||||
Reference in New Issue
Block a user