13 Commits
5.1.1 ... 5.2.0

Author SHA1 Message Date
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
8 changed files with 154 additions and 47 deletions

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.

View File

@@ -22,6 +22,7 @@ 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)
@@ -163,6 +164,23 @@ 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".

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;

View File

@@ -4,7 +4,7 @@
"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",
@@ -20,7 +20,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"

9
src/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;
@@ -35,9 +36,11 @@ export interface CookieConsentProps {
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%",
@@ -118,14 +129,14 @@ class CookieConsent extends Component {
accept({ acceptedByScrolling = false }) { accept({ acceptedByScrolling = false }) {
const { cookieName, cookieValue, hideOnAccept, onAccept } = this.props; const { cookieName, cookieValue, hideOnAccept, onAccept } = this.props;
this.setCookie(cookieName, cookieValue);
// fire onAccept // fire onAccept
onAccept({ acceptedByScrolling }); onAccept({ 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 });
} }
@@ -145,16 +156,16 @@ class CookieConsent extends Component {
setDeclineCookie, setDeclineCookie,
} = this.props; } = this.props;
if (setDeclineCookie) {
this.setCookie(cookieName, declineCookieValue);
}
// fire onDecline // 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 });
} }
@@ -238,6 +249,8 @@ class CookieConsent extends Component {
overlay, overlay,
overlayClasses, overlayClasses,
overlayStyle, overlayStyle,
ariaAcceptLabel,
ariaDeclineLabel,
} = this.props; } = this.props;
let myStyle = {}; let myStyle = {};
@@ -293,6 +306,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,6 +322,7 @@ class CookieConsent extends Component {
style={myButtonStyle} style={myButtonStyle}
className={buttonClasses} className={buttonClasses}
id={buttonId} id={buttonId}
aria-label={ariaAcceptLabel}
onClick={() => { onClick={() => {
this.accept({ acceptedByScrolling: false }); this.accept({ acceptedByScrolling: false });
}} }}
@@ -320,12 +335,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 +354,7 @@ class CookieConsent extends Component {
})} })}
</div> </div>
</div> </div>
</Wrapper> </ConditionalWrapper>
); );
} }
} }
@@ -380,6 +398,8 @@ 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 = {
@@ -410,10 +430,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