https://github.com/mattbit/biscuit

A simple, style-free, cookie banner
https://github.com/mattbit/biscuit

Last synced: 10 months ago
JSON representation

A simple, style-free, cookie banner

• Host: GitHub
• URL: https://github.com/mattbit/biscuit
• Owner: mattbit
• Created: 2015-06-02T21:55:29.000Z (about 11 years ago)
• Default Branch: master
• Last Pushed: 2015-10-28T09:15:05.000Z (over 10 years ago)
• Last Synced: 2025-04-09T09:40:39.889Z (about 1 year ago)
• Language: JavaScript
• Size: 122 KB
• Stars: 7
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
## 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:

```html

```

Then initialize the banner:

```js

    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: '✕', // The close button text

        hideOnScroll: true,

        template: '
{{ text }} {{ close_text }}
',

        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:

```js

    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