Compare commits

..

No commits in common. "a5f421b8bc4373ab59bbae76e76ab8e84a22b8c8" and "7f5989a539b1bf16337fc21f34cd841f0f3a2acf" have entirely different histories.

8 changed files with 3254 additions and 2686 deletions

View File

@ -1,6 +0,0 @@
{
"sonarlint.connectedMode.project": {
"connectionId": "public-sonarcloud",
"projectKey": "Mastermindzh_react-cookie-consent"
}
}

View File

@ -5,11 +5,6 @@ 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).
## [[9.0.0]((https://github.com/Mastermindzh/react-cookie-consent/releases/tag/9.0.0)]
Made all props optional and fixed documentation.
Fixes [#191](https://github.com/Mastermindzh/react-cookie-consent/issues/191) and [#193](https://github.com/Mastermindzh/react-cookie-consent/issues/193)
## [[8.0.1]((https://github.com/Mastermindzh/react-cookie-consent/releases/tag/8.0.1)] ## [[8.0.1]((https://github.com/Mastermindzh/react-cookie-consent/releases/tag/8.0.1)]
~~Second try of [np](https://github.com/sindresorhus/np)...~~ ~~Second try of [np](https://github.com/sindresorhus/np)...~~
@ -21,7 +16,7 @@ np is not my thing.. reverted to old release strategy
- Switched to tsdx and Typescript - Switched to tsdx and Typescript
- Added storybook with examples from readme - Added storybook with examples from readme
## [[7.6.0]](<https://github.com/Mastermindzh/react-cookie-consent/releases/tag/7.6.0>] ## [[7.6.0]](https://github.com/Mastermindzh/react-cookie-consent/releases/tag/7.6.0]
- Added `customButtonWrapperAttributes` prop which allows to add custom attributes to the button wrapper div - Added `customButtonWrapperAttributes` prop which allows to add custom attributes to the button wrapper div

View File

@ -4,7 +4,7 @@ A small, simple and customizable cookie consent bar for use in React application
[![NPM](https://nodei.co/npm/react-cookie-consent.png)](https://npmjs.org/package/react-cookie-consent) [![NPM](https://nodei.co/npm/react-cookie-consent.png)](https://npmjs.org/package/react-cookie-consent)
Demo (storybook): <https://mastermindzh.github.io/react-cookie-consent/> Demo (storybook): https://mastermindzh.github.io/react-cookie-consent/
![Downloads](https://img.shields.io/npm/dm/react-cookie-consent) ![Dependent repos (via libraries.io)](https://img.shields.io/librariesio/dependent-repos/npm/react-cookie-consent) ![GitHub contributors](https://img.shields.io/github/contributors/mastermindzh/react-cookie-consent) ![Minified size](https://img.shields.io/bundlephobia/min/react-cookie-consent) ![npm type definitions](https://img.shields.io/npm/types/react-cookie-consent) ![license-mit](https://img.shields.io/badge/license-MIT-green) ![Downloads](https://img.shields.io/npm/dm/react-cookie-consent) ![Dependent repos (via libraries.io)](https://img.shields.io/librariesio/dependent-repos/npm/react-cookie-consent) ![GitHub contributors](https://img.shields.io/github/contributors/mastermindzh/react-cookie-consent) ![Minified size](https://img.shields.io/bundlephobia/min/react-cookie-consent) ![npm type definitions](https://img.shields.io/npm/types/react-cookie-consent) ![license-mit](https://img.shields.io/badge/license-MIT-green)
@ -16,17 +16,13 @@ Demo (storybook): <https://mastermindzh.github.io/react-cookie-consent/>
<!-- toc --> <!-- toc -->
- [:cookie: react-cookie-consent :cookie:](#cookie-react-cookie-consent-cookie) - [Installation](#installation)
- [Default look](#default-look) - [Using it](#using-it)
- [Table of contents](#table-of-contents)
- [Installation](#installation)
- [Using it](#using-it)
- [getting the cookies value in your own code](#getting-the-cookies-value-in-your-own-code) - [getting the cookies value in your own code](#getting-the-cookies-value-in-your-own-code)
- [reset the cookies value in your own code](#reset-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)
@ -34,10 +30,10 @@ Demo (storybook): <https://mastermindzh.github.io/react-cookie-consent/>
- [Accept on scroll](#accept-on-scroll) - [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)
- [Overlay](#overlay) - [Overlay](#overlay)
- [Contributor information](#contributor-information) - [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 -->
@ -117,12 +113,12 @@ If the decline button is enabled then the (onDecline) prop function can be used,
### getting the cookies value in your own code ### getting the cookies value in your own code
react-cookie-consent exports a function called `getCookieConsentValue(cookieName: string)`. You can use it in your own code like so: react-cookie-consent exports a function called `getCookieConsentValue`. You can use it in your own code like so:
```js ```js
import CookieConsent, { Cookies, getCookieConsentValue } from "react-cookie-consent"; import CookieConsent, { Cookies, getCookieConsentValue } from "react-cookie-consent";
console.log(getCookieConsentValue("your_custom_cookie_name")); console.log(getCookieConsentValue());
``` ```
### reset the cookies value in your own code ### reset the cookies value in your own code

5763
package-lock.json generated

File diff suppressed because it is too large Load Diff

View File

@ -1,6 +1,6 @@
{ {
"name": "react-cookie-consent", "name": "react-cookie-consent",
"version": "9.0.0", "version": "8.0.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.",
"keywords": [ "keywords": [
"react", "react",

View File

@ -8,54 +8,54 @@ import {
export interface CookieConsentProps { export interface CookieConsentProps {
children?: ReactNode; children?: ReactNode;
style?: React.CSSProperties; style: React.CSSProperties;
buttonStyle?: React.CSSProperties; buttonStyle: React.CSSProperties;
declineButtonStyle?: React.CSSProperties; declineButtonStyle: React.CSSProperties;
contentStyle?: React.CSSProperties; contentStyle: React.CSSProperties;
disableStyles?: boolean; disableStyles: boolean;
hideOnAccept?: boolean; hideOnAccept: boolean;
hideOnDecline?: boolean; hideOnDecline: boolean;
onAccept?: (acceptedByScrolling: boolean) => void; onAccept: (acceptedByScrolling: boolean) => void;
onDecline?: () => void; onDecline: () => void;
buttonText?: string | ReactNode | Function; buttonText: string | ReactNode | Function;
declineButtonText?: string | ReactNode | Function; declineButtonText: string | ReactNode | Function;
cookieName?: string; cookieName: string;
cookieValue?: string | object; cookieValue: string | object;
declineCookieValue?: string | object; declineCookieValue: string | object;
setDeclineCookie?: boolean; setDeclineCookie: boolean;
debug?: boolean; debug: boolean;
expires?: number; expires: number;
containerClasses?: string; containerClasses: string;
contentClasses?: string; contentClasses: string;
buttonClasses?: string; buttonClasses: string;
buttonWrapperClasses?: string; buttonWrapperClasses: string;
declineButtonClasses?: string; declineButtonClasses: string;
buttonId?: string; buttonId: string;
declineButtonId?: string; declineButtonId: string;
overlayClasses?: string; overlayClasses: string;
ariaAcceptLabel?: string; ariaAcceptLabel: string;
ariaDeclineLabel?: string; ariaDeclineLabel: string;
disableButtonStyles?: boolean; disableButtonStyles: boolean;
enableDeclineButton?: boolean; enableDeclineButton: boolean;
flipButtons?: boolean; flipButtons: boolean;
cookieSecurity?: boolean; cookieSecurity?: boolean;
overlay?: boolean; overlay: boolean;
acceptOnOverlayClick?: boolean; acceptOnOverlayClick: boolean;
acceptOnScroll?: boolean; acceptOnScroll: boolean;
acceptOnScrollPercentage?: number; acceptOnScrollPercentage: number;
ButtonComponent?: any; ButtonComponent: any;
extraCookieOptions?: Object; extraCookieOptions: Object;
overlayStyle?: Object; overlayStyle: Object;
customContentAttributes?: Object; customContentAttributes: Object;
customContainerAttributes?: Object; customContainerAttributes: Object;
customButtonProps?: Object; customButtonProps: Object;
customDeclineButtonProps?: Object; customDeclineButtonProps: Object;
customButtonWrapperAttributes?: Object; customButtonWrapperAttributes: Object;
onOverlayClick?: () => void; onOverlayClick: () => void;
// these should be enums // these should be enums
location?: string; location: string;
visible?: string; visible: string;
sameSite?: "strict" | "Strict" | "lax" | "Lax" | "none" | "None"; sameSite: "strict" | "Strict" | "lax" | "Lax" | "none" | "None" | undefined;
} }
const DefaultButtonComponent: FunctionComponent<{ children: ReactNode; [x: string]: any }> = ({ const DefaultButtonComponent: FunctionComponent<{ children: ReactNode; [x: string]: any }> = ({
@ -65,13 +65,13 @@ const DefaultButtonComponent: FunctionComponent<{ children: ReactNode; [x: strin
return <button {...props}>{children}</button>; return <button {...props}>{children}</button>;
}; };
export const defaultCookieConsentProps = { export const defaultCookieConsentProps: CookieConsentProps = {
disableStyles: false, disableStyles: false,
hideOnAccept: true, hideOnAccept: true,
hideOnDecline: true, hideOnDecline: true,
location: POSITION_OPTIONS.BOTTOM, location: POSITION_OPTIONS.BOTTOM,
visible: VISIBILITY_OPTIONS.BY_COOKIE_VALUE, visible: VISIBILITY_OPTIONS.BY_COOKIE_VALUE,
onAccept: (_acceptedByScrolling: boolean) => {}, onAccept: (_acceptedByScrolling) => {},
onDecline: () => {}, onDecline: () => {},
cookieName: defaultCookieConsentName, cookieName: defaultCookieConsentName,
cookieValue: "true", cookieValue: "true",

View File

@ -33,10 +33,7 @@ export class CookieConsent extends Component<CookieConsentProps, CookieConsentSt
* Set a persistent accept cookie * Set a persistent accept cookie
*/ */
accept(acceptedByScrolling = false) { accept(acceptedByScrolling = false) {
const { cookieName, cookieValue, hideOnAccept, onAccept } = { const { cookieName, cookieValue, hideOnAccept, onAccept } = this.props;
...defaultCookieConsentProps,
...this.props,
};
this.setCookie(cookieName, cookieValue); this.setCookie(cookieName, cookieValue);
@ -52,10 +49,7 @@ export class CookieConsent extends Component<CookieConsentProps, CookieConsentSt
* Handle a click on the overlay * Handle a click on the overlay
*/ */
overlayClick() { overlayClick() {
const { acceptOnOverlayClick, onOverlayClick } = { const { acceptOnOverlayClick, onOverlayClick } = this.props;
...defaultCookieConsentProps,
...this.props,
};
if (acceptOnOverlayClick) { if (acceptOnOverlayClick) {
this.accept(); this.accept();
} }
@ -66,10 +60,8 @@ export class CookieConsent extends Component<CookieConsentProps, CookieConsentSt
* Set a persistent decline cookie * Set a persistent decline cookie
*/ */
decline() { decline() {
const { cookieName, declineCookieValue, hideOnDecline, onDecline, setDeclineCookie } = { const { cookieName, declineCookieValue, hideOnDecline, onDecline, setDeclineCookie } =
...defaultCookieConsentProps, this.props;
...this.props,
};
if (setDeclineCookie) { if (setDeclineCookie) {
this.setCookie(cookieName, declineCookieValue); this.setCookie(cookieName, declineCookieValue);
@ -121,7 +113,7 @@ export class CookieConsent extends Component<CookieConsentProps, CookieConsentSt
* checks whether scroll has exceeded set amount and fire accept if so. * checks whether scroll has exceeded set amount and fire accept if so.
*/ */
handleScroll = () => { handleScroll = () => {
const { acceptOnScrollPercentage } = { ...defaultCookieConsentProps, ...this.props }; const { acceptOnScrollPercentage } = this.props;
// (top / height) - height * 100 // (top / height) - height * 100
const rootNode = document.documentElement; const rootNode = document.documentElement;

View File

@ -1,7 +1,7 @@
import { FunctionComponent, ReactNode } from "react"; import { FunctionComponent, ReactNode } from "react";
type Props = { type Props = {
condition?: boolean; condition: boolean;
wrapper: (_: ReactNode) => any; wrapper: (_: ReactNode) => any;
children: ReactNode; children: ReactNode;
}; };