Security News
tea.xyz Spam Plagues npm and RubyGems Package Registries
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
@zeerobug/cookie-consent-banner
Advanced tools
Readme
This is a vanilla JS implementation (thanks to Svelte) of a compliant GDPR banner. It allows the user granular opt-in and out of four different cookie categories.
Simply install the node module into your codebase.
npm install --save-dev @beyonk/gdpr-cookie-consent-banner
then import the banner into your code:
import attachBanner from '@beyonk/gdpr-cookie-consent-banner';
import '@beyonk/gdpr-cookie-consent-banner/dist/style.css'; // import optional styles
attachBanner(document.body);
<link
rel="stylesheet"
href="//unpkg.com/@beyonk/gdpr-cookie-consent-banner/dist/style.css"
/>
<script src="//unpkg.com/@beyonk/gdpr-cookie-consent-banner/dist/browser/bundle.min.js"></script>
Download the contents of dist/browser/bundle.js
and dist/style.css
to your codebase, and include it in your html:
<link rel="stylesheet" href="path/to/style.css" />
<script src="path/to/bundle.js"></script>
<script>
GdprConsent.attachBanner(document.body);
</script>
Because this banner was designed to work across three different technology stacks, usage is a bit different to a regular es module.
I've documented our usage of it below:
Just use it as a regular svelte component:
<GdprBanner
cookieName="foo"
description="bar"
on:analytics="this.someFunction()"
/>
<script>
import '@beyonk/gdpr-cookie-consent-banner/dist/style.css'; // optional, you can also define your own styles
import GdprBanner from '@beyonk/gdpr-cookie-consent-banner';
</script>
See the v4.x.x tag of this repository.
You can use the banner in NuxtJS application as follows:
Create a component which uses the library, and mounts it during the render stage:
<template>
<div ref="gdprBanner"></div>
</template>
<script>
export default {
mounted () {
const { attachBanner } = require('@beyonk/gdpr-cookie-consent-banner/dist/esm/bundle.js')
attachBanner(this.$refs.gdprBanner, {
heading: 'Cookie policy'
})
}
}
</script>
Optionally, add this to your CSS array in your nuxt.config.js
file:
/**
* Global CSS
**/
css: ['your_other_css_file.css', '@beyonk/gdpr-cookie-consent-banner/dist/style.css'],
The defaults are shown below, simply put modified versions of as many of the below into an options object, and pass it to attachBanner.
It is not possible to opt-out of 'necessary' cookies.
const options = {
/**
* You must set the cookie name.
**/
cookieName: 'beyonk_gdpr',
/**
* The cookie configuration, such as domain and path.
**/
cookieConfig: {
domain: 'example.com',
path: '/',
},
/**
* These are the top two lines of text on the banner
* The 'description' field can include html such as links
**/
heading: 'GDPR Notice',
description:
'We use cookies to offer a better browsing experience, analyze site traffic, personalize content, and serve targeted advertisements. Please review our <a href="/privacy-policy">privacy policy page</a>. By clicking accept, you consent to our privacy policy & use of cookies.',
/**
* All the button labels
**/
acceptLabel: 'Confirm all',
settingsLabel: 'Preferences',
closeLabel: 'Close window',
/**
* These are the default opt-ins and their descriptions.
* When value is set to true, the option will automatically be checked on load.
*
* If you don't want to show a category, simply remove the specified key from this object.
**/
choices: {
necessary: {
label: 'Required cookies',
description:
"These can't be turned off as they are used to control all the other cookies",
value: true,
},
analytics: false,
},
/**
* Show an icon to edit cookies later, when banner is closed.
**/
showEditIcon: true,
/**
* These are the functions which are run if a user opts-in to that category.
* You should drop your cookies here (or set a variable to control the later dropping of cookies.
*
* If you are using svelte, you can use events instead - see the Svelte section below.
**/
categories: {
analytics: function () {
console.log('No analytics cookies specified');
},
tracking: function () {
console.log('No tracking cookies specified');
},
marketing: function () {
console.log('No marketing cookies specified');
},
necessary: function () {
console.log('No necessary cookies specified');
},
},
/**
* Added by zeerobug
* This is run when the submit button is pressed
* It contains all categories and their state
* usefull to toggle cookies on and off
**/
choicesHandler: function (choices) {
console.log('Currrent state of categories', choices);
},
};
GdprConsent.attachBanner(document.body, options);
FAQs
GDPR Cookie Consent Banner in vanilla js
The npm package @zeerobug/cookie-consent-banner receives a total of 1 weekly downloads. As such, @zeerobug/cookie-consent-banner popularity was classified as not popular.
We found that @zeerobug/cookie-consent-banner demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
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.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.
Security News
UnitedHealth Group disclosed that the ransomware attack on Change Healthcare compromised protected health information for millions in the U.S., with estimated costs to the company expected to reach $1 billion.