@cookie-banner/stencil
v0.0.9
Published
GDPR compliant cookie consent tool
Downloads
230
Readme
Web Component Cookie banner
A Web Component cookie banner, primarily built to comply with the GDPR. View the Github repo for more details.
Getting started
Installation
Since Stencil creates a web component, this can be used whether or not you are using Stencil in your project.
npm install @cookie-banner/stencilor, if you're using yarn:
yarn add @cookie-banner/stencilUsage
After adding the <cookie-banner></cookie-banner> component, a setup is required. This can be done by running a function after the component is defined:
await customElements.whenDefined('cookie-banner');
document.querySelector('cookie-banner').setOptions(options)Here is a minimal example of how the options object can look:
const options = {
categories: [
{
key: 'analytics',
name: 'Analytical Cookies',
description: 'Allows analytic to be used to improve the usability of the website in the future',
purpose: 'analytical',
},
],
cookiePolicyLastUpdated: '2023-09-13',
linkToPrivacyPolicy: 'https://example.com',
}Check out the Options and Category objects to view the details of these properties and other optional ones.
Example usage
<script>
customElements.whenDefined('cookie-banner').then(async () => {
const cookieBanner = document.querySelector('cookie-banner')!;
const options = {/*...*/};
cookieBanner.setOptions(options);
})
//manually check
const acceptedCategories = await cookieBanner.getCategoriesWithConsent();
if (category.includes('analytical')){
//run analytics
}
//listen to event
cookieBanner.addEventListener('consentUpdated', e => {
for (const category of e.detail){
//update data collection
}
})
</script>
<body>
<cookie-banner></cookie-banner>
</body>
´´´