#Cookie Consent 2 (Beta) Cookie Consent 2 is a lightweight JavaScript plugin to alert users about the use of cookies on your site.
- Lightweight: (~3.5kb minified)
- Customisable: Easily change the wording to fit your site.
- Built in themes: We've created a variety of different themes so you don't have to.
##Getting started
The easiest way to get up and running is to use our configurator (coming soon). This will guide you through customising the plugin.
For more advanced configuration, keep reading.
Include cookieconsent.js on your page.:
<!-- Minified Cookie Consent served from our CDN -->
<script src="http://cc.silktide.com/cookieconsent.min.js"></script>
The package is also available from bower and can be installed using bower install --save cookieconsent2
To customise the Cookie Consent plugin, you can provide an options object before including it.
<script>
window.cookieconsent_options = {
learnMore: 'More info',
link: 'http://example.com/cookiepolicy'
};
</script>
<script src="http://cc.silktide.com/cookieconsent.min.js"></script>
These are the options you can pass to Cookie Consent.
-
message: (string) - default: 'This website uses cookies to ensure you get the best experience on our website'
The message shown by the plugin
-
dismiss: (string) - default: 'Got it!'
The text used on the dismiss button
-
learnMore: (string) - default: 'More info'
The text shown on the link to the cookie policy (requires the link option to also be set)
-
link: (string) - default: null
The url of your cookie policy. If it's set to null, the link is hidden.
-
container: (string: CSS selector) - default: null
The element you want the Cookie Consent notification to be appended to. If null, the Cookie Consent plugin is appended to the body.
Note: the majority of our built in themes are designed around the plugin being a child of the body.
-
theme: (string) - default: 'light-floating'
The theme you wish to use. Can be any of the themes from the style directory, i.e. 'dark-top'.
If you wish to use your own css instead, pass a path here. i.e.
'styles/my_custom_theme.css'
and it will be dynamically loaded.To stop Cookie Consent from loading css at all, pass
false
.
Feel free to improve the plugin and send us a pull request.
We use gulp to compile scss and minify the javascript. Assuming nodejs is installed, you can run a build with:
cd path/to/cookieconsent
npm install
npm install -g gulp
gulp build
Code released under the GPLv3 License.
@drball - Themes
@adjohu - JavaScript