Socket
Socket
Sign inDemoInstall

@cookie-banner/stencil

Package Overview
Dependencies
1
Maintainers
1
Versions
6
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    @cookie-banner/stencil

GDPR compliant cookie consent tool


Version published
Weekly downloads
53
decreased by-26.39%
Maintainers
1
Install size
20.2 MB
Created
Weekly downloads
 

Readme

Source

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/stencil

or, if you're using yarn:

yarn add @cookie-banner/stencil

Usage

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>
´´´

FAQs

Last updated on 10 Dec 2023

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc