18 Commits
5.1.1 ... 6.0.0

Author SHA1 Message Date
Gerard Brull
86226dfbe3 Upgrade deps (#93) 2020-11-02 19:17:06 +01:00
Gerard Brull
d0c619542d Remove scroll on accept (#89) 2020-11-02 19:16:58 +01:00
f6243bd987 added the contributing guidelines and added package-lock.json (Thanks to @poteirard) 2020-11-01 09:16:36 +01:00
d99d88f5b8 readme update 2020-10-14 09:03:22 +02:00
f51e2a0555 release $PACKAGE_VERSION 2020-10-13 22:16:59 +02:00
5e4e8406e6 added aria label capabilities for both buttons 2020-10-13 22:13:09 +02:00
b1913d223e release $PACKAGE_VERSION 2020-10-04 09:52:10 +02:00
cb93ae6387 set default SameSite attribute to "lax" 2020-10-04 09:51:53 +02:00
35e45c3125 Create stale.yml 2020-08-16 16:30:08 +02:00
a7fe76056e auto tagging 2020-07-23 13:02:26 +02:00
3471a72b1e version bump and build 2020-07-23 12:50:54 +02:00
777ceb8e1a 5.1.3 2020-07-23 12:50:52 +02:00
72443a758a added link to github release and releasing will now create a git tag 2020-07-23 12:50:49 +02:00
Benedikt Bauer
5910a110ce Add ButtonWrapperClass from v4 to type definition (#80) 2020-07-23 12:44:16 +02:00
a56e806ee2 Update README.md
Added an explanation of the legacy cookie to the readme.
2020-07-06 10:12:54 +02:00
13c6909b1a align changelog with version 2020-06-28 12:00:32 +02:00
97bb1e5be0 version bump and build 2020-06-28 11:58:17 +02:00
Bram Devries
4fa6476406 Set cookie value before handling side-effects (#76) 2020-06-28 11:26:06 +02:00
13 changed files with 6704 additions and 201 deletions

View File

@@ -1,8 +1,8 @@
{ {
"presets": ["env"], "presets": ["@babel/preset-env"],
"plugins": [ "plugins": [
"transform-object-rest-spread", "@babel/plugin-proposal-object-rest-spread",
"transform-react-jsx", "@babel/plugin-transform-react-jsx",
"transform-object-assign" "@babel/plugin-transform-object-assign"
] ]
} }

1
.gitignore vendored
View File

@@ -1,2 +1 @@
node_modules node_modules
package-lock.json

View File

@@ -5,6 +5,31 @@ 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).
## [[5.2.0](https://github.com/Mastermindzh/react-cookie-consent/releases/tag/5.2.0)]
### added
Added aria labels for both the decline and accept button
## [[5.1.4](https://github.com/Mastermindzh/react-cookie-consent/releases/tag/5.1.4)]
### changed
- set default SameSite attribute to "lax" because browsers are already implementing the cookie policy changes.
## [[5.1.3](https://github.com/Mastermindzh/react-cookie-consent/releases/tag/5.1.3)]
### changed
- Fix missing buttonWrapperClasses prop in type definition
## [5.1.2]
### changed
- Set cookie value before handling side-effects.
- The overlay is now conditional. Meaning that the component behaves exactly as it did prior to 5.1.0 when you do not use the overlay
## [5.1.0] ## [5.1.0]
A new feature! This time it's an "overlay" on the entire website to block access whilst the cookiebar is displayed. A new feature! This time it's an "overlay" on the entire website to block access whilst the cookiebar is displayed.

152
CONTRIBUTING.md Normal file
View File

@@ -0,0 +1,152 @@
# Contributing
When contributing to this repository, please first discuss the change you wish to make via issue,
email, or any other method with the owners of this repository before making a changes in order to avoid wasting your time.
## scope
Please keep the scope of a PR down to a single change.
You can make multiple prs to change multiple things though.
## builds
Don't modify anything in the build/ directory please.
This will be done on release.
## Pull Request Process
1. Code away :D
2. Update the README.md with details of changes to the interface, this includes new environment
variables, exposed ports, useful file locations and container parameters.
_Please don't change the format of the variable table in the README_
3. Add the section "[next]" to the CHANGELOG.md and describe what you changed and why.
4. Create the PR. yay.
## Contributor Covenant Code of Conduct
### Our Pledge
We as members, contributors, and leaders pledge to make participation in our
community a harassment-free experience for everyone, regardless of age, body
size, visible or invisible disability, ethnicity, sex characteristics, gender
identity and expression, level of experience, education, socio-economic status,
nationality, personal appearance, race, religion, or sexual identity
and orientation.
We pledge to act and interact in ways that contribute to an open, welcoming,
diverse, inclusive, and healthy community.
### Our Standards
Examples of behavior that contributes to a positive environment for our
community include:
- Demonstrating empathy and kindness toward other people
- Being respectful of differing opinions, viewpoints, and experiences
- Giving and gracefully accepting constructive feedback
- Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience
- Focusing on what is best not just for us as individuals, but for the
overall community
Examples of unacceptable behavior include:
- The use of sexualized language or imagery, and sexual attention or
advances of any kind
- Trolling, insulting or derogatory comments, and personal or political attacks
- Public or private harassment
- Publishing others' private information, such as a physical or email
address, without their explicit permission
- Other conduct which could reasonably be considered inappropriate in a
professional setting
### Enforcement Responsibilities
Community leaders are responsible for clarifying and enforcing our standards of
acceptable behavior and will take appropriate and fair corrective action in
response to any behavior that they deem inappropriate, threatening, offensive,
or harmful.
Community leaders have the right and responsibility to remove, edit, or reject
comments, commits, code, wiki edits, issues, and other contributions that are
not aligned to this Code of Conduct, and will communicate reasons for moderation
decisions when appropriate.
### Scope
This Code of Conduct applies within all community spaces, and also applies when
an individual is officially representing the community in public spaces.
Examples of representing our community include using an official e-mail address,
posting via an official social media account, or acting as an appointed
representative at an online or offline event.
### Enforcement
Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement at
[info@rickvanlieshout.com](mailto:info@rickvanlieshout.com).
All complaints will be reviewed and investigated fairly.
All community leaders are obligated to respect the privacy and security of the
reporter of any incident.
### Enforcement Guidelines
Community leaders will follow these Community Impact Guidelines in determining
the consequences for any action they deem in violation of this Code of Conduct:
#### 1. Correction
**Community Impact**: Use of inappropriate language or other behavior deemed
unprofessional or unwelcome in the community.
**Consequence**: A private, written warning from community leaders, providing
clarity around the nature of the violation and an explanation of why the
behavior was inappropriate. A public apology may be requested.
#### 2. Warning
**Community Impact**: A violation through a single incident or series
of actions.
**Consequence**: A warning with consequences for continued behavior. No
interaction with the people involved, including unsolicited interaction with
those enforcing the Code of Conduct, for a specified period of time. This
includes avoiding interactions in community spaces as well as external channels
like social media. Violating these terms may lead to a temporary or
permanent ban.
#### 3. Temporary Ban
**Community Impact**: A serious violation of community standards, including
sustained inappropriate behavior.
**Consequence**: A temporary ban from any sort of interaction or public
communication with the community for a specified period of time. No public or
private interaction with the people involved, including unsolicited interaction
with those enforcing the Code of Conduct, is allowed during this period.
Violating these terms may lead to a permanent ban.
#### 4. Permanent Ban
**Community Impact**: Demonstrating a pattern of violation of community
standards, including sustained inappropriate behavior, harassment of an
individual, or aggression toward or disparagement of classes of individuals.
**Consequence**: A permanent ban from any sort of public interaction within
the community.
### Attribution
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 2.0, available at
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
Community Impact Guidelines were inspired by [Mozilla's code of conduct
enforcement ladder](https://github.com/mozilla/diversity).
[homepage]: https://www.contributor-covenant.org
For answers to common questions about this code of conduct, see the FAQ at
https://www.contributor-covenant.org/faq. Translations are available at
https://www.contributor-covenant.org/translations.

124
README.md
View File

@@ -22,12 +22,12 @@ Example branch: https://github.com/Mastermindzh/react-cookie-consent/tree/exampl
- [Using it](#using-it) - [Using it](#using-it)
- [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-)
- [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)
@@ -84,18 +84,12 @@ 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. 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: 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:
```js ```js
<CookieConsent <CookieConsent
acceptOnScroll={true} 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>
``` ```
@@ -113,45 +107,45 @@ If the decline button is enabled then the (onDecline) prop function can be used,
## 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 | | 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) | | 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) | | 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) | | buttonText | string or React component | "I understand" | Text to appear on the button |
| acceptOnScrollPercentage | number | 25 | Percentage of the page height the user has to scroll to trigger the accept function if acceptOnScroll is enabled | | 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 | `({ acceptedByScrolling }) => {}` | 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 |
## Debugging it ## Debugging it
@@ -163,6 +157,22 @@ Because the cookie consent bar will be hidden once accepted, you will have to se
**Note:** Don't forget to remove the `debug`-property for production. **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 [186-192](https://github.com/Mastermindzh/react-cookie-consent/blob/master/src/index.js#L186-L192)
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](https://github.com/Mastermindzh/react-cookie-consent/pull/68)
## Styling it ## 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". 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".
@@ -209,22 +219,6 @@ Which results in:
![bootstrap styling](https://github.com/Mastermindzh/react-cookie-consent/blob/master/images/css_classes.png?raw=true) ![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
<CookieConsent
acceptOnScroll={true}
acceptOnScrollPercentage={50}
onAccept={() => {
alert("consent given");
}}
>
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:

3
build/index.d.ts vendored
View File

@@ -24,6 +24,7 @@ export interface CookieConsentProps {
expires?: number; expires?: number;
containerClasses?: string; containerClasses?: string;
contentClasses?: string; contentClasses?: string;
buttonWrapperClasses?: string;
buttonClasses?: string; buttonClasses?: string;
declineButtonClasses?: string; declineButtonClasses?: string;
buttonId?: string; buttonId?: string;
@@ -38,6 +39,8 @@ export interface CookieConsentProps {
overlay?: boolean; overlay?: boolean;
overlayClasses?: string; overlayClasses?: string;
overlayStyle?: object; overlayStyle?: object;
ariaAcceptLabel?: string;
ariaDeclineLabel?: string;
} }
export default class CookieConsent extends React.Component<CookieConsentProps, {}> {} export default class CookieConsent extends React.Component<CookieConsentProps, {}> {}

View File

@@ -622,6 +622,21 @@ module.exports = /******/ (function (modules) {
NONE: "none", NONE: "none",
}); });
/**
* A function to wrap elements with a "wrapper" on a condition
* @param {object} wrappingOptions
* condition == boolean condition, when to wrap
* wrapper == style to wrap. e.g <div>{children}</div>
* children == react passes whatever is between tags as children. Don't supply this yourself.
*/
var ConditionalWrapper = function ConditionalWrapper(_ref) {
var condition = _ref.condition,
wrapper = _ref.wrapper,
children = _ref.children;
return condition ? wrapper(children) : children;
};
var CookieConsent = (function (_Component) { var CookieConsent = (function (_Component) {
_inherits(CookieConsent, _Component); _inherits(CookieConsent, _Component);
@@ -676,7 +691,7 @@ module.exports = /******/ (function (modules) {
margin: "15px", margin: "15px",
}, },
overlayStyle: { overlayStyle: {
position: "absolute", position: "fixed",
left: 0, left: 0,
top: 0, top: 0,
width: "100%", width: "100%",
@@ -744,25 +759,24 @@ module.exports = /******/ (function (modules) {
}, },
{ {
key: "accept", key: "accept",
value: function accept(_ref) { value: function accept(_ref2) {
var _ref$acceptedByScroll = _ref.acceptedByScrolling, var _ref2$acceptedByScrol = _ref2.acceptedByScrolling,
acceptedByScrolling = acceptedByScrolling =
_ref$acceptedByScroll === undefined ? false : _ref$acceptedByScroll; _ref2$acceptedByScrol === undefined ? false : _ref2$acceptedByScrol;
var _props = this.props, var _props = this.props,
cookieName = _props.cookieName, cookieName = _props.cookieName,
cookieValue = _props.cookieValue, cookieValue = _props.cookieValue,
hideOnAccept = _props.hideOnAccept, hideOnAccept = _props.hideOnAccept,
onAccept = _props.onAccept; onAccept = _props.onAccept;
// fire onAccept this.setCookie(cookieName, cookieValue);
// fire onAccept
onAccept({ acceptedByScrolling: acceptedByScrolling }); onAccept({ acceptedByScrolling: acceptedByScrolling });
// remove listener if set // remove listener if set
window.removeEventListener("scroll", this.handleScroll); window.removeEventListener("scroll", this.handleScroll);
this.setCookie(cookieName, cookieValue);
if (hideOnAccept) { if (hideOnAccept) {
this.setState({ visible: false }); this.setState({ visible: false });
} }
@@ -784,17 +798,16 @@ module.exports = /******/ (function (modules) {
extraCookieOptions = _props2.extraCookieOptions, extraCookieOptions = _props2.extraCookieOptions,
setDeclineCookie = _props2.setDeclineCookie; setDeclineCookie = _props2.setDeclineCookie;
// fire onDecline if (setDeclineCookie) {
this.setCookie(cookieName, declineCookieValue);
}
// fire onDecline
onDecline(); onDecline();
// remove listener if set // remove listener if set
window.removeEventListener("scroll", this.handleScroll); window.removeEventListener("scroll", this.handleScroll);
if (setDeclineCookie) {
this.setCookie(cookieName, declineCookieValue);
}
if (hideOnDecline) { if (hideOnDecline) {
this.setState({ visible: false }); this.setState({ visible: false });
} }
@@ -900,7 +913,9 @@ module.exports = /******/ (function (modules) {
ButtonComponent = _props4.ButtonComponent, ButtonComponent = _props4.ButtonComponent,
overlay = _props4.overlay, overlay = _props4.overlay,
overlayClasses = _props4.overlayClasses, overlayClasses = _props4.overlayClasses,
overlayStyle = _props4.overlayStyle; overlayStyle = _props4.overlayStyle,
ariaAcceptLabel = _props4.ariaAcceptLabel,
ariaDeclineLabel = _props4.ariaDeclineLabel;
var myStyle = {}; var myStyle = {};
var myButtonStyle = {}; var myButtonStyle = {};
@@ -957,6 +972,7 @@ module.exports = /******/ (function (modules) {
style: myDeclineButtonStyle, style: myDeclineButtonStyle,
className: declineButtonClasses, className: declineButtonClasses,
id: declineButtonId, id: declineButtonId,
"aria-label": ariaDeclineLabel,
onClick: function onClick() { onClick: function onClick() {
_this2.decline(); _this2.decline();
}, },
@@ -974,6 +990,7 @@ module.exports = /******/ (function (modules) {
style: myButtonStyle, style: myButtonStyle,
className: buttonClasses, className: buttonClasses,
id: buttonId, id: buttonId,
"aria-label": ariaAcceptLabel,
onClick: function onClick() { onClick: function onClick() {
_this2.accept({ acceptedByScrolling: false }); _this2.accept({ acceptedByScrolling: false });
}, },
@@ -986,20 +1003,18 @@ module.exports = /******/ (function (modules) {
buttonsToRender.reverse(); buttonsToRender.reverse();
} }
var Wrapper = !overlay return _react2.default.createElement(
? function (props) { ConditionalWrapper,
return _react2.default.createElement("div", props); {
} condition: overlay,
: function (props) { wrapper: function wrapper(children) {
return _react2.default.createElement( return _react2.default.createElement(
"div", "div",
_extends({}, props, { style: myOverlayStyle, className: overlayClasses }) { style: myOverlayStyle, className: overlayClasses },
children
); );
}; },
},
return _react2.default.createElement(
Wrapper,
null,
_react2.default.createElement( _react2.default.createElement(
"div", "div",
{ className: "" + containerClasses, style: myStyle }, { className: "" + containerClasses, style: myStyle },
@@ -1087,6 +1102,8 @@ module.exports = /******/ (function (modules) {
overlay: _propTypes2.default.bool, overlay: _propTypes2.default.bool,
overlayClasses: _propTypes2.default.string, overlayClasses: _propTypes2.default.string,
overlayStyle: _propTypes2.default.object, overlayStyle: _propTypes2.default.object,
ariaAcceptLabel: _propTypes2.default.string,
ariaDeclineLabel: _propTypes2.default.string,
}; };
CookieConsent.defaultProps = { CookieConsent.defaultProps = {
@@ -1117,15 +1134,17 @@ module.exports = /******/ (function (modules) {
disableButtonStyles: false, disableButtonStyles: false,
enableDeclineButton: false, enableDeclineButton: false,
flipButtons: false, flipButtons: false,
sameSite: SAME_SITE_OPTIONS.NONE, sameSite: SAME_SITE_OPTIONS.LAX,
ButtonComponent: function ButtonComponent(_ref2) { ButtonComponent: function ButtonComponent(_ref3) {
var children = _ref2.children, var children = _ref3.children,
props = _objectWithoutProperties(_ref2, ["children"]); props = _objectWithoutProperties(_ref3, ["children"]);
return _react2.default.createElement("button", props, children); return _react2.default.createElement("button", props, children);
}, },
overlay: false, overlay: false,
overlayClasses: "", overlayClasses: "",
ariaAcceptLabel: "Accept cookies",
ariaDeclineLabel: "Decline cookies",
}; };
exports.default = CookieConsent; exports.default = CookieConsent;

6321
package-lock.json generated Normal file

File diff suppressed because it is too large Load Diff

View File

@@ -4,12 +4,13 @@
"name": "Rick van Lieshout", "name": "Rick van Lieshout",
"email": "info@rickvanlieshout.com" "email": "info@rickvanlieshout.com"
}, },
"version": "5.1.1", "version": "5.2.0",
"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",
"dependencies": { "dependencies": {
"js-cookie": "^2.2.1" "js-cookie": "^2.2.1",
"prop-types": "^15.7.2"
}, },
"peerDependencies": { "peerDependencies": {
"react": "^16.13.1" "react": "^16.13.1"
@@ -20,7 +21,7 @@
"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 && git commit -m 'version bump and build' && git push && npm publish", "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",
"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"
@@ -41,28 +42,27 @@
}, },
"homepage": "https://github.com/Mastermindzh/react-cookie-consent#readme", "homepage": "https://github.com/Mastermindzh/react-cookie-consent#readme",
"devDependencies": { "devDependencies": {
"@babel/cli": "^7.12.1",
"@babel/core": "^7.12.3",
"@babel/plugin-proposal-object-rest-spread": "^7.12.1",
"@babel/plugin-transform-object-assign": "^7.12.1",
"@babel/plugin-transform-react-jsx": "^7.12.1",
"@babel/preset-env": "^7.12.1",
"@mastermindzh/prettier-config": "^1.0.0", "@mastermindzh/prettier-config": "^1.0.0",
"@types/js-cookie": "^2.2.6", "@types/js-cookie": "^2.2.6",
"babel-cli": "^6.26.0", "babel-loader": "^8.1.0",
"babel-core": "^6.26.3", "copy-webpack-plugin": "^6.2.1",
"babel-loader": "^7.1.4", "husky": "^4.3.0",
"babel-plugin-transform-object-assign": "^6.22.0", "lint-staged": "^10.5.1",
"babel-plugin-transform-object-rest-spread": "^6.26.0", "prettier": "^2.1.2",
"babel-plugin-transform-react-jsx": "^6.24.1",
"babel-preset-env": "^1.7.0",
"babel-preset-es2015": "^6.24.1",
"babel-preset-stage-1": "^6.24.1",
"copy-webpack-plugin": "^4.6.0",
"husky": "^4.2.5",
"lint-staged": "^10.2.10",
"prettier": "^2.0.5",
"react": "^16.13.1", "react": "^16.13.1",
"webpack": "^2.6.1" "webpack": "^5.3.2",
"webpack-cli": "^4.1.0"
}, },
"prettier": "@mastermindzh/prettier-config", "prettier": "@mastermindzh/prettier-config",
"husky": { "husky": {
"hooks": { "hooks": {
"pre-commit": "lint-staged" "pre-commit": "lint-staged --allow-empty"
} }
}, },
"lint-staged": { "lint-staged": {

13
src/index.d.ts vendored
View File

@@ -12,7 +12,7 @@ export interface CookieConsentProps {
children?: React.ReactNode; children?: React.ReactNode;
disableStyles?: boolean; disableStyles?: boolean;
hideOnAccept?: boolean; hideOnAccept?: boolean;
onAccept?: ({ acceptedByScrolling }: { acceptedByScrolling?: boolean }) => void; onAccept?: () => void;
onDecline?: Function; onDecline?: Function;
buttonText?: Function | React.ReactNode; buttonText?: Function | React.ReactNode;
declineButtonText?: Function | React.ReactNode; declineButtonText?: Function | React.ReactNode;
@@ -24,20 +24,21 @@ export interface CookieConsentProps {
expires?: number; expires?: number;
containerClasses?: string; containerClasses?: string;
contentClasses?: string; contentClasses?: string;
buttonWrapperClasses?: string;
buttonClasses?: string; buttonClasses?: string;
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;
flipButtons?: boolean; flipButtons?: boolean;
ButtonComponent?: React.ElementType; ButtonComponent?: React.ElementType;
overlay?: boolean, overlay?: boolean;
overlayClasses?: string, overlayClasses?: string;
overlayStyle?: object, overlayStyle?: object;
ariaAcceptLabel?: string;
ariaDeclineLabel?: string;
} }
export default class CookieConsent extends React.Component<CookieConsentProps, {}> {} export default class CookieConsent extends React.Component<CookieConsentProps, {}> {}

View File

@@ -14,6 +14,17 @@ export const SAME_SITE_OPTIONS = {
NONE: "none", NONE: "none",
}; };
/**
* A function to wrap elements with a "wrapper" on a condition
* @param {object} wrappingOptions
* condition == boolean condition, when to wrap
* wrapper == style to wrap. e.g <div>{children}</div>
* children == react passes whatever is between tags as children. Don't supply this yourself.
*/
const ConditionalWrapper = ({ condition, wrapper, children }) => {
return condition ? wrapper(children) : children;
};
class CookieConsent extends Component { class CookieConsent extends Component {
constructor(props) { constructor(props) {
super(props); super(props);
@@ -60,7 +71,7 @@ class CookieConsent extends Component {
margin: "15px", margin: "15px",
}, },
overlayStyle: { overlayStyle: {
position: "absolute", position: "fixed",
left: 0, left: 0,
top: 0, top: 0,
width: "100%", width: "100%",
@@ -69,8 +80,6 @@ class CookieConsent extends Component {
backgroundColor: "rgba(0,0,0,0.3)", backgroundColor: "rgba(0,0,0,0.3)",
}, },
}; };
this.handleScroll = this.handleScroll.bind(this);
} }
componentDidMount() { componentDidMount() {
@@ -79,53 +88,19 @@ 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
window.removeEventListener("scroll", this.handleScroll);
}
/**
* checks whether scroll has exceeded set amount and fire accept if so.
*/
handleScroll() {
// (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 > this.props.acceptOnScrollPercentage) {
this.accept({ acceptedByScrolling: true });
} }
} }
/** /**
* Set a persistent accept cookie * Set a persistent accept cookie
*/ */
accept({ acceptedByScrolling = false }) { accept() {
const { cookieName, cookieValue, hideOnAccept, onAccept } = this.props; const { cookieName, cookieValue, hideOnAccept, onAccept } = this.props;
// fire onAccept
onAccept({ acceptedByScrolling });
// remove listener if set
window.removeEventListener("scroll", this.handleScroll);
this.setCookie(cookieName, cookieValue); this.setCookie(cookieName, cookieValue);
onAccept();
if (hideOnAccept) { if (hideOnAccept) {
this.setState({ visible: false }); this.setState({ visible: false });
} }
@@ -138,23 +113,17 @@ class CookieConsent extends Component {
const { const {
cookieName, cookieName,
declineCookieValue, declineCookieValue,
expires,
hideOnDecline, hideOnDecline,
onDecline, onDecline,
extraCookieOptions,
setDeclineCookie, setDeclineCookie,
} = this.props; } = this.props;
// fire onDecline
onDecline();
// remove listener if set
window.removeEventListener("scroll", this.handleScroll);
if (setDeclineCookie) { if (setDeclineCookie) {
this.setCookie(cookieName, declineCookieValue); this.setCookie(cookieName, declineCookieValue);
} }
onDecline();
if (hideOnDecline) { if (hideOnDecline) {
this.setState({ visible: false }); this.setState({ visible: false });
} }
@@ -238,6 +207,8 @@ class CookieConsent extends Component {
overlay, overlay,
overlayClasses, overlayClasses,
overlayStyle, overlayStyle,
ariaAcceptLabel,
ariaDeclineLabel,
} = this.props; } = this.props;
let myStyle = {}; let myStyle = {};
@@ -293,6 +264,7 @@ class CookieConsent extends Component {
style={myDeclineButtonStyle} style={myDeclineButtonStyle}
className={declineButtonClasses} className={declineButtonClasses}
id={declineButtonId} id={declineButtonId}
aria-label={ariaDeclineLabel}
onClick={() => { onClick={() => {
this.decline(); this.decline();
}} }}
@@ -308,9 +280,8 @@ class CookieConsent extends Component {
style={myButtonStyle} style={myButtonStyle}
className={buttonClasses} className={buttonClasses}
id={buttonId} id={buttonId}
onClick={() => { aria-label={ariaAcceptLabel}
this.accept({ acceptedByScrolling: false }); onClick={this.accept}
}}
> >
{buttonText} {buttonText}
</ButtonComponent> </ButtonComponent>
@@ -320,12 +291,15 @@ class CookieConsent extends Component {
buttonsToRender.reverse(); buttonsToRender.reverse();
} }
const Wrapper = !overlay
? (props) => <div {...props} />
: (props) => <div {...props} style={myOverlayStyle} className={overlayClasses} />;
return ( return (
<Wrapper> <ConditionalWrapper
condition={overlay}
wrapper={(children) => (
<div style={myOverlayStyle} className={overlayClasses}>
{children}
</div>
)}
>
<div className={`${containerClasses}`} style={myStyle}> <div className={`${containerClasses}`} style={myStyle}>
<div style={myContentStyle} className={contentClasses}> <div style={myContentStyle} className={contentClasses}>
{this.props.children} {this.props.children}
@@ -336,7 +310,7 @@ class CookieConsent extends Component {
})} })}
</div> </div>
</div> </div>
</Wrapper> </ConditionalWrapper>
); );
} }
} }
@@ -369,8 +343,6 @@ CookieConsent.propTypes = {
declineButtonClasses: PropTypes.string, declineButtonClasses: PropTypes.string,
buttonId: PropTypes.string, buttonId: PropTypes.string,
declineButtonId: PropTypes.string, declineButtonId: PropTypes.string,
acceptOnScroll: PropTypes.bool,
acceptOnScrollPercentage: PropTypes.number,
extraCookieOptions: PropTypes.object, extraCookieOptions: PropTypes.object,
disableButtonStyles: PropTypes.bool, disableButtonStyles: PropTypes.bool,
enableDeclineButton: PropTypes.bool, enableDeclineButton: PropTypes.bool,
@@ -380,14 +352,14 @@ CookieConsent.propTypes = {
overlay: PropTypes.bool, overlay: PropTypes.bool,
overlayClasses: PropTypes.string, overlayClasses: PropTypes.string,
overlayStyle: PropTypes.object, overlayStyle: PropTypes.object,
ariaAcceptLabel: PropTypes.string,
ariaDeclineLabel: PropTypes.string,
}; };
CookieConsent.defaultProps = { CookieConsent.defaultProps = {
disableStyles: false, disableStyles: false,
hideOnAccept: true, hideOnAccept: true,
hideOnDecline: true, hideOnDecline: true,
acceptOnScroll: false,
acceptOnScrollPercentage: 25,
location: OPTIONS.BOTTOM, location: OPTIONS.BOTTOM,
onAccept: () => {}, onAccept: () => {},
onDecline: () => {}, onDecline: () => {},
@@ -410,10 +382,12 @@ CookieConsent.defaultProps = {
disableButtonStyles: false, disableButtonStyles: false,
enableDeclineButton: false, enableDeclineButton: false,
flipButtons: false, flipButtons: false,
sameSite: SAME_SITE_OPTIONS.NONE, sameSite: SAME_SITE_OPTIONS.LAX,
ButtonComponent: ({ children, ...props }) => <button {...props}>{children}</button>, ButtonComponent: ({ children, ...props }) => <button {...props}>{children}</button>,
overlay: false, overlay: false,
overlayClasses: "", overlayClasses: "",
ariaAcceptLabel: "Accept cookies",
ariaDeclineLabel: "Decline cookies",
}; };
export default CookieConsent; export default CookieConsent;

17
stale.yml Normal file
View File

@@ -0,0 +1,17 @@
# Number of days of inactivity before an issue becomes stale
daysUntilStale: 30
# Number of days of inactivity before a stale issue is closed
daysUntilClose: 2
# Issues with these labels will never be considered stale
exemptLabels:
- good first issue
- security
# Label to use when marking an issue as stale
staleLabel: stale
# Comment to post when marking an issue as stale. Set to `false` to disable
markComment: >
This issue has been automatically marked as stale because it has not had
recent activity. It will be closed if no further activity occurs. Thank you
for your contributions.
# Comment to post when closing a stale issue. Set to `false` to disable
closeComment: false

View File

@@ -1,32 +1,30 @@
var path = require('path'); var path = require("path");
var CopyWebpackPlugin = require('copy-webpack-plugin'); var CopyWebpackPlugin = require("copy-webpack-plugin");
module.exports = { module.exports = {
entry: './src/index.js', entry: "./src/index.js",
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. 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.
}, },
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|bower_components|build)/,
use: { use: {
loader: 'babel-loader', loader: "babel-loader",
options: { options: {
presets: ['env'] presets: ["@babel/preset-env"],
} },
} },
} },
] ],
}, },
externals: { externals: {
'react': 'commonjs react' // this line is just to use the React dependency of our parent-testing-project instead of using our own React. react: "commonjs react", // this line is just to use the React dependency of our parent-testing-project instead of using our own React.
}, },
plugins: [ plugins: [new CopyWebpackPlugin({ patterns: [{ from: "src/index.d.ts", to: "index.d.ts" }] })],
new CopyWebpackPlugin([{ from: 'src/index.d.ts', to: 'index.d.ts' }])
]
}; };