Gathering detailed insights and metrics for @porscheofficial/cookie-consent-banner-react
Gathering detailed insights and metrics for @porscheofficial/cookie-consent-banner-react
The lightweight and flexible Cookie Consent Banner
4.0.3
167
MIT
TypeScript
739.21 kB
Installations
npm install @porscheofficial/cookie-consent-banner-reactDeveloper Guide
BETA
Typescript
Yes
Module System
CommonJS
Node Version
18.18.1
NPM Version
9.8.1
Releases
17
Languages
3
TypeScript
CSS
HTML
TypeScript (63.3%)
CSS (21.74%)
HTML (14.96%)
Developer
porscheofficial
Download Statistics
Total Downloads
0
Last Day
0
Last Week
0
Last Month
0
Last Year
0
GitHub Statistics
MIT License
167 Stars
142 Commits
12 Forks
7 Watchers
5 Branches
5 Contributors
Updated on Jun 30, 2025
Maintainers
2
Package Meta Information
Latest Version
4.0.3
Package Id
@porscheofficial/cookie-consent-banner-react@4.0.3
Unpacked Size
739.21 kB
Size
76.81 kB
File Count
64
NPM Version
9.8.1
Node Version
18.18.1
Published on
Apr 25, 2024
Total Downloads
Cumulative downloads
Total Downloads
NaN
Last Day
0%
NaN
Compared to previous day
Last Week
0%
NaN
Compared to previous week
Last Month
0%
NaN
Compared to previous month
Last Year
0%
NaN
Compared to previous year
Weekly Downloads
Monthly Downloads
Yearly Downloads
Dependencies
1
Cookie Consent Banner – React
The Cookie Consent Banner is implemented as Web Component and additionally exported as React Component. This guide explains how to use the React Component.
Click here to have a look on the documentation of the Web Component.
Make sure to also have a look on the main repository.
:spiral_notepad: Usage
Installation
1// yarn 2yarn add @porscheofficial/cookie-consent-banner-react 3// or npm 4npm i @porscheofficial/cookie-consent-banner-react --S
Properties
| Property (React) | Default | Type | Description |
|---|---|---|---|
availableCategories | [] | CategoryItem[] | Provide the available Categories. See Real World example |
cookieAttributes | {path: "/",expires: 7,domain: document.location.hostname} | CookieAttributes | Customization of the cookie attributes for the consent cookie (expires can either be a number of days or a Date object). |
cookieName | "cookies_accepted_categories" | string | |
disableResetSiteCookiesOnConsentWithdrawn | false | boolean | Prevent cookies from being deleted automatically if consent of the user changed. |
disableSlideInAnimation | false | boolean | Disable slide-in animation of banner (See #7) |
headline | undefined | string | |
btnLabelAcceptAndContinue | undefined | string | |
btnLabelAllAndContinue | undefined | string | |
btnLabelOnlyEssentialAndContinue | undefined | string | |
btnLabelPersistSelectionAndContinue | undefined | string | |
contentSettingsDescription | undefined | string | |
handlePreferencesRestored | undefined | ({ acceptedCategories, }: { acceptedCategories: string[]; }) => void | |
handlePreferencesUpdated | undefined | ({ acceptedCategories, }: { acceptedCategories: string[]; }) => void |
Events Dispatched by the Component
Instead of listening to the events directly, the props handlePreferencesRestored and handlePreferencesUpdated can be used.
| Event | Description |
|---|---|
cookie_consent_preferences_restored | Consent Settings have been saved previously and are now restored on Page Load. |
cookie_consent_preferences_updated | Consent Settings have been updated. Either initially set or changed. |
Events Receivable by the Component
It's possible to send JavaScript Events to control the banner.
| Event | Description |
|---|---|
cookie_consent_show | Show the the Consent Banner. |
cookie_consent_details_show | Show the detailed settings (categories). Also the Consent Banner is shown if not done already. |
How to use it?
In order to allow the user to always update its preferences it's possible to trigger the banner by sending an event:
1<a href="javascript:document.dispatchEvent(new Event('cookie_consent_show'))"> 2 Show Cookie Settings 3</a>
Convenience Functions
React Hook useCookieConsent
Subscribe to changes of the consent.
1import { useCookieConsent } from "@porscheofficial/cookie-consent-banner-react"; 2 3export const SomePage: React.FC = () => { 4 const acceptedCategories = useCookieConsent(); 5 //... 6};
triggerCookieConsentBanner
Easily show the cookie consent banner.
1import { triggerCookieConsentBanner } from "@porscheofficial/cookie-consent-banner-react"; 2 3// Only the banner 4triggerCookieConsentBanner(); 5 6// Also show the details 7triggerCookieConsentBanner({ showDetails: true });
Styling
Styling can be done in two different ways: Either via the availabe CSS Properties or via the CSS ::part pseudo-element.
Styling with CSS Properties
The appearance of the component can be influenced by updating the availabe CSS Properties. In most cases this is enough customization flexibility but since not every aspect is exposed, you might want to use the ::part selectors if you need more flexibility.
1<style> 2 :root { 3 /* COLORS */ 4 --cookie-consent-banner-colors-primary: #81c784; 5 --cookie-consent-banner-colors-primary-border: #81c784; 6 --cookie-consent-banner-colors-primary-content: #fff; 7 --cookie-consent-banner-colors-secondary: transparent; 8 --cookie-consent-banner-colors-secondary-border: #fff; 9 --cookie-consent-banner-colors-secondary-content: #fff; 10 --cookie-consent-banner-colors-background-body: rgba(25, 31, 34, 0.92); 11 --cookie-consent-banner-colors-text: #fff; 12 13 /* BORDER-RADIUS */ 14 --cookie-consent-banner-border-radius-buttons: 1rem; 15 --cookie-consent-banner-border-radius-body: 0; 16 17 // BOX-SHADOW 18 --cookie-consent-banner-box-shadow: 0px -3px 13px 0px rgba(57, 57, 57, 0.38); 19 20 /* SPACINGS */ 21 --cookie-consent-banner-spacings-container-padding-top: 1rem; 22 --cookie-consent-banner-spacings-container-padding-left: 1rem; 23 --cookie-consent-banner-spacings-container-padding-bottom: 1rem; 24 --cookie-consent-banner-spacings-container-padding-right: 1rem; 25 26 --cookie-consent-banner-spacings-body-padding-top: 0; 27 --cookie-consent-banner-spacings-body-padding-left: 2rem; 28 --cookie-consent-banner-spacings-body-padding-bottom: 0; 29 --cookie-consent-banner-spacings-body-padding-right: 2rem; 30 31 /* Z-INDEX */ 32 --cookie-consent-banner-z-index-container: 99; 33 34 /* FONTS */ 35 --cookie-consent-banner-font-family-headline: inherit; 36 --cookie-consent-banner-font-size-headline: 1.5rem; 37 --cookie-consent-banner-font-family-body: inherit; 38 --cookie-consent-banner-font-size-body: 0.875rem; 39 } 40</style>
Styling with the ::part selectors
For full control over the styles we provide you these CSS parts to customize completely by your own:
cookie-consent-banner::part(button-accept-all)for styling the primary button which triggers "Accept All Cookies"cookie-consent-banner::part(button-persist-selection)for styling the secondary button which triggers "Save Selection"cookie-consent-banner::part(button-essential-only)for styling the secondary button which triggers "Only required Cookies"cookie-consent-banner::part(checkbox)for styling the checkboxescookie-consent-banner::part(description-main)for styling the main description textcookie-consent-banner::part(description-settings)for styling the description text on the expanded settingscookie-consent-banner::part(headline)for styling the headlinecookie-consent-banner::part(body)for styling the banner body
1<style> 2 cookie-consent-banner::part(button-accept-all) { 3 text-transform: uppercase; 4 } 5 6 cookie-consent-banner::part(button-persist-selection), 7 cookie-consent-banner::part(button-essential-only) { 8 text-transform: uppercase; 9 box-shadow: 0 2px 5px 0 rgba(0, 0, 0, 0.26); 10 } 11 12 cookie-consent-banner::part(checkbox) { 13 accent-color: rgb(24, 251, 107); 14 } 15 16 cookie-consent-banner::part(description), 17 cookie-consent-banner::part(headline) { 18 font-family: "Arial", sans-serif; 19 } 20</style>
🚀 Real World example with Tag Manager and Custom Error Tracking
This example shows how the component could be integrated into your web application.
Additional scripts that set cookies, for which the consent of the visitor is required, can either be loaded via a tag manager or programmatically.
In the following example, an ErrorTrackingService is initialized after the consent has been given and a Tag Manager Script is added to the head of the page.
Once the visitor stores the consent settings, two things happen: The consent data is stored as a cookie cookies_accepted_categories and the tag manager is initialized, which takes care of other scripts (tags).
Have a look on the main repository for an example consent flow.
1import { 2 CookieConsentBanner, 3 triggerCookieConsentBanner, 4} from "@porscheofficial/cookie-consent-banner-react"; 5 6const initConsent = ({ acceptedCategories }) => { 7 // ------------------------------------------------------------------------- 8 // Error Tracking Service 9 // Analytics 10 // ------------------------------------------------------------------------- 11 if (acceptedCategories.includes("analytics")) { 12 ErrorTrackingService.init({ 13 dsn: process.env.DSN, 14 environment: process.env.ENV, 15 }); 16 } 17}; 18 19const Root = ({ children }) => { 20 const [acceptedCategories, setAcceptedCategories] = useState([]); 21 22 return ( 23 <div> 24 <Helmet> 25 {(Boolean(acceptedCategories.includes("analytics")) || 26 Boolean(acceptedCategories.includes("marketing"))) && 27 process.env.ENV === "prod" && ( 28 <script id="tagmanager-script" key="tagmanager-script"> 29 {/* Load Tag Manager Script */} 30 </script> 31 )} 32 </Helmet> 33 <div>{children}</div> 34 <CookieConsentBanner 35 handlePreferencesUpdated={initConsent} 36 handlePreferencesRestored={initConsent} 37 btnLabelAcceptAndContinue="Agree and continue" 38 btnLabelSelectAllAndContinue="Select all and continue" 39 btnLabelOnlyEssentialAndContinue="Continue with technically required cookies only" 40 btnLabelPersistSelectionAndContinue="Save selection and continue" 41 contentSettingsDescription="You can decide which cookies are used by selecting the respective options below. Please note that your selection may impair in the functionality of the service." 42 availableCategories={[ 43 { 44 description: 45 "Enable you to navigate and use the basic functions and to store preferences.", 46 key: "technically_required", 47 label: "Technically necessary cookies", 48 isMandatory: true, 49 }, 50 { 51 description: 52 "Enable us to determine how visitors interact with our service in order to improve the user experience.", 53 key: "analytics", 54 label: "Analysis cookies", 55 }, 56 { 57 description: 58 "Enable us to offer and evaluate relevant content and interest-based advertising.", 59 key: "marketing", 60 label: "Marketing cookies", 61 }, 62 ]} 63 > 64 We use cookies and similar technologies to provide certain features, 65 enhance the user experience and deliver content that is relevant to your 66 interests. Depending on their purpose, analysis and marketing cookies 67 may be used in addition to technically necessary cookies. By clicking on 68 "Agree and continue", you declare your consent to the use of 69 the aforementioned cookies. 70 <button 71 onClick={() => { 72 triggerCookieConsentBanner({ showDetails: true }); 73 }} 74 onKeyPress={() => { 75 triggerCookieConsentBanner({ showDetails: true }); 76 }} 77 type="button" 78 > 79 Here 80 </button> you can make detailed settings or revoke your consent (in part 81 if necessary) with effect for the future. For further information, please 82 refer to our 83 <a href="/privacy-policy">Privacy Policy</a>. 84 </CookieConsentBanner> 85 </div> 86 ); 87};
Disclaimer
Please note that you must individually assess the legal requirements regarding the implementation of the Cookie Consent Banner, in particular which choices to offer in which granularity and which information to provide in which detail and at which point of the user journey. The examples mentioned are not intended to provide any advice regarding legal requirements. All responsibility for the implementation of the Cookie Consent Banner and its compliance with legal requirements lies with the user.
License
See LICENSE.
No vulnerabilities found.
No security vulnerabilities found.