Coder Social home page Coder Social logo

biscuit's Introduction

Biscuit

Biscuit is a simple Javascript library to display a cookie law banner. It has no dependency and is style-free.

Usage

Include the script in you page:

<script type="text/javascript" src="biscuit.min.js"></script>

Then initialize the banner:

    Biscuit.init({
        cookie: "biscuit_consent", // The name of the cookie used to remember the consent
        expire: 365, // Number of days the cookie will be kept
        text: "This website uses cookies ;)",
        link: "/cookie-policy",
        link_text: "More info",
        close_text: '&#x2715;', // The close button text
        hideOnScroll: true,
        template: '<div id="cookie-banner">{{ text }} <button id="close-btn">{{ close_text }}</button></div>',
        containerId: 'cookie-banner', // Adjust to your needs if you use a custom template
        closeButtonId: 'close-btn' 
    });

The variables available inside the template are text, link, link_text, close_text.

You can also manually remove/insert the banner:

    var biscuit = Biscuit.init();
    
    biscuit.remove(); // Removes the banner (and sets a cookie to remember the consent)
    biscuit.show(); // Shows the banner

To do

  • Write tests

biscuit's People

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

Forkers

tatma

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.