simple-cookie-handler
v0.1.8
Published
Handling Cookie Warning
Downloads
12
Readme
Cookie Warning Handler
DSGVO <3. Shows a cookie warning. If the user accepts the cookie warning, a cookie is written and the alert is no longer displayed.
Installing Package
- Loading package via
npm:npm install simple-cookie-handler -E
bower:bower install simple-cookie-handler
yarn:yarn add simple-cookie-handler --E
- Load the files
simple-cookie-handler/dist/cookie.min.js
andsimple-cookie-handler/dist/cookie.min.css
Loading via html
<link rel="stylesheet" href="[path-to-folder]simple-cookie-handler/dist/cookie.min.css">
<script src="[path-to-folder]simple-cookie-handler/dist/cookie.min.js">
<script>
new CookieWarning().init(options);
</script>
Usage with webpack
import 'simple-cookie-handler/dist/cookie.min.css';
const CookieWarning = require('simple-cookie-handler/dist/cookie.min');
new CookieWarning().init(options);
Or
webpack.common.js
new webpack.ProvidePlugin({
CookieWarning: 'exports-loader?CookieWarning!simple-cookie-handler/dist/cookie.min'
});
import.scss
@import "~simple-cookie-handler/dist/cookie.min.css";
main.js
new CookieWarning().init(options);
Options
onAccept
function
- will be triggered if cookie has been accepted
Default: function() {}
localUrls
string regex
- regex string to detect local url
Default: localhost
cookieName
string
- name of the cookie
Default: kr-cookie-acc
declineAction
function
- evil eval function because dont know what to do with this option :)
Default: console.log('user declined cookie');
duration
int
- duration the cookie exist
Default: 31536e3
value
string
- value of cookie
Default: true
path
string
- path for the cookie
Default: /
tplWording
object
- contains the template texts
Defaults:
content:string
- cookie content
Default: Diese Website verwendet Cookies. Indem (...)
btnAcceptstring
- contains accept button text
Default: Akzeptieren
btnDeclinestring
: - contains decline button text
Default:
btnInfostring
- contains accept button text
Default: Mehr erfahren
tplOptions
object
- contains the template options
Defaults:
infoLinkobject
- contains info link and target attribute
Default: target: "", url: ""
positionstring
- position of the cookie warning
Default: bottom, accepted is: top, bottom
btnAcceptClassstring
- class of the accept button
Default: cookie-warning__accept
btnDeclineClass:string
- class of the decline button
Default: cookie-warning__decline
btnInfoClass:string
- class of the info button (link)
Default: cookie-warning__info
template
template: function(wording, options) {
return `<div class="cookie-warning ${options.position}">
<div class="cookie-warning__inner ">
<p>${ wording.content }</p>
</div>
<div class="cookie-warning__footer">
${ wording.btnDecline.length > 0 ? `<button class="${ options.btnDeclineClass } cookie-warning__btn cookie-warning__button--secondary">${ wording.btnDecline }</button>` : ''}
<button class="${ options.btnAcceptClass } cookie-warning__btn cookie-warning__button--primary">${ wording.btnAccept }</button>
${ wording.btnInfo.length > 0 ? `<a href="${ options.infoLink.url}" target="${ options.infoLink.target}"
class="${ options.btnInfoClass } cookie-warning__btn cookie-warning__button--primary">${ wording.btnInfo }</a>` : ''
}
</div>
</div>
`;
}