1.0.5 • Published 6 years ago

@cyb10101/cookie-bar v1.0.5

Weekly downloads
2
License
Public domain
Repository
github
Last release
6 years ago

Cookie Bar

Licence: Public Domain - Feel free to use it, but you can also improve this.

Install via Git

Simply clone git and add JavaScript and CSS file.

You'll get that somehow.

Install via NPM or Yarn

Execute command to add the package:

# Add package via NPM
npm add @cyb10101/cookie-bar

# Add package via Yarn
yarn add @cyb10101/cookie-bar

Add the JavaScript include:

// For Webpack
require('@cyb10101/cookie-bar');

Add the CSS include in Sass generation:

@import '~@cyb10101/cookie-bar/jquery.cookie-bar.css';

Simplest configuration

Include JavaScript after the jQuery library

<link rel="stylesheet" href="jquery.cookie-bar.css"/>
<script src="jquery.cookie-bar.js" type="text/javascript"></script>

Add JavaScript call to run the cookie bar

jQuery(function ($) {
    $.cookieBar();
});

Fixed navigation bar

How to set for fixed top navigation

  • HTML
<div class="fixed-top" style="position: fixed; top: 0; right: 0; left: 0;">
    <nav class="navbar">
        Content
    </nav>
</div>
  • JavaScript
$.cookieBar({
    attach: '.fixed-top',
    fixed: false
});

Advanced/full configuration

$.cookieBar({
    attach: 'body',
    fixed: true,
    language: 'en', // Empty for auto detection [en,de]
    classText: '',
    classButtonAccept: '',
    classButtonDecline: '',
    showButtonDecline: true,
    animationSpeed: 400,
    cookieName: 'cookies',
    cookieValueAccept: 'allowed',
    cookiePath: '/',
    cookieSecure: false,
    cookieDomain: '', // example.org
    cookieExpires: 365, // Date or days if it is a number
    callAfterClickedAccept: function () {
        console.log('Run method');
    },
    callAfterClickedDecline: function () {
        console.log('Run method');
    }
});

Run Cookiebar with own template

JavaScript adaptations

$('#cookie-bar-template').cookieBar({
    classText: 'text',
    classButtonAccept: 'button-accept',
    classButtonDecline: 'button-decline',
});

HTML template. The cookiebar-* classes then only used for styling.

<div id="cookie-bar-template" class="cookie-bar" style="display: none;">
    <a class="button-accept cookiebar-decline">No, that's my cookies!</a>
    <a class="button-decline cookiebar-accept">Okay, we could share...</a>
    <p class="text cookiebar-text">Give cookie monster cookies!</p>
</div>

Add your own language or override existing

Cyb.CookieBar.languageText.en = {
    accept: 'Okay, we could share...',
    decline: 'No, that\'s my cookies!',
    cookieText: 'Give cookie monster cookies!'
};

$.cookieBar();

Opt Out

Add opt out button to reset cookie bar.

  • JavaScript
// Without settings
$('.cookie-bar-optout').cookieBarOptOut();

// With settings
$('.cookie-bar-optout').cookieBarOptOut({
    cookieName: 'cookies',
    cookieValueDecline: 'denied',
    cookiePath: '/',
    cookieSecure: false,
    cookieDomain: '',
    callAfterClickedOptOut: function () {
        console.log('Run method');
    }
});
  • HTML Button
<a class="cookie-bar-optout">Cookie Bar Opt Out</a>
1.0.5

6 years ago

1.0.4

6 years ago

1.0.3

6 years ago

1.0.2

6 years ago

1.0.0

6 years ago