{"_id":"@porscheofficial/cookie-consent-banner","_rev":"27-7b21dbb0510739da41029da5d6fd1075","name":"@porscheofficial/cookie-consent-banner","dist-tags":{"latest":"4.1.0"},"versions":{"1.0.0":{"name":"@porscheofficial/cookie-consent-banner","version":"1.0.0","license":"MIT","_id":"@porscheofficial/cookie-consent-banner@1.0.0","maintainers":[{"name":"ppuritscher","email":"patrick.puritscher@porsche.digital"},{"name":"open_source_office_porsche","email":"Open_Source_Office@porsche.de"}],"homepage":"https://github.com/porscheofficial/cookie-consent-banner#readme","bugs":{"url":"https://github.com/porscheofficial/cookie-consent-banner/issues"},"dist":{"shasum":"bd48647790332a275221465f7fee594671281b07","tarball":"https://registry.npmjs.org/@porscheofficial/cookie-consent-banner/-/cookie-consent-banner-1.0.0.tgz","fileCount":42,"integrity":"sha512-I1DRC1zfoER9H6QwDwQYW4zEl0rYs19cxD5/eSObuwI+87ORo4Rnb062pbX5/DKnbz2DQiTHf3agFps+4/qoXQ==","signatures":[{"sig":"MEUCIHJrZjikLtfXznW3qINtcsxQA5CHtjDuFtCGKcxDl8eVAiEAq/cBOT74Xccjl0H8NJ3zjZT2CsJrXJ28mZKwxOcl5VA=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":405583,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhQLTcCRA9TVsSAnZWagAAmqgP/2FqLwTibO6+B0rVGNbd\nZH3xu+9GRaWgCN6Q5YMHlQBNbShIvvD8nEVNbWBKKjF50sH3Mf8ey73w+aPS\n7DucUYoF7UQQjYgRknIuotJ9BmgzLRr3CWlRRBgRMAk5rFvN5R0M8PL8AE8S\nFn+3sGCEhrpuUq0fOSeMM9zteeN3cWTjVzSIhveJ9SbhZfUmtltGFPGH7Z3i\nO19BQY8/2UcXhxA4GD5ccpNROWdEpjsbtJwfNBXM4VB+RvsmPuHFzea+Ukhg\neBWUoo3J45DhtJNtEcWDMwEFOUpgLtRbScX7DyQ3oQwBCLwCbjoI7iU7BWjD\nDvlKv5Mea+pIHbDZ+2vbU50tTjVu1wDl/u2RuqkjDR4HqaoRozlirn5uneDB\nC1Ppe0uxnA8Zs49d1u4cThRDYYSFR6awta9lhmsLl52HqTTjsr0vhe3MUWUL\n75Cn5J2jpqF/O3WhRTF5R93ptlon5EbdyZyx/uVN+q8HrcJl34/H2PbgoQ5L\nfWHtyP6ufHxm29QYCmCUc1cGj4Dwx+lXkucFfRGIYH0rOdl2/xnoEHhMKJvw\n/9LKd1rdkjDUiQAuhjIAhk6GmZ3midoYPpyAtjLts8V0CuUsLQo5EFgRoStd\noRxMWuu5rJe8sZb4MiIQcvYC2udKTN4SPhdKxkZJnEzwEf8lOkuV5lhWR1MQ\nxq1m\r\n=njl/\r\n-----END PGP SIGNATURE-----\r\n"},"main":"dist/index.cjs.js","types":"dist/types/index.d.ts","unpkg":"dist/cookie-consent-banner/cookie-consent-banner.js","es2015":"dist/esm/index.js","es2017":"dist/esm/index.js","module":"dist/index.js","scripts":{"test":"stencil test --spec --e2e","build":"stencil build","start":"stencil build --dev --watch --serve","test:ci":"yarn eslint:ci && stencil test --spec --passWithNoTests","generate":"stencil generate","eslint:ci":"eslint ./src/ --ext .js,.jsx,.tsx,.ts -f table","eslint:fix":"eslint ./src/ --fix --ext .js,.jsx,.tsx,.ts -f table","test:watch":"stencil test --spec --e2e --watchAll"},"_npmUser":{"name":"ppuritscher","email":"patrick.puritscher@porsche.digital"},"collection":"dist/collection/collection-manifest.json","repository":{"url":"git+https://github.com/porscheofficial/cookie-consent-banner.git","type":"git","directory":"packages/cookie-consent-banner"},"_npmVersion":"7.20.3","description":"
\"\" \"\" \"\" \"\" \"\" \"\" \"\" \"\" \"\" \"\" \"\" \"\" \"\" \"\" \"\" \"\" \"\" \"\" \"\" \"\" \"\" \"\"\n \n \"\"\n \n\n# Cookie Consent Banner – Web Component\n\n
\n\nThe Cookie Consent Banner is implemented as Web Component and additionally exported as React Component.\nThis guide explains how to use the Web Component.\n\n_Click here to have a look on the documentation of the [React Component](https://github.com/porscheofficial/cookie-consent-banner/tree/main/packages/cookie-consent-banner-react)._\n_Make sure to also have a look on the [main repository](https://github.com/porscheofficial/cookie-consent-banner)._\n\n---\n\n- [Usage](#spiral_notepad-usage)\n - [Installation](#installation)\n - [Attributes](#attributes)\n - [Events Dispatched](#events-dispatched-by-the-component)\n - [Events Receivable](#events-receivable-by-the-component)\n - [Styling](#styling)\n- [Real World Examples](#rocket-real-world-examples)\n - [with Tag Manager](#with-tag-manager)\n - [without Tag Manager](#without-tag-manager)\n- [Disclaimer](#disclaimer)\n- [License](#license)\n\n## :spiral_notepad: Usage\n\n### Installation\n\nEither install via a package manager, or include the component through one of the various npm delivery networks (skypack, unpkg,..).\n\n```bash\n// yarn\nyarn add @porscheofficial/cookie-consent-banner\n// or npm\nnpm i @porscheofficial/cookie-consent-banner --S\n```\n\n```html\n\n```\n\n### Attributes\n\n| Attribute (Web Component) | Default | Type | Description |\n| :------------------------------------------------ | :---------------------------------------------------------- | :-------------------------------------------------------------------- | :--------------------------------------------------------------------------------------------------------------------------- |\n| `available-categories` | `[]` | `CategoryItem[]` | Provide the available Categories. See Real World example |\n| `cookie-attributes` | `{path: \"/\",expires: 7,domain: document.location.hostname}` | [`CookieAttributes`](./src/components/cookie-consent-banner/types.ts) | Customization of the cookie attributes for the consent cookie (`expires` can either be a number of days or a `Date` object). |\n| `cookie-name` | `\"cookies_accepted_categories\"` | `string` | |\n| `disable-reset-site-cookies-on-consent-withdrawn` | `false` | `boolean` | Prevent cookies from being deleted automatically if consent of the user changed. |\n| `disable-slide-in-animation` | `false` | `boolean` | Disable slide-in animation of banner (See #7) |\n| `headline` | `undefined` | `string` | |\n| `btn-label-accept-and-continue` | `undefined` | `string` | |\n| `btn-label-select-all-and-continue` | `undefined` | `string` | |\n| `btn-label-only-essential-and-continue` | `undefined` | `string` | |\n| `btn-label-persist-selection-and-continue` | `undefined` | `string` |\n| `content-settings-description` | `undefined` | `string` | |\n\n### Events Dispatched by the Component\n\n| Event | Description |\n| ------------------------------------- | ------------------------------------------------------------------------------ |\n| `cookie_consent_preferences_restored` | Consent Settings have been saved previously and are now restored on Page Load. |\n| `cookie_consent_preferences_updated` | Consent Settings have been updated. Either initially set or changed. |\n\n### Events Receivable by the Component\n\nIt's possible to send JavaScript Events to control the banner.\n\n| Event | Description |\n| ----------------------------- | ---------------------------------------------------------------------------------------------- |\n| `cookie_consent_show` | Show the the Consent Banner. |\n| `cookie_consent_details_show` | Show the detailed settings (categories). Also the Consent Banner is shown if not done already. |\n\n#### Q: How to show the cookie consent banner again?\n\nIn order to allow the user to always update its preferences it's possible to trigger the banner by sending an event:\n\n```html\n\n Show Cookie Settings\n\n```\n\n### Styling\n\nStyling can be done in two different ways: Either via the availabe CSS Properties or via the [CSS `::part` pseudo-element](https://developer.mozilla.org/en-US/docs/Web/CSS/::part).\n\n#### Styling with CSS Properties\n\nThe 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](#styling-with-the-part-selectors) if you need more flexibility.\n\n```html\n\n```\n\n#### Styling with the `::part` selectors\n\nFor full control over the styles we provide you these CSS parts to customize completely by your own:\n\n1. `cookie-consent-banner::part(button-accept-all)` for styling the primary button which triggers \"Accept All Cookies\"\n2. `cookie-consent-banner::part(button-persist-selection)` for styling the secondary button which triggers \"Save Selection\"\n3. `cookie-consent-banner::part(button-essential-only)` for styling the secondary button which triggers \"Only required Cookies\"\n4. `cookie-consent-banner::part(checkbox)` for styling the checkboxes\n5. `cookie-consent-banner::part(description-main)` for styling the main description text\n6. `cookie-consent-banner::part(description-settings)` for styling the description text on the expanded settings\n7. `cookie-consent-banner::part(headline)` for styling the headline\n8. `cookie-consent-banner::part(body)` for styling the banner body\n\n```html\n\n```\n\n## :rocket: Real World Examples\n\n### ...with Tag Manager\n\nThis example shows how the component could be integrated into your web application by leveraging the features of a tag manager.\nThe tag manager is not loaded as long as there is no consent given.\nOnce 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.\nHave a look on the main repository for an [example consent flow](https://github.com/porscheofficial/cookie-consent-banner#arrows_counterclockwise-consent-flow).\n\n```html\n\n\n\n\n\n\n\n We use cookies and similar technologies to provide certain features, enhance\n the user experience and deliver content that is relevant to your interests.\n Depending on their purpose, analysis and marketing cookies may be used in\n addition to technically necessary cookies. By clicking on \"Agree and\n continue\", you declare your consent to the use of the aforementioned cookies.\n \n Here\n \n you can make detailed settings or revoke your consent (in part if necessary)\n with effect for the future. For further information, please refer to our\n Privacy Policy\n .\n\n\n\n\n Show Cookie Consent Settings\n\n\n\n\n```\n\n### ...without Tag Manager\n\nThis example shows how the component could be integrated into your web application without leveraging the features of a tag manager.\nThe scripts are not loaded as long as there is no consent given.\nOnce the visitor stores the consent settings, two things happen: The consent data is stored as a cookie `cookies_accepted_categories` and the script elements are added to the page.\n\n```html\n\n\n\n\n\n\n\n We use cookies and similar technologies to provide certain features, enhance\n the user experience and deliver content that is relevant to your interests.\n Depending on their purpose, analysis and marketing cookies may be used in\n addition to technically necessary cookies. By clicking on \"Agree and\n continue\", you declare your consent to the use of the aforementioned cookies.\n \n Here\n \n you can make detailed settings or revoke your consent (in part if necessary)\n with effect for the future. For further information, please refer to our\n Privacy Policy\n .\n\n\n\n\n Show Cookie Consent Settings\n\n\n\n\n\n```\n\n---\n\n## Disclaimer\n\n_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._\n\n## License\n\nSee [LICENSE](./LICENSE.md).\n","readmeFilename":"README.md"}