Cookie Consent App for LFS/Django
Project description
LFS Cookie Consent
A reusable Django app for GDPR-compliant cookie consent management, featuring integration with Google Tag Manager (GTM) and Google Consent Mode V2. Originally developed for Lightning Fast Shop, it is designed to be used in any Django project.
Note: LFS Cookie Consent currently supports Google Analytics cookies only. Additional cookie types will be supported in upcoming releases.
Features
- Cookie banner with options to accept, decline, or customize consent
- Granular control for necessary and analytics cookies
- Google Tag Manager (GTM) integration
- Google Consent Mode V2 support (only analytics_storage at the moment)
Installation
-
Add the app to your Django project:
- Copy the
lfs_cookie_consentdirectory into your project. - Add
'lfs_cookie_consent'to yourINSTALLED_APPSinsettings.py.
- Copy the
-
Configure your GTM ID in
settings.py:GTM_ID = "GTM-XXXXXXX" # Replace with your GTM container ID
-
Collect static files:
python manage.py collectstatic
Usage
-
Include the template tags and the provided CSS and Javascript in your base template:
{% load static %} {% load lfs_cookie_consent_tags %} <head> <link rel="stylesheet" href="{% static 'lfs_cookie_consent/lfs_cookie_consent.css' %}"> <script src="{% static 'lfs_cookie_consent/lfs_cookie_consent.js' %}"></script> {% gtm_script %} </head> <body> {% gtm_noscript %} {% cookie_banner %} {% cookie_modal %} </body>
-
Add a link to open the modal anywhere:
<a href="#" onclick="window.showCookieSettings(); return false;">Open cookie settings</a>
How it works
- On first visit, a cookie banner is shown.
- Users can accept all, decline all, or customize their preferences (analytics cookies only for now).
- Consent is stored in a cookie and applied via Google Consent Mode V2 (
analytics_storage). - GTM and Google Analytics tags will only fire if consent is granted.
Google Tag Manager Setup
- Create a GTM container and use the ID in your Django settings.
- Add a Google Analytics 4 tag in GTM.
- Add a trigger
Page Viewto your tag - Don't forget to publish your changes
- Consent Mode is automatically handled by this app (no extra GTM configuration needed).
- Test with Tag Assistant or GTM Preview to ensure tags fire only after consent.
Customization
- Edit the templates in
lfs_cookie_consent/templates/lfs_cookie_consent/for your own texts and styles. - Edit the CSS in
static/lfs_cookie_consent/lfs_cookie_consent.cssfor design adjustments.
CSS Naming Convention and Conflict Avoidance
All CSS classes and IDs in this app are prefixed with lcc- (e.g. .lcc-cookie-banner, #lcc-accept-all, .lcc-modal-content, etc.).
This reliably hopefully prevents conflicts with other apps or the main project.
Test view and temporary URL inclusion
This package comes with a simple test view that lets you quickly try out the cookie banner and modal. The view renders a sample page with all relevant components.
How to use the test view:
-
Temporarily add the test view URL to your project: Open your main
urls.py(e.g. in your main project or test project) and add:from lfs_cookie_consent.views import test_cookie_banner from django.urls import path urlpatterns = [ # ... your other URLs ... path("", test_cookie_banner, name="test_cookie_banner"), ]
Note: This should only be done for testing purposes and should not remain active in production. Make sure you have set your GTM_ID in the settings.
-
Open your project's start page in the browser. You should see the cookie banner and modal as intended.
-
Open your browser's developer tools, go to the cookies section, and observe how cookies are set or deleted based on your consent choices.
-
Remove the temporary URL once you have finished testing the functionality.
License
MIT License
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
